done
This commit is contained in:
305
lib/python3.11/site-packages/plotly/graph_objs/__init__.py
Normal file
305
lib/python3.11/site-packages/plotly/graph_objs/__init__.py
Normal file
@ -0,0 +1,305 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._bar import Bar
|
||||
from ._barpolar import Barpolar
|
||||
from ._box import Box
|
||||
from ._candlestick import Candlestick
|
||||
from ._carpet import Carpet
|
||||
from ._choropleth import Choropleth
|
||||
from ._choroplethmap import Choroplethmap
|
||||
from ._choroplethmapbox import Choroplethmapbox
|
||||
from ._cone import Cone
|
||||
from ._contour import Contour
|
||||
from ._contourcarpet import Contourcarpet
|
||||
from ._densitymap import Densitymap
|
||||
from ._densitymapbox import Densitymapbox
|
||||
from ._deprecations import AngularAxis
|
||||
from ._deprecations import Annotation
|
||||
from ._deprecations import Annotations
|
||||
from ._deprecations import ColorBar
|
||||
from ._deprecations import Contours
|
||||
from ._deprecations import Data
|
||||
from ._deprecations import ErrorX
|
||||
from ._deprecations import ErrorY
|
||||
from ._deprecations import ErrorZ
|
||||
from ._deprecations import Font
|
||||
from ._deprecations import Frames
|
||||
from ._deprecations import Histogram2dcontour
|
||||
from ._deprecations import Legend
|
||||
from ._deprecations import Line
|
||||
from ._deprecations import Margin
|
||||
from ._deprecations import Marker
|
||||
from ._deprecations import RadialAxis
|
||||
from ._deprecations import Scene
|
||||
from ._deprecations import Stream
|
||||
from ._deprecations import Trace
|
||||
from ._deprecations import XAxis
|
||||
from ._deprecations import XBins
|
||||
from ._deprecations import YAxis
|
||||
from ._deprecations import YBins
|
||||
from ._deprecations import ZAxis
|
||||
from ._figure import Figure
|
||||
from ._frame import Frame
|
||||
from ._funnel import Funnel
|
||||
from ._funnelarea import Funnelarea
|
||||
from ._heatmap import Heatmap
|
||||
from ._histogram import Histogram
|
||||
from ._histogram2d import Histogram2d
|
||||
from ._histogram2dcontour import Histogram2dContour
|
||||
from ._icicle import Icicle
|
||||
from ._image import Image
|
||||
from ._indicator import Indicator
|
||||
from ._isosurface import Isosurface
|
||||
from ._layout import Layout
|
||||
from ._mesh3d import Mesh3d
|
||||
from ._ohlc import Ohlc
|
||||
from ._parcats import Parcats
|
||||
from ._parcoords import Parcoords
|
||||
from ._pie import Pie
|
||||
from ._sankey import Sankey
|
||||
from ._scatter import Scatter
|
||||
from ._scatter3d import Scatter3d
|
||||
from ._scattercarpet import Scattercarpet
|
||||
from ._scattergeo import Scattergeo
|
||||
from ._scattergl import Scattergl
|
||||
from ._scattermap import Scattermap
|
||||
from ._scattermapbox import Scattermapbox
|
||||
from ._scatterpolar import Scatterpolar
|
||||
from ._scatterpolargl import Scatterpolargl
|
||||
from ._scattersmith import Scattersmith
|
||||
from ._scatterternary import Scatterternary
|
||||
from ._splom import Splom
|
||||
from ._streamtube import Streamtube
|
||||
from ._sunburst import Sunburst
|
||||
from ._surface import Surface
|
||||
from ._table import Table
|
||||
from ._treemap import Treemap
|
||||
from ._violin import Violin
|
||||
from ._volume import Volume
|
||||
from ._waterfall import Waterfall
|
||||
from . import bar
|
||||
from . import barpolar
|
||||
from . import box
|
||||
from . import candlestick
|
||||
from . import carpet
|
||||
from . import choropleth
|
||||
from . import choroplethmap
|
||||
from . import choroplethmapbox
|
||||
from . import cone
|
||||
from . import contour
|
||||
from . import contourcarpet
|
||||
from . import densitymap
|
||||
from . import densitymapbox
|
||||
from . import funnel
|
||||
from . import funnelarea
|
||||
from . import heatmap
|
||||
from . import histogram
|
||||
from . import histogram2d
|
||||
from . import histogram2dcontour
|
||||
from . import icicle
|
||||
from . import image
|
||||
from . import indicator
|
||||
from . import isosurface
|
||||
from . import layout
|
||||
from . import mesh3d
|
||||
from . import ohlc
|
||||
from . import parcats
|
||||
from . import parcoords
|
||||
from . import pie
|
||||
from . import sankey
|
||||
from . import scatter
|
||||
from . import scatter3d
|
||||
from . import scattercarpet
|
||||
from . import scattergeo
|
||||
from . import scattergl
|
||||
from . import scattermap
|
||||
from . import scattermapbox
|
||||
from . import scatterpolar
|
||||
from . import scatterpolargl
|
||||
from . import scattersmith
|
||||
from . import scatterternary
|
||||
from . import splom
|
||||
from . import streamtube
|
||||
from . import sunburst
|
||||
from . import surface
|
||||
from . import table
|
||||
from . import treemap
|
||||
from . import violin
|
||||
from . import volume
|
||||
from . import waterfall
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[
|
||||
".bar",
|
||||
".barpolar",
|
||||
".box",
|
||||
".candlestick",
|
||||
".carpet",
|
||||
".choropleth",
|
||||
".choroplethmap",
|
||||
".choroplethmapbox",
|
||||
".cone",
|
||||
".contour",
|
||||
".contourcarpet",
|
||||
".densitymap",
|
||||
".densitymapbox",
|
||||
".funnel",
|
||||
".funnelarea",
|
||||
".heatmap",
|
||||
".histogram",
|
||||
".histogram2d",
|
||||
".histogram2dcontour",
|
||||
".icicle",
|
||||
".image",
|
||||
".indicator",
|
||||
".isosurface",
|
||||
".layout",
|
||||
".mesh3d",
|
||||
".ohlc",
|
||||
".parcats",
|
||||
".parcoords",
|
||||
".pie",
|
||||
".sankey",
|
||||
".scatter",
|
||||
".scatter3d",
|
||||
".scattercarpet",
|
||||
".scattergeo",
|
||||
".scattergl",
|
||||
".scattermap",
|
||||
".scattermapbox",
|
||||
".scatterpolar",
|
||||
".scatterpolargl",
|
||||
".scattersmith",
|
||||
".scatterternary",
|
||||
".splom",
|
||||
".streamtube",
|
||||
".sunburst",
|
||||
".surface",
|
||||
".table",
|
||||
".treemap",
|
||||
".violin",
|
||||
".volume",
|
||||
".waterfall",
|
||||
],
|
||||
[
|
||||
"._bar.Bar",
|
||||
"._barpolar.Barpolar",
|
||||
"._box.Box",
|
||||
"._candlestick.Candlestick",
|
||||
"._carpet.Carpet",
|
||||
"._choropleth.Choropleth",
|
||||
"._choroplethmap.Choroplethmap",
|
||||
"._choroplethmapbox.Choroplethmapbox",
|
||||
"._cone.Cone",
|
||||
"._contour.Contour",
|
||||
"._contourcarpet.Contourcarpet",
|
||||
"._densitymap.Densitymap",
|
||||
"._densitymapbox.Densitymapbox",
|
||||
"._deprecations.AngularAxis",
|
||||
"._deprecations.Annotation",
|
||||
"._deprecations.Annotations",
|
||||
"._deprecations.ColorBar",
|
||||
"._deprecations.Contours",
|
||||
"._deprecations.Data",
|
||||
"._deprecations.ErrorX",
|
||||
"._deprecations.ErrorY",
|
||||
"._deprecations.ErrorZ",
|
||||
"._deprecations.Font",
|
||||
"._deprecations.Frames",
|
||||
"._deprecations.Histogram2dcontour",
|
||||
"._deprecations.Legend",
|
||||
"._deprecations.Line",
|
||||
"._deprecations.Margin",
|
||||
"._deprecations.Marker",
|
||||
"._deprecations.RadialAxis",
|
||||
"._deprecations.Scene",
|
||||
"._deprecations.Stream",
|
||||
"._deprecations.Trace",
|
||||
"._deprecations.XAxis",
|
||||
"._deprecations.XBins",
|
||||
"._deprecations.YAxis",
|
||||
"._deprecations.YBins",
|
||||
"._deprecations.ZAxis",
|
||||
"._figure.Figure",
|
||||
"._frame.Frame",
|
||||
"._funnel.Funnel",
|
||||
"._funnelarea.Funnelarea",
|
||||
"._heatmap.Heatmap",
|
||||
"._histogram.Histogram",
|
||||
"._histogram2d.Histogram2d",
|
||||
"._histogram2dcontour.Histogram2dContour",
|
||||
"._icicle.Icicle",
|
||||
"._image.Image",
|
||||
"._indicator.Indicator",
|
||||
"._isosurface.Isosurface",
|
||||
"._layout.Layout",
|
||||
"._mesh3d.Mesh3d",
|
||||
"._ohlc.Ohlc",
|
||||
"._parcats.Parcats",
|
||||
"._parcoords.Parcoords",
|
||||
"._pie.Pie",
|
||||
"._sankey.Sankey",
|
||||
"._scatter.Scatter",
|
||||
"._scatter3d.Scatter3d",
|
||||
"._scattercarpet.Scattercarpet",
|
||||
"._scattergeo.Scattergeo",
|
||||
"._scattergl.Scattergl",
|
||||
"._scattermap.Scattermap",
|
||||
"._scattermapbox.Scattermapbox",
|
||||
"._scatterpolar.Scatterpolar",
|
||||
"._scatterpolargl.Scatterpolargl",
|
||||
"._scattersmith.Scattersmith",
|
||||
"._scatterternary.Scatterternary",
|
||||
"._splom.Splom",
|
||||
"._streamtube.Streamtube",
|
||||
"._sunburst.Sunburst",
|
||||
"._surface.Surface",
|
||||
"._table.Table",
|
||||
"._treemap.Treemap",
|
||||
"._violin.Violin",
|
||||
"._volume.Volume",
|
||||
"._waterfall.Waterfall",
|
||||
],
|
||||
)
|
||||
|
||||
|
||||
if sys.version_info < (3, 7) or TYPE_CHECKING:
|
||||
try:
|
||||
import ipywidgets as _ipywidgets
|
||||
from packaging.version import Version as _Version
|
||||
|
||||
if _Version(_ipywidgets.__version__) >= _Version("7.0.0"):
|
||||
from ..graph_objs._figurewidget import FigureWidget
|
||||
else:
|
||||
raise ImportError()
|
||||
except Exception:
|
||||
from ..missing_anywidget import FigureWidget
|
||||
else:
|
||||
__all__.append("FigureWidget")
|
||||
orig_getattr = __getattr__
|
||||
|
||||
def __getattr__(import_name):
|
||||
if import_name == "FigureWidget":
|
||||
try:
|
||||
import ipywidgets
|
||||
from packaging.version import Version
|
||||
|
||||
if Version(ipywidgets.__version__) >= Version("7.0.0"):
|
||||
from ..graph_objs._figurewidget import FigureWidget
|
||||
|
||||
return FigureWidget
|
||||
else:
|
||||
raise ImportError()
|
||||
except Exception:
|
||||
from ..missing_anywidget import FigureWidget
|
||||
|
||||
return FigureWidget
|
||||
else:
|
||||
raise ImportError()
|
||||
|
||||
return orig_getattr(import_name)
|
||||
2598
lib/python3.11/site-packages/plotly/graph_objs/_bar.py
Normal file
2598
lib/python3.11/site-packages/plotly/graph_objs/_bar.py
Normal file
File diff suppressed because it is too large
Load Diff
1608
lib/python3.11/site-packages/plotly/graph_objs/_barpolar.py
Normal file
1608
lib/python3.11/site-packages/plotly/graph_objs/_barpolar.py
Normal file
File diff suppressed because it is too large
Load Diff
3052
lib/python3.11/site-packages/plotly/graph_objs/_box.py
Normal file
3052
lib/python3.11/site-packages/plotly/graph_objs/_box.py
Normal file
File diff suppressed because it is too large
Load Diff
1677
lib/python3.11/site-packages/plotly/graph_objs/_candlestick.py
Normal file
1677
lib/python3.11/site-packages/plotly/graph_objs/_candlestick.py
Normal file
File diff suppressed because it is too large
Load Diff
1257
lib/python3.11/site-packages/plotly/graph_objs/_carpet.py
Normal file
1257
lib/python3.11/site-packages/plotly/graph_objs/_carpet.py
Normal file
File diff suppressed because it is too large
Load Diff
1776
lib/python3.11/site-packages/plotly/graph_objs/_choropleth.py
Normal file
1776
lib/python3.11/site-packages/plotly/graph_objs/_choropleth.py
Normal file
File diff suppressed because it is too large
Load Diff
1749
lib/python3.11/site-packages/plotly/graph_objs/_choroplethmap.py
Normal file
1749
lib/python3.11/site-packages/plotly/graph_objs/_choroplethmap.py
Normal file
File diff suppressed because it is too large
Load Diff
1777
lib/python3.11/site-packages/plotly/graph_objs/_choroplethmapbox.py
Normal file
1777
lib/python3.11/site-packages/plotly/graph_objs/_choroplethmapbox.py
Normal file
File diff suppressed because it is too large
Load Diff
2262
lib/python3.11/site-packages/plotly/graph_objs/_cone.py
Normal file
2262
lib/python3.11/site-packages/plotly/graph_objs/_cone.py
Normal file
File diff suppressed because it is too large
Load Diff
2618
lib/python3.11/site-packages/plotly/graph_objs/_contour.py
Normal file
2618
lib/python3.11/site-packages/plotly/graph_objs/_contour.py
Normal file
File diff suppressed because it is too large
Load Diff
1837
lib/python3.11/site-packages/plotly/graph_objs/_contourcarpet.py
Normal file
1837
lib/python3.11/site-packages/plotly/graph_objs/_contourcarpet.py
Normal file
File diff suppressed because it is too large
Load Diff
1724
lib/python3.11/site-packages/plotly/graph_objs/_densitymap.py
Normal file
1724
lib/python3.11/site-packages/plotly/graph_objs/_densitymap.py
Normal file
File diff suppressed because it is too large
Load Diff
1751
lib/python3.11/site-packages/plotly/graph_objs/_densitymapbox.py
Normal file
1751
lib/python3.11/site-packages/plotly/graph_objs/_densitymapbox.py
Normal file
File diff suppressed because it is too large
Load Diff
723
lib/python3.11/site-packages/plotly/graph_objs/_deprecations.py
Normal file
723
lib/python3.11/site-packages/plotly/graph_objs/_deprecations.py
Normal file
@ -0,0 +1,723 @@
|
||||
import warnings
|
||||
|
||||
warnings.filterwarnings(
|
||||
"default", r"plotly\.graph_objs\.\w+ is deprecated", DeprecationWarning
|
||||
)
|
||||
|
||||
|
||||
class Data(list):
|
||||
"""
|
||||
plotly.graph_objs.Data is deprecated.
|
||||
Please replace it with a list or tuple of instances of the following types
|
||||
- plotly.graph_objs.Scatter
|
||||
- plotly.graph_objs.Bar
|
||||
- plotly.graph_objs.Area
|
||||
- plotly.graph_objs.Histogram
|
||||
- etc.
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.Data is deprecated.
|
||||
Please replace it with a list or tuple of instances of the following types
|
||||
- plotly.graph_objs.Scatter
|
||||
- plotly.graph_objs.Bar
|
||||
- plotly.graph_objs.Area
|
||||
- plotly.graph_objs.Histogram
|
||||
- etc.
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.Data is deprecated.
|
||||
Please replace it with a list or tuple of instances of the following types
|
||||
- plotly.graph_objs.Scatter
|
||||
- plotly.graph_objs.Bar
|
||||
- plotly.graph_objs.Area
|
||||
- plotly.graph_objs.Histogram
|
||||
- etc.
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class Annotations(list):
|
||||
"""
|
||||
plotly.graph_objs.Annotations is deprecated.
|
||||
Please replace it with a list or tuple of instances of the following types
|
||||
- plotly.graph_objs.layout.Annotation
|
||||
- plotly.graph_objs.layout.scene.Annotation
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.Annotations is deprecated.
|
||||
Please replace it with a list or tuple of instances of the following types
|
||||
- plotly.graph_objs.layout.Annotation
|
||||
- plotly.graph_objs.layout.scene.Annotation
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.Annotations is deprecated.
|
||||
Please replace it with a list or tuple of instances of the following types
|
||||
- plotly.graph_objs.layout.Annotation
|
||||
- plotly.graph_objs.layout.scene.Annotation
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class Frames(list):
|
||||
"""
|
||||
plotly.graph_objs.Frames is deprecated.
|
||||
Please replace it with a list or tuple of instances of the following types
|
||||
- plotly.graph_objs.Frame
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.Frames is deprecated.
|
||||
Please replace it with a list or tuple of instances of the following types
|
||||
- plotly.graph_objs.Frame
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.Frames is deprecated.
|
||||
Please replace it with a list or tuple of instances of the following types
|
||||
- plotly.graph_objs.Frame
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class AngularAxis(dict):
|
||||
"""
|
||||
plotly.graph_objs.AngularAxis is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.AngularAxis
|
||||
- plotly.graph_objs.layout.polar.AngularAxis
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.AngularAxis is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.AngularAxis
|
||||
- plotly.graph_objs.layout.polar.AngularAxis
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.AngularAxis is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.AngularAxis
|
||||
- plotly.graph_objs.layout.polar.AngularAxis
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class Annotation(dict):
|
||||
"""
|
||||
plotly.graph_objs.Annotation is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.Annotation
|
||||
- plotly.graph_objs.layout.scene.Annotation
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.Annotation is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.Annotation
|
||||
- plotly.graph_objs.layout.scene.Annotation
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.Annotation is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.Annotation
|
||||
- plotly.graph_objs.layout.scene.Annotation
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class ColorBar(dict):
|
||||
"""
|
||||
plotly.graph_objs.ColorBar is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.marker.ColorBar
|
||||
- plotly.graph_objs.surface.ColorBar
|
||||
- etc.
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.ColorBar is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.marker.ColorBar
|
||||
- plotly.graph_objs.surface.ColorBar
|
||||
- etc.
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.ColorBar is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.marker.ColorBar
|
||||
- plotly.graph_objs.surface.ColorBar
|
||||
- etc.
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class Contours(dict):
|
||||
"""
|
||||
plotly.graph_objs.Contours is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.contour.Contours
|
||||
- plotly.graph_objs.surface.Contours
|
||||
- etc.
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.Contours is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.contour.Contours
|
||||
- plotly.graph_objs.surface.Contours
|
||||
- etc.
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.Contours is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.contour.Contours
|
||||
- plotly.graph_objs.surface.Contours
|
||||
- etc.
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class ErrorX(dict):
|
||||
"""
|
||||
plotly.graph_objs.ErrorX is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.ErrorX
|
||||
- plotly.graph_objs.histogram.ErrorX
|
||||
- etc.
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.ErrorX is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.ErrorX
|
||||
- plotly.graph_objs.histogram.ErrorX
|
||||
- etc.
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.ErrorX is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.ErrorX
|
||||
- plotly.graph_objs.histogram.ErrorX
|
||||
- etc.
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class ErrorY(dict):
|
||||
"""
|
||||
plotly.graph_objs.ErrorY is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.ErrorY
|
||||
- plotly.graph_objs.histogram.ErrorY
|
||||
- etc.
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.ErrorY is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.ErrorY
|
||||
- plotly.graph_objs.histogram.ErrorY
|
||||
- etc.
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.ErrorY is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.ErrorY
|
||||
- plotly.graph_objs.histogram.ErrorY
|
||||
- etc.
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class ErrorZ(dict):
|
||||
"""
|
||||
plotly.graph_objs.ErrorZ is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter3d.ErrorZ
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.ErrorZ is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter3d.ErrorZ
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.ErrorZ is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter3d.ErrorZ
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class Font(dict):
|
||||
"""
|
||||
plotly.graph_objs.Font is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.Font
|
||||
- plotly.graph_objs.layout.hoverlabel.Font
|
||||
- etc.
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.Font is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.Font
|
||||
- plotly.graph_objs.layout.hoverlabel.Font
|
||||
- etc.
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.Font is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.Font
|
||||
- plotly.graph_objs.layout.hoverlabel.Font
|
||||
- etc.
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class Legend(dict):
|
||||
"""
|
||||
plotly.graph_objs.Legend is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.Legend
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.Legend is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.Legend
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.Legend is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.Legend
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class Line(dict):
|
||||
"""
|
||||
plotly.graph_objs.Line is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.Line
|
||||
- plotly.graph_objs.layout.shape.Line
|
||||
- etc.
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.Line is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.Line
|
||||
- plotly.graph_objs.layout.shape.Line
|
||||
- etc.
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.Line is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.Line
|
||||
- plotly.graph_objs.layout.shape.Line
|
||||
- etc.
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class Margin(dict):
|
||||
"""
|
||||
plotly.graph_objs.Margin is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.Margin
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.Margin is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.Margin
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.Margin is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.Margin
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class Marker(dict):
|
||||
"""
|
||||
plotly.graph_objs.Marker is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.Marker
|
||||
- plotly.graph_objs.histogram.selected.Marker
|
||||
- etc.
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.Marker is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.Marker
|
||||
- plotly.graph_objs.histogram.selected.Marker
|
||||
- etc.
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.Marker is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.Marker
|
||||
- plotly.graph_objs.histogram.selected.Marker
|
||||
- etc.
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class RadialAxis(dict):
|
||||
"""
|
||||
plotly.graph_objs.RadialAxis is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.RadialAxis
|
||||
- plotly.graph_objs.layout.polar.RadialAxis
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.RadialAxis is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.RadialAxis
|
||||
- plotly.graph_objs.layout.polar.RadialAxis
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.RadialAxis is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.RadialAxis
|
||||
- plotly.graph_objs.layout.polar.RadialAxis
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class Scene(dict):
|
||||
"""
|
||||
plotly.graph_objs.Scene is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.Scene
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.Scene is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.Scene
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.Scene is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.Scene
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class Stream(dict):
|
||||
"""
|
||||
plotly.graph_objs.Stream is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.Stream
|
||||
- plotly.graph_objs.area.Stream
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.Stream is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.Stream
|
||||
- plotly.graph_objs.area.Stream
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.Stream is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.scatter.Stream
|
||||
- plotly.graph_objs.area.Stream
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class XAxis(dict):
|
||||
"""
|
||||
plotly.graph_objs.XAxis is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.XAxis
|
||||
- plotly.graph_objs.layout.scene.XAxis
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.XAxis is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.XAxis
|
||||
- plotly.graph_objs.layout.scene.XAxis
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.XAxis is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.XAxis
|
||||
- plotly.graph_objs.layout.scene.XAxis
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class YAxis(dict):
|
||||
"""
|
||||
plotly.graph_objs.YAxis is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.YAxis
|
||||
- plotly.graph_objs.layout.scene.YAxis
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.YAxis is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.YAxis
|
||||
- plotly.graph_objs.layout.scene.YAxis
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.YAxis is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.YAxis
|
||||
- plotly.graph_objs.layout.scene.YAxis
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class ZAxis(dict):
|
||||
"""
|
||||
plotly.graph_objs.ZAxis is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.scene.ZAxis
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.ZAxis is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.scene.ZAxis
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.ZAxis is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.layout.scene.ZAxis
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class XBins(dict):
|
||||
"""
|
||||
plotly.graph_objs.XBins is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.histogram.XBins
|
||||
- plotly.graph_objs.histogram2d.XBins
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.XBins is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.histogram.XBins
|
||||
- plotly.graph_objs.histogram2d.XBins
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.XBins is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.histogram.XBins
|
||||
- plotly.graph_objs.histogram2d.XBins
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class YBins(dict):
|
||||
"""
|
||||
plotly.graph_objs.YBins is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.histogram.YBins
|
||||
- plotly.graph_objs.histogram2d.YBins
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.YBins is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.histogram.YBins
|
||||
- plotly.graph_objs.histogram2d.YBins
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.YBins is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.histogram.YBins
|
||||
- plotly.graph_objs.histogram2d.YBins
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class Trace(dict):
|
||||
"""
|
||||
plotly.graph_objs.Trace is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.Scatter
|
||||
- plotly.graph_objs.Bar
|
||||
- plotly.graph_objs.Area
|
||||
- plotly.graph_objs.Histogram
|
||||
- etc.
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.Trace is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.Scatter
|
||||
- plotly.graph_objs.Bar
|
||||
- plotly.graph_objs.Area
|
||||
- plotly.graph_objs.Histogram
|
||||
- etc.
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.Trace is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.Scatter
|
||||
- plotly.graph_objs.Bar
|
||||
- plotly.graph_objs.Area
|
||||
- plotly.graph_objs.Histogram
|
||||
- etc.
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
|
||||
|
||||
class Histogram2dcontour(dict):
|
||||
"""
|
||||
plotly.graph_objs.Histogram2dcontour is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.Histogram2dContour
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
"""
|
||||
plotly.graph_objs.Histogram2dcontour is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.Histogram2dContour
|
||||
|
||||
"""
|
||||
warnings.warn(
|
||||
"""plotly.graph_objs.Histogram2dcontour is deprecated.
|
||||
Please replace it with one of the following more specific types
|
||||
- plotly.graph_objs.Histogram2dContour
|
||||
""",
|
||||
DeprecationWarning,
|
||||
)
|
||||
super().__init__(*args, **kwargs)
|
||||
24476
lib/python3.11/site-packages/plotly/graph_objs/_figure.py
Normal file
24476
lib/python3.11/site-packages/plotly/graph_objs/_figure.py
Normal file
File diff suppressed because it is too large
Load Diff
24480
lib/python3.11/site-packages/plotly/graph_objs/_figurewidget.py
Normal file
24480
lib/python3.11/site-packages/plotly/graph_objs/_figurewidget.py
Normal file
File diff suppressed because it is too large
Load Diff
220
lib/python3.11/site-packages/plotly/graph_objs/_frame.py
Normal file
220
lib/python3.11/site-packages/plotly/graph_objs/_frame.py
Normal file
@ -0,0 +1,220 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseFrameHierarchyType as _BaseFrameHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Frame(_BaseFrameHierarchyType):
|
||||
_parent_path_str = ""
|
||||
_path_str = "frame"
|
||||
_valid_props = {"baseframe", "data", "group", "layout", "name", "traces"}
|
||||
|
||||
@property
|
||||
def baseframe(self):
|
||||
"""
|
||||
The name of the frame into which this frame's properties are
|
||||
merged before applying. This is used to unify properties and
|
||||
avoid needing to specify the same values for the same
|
||||
properties in multiple frames.
|
||||
|
||||
The 'baseframe' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["baseframe"]
|
||||
|
||||
@baseframe.setter
|
||||
def baseframe(self, val):
|
||||
self["baseframe"] = val
|
||||
|
||||
@property
|
||||
def data(self):
|
||||
"""
|
||||
A list of traces this frame modifies. The format is identical
|
||||
to the normal trace definition.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["data"]
|
||||
|
||||
@data.setter
|
||||
def data(self, val):
|
||||
self["data"] = val
|
||||
|
||||
@property
|
||||
def group(self):
|
||||
"""
|
||||
An identifier that specifies the group to which the frame
|
||||
belongs, used by animate to select a subset of frames.
|
||||
|
||||
The 'group' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["group"]
|
||||
|
||||
@group.setter
|
||||
def group(self, val):
|
||||
self["group"] = val
|
||||
|
||||
@property
|
||||
def layout(self):
|
||||
"""
|
||||
Layout properties which this frame modifies. The format is
|
||||
identical to the normal layout definition.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["layout"]
|
||||
|
||||
@layout.setter
|
||||
def layout(self, val):
|
||||
self["layout"] = val
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""
|
||||
A label by which to identify the frame
|
||||
|
||||
The 'name' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["name"]
|
||||
|
||||
@name.setter
|
||||
def name(self, val):
|
||||
self["name"] = val
|
||||
|
||||
@property
|
||||
def traces(self):
|
||||
"""
|
||||
A list of trace indices that identify the respective traces in
|
||||
the data attribute
|
||||
|
||||
The 'traces' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["traces"]
|
||||
|
||||
@traces.setter
|
||||
def traces(self, val):
|
||||
self["traces"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
baseframe
|
||||
The name of the frame into which this frame's
|
||||
properties are merged before applying. This is used to
|
||||
unify properties and avoid needing to specify the same
|
||||
values for the same properties in multiple frames.
|
||||
data
|
||||
A list of traces this frame modifies. The format is
|
||||
identical to the normal trace definition.
|
||||
group
|
||||
An identifier that specifies the group to which the
|
||||
frame belongs, used by animate to select a subset of
|
||||
frames.
|
||||
layout
|
||||
Layout properties which this frame modifies. The format
|
||||
is identical to the normal layout definition.
|
||||
name
|
||||
A label by which to identify the frame
|
||||
traces
|
||||
A list of trace indices that identify the respective
|
||||
traces in the data attribute
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
baseframe=None,
|
||||
data=None,
|
||||
group=None,
|
||||
layout=None,
|
||||
name=None,
|
||||
traces=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Frame object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.Frame`
|
||||
baseframe
|
||||
The name of the frame into which this frame's
|
||||
properties are merged before applying. This is used to
|
||||
unify properties and avoid needing to specify the same
|
||||
values for the same properties in multiple frames.
|
||||
data
|
||||
A list of traces this frame modifies. The format is
|
||||
identical to the normal trace definition.
|
||||
group
|
||||
An identifier that specifies the group to which the
|
||||
frame belongs, used by animate to select a subset of
|
||||
frames.
|
||||
layout
|
||||
Layout properties which this frame modifies. The format
|
||||
is identical to the normal layout definition.
|
||||
name
|
||||
A label by which to identify the frame
|
||||
traces
|
||||
A list of trace indices that identify the respective
|
||||
traces in the data attribute
|
||||
|
||||
Returns
|
||||
-------
|
||||
Frame
|
||||
"""
|
||||
super().__init__("frames")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.Frame
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.Frame`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("baseframe", arg, baseframe)
|
||||
self._set_property("data", arg, data)
|
||||
self._set_property("group", arg, group)
|
||||
self._set_property("layout", arg, layout)
|
||||
self._set_property("name", arg, name)
|
||||
self._set_property("traces", arg, traces)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
2394
lib/python3.11/site-packages/plotly/graph_objs/_funnel.py
Normal file
2394
lib/python3.11/site-packages/plotly/graph_objs/_funnel.py
Normal file
File diff suppressed because it is too large
Load Diff
1642
lib/python3.11/site-packages/plotly/graph_objs/_funnelarea.py
Normal file
1642
lib/python3.11/site-packages/plotly/graph_objs/_funnelarea.py
Normal file
File diff suppressed because it is too large
Load Diff
2533
lib/python3.11/site-packages/plotly/graph_objs/_heatmap.py
Normal file
2533
lib/python3.11/site-packages/plotly/graph_objs/_heatmap.py
Normal file
File diff suppressed because it is too large
Load Diff
2419
lib/python3.11/site-packages/plotly/graph_objs/_histogram.py
Normal file
2419
lib/python3.11/site-packages/plotly/graph_objs/_histogram.py
Normal file
File diff suppressed because it is too large
Load Diff
2365
lib/python3.11/site-packages/plotly/graph_objs/_histogram2d.py
Normal file
2365
lib/python3.11/site-packages/plotly/graph_objs/_histogram2d.py
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
1767
lib/python3.11/site-packages/plotly/graph_objs/_icicle.py
Normal file
1767
lib/python3.11/site-packages/plotly/graph_objs/_icicle.py
Normal file
File diff suppressed because it is too large
Load Diff
1456
lib/python3.11/site-packages/plotly/graph_objs/_image.py
Normal file
1456
lib/python3.11/site-packages/plotly/graph_objs/_image.py
Normal file
File diff suppressed because it is too large
Load Diff
848
lib/python3.11/site-packages/plotly/graph_objs/_indicator.py
Normal file
848
lib/python3.11/site-packages/plotly/graph_objs/_indicator.py
Normal file
@ -0,0 +1,848 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Indicator(_BaseTraceType):
|
||||
_parent_path_str = ""
|
||||
_path_str = "indicator"
|
||||
_valid_props = {
|
||||
"align",
|
||||
"customdata",
|
||||
"customdatasrc",
|
||||
"delta",
|
||||
"domain",
|
||||
"gauge",
|
||||
"ids",
|
||||
"idssrc",
|
||||
"legend",
|
||||
"legendgrouptitle",
|
||||
"legendrank",
|
||||
"legendwidth",
|
||||
"meta",
|
||||
"metasrc",
|
||||
"mode",
|
||||
"name",
|
||||
"number",
|
||||
"stream",
|
||||
"title",
|
||||
"type",
|
||||
"uid",
|
||||
"uirevision",
|
||||
"value",
|
||||
"visible",
|
||||
}
|
||||
|
||||
@property
|
||||
def align(self):
|
||||
"""
|
||||
Sets the horizontal alignment of the `text` within the box.
|
||||
Note that this attribute has no effect if an angular gauge is
|
||||
displayed: in this case, it is always centered
|
||||
|
||||
The 'align' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['left', 'center', 'right']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["align"]
|
||||
|
||||
@align.setter
|
||||
def align(self, val):
|
||||
self["align"] = val
|
||||
|
||||
@property
|
||||
def customdata(self):
|
||||
"""
|
||||
Assigns extra data each datum. This may be useful when
|
||||
listening to hover, click and selection events. Note that,
|
||||
"scatter" traces also appends customdata items in the markers
|
||||
DOM elements
|
||||
|
||||
The 'customdata' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["customdata"]
|
||||
|
||||
@customdata.setter
|
||||
def customdata(self, val):
|
||||
self["customdata"] = val
|
||||
|
||||
@property
|
||||
def customdatasrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`customdata`.
|
||||
|
||||
The 'customdatasrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["customdatasrc"]
|
||||
|
||||
@customdatasrc.setter
|
||||
def customdatasrc(self, val):
|
||||
self["customdatasrc"] = val
|
||||
|
||||
@property
|
||||
def delta(self):
|
||||
"""
|
||||
The 'delta' property is an instance of Delta
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.indicator.Delta`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Delta constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.indicator.Delta
|
||||
"""
|
||||
return self["delta"]
|
||||
|
||||
@delta.setter
|
||||
def delta(self, val):
|
||||
self["delta"] = val
|
||||
|
||||
@property
|
||||
def domain(self):
|
||||
"""
|
||||
The 'domain' property is an instance of Domain
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.indicator.Domain`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Domain constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.indicator.Domain
|
||||
"""
|
||||
return self["domain"]
|
||||
|
||||
@domain.setter
|
||||
def domain(self, val):
|
||||
self["domain"] = val
|
||||
|
||||
@property
|
||||
def gauge(self):
|
||||
"""
|
||||
The gauge of the Indicator plot.
|
||||
|
||||
The 'gauge' property is an instance of Gauge
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.indicator.Gauge`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Gauge constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.indicator.Gauge
|
||||
"""
|
||||
return self["gauge"]
|
||||
|
||||
@gauge.setter
|
||||
def gauge(self, val):
|
||||
self["gauge"] = val
|
||||
|
||||
@property
|
||||
def ids(self):
|
||||
"""
|
||||
Assigns id labels to each datum. These ids for object constancy
|
||||
of data points during animation. Should be an array of strings,
|
||||
not numbers or any other type.
|
||||
|
||||
The 'ids' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["ids"]
|
||||
|
||||
@ids.setter
|
||||
def ids(self, val):
|
||||
self["ids"] = val
|
||||
|
||||
@property
|
||||
def idssrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `ids`.
|
||||
|
||||
The 'idssrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["idssrc"]
|
||||
|
||||
@idssrc.setter
|
||||
def idssrc(self, val):
|
||||
self["idssrc"] = val
|
||||
|
||||
@property
|
||||
def legend(self):
|
||||
"""
|
||||
Sets the reference to a legend to show this trace in.
|
||||
References to these legends are "legend", "legend2", "legend3",
|
||||
etc. Settings for these legends are set in the layout, under
|
||||
`layout.legend`, `layout.legend2`, etc.
|
||||
|
||||
The 'legend' property is an identifier of a particular
|
||||
subplot, of type 'legend', that may be specified as the string 'legend'
|
||||
optionally followed by an integer >= 1
|
||||
(e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["legend"]
|
||||
|
||||
@legend.setter
|
||||
def legend(self, val):
|
||||
self["legend"] = val
|
||||
|
||||
@property
|
||||
def legendgrouptitle(self):
|
||||
"""
|
||||
The 'legendgrouptitle' property is an instance of Legendgrouptitle
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.indicator.Legendgrouptitle`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Legendgrouptitle constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.indicator.Legendgrouptitle
|
||||
"""
|
||||
return self["legendgrouptitle"]
|
||||
|
||||
@legendgrouptitle.setter
|
||||
def legendgrouptitle(self, val):
|
||||
self["legendgrouptitle"] = val
|
||||
|
||||
@property
|
||||
def legendrank(self):
|
||||
"""
|
||||
Sets the legend rank for this trace. Items and groups with
|
||||
smaller ranks are presented on top/left side while with
|
||||
"reversed" `legend.traceorder` they are on bottom/right side.
|
||||
The default legendrank is 1000, so that you can use ranks less
|
||||
than 1000 to place certain items before all unranked items, and
|
||||
ranks greater than 1000 to go after all unranked items. When
|
||||
having unranked or equal rank items shapes would be displayed
|
||||
after traces i.e. according to their order in data and layout.
|
||||
|
||||
The 'legendrank' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["legendrank"]
|
||||
|
||||
@legendrank.setter
|
||||
def legendrank(self, val):
|
||||
self["legendrank"] = val
|
||||
|
||||
@property
|
||||
def legendwidth(self):
|
||||
"""
|
||||
Sets the width (in px or fraction) of the legend for this
|
||||
trace.
|
||||
|
||||
The 'legendwidth' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["legendwidth"]
|
||||
|
||||
@legendwidth.setter
|
||||
def legendwidth(self, val):
|
||||
self["legendwidth"] = val
|
||||
|
||||
@property
|
||||
def meta(self):
|
||||
"""
|
||||
Assigns extra meta information associated with this trace that
|
||||
can be used in various text attributes. Attributes such as
|
||||
trace `name`, graph, axis and colorbar `title.text`, annotation
|
||||
`text` `rangeselector`, `updatemenues` and `sliders` `label`
|
||||
text all support `meta`. To access the trace `meta` values in
|
||||
an attribute in the same trace, simply use `%{meta[i]}` where
|
||||
`i` is the index or key of the `meta` item in question. To
|
||||
access trace `meta` in layout attributes, use
|
||||
`%{data[n[.meta[i]}` where `i` is the index or key of the
|
||||
`meta` and `n` is the trace index.
|
||||
|
||||
The 'meta' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["meta"]
|
||||
|
||||
@meta.setter
|
||||
def meta(self, val):
|
||||
self["meta"] = val
|
||||
|
||||
@property
|
||||
def metasrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `meta`.
|
||||
|
||||
The 'metasrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["metasrc"]
|
||||
|
||||
@metasrc.setter
|
||||
def metasrc(self, val):
|
||||
self["metasrc"] = val
|
||||
|
||||
@property
|
||||
def mode(self):
|
||||
"""
|
||||
Determines how the value is displayed on the graph. `number`
|
||||
displays the value numerically in text. `delta` displays the
|
||||
difference to a reference value in text. Finally, `gauge`
|
||||
displays the value graphically on an axis.
|
||||
|
||||
The 'mode' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['number', 'delta', 'gauge'] joined with '+' characters
|
||||
(e.g. 'number+delta')
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["mode"]
|
||||
|
||||
@mode.setter
|
||||
def mode(self, val):
|
||||
self["mode"] = val
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""
|
||||
Sets the trace name. The trace name appears as the legend item
|
||||
and on hover.
|
||||
|
||||
The 'name' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["name"]
|
||||
|
||||
@name.setter
|
||||
def name(self, val):
|
||||
self["name"] = val
|
||||
|
||||
@property
|
||||
def number(self):
|
||||
"""
|
||||
The 'number' property is an instance of Number
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.indicator.Number`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Number constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.indicator.Number
|
||||
"""
|
||||
return self["number"]
|
||||
|
||||
@number.setter
|
||||
def number(self, val):
|
||||
self["number"] = val
|
||||
|
||||
@property
|
||||
def stream(self):
|
||||
"""
|
||||
The 'stream' property is an instance of Stream
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.indicator.Stream`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Stream constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.indicator.Stream
|
||||
"""
|
||||
return self["stream"]
|
||||
|
||||
@stream.setter
|
||||
def stream(self, val):
|
||||
self["stream"] = val
|
||||
|
||||
@property
|
||||
def title(self):
|
||||
"""
|
||||
The 'title' property is an instance of Title
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.indicator.Title`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Title constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.indicator.Title
|
||||
"""
|
||||
return self["title"]
|
||||
|
||||
@title.setter
|
||||
def title(self, val):
|
||||
self["title"] = val
|
||||
|
||||
@property
|
||||
def uid(self):
|
||||
"""
|
||||
Assign an id to this trace, Use this to provide object
|
||||
constancy between traces during animations and transitions.
|
||||
|
||||
The 'uid' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["uid"]
|
||||
|
||||
@uid.setter
|
||||
def uid(self, val):
|
||||
self["uid"] = val
|
||||
|
||||
@property
|
||||
def uirevision(self):
|
||||
"""
|
||||
Controls persistence of some user-driven changes to the trace:
|
||||
`constraintrange` in `parcoords` traces, as well as some
|
||||
`editable: true` modifications such as `name` and
|
||||
`colorbar.title`. Defaults to `layout.uirevision`. Note that
|
||||
other user-driven trace attribute changes are controlled by
|
||||
`layout` attributes: `trace.visible` is controlled by
|
||||
`layout.legend.uirevision`, `selectedpoints` is controlled by
|
||||
`layout.selectionrevision`, and `colorbar.(x|y)` (accessible
|
||||
with `config: {editable: true}`) is controlled by
|
||||
`layout.editrevision`. Trace changes are tracked by `uid`,
|
||||
which only falls back on trace index if no `uid` is provided.
|
||||
So if your app can add/remove traces before the end of the
|
||||
`data` array, such that the same trace has a different index,
|
||||
you can still preserve user-driven changes if you give each
|
||||
trace a `uid` that stays with it as it moves.
|
||||
|
||||
The 'uirevision' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["uirevision"]
|
||||
|
||||
@uirevision.setter
|
||||
def uirevision(self, val):
|
||||
self["uirevision"] = val
|
||||
|
||||
@property
|
||||
def value(self):
|
||||
"""
|
||||
Sets the number to be displayed.
|
||||
|
||||
The 'value' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["value"]
|
||||
|
||||
@value.setter
|
||||
def value(self, val):
|
||||
self["value"] = val
|
||||
|
||||
@property
|
||||
def visible(self):
|
||||
"""
|
||||
Determines whether or not this trace is visible. If
|
||||
"legendonly", the trace is not drawn, but can appear as a
|
||||
legend item (provided that the legend itself is visible).
|
||||
|
||||
The 'visible' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
[True, False, 'legendonly']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["visible"]
|
||||
|
||||
@visible.setter
|
||||
def visible(self, val):
|
||||
self["visible"] = val
|
||||
|
||||
@property
|
||||
def type(self):
|
||||
return self._props["type"]
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
align
|
||||
Sets the horizontal alignment of the `text` within the
|
||||
box. Note that this attribute has no effect if an
|
||||
angular gauge is displayed: in this case, it is always
|
||||
centered
|
||||
customdata
|
||||
Assigns extra data each datum. This may be useful when
|
||||
listening to hover, click and selection events. Note
|
||||
that, "scatter" traces also appends customdata items in
|
||||
the markers DOM elements
|
||||
customdatasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`customdata`.
|
||||
delta
|
||||
:class:`plotly.graph_objects.indicator.Delta` instance
|
||||
or dict with compatible properties
|
||||
domain
|
||||
:class:`plotly.graph_objects.indicator.Domain` instance
|
||||
or dict with compatible properties
|
||||
gauge
|
||||
The gauge of the Indicator plot.
|
||||
ids
|
||||
Assigns id labels to each datum. These ids for object
|
||||
constancy of data points during animation. Should be an
|
||||
array of strings, not numbers or any other type.
|
||||
idssrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`ids`.
|
||||
legend
|
||||
Sets the reference to a legend to show this trace in.
|
||||
References to these legends are "legend", "legend2",
|
||||
"legend3", etc. Settings for these legends are set in
|
||||
the layout, under `layout.legend`, `layout.legend2`,
|
||||
etc.
|
||||
legendgrouptitle
|
||||
:class:`plotly.graph_objects.indicator.Legendgrouptitle
|
||||
` instance or dict with compatible properties
|
||||
legendrank
|
||||
Sets the legend rank for this trace. Items and groups
|
||||
with smaller ranks are presented on top/left side while
|
||||
with "reversed" `legend.traceorder` they are on
|
||||
bottom/right side. The default legendrank is 1000, so
|
||||
that you can use ranks less than 1000 to place certain
|
||||
items before all unranked items, and ranks greater than
|
||||
1000 to go after all unranked items. When having
|
||||
unranked or equal rank items shapes would be displayed
|
||||
after traces i.e. according to their order in data and
|
||||
layout.
|
||||
legendwidth
|
||||
Sets the width (in px or fraction) of the legend for
|
||||
this trace.
|
||||
meta
|
||||
Assigns extra meta information associated with this
|
||||
trace that can be used in various text attributes.
|
||||
Attributes such as trace `name`, graph, axis and
|
||||
colorbar `title.text`, annotation `text`
|
||||
`rangeselector`, `updatemenues` and `sliders` `label`
|
||||
text all support `meta`. To access the trace `meta`
|
||||
values in an attribute in the same trace, simply use
|
||||
`%{meta[i]}` where `i` is the index or key of the
|
||||
`meta` item in question. To access trace `meta` in
|
||||
layout attributes, use `%{data[n[.meta[i]}` where `i`
|
||||
is the index or key of the `meta` and `n` is the trace
|
||||
index.
|
||||
metasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`meta`.
|
||||
mode
|
||||
Determines how the value is displayed on the graph.
|
||||
`number` displays the value numerically in text.
|
||||
`delta` displays the difference to a reference value in
|
||||
text. Finally, `gauge` displays the value graphically
|
||||
on an axis.
|
||||
name
|
||||
Sets the trace name. The trace name appears as the
|
||||
legend item and on hover.
|
||||
number
|
||||
:class:`plotly.graph_objects.indicator.Number` instance
|
||||
or dict with compatible properties
|
||||
stream
|
||||
:class:`plotly.graph_objects.indicator.Stream` instance
|
||||
or dict with compatible properties
|
||||
title
|
||||
:class:`plotly.graph_objects.indicator.Title` instance
|
||||
or dict with compatible properties
|
||||
uid
|
||||
Assign an id to this trace, Use this to provide object
|
||||
constancy between traces during animations and
|
||||
transitions.
|
||||
uirevision
|
||||
Controls persistence of some user-driven changes to the
|
||||
trace: `constraintrange` in `parcoords` traces, as well
|
||||
as some `editable: true` modifications such as `name`
|
||||
and `colorbar.title`. Defaults to `layout.uirevision`.
|
||||
Note that other user-driven trace attribute changes are
|
||||
controlled by `layout` attributes: `trace.visible` is
|
||||
controlled by `layout.legend.uirevision`,
|
||||
`selectedpoints` is controlled by
|
||||
`layout.selectionrevision`, and `colorbar.(x|y)`
|
||||
(accessible with `config: {editable: true}`) is
|
||||
controlled by `layout.editrevision`. Trace changes are
|
||||
tracked by `uid`, which only falls back on trace index
|
||||
if no `uid` is provided. So if your app can add/remove
|
||||
traces before the end of the `data` array, such that
|
||||
the same trace has a different index, you can still
|
||||
preserve user-driven changes if you give each trace a
|
||||
`uid` that stays with it as it moves.
|
||||
value
|
||||
Sets the number to be displayed.
|
||||
visible
|
||||
Determines whether or not this trace is visible. If
|
||||
"legendonly", the trace is not drawn, but can appear as
|
||||
a legend item (provided that the legend itself is
|
||||
visible).
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
align=None,
|
||||
customdata=None,
|
||||
customdatasrc=None,
|
||||
delta=None,
|
||||
domain=None,
|
||||
gauge=None,
|
||||
ids=None,
|
||||
idssrc=None,
|
||||
legend=None,
|
||||
legendgrouptitle=None,
|
||||
legendrank=None,
|
||||
legendwidth=None,
|
||||
meta=None,
|
||||
metasrc=None,
|
||||
mode=None,
|
||||
name=None,
|
||||
number=None,
|
||||
stream=None,
|
||||
title=None,
|
||||
uid=None,
|
||||
uirevision=None,
|
||||
value=None,
|
||||
visible=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Indicator object
|
||||
|
||||
An indicator is used to visualize a single `value` along with
|
||||
some contextual information such as `steps` or a `threshold`,
|
||||
using a combination of three visual elements: a number, a
|
||||
delta, and/or a gauge. Deltas are taken with respect to a
|
||||
`reference`. Gauges can be either angular or bullet (aka
|
||||
linear) gauges.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.Indicator`
|
||||
align
|
||||
Sets the horizontal alignment of the `text` within the
|
||||
box. Note that this attribute has no effect if an
|
||||
angular gauge is displayed: in this case, it is always
|
||||
centered
|
||||
customdata
|
||||
Assigns extra data each datum. This may be useful when
|
||||
listening to hover, click and selection events. Note
|
||||
that, "scatter" traces also appends customdata items in
|
||||
the markers DOM elements
|
||||
customdatasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`customdata`.
|
||||
delta
|
||||
:class:`plotly.graph_objects.indicator.Delta` instance
|
||||
or dict with compatible properties
|
||||
domain
|
||||
:class:`plotly.graph_objects.indicator.Domain` instance
|
||||
or dict with compatible properties
|
||||
gauge
|
||||
The gauge of the Indicator plot.
|
||||
ids
|
||||
Assigns id labels to each datum. These ids for object
|
||||
constancy of data points during animation. Should be an
|
||||
array of strings, not numbers or any other type.
|
||||
idssrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`ids`.
|
||||
legend
|
||||
Sets the reference to a legend to show this trace in.
|
||||
References to these legends are "legend", "legend2",
|
||||
"legend3", etc. Settings for these legends are set in
|
||||
the layout, under `layout.legend`, `layout.legend2`,
|
||||
etc.
|
||||
legendgrouptitle
|
||||
:class:`plotly.graph_objects.indicator.Legendgrouptitle
|
||||
` instance or dict with compatible properties
|
||||
legendrank
|
||||
Sets the legend rank for this trace. Items and groups
|
||||
with smaller ranks are presented on top/left side while
|
||||
with "reversed" `legend.traceorder` they are on
|
||||
bottom/right side. The default legendrank is 1000, so
|
||||
that you can use ranks less than 1000 to place certain
|
||||
items before all unranked items, and ranks greater than
|
||||
1000 to go after all unranked items. When having
|
||||
unranked or equal rank items shapes would be displayed
|
||||
after traces i.e. according to their order in data and
|
||||
layout.
|
||||
legendwidth
|
||||
Sets the width (in px or fraction) of the legend for
|
||||
this trace.
|
||||
meta
|
||||
Assigns extra meta information associated with this
|
||||
trace that can be used in various text attributes.
|
||||
Attributes such as trace `name`, graph, axis and
|
||||
colorbar `title.text`, annotation `text`
|
||||
`rangeselector`, `updatemenues` and `sliders` `label`
|
||||
text all support `meta`. To access the trace `meta`
|
||||
values in an attribute in the same trace, simply use
|
||||
`%{meta[i]}` where `i` is the index or key of the
|
||||
`meta` item in question. To access trace `meta` in
|
||||
layout attributes, use `%{data[n[.meta[i]}` where `i`
|
||||
is the index or key of the `meta` and `n` is the trace
|
||||
index.
|
||||
metasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`meta`.
|
||||
mode
|
||||
Determines how the value is displayed on the graph.
|
||||
`number` displays the value numerically in text.
|
||||
`delta` displays the difference to a reference value in
|
||||
text. Finally, `gauge` displays the value graphically
|
||||
on an axis.
|
||||
name
|
||||
Sets the trace name. The trace name appears as the
|
||||
legend item and on hover.
|
||||
number
|
||||
:class:`plotly.graph_objects.indicator.Number` instance
|
||||
or dict with compatible properties
|
||||
stream
|
||||
:class:`plotly.graph_objects.indicator.Stream` instance
|
||||
or dict with compatible properties
|
||||
title
|
||||
:class:`plotly.graph_objects.indicator.Title` instance
|
||||
or dict with compatible properties
|
||||
uid
|
||||
Assign an id to this trace, Use this to provide object
|
||||
constancy between traces during animations and
|
||||
transitions.
|
||||
uirevision
|
||||
Controls persistence of some user-driven changes to the
|
||||
trace: `constraintrange` in `parcoords` traces, as well
|
||||
as some `editable: true` modifications such as `name`
|
||||
and `colorbar.title`. Defaults to `layout.uirevision`.
|
||||
Note that other user-driven trace attribute changes are
|
||||
controlled by `layout` attributes: `trace.visible` is
|
||||
controlled by `layout.legend.uirevision`,
|
||||
`selectedpoints` is controlled by
|
||||
`layout.selectionrevision`, and `colorbar.(x|y)`
|
||||
(accessible with `config: {editable: true}`) is
|
||||
controlled by `layout.editrevision`. Trace changes are
|
||||
tracked by `uid`, which only falls back on trace index
|
||||
if no `uid` is provided. So if your app can add/remove
|
||||
traces before the end of the `data` array, such that
|
||||
the same trace has a different index, you can still
|
||||
preserve user-driven changes if you give each trace a
|
||||
`uid` that stays with it as it moves.
|
||||
value
|
||||
Sets the number to be displayed.
|
||||
visible
|
||||
Determines whether or not this trace is visible. If
|
||||
"legendonly", the trace is not drawn, but can appear as
|
||||
a legend item (provided that the legend itself is
|
||||
visible).
|
||||
|
||||
Returns
|
||||
-------
|
||||
Indicator
|
||||
"""
|
||||
super().__init__("indicator")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.Indicator
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.Indicator`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("align", arg, align)
|
||||
self._set_property("customdata", arg, customdata)
|
||||
self._set_property("customdatasrc", arg, customdatasrc)
|
||||
self._set_property("delta", arg, delta)
|
||||
self._set_property("domain", arg, domain)
|
||||
self._set_property("gauge", arg, gauge)
|
||||
self._set_property("ids", arg, ids)
|
||||
self._set_property("idssrc", arg, idssrc)
|
||||
self._set_property("legend", arg, legend)
|
||||
self._set_property("legendgrouptitle", arg, legendgrouptitle)
|
||||
self._set_property("legendrank", arg, legendrank)
|
||||
self._set_property("legendwidth", arg, legendwidth)
|
||||
self._set_property("meta", arg, meta)
|
||||
self._set_property("metasrc", arg, metasrc)
|
||||
self._set_property("mode", arg, mode)
|
||||
self._set_property("name", arg, name)
|
||||
self._set_property("number", arg, number)
|
||||
self._set_property("stream", arg, stream)
|
||||
self._set_property("title", arg, title)
|
||||
self._set_property("uid", arg, uid)
|
||||
self._set_property("uirevision", arg, uirevision)
|
||||
self._set_property("value", arg, value)
|
||||
self._set_property("visible", arg, visible)
|
||||
|
||||
self._props["type"] = "indicator"
|
||||
arg.pop("type", None)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
2163
lib/python3.11/site-packages/plotly/graph_objs/_isosurface.py
Normal file
2163
lib/python3.11/site-packages/plotly/graph_objs/_isosurface.py
Normal file
File diff suppressed because it is too large
Load Diff
3507
lib/python3.11/site-packages/plotly/graph_objs/_layout.py
Normal file
3507
lib/python3.11/site-packages/plotly/graph_objs/_layout.py
Normal file
File diff suppressed because it is too large
Load Diff
2579
lib/python3.11/site-packages/plotly/graph_objs/_mesh3d.py
Normal file
2579
lib/python3.11/site-packages/plotly/graph_objs/_mesh3d.py
Normal file
File diff suppressed because it is too large
Load Diff
1675
lib/python3.11/site-packages/plotly/graph_objs/_ohlc.py
Normal file
1675
lib/python3.11/site-packages/plotly/graph_objs/_ohlc.py
Normal file
File diff suppressed because it is too large
Load Diff
934
lib/python3.11/site-packages/plotly/graph_objs/_parcats.py
Normal file
934
lib/python3.11/site-packages/plotly/graph_objs/_parcats.py
Normal file
@ -0,0 +1,934 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Parcats(_BaseTraceType):
|
||||
_parent_path_str = ""
|
||||
_path_str = "parcats"
|
||||
_valid_props = {
|
||||
"arrangement",
|
||||
"bundlecolors",
|
||||
"counts",
|
||||
"countssrc",
|
||||
"dimensiondefaults",
|
||||
"dimensions",
|
||||
"domain",
|
||||
"hoverinfo",
|
||||
"hoveron",
|
||||
"hovertemplate",
|
||||
"labelfont",
|
||||
"legendgrouptitle",
|
||||
"legendwidth",
|
||||
"line",
|
||||
"meta",
|
||||
"metasrc",
|
||||
"name",
|
||||
"sortpaths",
|
||||
"stream",
|
||||
"tickfont",
|
||||
"type",
|
||||
"uid",
|
||||
"uirevision",
|
||||
"visible",
|
||||
}
|
||||
|
||||
@property
|
||||
def arrangement(self):
|
||||
"""
|
||||
Sets the drag interaction mode for categories and dimensions.
|
||||
If `perpendicular`, the categories can only move along a line
|
||||
perpendicular to the paths. If `freeform`, the categories can
|
||||
freely move on the plane. If `fixed`, the categories and
|
||||
dimensions are stationary.
|
||||
|
||||
The 'arrangement' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['perpendicular', 'freeform', 'fixed']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["arrangement"]
|
||||
|
||||
@arrangement.setter
|
||||
def arrangement(self, val):
|
||||
self["arrangement"] = val
|
||||
|
||||
@property
|
||||
def bundlecolors(self):
|
||||
"""
|
||||
Sort paths so that like colors are bundled together within each
|
||||
category.
|
||||
|
||||
The 'bundlecolors' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["bundlecolors"]
|
||||
|
||||
@bundlecolors.setter
|
||||
def bundlecolors(self, val):
|
||||
self["bundlecolors"] = val
|
||||
|
||||
@property
|
||||
def counts(self):
|
||||
"""
|
||||
The number of observations represented by each state. Defaults
|
||||
to 1 so that each state represents one observation
|
||||
|
||||
The 'counts' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["counts"]
|
||||
|
||||
@counts.setter
|
||||
def counts(self, val):
|
||||
self["counts"] = val
|
||||
|
||||
@property
|
||||
def countssrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `counts`.
|
||||
|
||||
The 'countssrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["countssrc"]
|
||||
|
||||
@countssrc.setter
|
||||
def countssrc(self, val):
|
||||
self["countssrc"] = val
|
||||
|
||||
@property
|
||||
def dimensions(self):
|
||||
"""
|
||||
The dimensions (variables) of the parallel categories diagram.
|
||||
|
||||
The 'dimensions' property is a tuple of instances of
|
||||
Dimension that may be specified as:
|
||||
- A list or tuple of instances of plotly.graph_objs.parcats.Dimension
|
||||
- A list or tuple of dicts of string/value properties that
|
||||
will be passed to the Dimension constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
tuple[plotly.graph_objs.parcats.Dimension]
|
||||
"""
|
||||
return self["dimensions"]
|
||||
|
||||
@dimensions.setter
|
||||
def dimensions(self, val):
|
||||
self["dimensions"] = val
|
||||
|
||||
@property
|
||||
def dimensiondefaults(self):
|
||||
"""
|
||||
When used in a template (as
|
||||
layout.template.data.parcats.dimensiondefaults), sets the
|
||||
default property values to use for elements of
|
||||
parcats.dimensions
|
||||
|
||||
The 'dimensiondefaults' property is an instance of Dimension
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcats.Dimension`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Dimension constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcats.Dimension
|
||||
"""
|
||||
return self["dimensiondefaults"]
|
||||
|
||||
@dimensiondefaults.setter
|
||||
def dimensiondefaults(self, val):
|
||||
self["dimensiondefaults"] = val
|
||||
|
||||
@property
|
||||
def domain(self):
|
||||
"""
|
||||
The 'domain' property is an instance of Domain
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcats.Domain`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Domain constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcats.Domain
|
||||
"""
|
||||
return self["domain"]
|
||||
|
||||
@domain.setter
|
||||
def domain(self, val):
|
||||
self["domain"] = val
|
||||
|
||||
@property
|
||||
def hoverinfo(self):
|
||||
"""
|
||||
Determines which trace information appear on hover. If `none`
|
||||
or `skip` are set, no information is displayed upon hovering.
|
||||
But, if `none` is set, click and hover events are still fired.
|
||||
|
||||
The 'hoverinfo' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['count', 'probability'] joined with '+' characters
|
||||
(e.g. 'count+probability')
|
||||
OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["hoverinfo"]
|
||||
|
||||
@hoverinfo.setter
|
||||
def hoverinfo(self, val):
|
||||
self["hoverinfo"] = val
|
||||
|
||||
@property
|
||||
def hoveron(self):
|
||||
"""
|
||||
Sets the hover interaction mode for the parcats diagram. If
|
||||
`category`, hover interaction take place per category. If
|
||||
`color`, hover interactions take place per color per category.
|
||||
If `dimension`, hover interactions take place across all
|
||||
categories per dimension.
|
||||
|
||||
The 'hoveron' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['category', 'color', 'dimension']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["hoveron"]
|
||||
|
||||
@hoveron.setter
|
||||
def hoveron(self, val):
|
||||
self["hoveron"] = val
|
||||
|
||||
@property
|
||||
def hovertemplate(self):
|
||||
"""
|
||||
Template string used for rendering the information that appear
|
||||
on hover box. Note that this will override `hoverinfo`.
|
||||
Variables are inserted using %{variable}, for example "y: %{y}"
|
||||
as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When
|
||||
showing info for several points, "xother" will be added to
|
||||
those with different x positions from the first point. An
|
||||
underscore before or after "(x|y)other" will add a space on
|
||||
that side, only when this field is shown. Numbers are formatted
|
||||
using d3-format's syntax %{variable:d3-format}, for example
|
||||
"Price: %{y:$.2f}".
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format for
|
||||
details on the formatting syntax. Dates are formatted using
|
||||
d3-time-format's syntax %{variable|d3-time-format}, for example
|
||||
"Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-
|
||||
format/tree/v2.2.3#locale_format for details on the date
|
||||
formatting syntax. The variables available in `hovertemplate`
|
||||
are the ones emitted as event data described at this link
|
||||
https://plotly.com/javascript/plotlyjs-events/#event-data.
|
||||
Additionally, every attributes that can be specified per-point
|
||||
(the ones that are `arrayOk: true`) are available. This value
|
||||
here applies when hovering over dimensions. Note that
|
||||
`*categorycount`, "colorcount" and "bandcolorcount" are only
|
||||
available when `hoveron` contains the "color" flagFinally, the
|
||||
template string has access to variables `count`, `probability`,
|
||||
`category`, `categorycount`, `colorcount` and `bandcolorcount`.
|
||||
Anything contained in tag `<extra>` is displayed in the
|
||||
secondary box, for example `<extra>%{fullData.name}</extra>`.
|
||||
To hide the secondary box completely, use an empty tag
|
||||
`<extra></extra>`.
|
||||
|
||||
The 'hovertemplate' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["hovertemplate"]
|
||||
|
||||
@hovertemplate.setter
|
||||
def hovertemplate(self, val):
|
||||
self["hovertemplate"] = val
|
||||
|
||||
@property
|
||||
def labelfont(self):
|
||||
"""
|
||||
Sets the font for the `dimension` labels.
|
||||
|
||||
The 'labelfont' property is an instance of Labelfont
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcats.Labelfont`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Labelfont constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcats.Labelfont
|
||||
"""
|
||||
return self["labelfont"]
|
||||
|
||||
@labelfont.setter
|
||||
def labelfont(self, val):
|
||||
self["labelfont"] = val
|
||||
|
||||
@property
|
||||
def legendgrouptitle(self):
|
||||
"""
|
||||
The 'legendgrouptitle' property is an instance of Legendgrouptitle
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcats.Legendgrouptitle`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Legendgrouptitle constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcats.Legendgrouptitle
|
||||
"""
|
||||
return self["legendgrouptitle"]
|
||||
|
||||
@legendgrouptitle.setter
|
||||
def legendgrouptitle(self, val):
|
||||
self["legendgrouptitle"] = val
|
||||
|
||||
@property
|
||||
def legendwidth(self):
|
||||
"""
|
||||
Sets the width (in px or fraction) of the legend for this
|
||||
trace.
|
||||
|
||||
The 'legendwidth' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["legendwidth"]
|
||||
|
||||
@legendwidth.setter
|
||||
def legendwidth(self, val):
|
||||
self["legendwidth"] = val
|
||||
|
||||
@property
|
||||
def line(self):
|
||||
"""
|
||||
The 'line' property is an instance of Line
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcats.Line`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Line constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcats.Line
|
||||
"""
|
||||
return self["line"]
|
||||
|
||||
@line.setter
|
||||
def line(self, val):
|
||||
self["line"] = val
|
||||
|
||||
@property
|
||||
def meta(self):
|
||||
"""
|
||||
Assigns extra meta information associated with this trace that
|
||||
can be used in various text attributes. Attributes such as
|
||||
trace `name`, graph, axis and colorbar `title.text`, annotation
|
||||
`text` `rangeselector`, `updatemenues` and `sliders` `label`
|
||||
text all support `meta`. To access the trace `meta` values in
|
||||
an attribute in the same trace, simply use `%{meta[i]}` where
|
||||
`i` is the index or key of the `meta` item in question. To
|
||||
access trace `meta` in layout attributes, use
|
||||
`%{data[n[.meta[i]}` where `i` is the index or key of the
|
||||
`meta` and `n` is the trace index.
|
||||
|
||||
The 'meta' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["meta"]
|
||||
|
||||
@meta.setter
|
||||
def meta(self, val):
|
||||
self["meta"] = val
|
||||
|
||||
@property
|
||||
def metasrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `meta`.
|
||||
|
||||
The 'metasrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["metasrc"]
|
||||
|
||||
@metasrc.setter
|
||||
def metasrc(self, val):
|
||||
self["metasrc"] = val
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""
|
||||
Sets the trace name. The trace name appears as the legend item
|
||||
and on hover.
|
||||
|
||||
The 'name' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["name"]
|
||||
|
||||
@name.setter
|
||||
def name(self, val):
|
||||
self["name"] = val
|
||||
|
||||
@property
|
||||
def sortpaths(self):
|
||||
"""
|
||||
Sets the path sorting algorithm. If `forward`, sort paths based
|
||||
on dimension categories from left to right. If `backward`, sort
|
||||
paths based on dimensions categories from right to left.
|
||||
|
||||
The 'sortpaths' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['forward', 'backward']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["sortpaths"]
|
||||
|
||||
@sortpaths.setter
|
||||
def sortpaths(self, val):
|
||||
self["sortpaths"] = val
|
||||
|
||||
@property
|
||||
def stream(self):
|
||||
"""
|
||||
The 'stream' property is an instance of Stream
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcats.Stream`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Stream constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcats.Stream
|
||||
"""
|
||||
return self["stream"]
|
||||
|
||||
@stream.setter
|
||||
def stream(self, val):
|
||||
self["stream"] = val
|
||||
|
||||
@property
|
||||
def tickfont(self):
|
||||
"""
|
||||
Sets the font for the `category` labels.
|
||||
|
||||
The 'tickfont' property is an instance of Tickfont
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcats.Tickfont`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Tickfont constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcats.Tickfont
|
||||
"""
|
||||
return self["tickfont"]
|
||||
|
||||
@tickfont.setter
|
||||
def tickfont(self, val):
|
||||
self["tickfont"] = val
|
||||
|
||||
@property
|
||||
def uid(self):
|
||||
"""
|
||||
Assign an id to this trace, Use this to provide object
|
||||
constancy between traces during animations and transitions.
|
||||
|
||||
The 'uid' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["uid"]
|
||||
|
||||
@uid.setter
|
||||
def uid(self, val):
|
||||
self["uid"] = val
|
||||
|
||||
@property
|
||||
def uirevision(self):
|
||||
"""
|
||||
Controls persistence of some user-driven changes to the trace:
|
||||
`constraintrange` in `parcoords` traces, as well as some
|
||||
`editable: true` modifications such as `name` and
|
||||
`colorbar.title`. Defaults to `layout.uirevision`. Note that
|
||||
other user-driven trace attribute changes are controlled by
|
||||
`layout` attributes: `trace.visible` is controlled by
|
||||
`layout.legend.uirevision`, `selectedpoints` is controlled by
|
||||
`layout.selectionrevision`, and `colorbar.(x|y)` (accessible
|
||||
with `config: {editable: true}`) is controlled by
|
||||
`layout.editrevision`. Trace changes are tracked by `uid`,
|
||||
which only falls back on trace index if no `uid` is provided.
|
||||
So if your app can add/remove traces before the end of the
|
||||
`data` array, such that the same trace has a different index,
|
||||
you can still preserve user-driven changes if you give each
|
||||
trace a `uid` that stays with it as it moves.
|
||||
|
||||
The 'uirevision' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["uirevision"]
|
||||
|
||||
@uirevision.setter
|
||||
def uirevision(self, val):
|
||||
self["uirevision"] = val
|
||||
|
||||
@property
|
||||
def visible(self):
|
||||
"""
|
||||
Determines whether or not this trace is visible. If
|
||||
"legendonly", the trace is not drawn, but can appear as a
|
||||
legend item (provided that the legend itself is visible).
|
||||
|
||||
The 'visible' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
[True, False, 'legendonly']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["visible"]
|
||||
|
||||
@visible.setter
|
||||
def visible(self, val):
|
||||
self["visible"] = val
|
||||
|
||||
@property
|
||||
def type(self):
|
||||
return self._props["type"]
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
arrangement
|
||||
Sets the drag interaction mode for categories and
|
||||
dimensions. If `perpendicular`, the categories can only
|
||||
move along a line perpendicular to the paths. If
|
||||
`freeform`, the categories can freely move on the
|
||||
plane. If `fixed`, the categories and dimensions are
|
||||
stationary.
|
||||
bundlecolors
|
||||
Sort paths so that like colors are bundled together
|
||||
within each category.
|
||||
counts
|
||||
The number of observations represented by each state.
|
||||
Defaults to 1 so that each state represents one
|
||||
observation
|
||||
countssrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`counts`.
|
||||
dimensions
|
||||
The dimensions (variables) of the parallel categories
|
||||
diagram.
|
||||
dimensiondefaults
|
||||
When used in a template (as
|
||||
layout.template.data.parcats.dimensiondefaults), sets
|
||||
the default property values to use for elements of
|
||||
parcats.dimensions
|
||||
domain
|
||||
:class:`plotly.graph_objects.parcats.Domain` instance
|
||||
or dict with compatible properties
|
||||
hoverinfo
|
||||
Determines which trace information appear on hover. If
|
||||
`none` or `skip` are set, no information is displayed
|
||||
upon hovering. But, if `none` is set, click and hover
|
||||
events are still fired.
|
||||
hoveron
|
||||
Sets the hover interaction mode for the parcats
|
||||
diagram. If `category`, hover interaction take place
|
||||
per category. If `color`, hover interactions take place
|
||||
per color per category. If `dimension`, hover
|
||||
interactions take place across all categories per
|
||||
dimension.
|
||||
hovertemplate
|
||||
Template string used for rendering the information that
|
||||
appear on hover box. Note that this will override
|
||||
`hoverinfo`. Variables are inserted using %{variable},
|
||||
for example "y: %{y}" as well as %{xother}, {%_xother},
|
||||
{%_xother_}, {%xother_}. When showing info for several
|
||||
points, "xother" will be added to those with different
|
||||
x positions from the first point. An underscore before
|
||||
or after "(x|y)other" will add a space on that side,
|
||||
only when this field is shown. Numbers are formatted
|
||||
using d3-format's syntax %{variable:d3-format}, for
|
||||
example "Price: %{y:$.2f}".
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
|
||||
for details on the formatting syntax. Dates are
|
||||
formatted using d3-time-format's syntax
|
||||
%{variable|d3-time-format}, for example "Day:
|
||||
%{2019-01-01|%A}". https://github.com/d3/d3-time-
|
||||
format/tree/v2.2.3#locale_format for details on the
|
||||
date formatting syntax. The variables available in
|
||||
`hovertemplate` are the ones emitted as event data
|
||||
described at this link
|
||||
https://plotly.com/javascript/plotlyjs-events/#event-
|
||||
data. Additionally, every attributes that can be
|
||||
specified per-point (the ones that are `arrayOk: true`)
|
||||
are available. This value here applies when hovering
|
||||
over dimensions. Note that `*categorycount`,
|
||||
"colorcount" and "bandcolorcount" are only available
|
||||
when `hoveron` contains the "color" flagFinally, the
|
||||
template string has access to variables `count`,
|
||||
`probability`, `category`, `categorycount`,
|
||||
`colorcount` and `bandcolorcount`. Anything contained
|
||||
in tag `<extra>` is displayed in the secondary box, for
|
||||
example `<extra>%{fullData.name}</extra>`. To hide the
|
||||
secondary box completely, use an empty tag
|
||||
`<extra></extra>`.
|
||||
labelfont
|
||||
Sets the font for the `dimension` labels.
|
||||
legendgrouptitle
|
||||
:class:`plotly.graph_objects.parcats.Legendgrouptitle`
|
||||
instance or dict with compatible properties
|
||||
legendwidth
|
||||
Sets the width (in px or fraction) of the legend for
|
||||
this trace.
|
||||
line
|
||||
:class:`plotly.graph_objects.parcats.Line` instance or
|
||||
dict with compatible properties
|
||||
meta
|
||||
Assigns extra meta information associated with this
|
||||
trace that can be used in various text attributes.
|
||||
Attributes such as trace `name`, graph, axis and
|
||||
colorbar `title.text`, annotation `text`
|
||||
`rangeselector`, `updatemenues` and `sliders` `label`
|
||||
text all support `meta`. To access the trace `meta`
|
||||
values in an attribute in the same trace, simply use
|
||||
`%{meta[i]}` where `i` is the index or key of the
|
||||
`meta` item in question. To access trace `meta` in
|
||||
layout attributes, use `%{data[n[.meta[i]}` where `i`
|
||||
is the index or key of the `meta` and `n` is the trace
|
||||
index.
|
||||
metasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`meta`.
|
||||
name
|
||||
Sets the trace name. The trace name appears as the
|
||||
legend item and on hover.
|
||||
sortpaths
|
||||
Sets the path sorting algorithm. If `forward`, sort
|
||||
paths based on dimension categories from left to right.
|
||||
If `backward`, sort paths based on dimensions
|
||||
categories from right to left.
|
||||
stream
|
||||
:class:`plotly.graph_objects.parcats.Stream` instance
|
||||
or dict with compatible properties
|
||||
tickfont
|
||||
Sets the font for the `category` labels.
|
||||
uid
|
||||
Assign an id to this trace, Use this to provide object
|
||||
constancy between traces during animations and
|
||||
transitions.
|
||||
uirevision
|
||||
Controls persistence of some user-driven changes to the
|
||||
trace: `constraintrange` in `parcoords` traces, as well
|
||||
as some `editable: true` modifications such as `name`
|
||||
and `colorbar.title`. Defaults to `layout.uirevision`.
|
||||
Note that other user-driven trace attribute changes are
|
||||
controlled by `layout` attributes: `trace.visible` is
|
||||
controlled by `layout.legend.uirevision`,
|
||||
`selectedpoints` is controlled by
|
||||
`layout.selectionrevision`, and `colorbar.(x|y)`
|
||||
(accessible with `config: {editable: true}`) is
|
||||
controlled by `layout.editrevision`. Trace changes are
|
||||
tracked by `uid`, which only falls back on trace index
|
||||
if no `uid` is provided. So if your app can add/remove
|
||||
traces before the end of the `data` array, such that
|
||||
the same trace has a different index, you can still
|
||||
preserve user-driven changes if you give each trace a
|
||||
`uid` that stays with it as it moves.
|
||||
visible
|
||||
Determines whether or not this trace is visible. If
|
||||
"legendonly", the trace is not drawn, but can appear as
|
||||
a legend item (provided that the legend itself is
|
||||
visible).
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
arrangement=None,
|
||||
bundlecolors=None,
|
||||
counts=None,
|
||||
countssrc=None,
|
||||
dimensions=None,
|
||||
dimensiondefaults=None,
|
||||
domain=None,
|
||||
hoverinfo=None,
|
||||
hoveron=None,
|
||||
hovertemplate=None,
|
||||
labelfont=None,
|
||||
legendgrouptitle=None,
|
||||
legendwidth=None,
|
||||
line=None,
|
||||
meta=None,
|
||||
metasrc=None,
|
||||
name=None,
|
||||
sortpaths=None,
|
||||
stream=None,
|
||||
tickfont=None,
|
||||
uid=None,
|
||||
uirevision=None,
|
||||
visible=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Parcats object
|
||||
|
||||
Parallel categories diagram for multidimensional categorical
|
||||
data.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.Parcats`
|
||||
arrangement
|
||||
Sets the drag interaction mode for categories and
|
||||
dimensions. If `perpendicular`, the categories can only
|
||||
move along a line perpendicular to the paths. If
|
||||
`freeform`, the categories can freely move on the
|
||||
plane. If `fixed`, the categories and dimensions are
|
||||
stationary.
|
||||
bundlecolors
|
||||
Sort paths so that like colors are bundled together
|
||||
within each category.
|
||||
counts
|
||||
The number of observations represented by each state.
|
||||
Defaults to 1 so that each state represents one
|
||||
observation
|
||||
countssrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`counts`.
|
||||
dimensions
|
||||
The dimensions (variables) of the parallel categories
|
||||
diagram.
|
||||
dimensiondefaults
|
||||
When used in a template (as
|
||||
layout.template.data.parcats.dimensiondefaults), sets
|
||||
the default property values to use for elements of
|
||||
parcats.dimensions
|
||||
domain
|
||||
:class:`plotly.graph_objects.parcats.Domain` instance
|
||||
or dict with compatible properties
|
||||
hoverinfo
|
||||
Determines which trace information appear on hover. If
|
||||
`none` or `skip` are set, no information is displayed
|
||||
upon hovering. But, if `none` is set, click and hover
|
||||
events are still fired.
|
||||
hoveron
|
||||
Sets the hover interaction mode for the parcats
|
||||
diagram. If `category`, hover interaction take place
|
||||
per category. If `color`, hover interactions take place
|
||||
per color per category. If `dimension`, hover
|
||||
interactions take place across all categories per
|
||||
dimension.
|
||||
hovertemplate
|
||||
Template string used for rendering the information that
|
||||
appear on hover box. Note that this will override
|
||||
`hoverinfo`. Variables are inserted using %{variable},
|
||||
for example "y: %{y}" as well as %{xother}, {%_xother},
|
||||
{%_xother_}, {%xother_}. When showing info for several
|
||||
points, "xother" will be added to those with different
|
||||
x positions from the first point. An underscore before
|
||||
or after "(x|y)other" will add a space on that side,
|
||||
only when this field is shown. Numbers are formatted
|
||||
using d3-format's syntax %{variable:d3-format}, for
|
||||
example "Price: %{y:$.2f}".
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
|
||||
for details on the formatting syntax. Dates are
|
||||
formatted using d3-time-format's syntax
|
||||
%{variable|d3-time-format}, for example "Day:
|
||||
%{2019-01-01|%A}". https://github.com/d3/d3-time-
|
||||
format/tree/v2.2.3#locale_format for details on the
|
||||
date formatting syntax. The variables available in
|
||||
`hovertemplate` are the ones emitted as event data
|
||||
described at this link
|
||||
https://plotly.com/javascript/plotlyjs-events/#event-
|
||||
data. Additionally, every attributes that can be
|
||||
specified per-point (the ones that are `arrayOk: true`)
|
||||
are available. This value here applies when hovering
|
||||
over dimensions. Note that `*categorycount`,
|
||||
"colorcount" and "bandcolorcount" are only available
|
||||
when `hoveron` contains the "color" flagFinally, the
|
||||
template string has access to variables `count`,
|
||||
`probability`, `category`, `categorycount`,
|
||||
`colorcount` and `bandcolorcount`. Anything contained
|
||||
in tag `<extra>` is displayed in the secondary box, for
|
||||
example `<extra>%{fullData.name}</extra>`. To hide the
|
||||
secondary box completely, use an empty tag
|
||||
`<extra></extra>`.
|
||||
labelfont
|
||||
Sets the font for the `dimension` labels.
|
||||
legendgrouptitle
|
||||
:class:`plotly.graph_objects.parcats.Legendgrouptitle`
|
||||
instance or dict with compatible properties
|
||||
legendwidth
|
||||
Sets the width (in px or fraction) of the legend for
|
||||
this trace.
|
||||
line
|
||||
:class:`plotly.graph_objects.parcats.Line` instance or
|
||||
dict with compatible properties
|
||||
meta
|
||||
Assigns extra meta information associated with this
|
||||
trace that can be used in various text attributes.
|
||||
Attributes such as trace `name`, graph, axis and
|
||||
colorbar `title.text`, annotation `text`
|
||||
`rangeselector`, `updatemenues` and `sliders` `label`
|
||||
text all support `meta`. To access the trace `meta`
|
||||
values in an attribute in the same trace, simply use
|
||||
`%{meta[i]}` where `i` is the index or key of the
|
||||
`meta` item in question. To access trace `meta` in
|
||||
layout attributes, use `%{data[n[.meta[i]}` where `i`
|
||||
is the index or key of the `meta` and `n` is the trace
|
||||
index.
|
||||
metasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`meta`.
|
||||
name
|
||||
Sets the trace name. The trace name appears as the
|
||||
legend item and on hover.
|
||||
sortpaths
|
||||
Sets the path sorting algorithm. If `forward`, sort
|
||||
paths based on dimension categories from left to right.
|
||||
If `backward`, sort paths based on dimensions
|
||||
categories from right to left.
|
||||
stream
|
||||
:class:`plotly.graph_objects.parcats.Stream` instance
|
||||
or dict with compatible properties
|
||||
tickfont
|
||||
Sets the font for the `category` labels.
|
||||
uid
|
||||
Assign an id to this trace, Use this to provide object
|
||||
constancy between traces during animations and
|
||||
transitions.
|
||||
uirevision
|
||||
Controls persistence of some user-driven changes to the
|
||||
trace: `constraintrange` in `parcoords` traces, as well
|
||||
as some `editable: true` modifications such as `name`
|
||||
and `colorbar.title`. Defaults to `layout.uirevision`.
|
||||
Note that other user-driven trace attribute changes are
|
||||
controlled by `layout` attributes: `trace.visible` is
|
||||
controlled by `layout.legend.uirevision`,
|
||||
`selectedpoints` is controlled by
|
||||
`layout.selectionrevision`, and `colorbar.(x|y)`
|
||||
(accessible with `config: {editable: true}`) is
|
||||
controlled by `layout.editrevision`. Trace changes are
|
||||
tracked by `uid`, which only falls back on trace index
|
||||
if no `uid` is provided. So if your app can add/remove
|
||||
traces before the end of the `data` array, such that
|
||||
the same trace has a different index, you can still
|
||||
preserve user-driven changes if you give each trace a
|
||||
`uid` that stays with it as it moves.
|
||||
visible
|
||||
Determines whether or not this trace is visible. If
|
||||
"legendonly", the trace is not drawn, but can appear as
|
||||
a legend item (provided that the legend itself is
|
||||
visible).
|
||||
|
||||
Returns
|
||||
-------
|
||||
Parcats
|
||||
"""
|
||||
super().__init__("parcats")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.Parcats
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.Parcats`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("arrangement", arg, arrangement)
|
||||
self._set_property("bundlecolors", arg, bundlecolors)
|
||||
self._set_property("counts", arg, counts)
|
||||
self._set_property("countssrc", arg, countssrc)
|
||||
self._set_property("dimensions", arg, dimensions)
|
||||
self._set_property("dimensiondefaults", arg, dimensiondefaults)
|
||||
self._set_property("domain", arg, domain)
|
||||
self._set_property("hoverinfo", arg, hoverinfo)
|
||||
self._set_property("hoveron", arg, hoveron)
|
||||
self._set_property("hovertemplate", arg, hovertemplate)
|
||||
self._set_property("labelfont", arg, labelfont)
|
||||
self._set_property("legendgrouptitle", arg, legendgrouptitle)
|
||||
self._set_property("legendwidth", arg, legendwidth)
|
||||
self._set_property("line", arg, line)
|
||||
self._set_property("meta", arg, meta)
|
||||
self._set_property("metasrc", arg, metasrc)
|
||||
self._set_property("name", arg, name)
|
||||
self._set_property("sortpaths", arg, sortpaths)
|
||||
self._set_property("stream", arg, stream)
|
||||
self._set_property("tickfont", arg, tickfont)
|
||||
self._set_property("uid", arg, uid)
|
||||
self._set_property("uirevision", arg, uirevision)
|
||||
self._set_property("visible", arg, visible)
|
||||
|
||||
self._props["type"] = "parcats"
|
||||
arg.pop("type", None)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
919
lib/python3.11/site-packages/plotly/graph_objs/_parcoords.py
Normal file
919
lib/python3.11/site-packages/plotly/graph_objs/_parcoords.py
Normal file
@ -0,0 +1,919 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Parcoords(_BaseTraceType):
|
||||
_parent_path_str = ""
|
||||
_path_str = "parcoords"
|
||||
_valid_props = {
|
||||
"customdata",
|
||||
"customdatasrc",
|
||||
"dimensiondefaults",
|
||||
"dimensions",
|
||||
"domain",
|
||||
"ids",
|
||||
"idssrc",
|
||||
"labelangle",
|
||||
"labelfont",
|
||||
"labelside",
|
||||
"legend",
|
||||
"legendgrouptitle",
|
||||
"legendrank",
|
||||
"legendwidth",
|
||||
"line",
|
||||
"meta",
|
||||
"metasrc",
|
||||
"name",
|
||||
"rangefont",
|
||||
"stream",
|
||||
"tickfont",
|
||||
"type",
|
||||
"uid",
|
||||
"uirevision",
|
||||
"unselected",
|
||||
"visible",
|
||||
}
|
||||
|
||||
@property
|
||||
def customdata(self):
|
||||
"""
|
||||
Assigns extra data each datum. This may be useful when
|
||||
listening to hover, click and selection events. Note that,
|
||||
"scatter" traces also appends customdata items in the markers
|
||||
DOM elements
|
||||
|
||||
The 'customdata' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["customdata"]
|
||||
|
||||
@customdata.setter
|
||||
def customdata(self, val):
|
||||
self["customdata"] = val
|
||||
|
||||
@property
|
||||
def customdatasrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`customdata`.
|
||||
|
||||
The 'customdatasrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["customdatasrc"]
|
||||
|
||||
@customdatasrc.setter
|
||||
def customdatasrc(self, val):
|
||||
self["customdatasrc"] = val
|
||||
|
||||
@property
|
||||
def dimensions(self):
|
||||
"""
|
||||
The dimensions (variables) of the parallel coordinates chart.
|
||||
2..60 dimensions are supported.
|
||||
|
||||
The 'dimensions' property is a tuple of instances of
|
||||
Dimension that may be specified as:
|
||||
- A list or tuple of instances of plotly.graph_objs.parcoords.Dimension
|
||||
- A list or tuple of dicts of string/value properties that
|
||||
will be passed to the Dimension constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
tuple[plotly.graph_objs.parcoords.Dimension]
|
||||
"""
|
||||
return self["dimensions"]
|
||||
|
||||
@dimensions.setter
|
||||
def dimensions(self, val):
|
||||
self["dimensions"] = val
|
||||
|
||||
@property
|
||||
def dimensiondefaults(self):
|
||||
"""
|
||||
When used in a template (as
|
||||
layout.template.data.parcoords.dimensiondefaults), sets the
|
||||
default property values to use for elements of
|
||||
parcoords.dimensions
|
||||
|
||||
The 'dimensiondefaults' property is an instance of Dimension
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcoords.Dimension`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Dimension constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcoords.Dimension
|
||||
"""
|
||||
return self["dimensiondefaults"]
|
||||
|
||||
@dimensiondefaults.setter
|
||||
def dimensiondefaults(self, val):
|
||||
self["dimensiondefaults"] = val
|
||||
|
||||
@property
|
||||
def domain(self):
|
||||
"""
|
||||
The 'domain' property is an instance of Domain
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcoords.Domain`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Domain constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcoords.Domain
|
||||
"""
|
||||
return self["domain"]
|
||||
|
||||
@domain.setter
|
||||
def domain(self, val):
|
||||
self["domain"] = val
|
||||
|
||||
@property
|
||||
def ids(self):
|
||||
"""
|
||||
Assigns id labels to each datum. These ids for object constancy
|
||||
of data points during animation. Should be an array of strings,
|
||||
not numbers or any other type.
|
||||
|
||||
The 'ids' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["ids"]
|
||||
|
||||
@ids.setter
|
||||
def ids(self, val):
|
||||
self["ids"] = val
|
||||
|
||||
@property
|
||||
def idssrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `ids`.
|
||||
|
||||
The 'idssrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["idssrc"]
|
||||
|
||||
@idssrc.setter
|
||||
def idssrc(self, val):
|
||||
self["idssrc"] = val
|
||||
|
||||
@property
|
||||
def labelangle(self):
|
||||
"""
|
||||
Sets the angle of the labels with respect to the horizontal.
|
||||
For example, a `tickangle` of -90 draws the labels vertically.
|
||||
Tilted labels with "labelangle" may be positioned better inside
|
||||
margins when `labelposition` is set to "bottom".
|
||||
|
||||
The 'labelangle' property is a angle (in degrees) that may be
|
||||
specified as a number between -180 and 180.
|
||||
Numeric values outside this range are converted to the equivalent value
|
||||
(e.g. 270 is converted to -90).
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["labelangle"]
|
||||
|
||||
@labelangle.setter
|
||||
def labelangle(self, val):
|
||||
self["labelangle"] = val
|
||||
|
||||
@property
|
||||
def labelfont(self):
|
||||
"""
|
||||
Sets the font for the `dimension` labels.
|
||||
|
||||
The 'labelfont' property is an instance of Labelfont
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcoords.Labelfont`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Labelfont constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcoords.Labelfont
|
||||
"""
|
||||
return self["labelfont"]
|
||||
|
||||
@labelfont.setter
|
||||
def labelfont(self, val):
|
||||
self["labelfont"] = val
|
||||
|
||||
@property
|
||||
def labelside(self):
|
||||
"""
|
||||
Specifies the location of the `label`. "top" positions labels
|
||||
above, next to the title "bottom" positions labels below the
|
||||
graph Tilted labels with "labelangle" may be positioned better
|
||||
inside margins when `labelposition` is set to "bottom".
|
||||
|
||||
The 'labelside' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['top', 'bottom']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["labelside"]
|
||||
|
||||
@labelside.setter
|
||||
def labelside(self, val):
|
||||
self["labelside"] = val
|
||||
|
||||
@property
|
||||
def legend(self):
|
||||
"""
|
||||
Sets the reference to a legend to show this trace in.
|
||||
References to these legends are "legend", "legend2", "legend3",
|
||||
etc. Settings for these legends are set in the layout, under
|
||||
`layout.legend`, `layout.legend2`, etc.
|
||||
|
||||
The 'legend' property is an identifier of a particular
|
||||
subplot, of type 'legend', that may be specified as the string 'legend'
|
||||
optionally followed by an integer >= 1
|
||||
(e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["legend"]
|
||||
|
||||
@legend.setter
|
||||
def legend(self, val):
|
||||
self["legend"] = val
|
||||
|
||||
@property
|
||||
def legendgrouptitle(self):
|
||||
"""
|
||||
The 'legendgrouptitle' property is an instance of Legendgrouptitle
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcoords.Legendgrouptitle`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Legendgrouptitle constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcoords.Legendgrouptitle
|
||||
"""
|
||||
return self["legendgrouptitle"]
|
||||
|
||||
@legendgrouptitle.setter
|
||||
def legendgrouptitle(self, val):
|
||||
self["legendgrouptitle"] = val
|
||||
|
||||
@property
|
||||
def legendrank(self):
|
||||
"""
|
||||
Sets the legend rank for this trace. Items and groups with
|
||||
smaller ranks are presented on top/left side while with
|
||||
"reversed" `legend.traceorder` they are on bottom/right side.
|
||||
The default legendrank is 1000, so that you can use ranks less
|
||||
than 1000 to place certain items before all unranked items, and
|
||||
ranks greater than 1000 to go after all unranked items. When
|
||||
having unranked or equal rank items shapes would be displayed
|
||||
after traces i.e. according to their order in data and layout.
|
||||
|
||||
The 'legendrank' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["legendrank"]
|
||||
|
||||
@legendrank.setter
|
||||
def legendrank(self, val):
|
||||
self["legendrank"] = val
|
||||
|
||||
@property
|
||||
def legendwidth(self):
|
||||
"""
|
||||
Sets the width (in px or fraction) of the legend for this
|
||||
trace.
|
||||
|
||||
The 'legendwidth' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["legendwidth"]
|
||||
|
||||
@legendwidth.setter
|
||||
def legendwidth(self, val):
|
||||
self["legendwidth"] = val
|
||||
|
||||
@property
|
||||
def line(self):
|
||||
"""
|
||||
The 'line' property is an instance of Line
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcoords.Line`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Line constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcoords.Line
|
||||
"""
|
||||
return self["line"]
|
||||
|
||||
@line.setter
|
||||
def line(self, val):
|
||||
self["line"] = val
|
||||
|
||||
@property
|
||||
def meta(self):
|
||||
"""
|
||||
Assigns extra meta information associated with this trace that
|
||||
can be used in various text attributes. Attributes such as
|
||||
trace `name`, graph, axis and colorbar `title.text`, annotation
|
||||
`text` `rangeselector`, `updatemenues` and `sliders` `label`
|
||||
text all support `meta`. To access the trace `meta` values in
|
||||
an attribute in the same trace, simply use `%{meta[i]}` where
|
||||
`i` is the index or key of the `meta` item in question. To
|
||||
access trace `meta` in layout attributes, use
|
||||
`%{data[n[.meta[i]}` where `i` is the index or key of the
|
||||
`meta` and `n` is the trace index.
|
||||
|
||||
The 'meta' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["meta"]
|
||||
|
||||
@meta.setter
|
||||
def meta(self, val):
|
||||
self["meta"] = val
|
||||
|
||||
@property
|
||||
def metasrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `meta`.
|
||||
|
||||
The 'metasrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["metasrc"]
|
||||
|
||||
@metasrc.setter
|
||||
def metasrc(self, val):
|
||||
self["metasrc"] = val
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""
|
||||
Sets the trace name. The trace name appears as the legend item
|
||||
and on hover.
|
||||
|
||||
The 'name' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["name"]
|
||||
|
||||
@name.setter
|
||||
def name(self, val):
|
||||
self["name"] = val
|
||||
|
||||
@property
|
||||
def rangefont(self):
|
||||
"""
|
||||
Sets the font for the `dimension` range values.
|
||||
|
||||
The 'rangefont' property is an instance of Rangefont
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcoords.Rangefont`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Rangefont constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcoords.Rangefont
|
||||
"""
|
||||
return self["rangefont"]
|
||||
|
||||
@rangefont.setter
|
||||
def rangefont(self, val):
|
||||
self["rangefont"] = val
|
||||
|
||||
@property
|
||||
def stream(self):
|
||||
"""
|
||||
The 'stream' property is an instance of Stream
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcoords.Stream`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Stream constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcoords.Stream
|
||||
"""
|
||||
return self["stream"]
|
||||
|
||||
@stream.setter
|
||||
def stream(self, val):
|
||||
self["stream"] = val
|
||||
|
||||
@property
|
||||
def tickfont(self):
|
||||
"""
|
||||
Sets the font for the `dimension` tick values.
|
||||
|
||||
The 'tickfont' property is an instance of Tickfont
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcoords.Tickfont`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Tickfont constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcoords.Tickfont
|
||||
"""
|
||||
return self["tickfont"]
|
||||
|
||||
@tickfont.setter
|
||||
def tickfont(self, val):
|
||||
self["tickfont"] = val
|
||||
|
||||
@property
|
||||
def uid(self):
|
||||
"""
|
||||
Assign an id to this trace, Use this to provide object
|
||||
constancy between traces during animations and transitions.
|
||||
|
||||
The 'uid' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["uid"]
|
||||
|
||||
@uid.setter
|
||||
def uid(self, val):
|
||||
self["uid"] = val
|
||||
|
||||
@property
|
||||
def uirevision(self):
|
||||
"""
|
||||
Controls persistence of some user-driven changes to the trace:
|
||||
`constraintrange` in `parcoords` traces, as well as some
|
||||
`editable: true` modifications such as `name` and
|
||||
`colorbar.title`. Defaults to `layout.uirevision`. Note that
|
||||
other user-driven trace attribute changes are controlled by
|
||||
`layout` attributes: `trace.visible` is controlled by
|
||||
`layout.legend.uirevision`, `selectedpoints` is controlled by
|
||||
`layout.selectionrevision`, and `colorbar.(x|y)` (accessible
|
||||
with `config: {editable: true}`) is controlled by
|
||||
`layout.editrevision`. Trace changes are tracked by `uid`,
|
||||
which only falls back on trace index if no `uid` is provided.
|
||||
So if your app can add/remove traces before the end of the
|
||||
`data` array, such that the same trace has a different index,
|
||||
you can still preserve user-driven changes if you give each
|
||||
trace a `uid` that stays with it as it moves.
|
||||
|
||||
The 'uirevision' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["uirevision"]
|
||||
|
||||
@uirevision.setter
|
||||
def uirevision(self, val):
|
||||
self["uirevision"] = val
|
||||
|
||||
@property
|
||||
def unselected(self):
|
||||
"""
|
||||
The 'unselected' property is an instance of Unselected
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.parcoords.Unselected`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Unselected constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.parcoords.Unselected
|
||||
"""
|
||||
return self["unselected"]
|
||||
|
||||
@unselected.setter
|
||||
def unselected(self, val):
|
||||
self["unselected"] = val
|
||||
|
||||
@property
|
||||
def visible(self):
|
||||
"""
|
||||
Determines whether or not this trace is visible. If
|
||||
"legendonly", the trace is not drawn, but can appear as a
|
||||
legend item (provided that the legend itself is visible).
|
||||
|
||||
The 'visible' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
[True, False, 'legendonly']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["visible"]
|
||||
|
||||
@visible.setter
|
||||
def visible(self, val):
|
||||
self["visible"] = val
|
||||
|
||||
@property
|
||||
def type(self):
|
||||
return self._props["type"]
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
customdata
|
||||
Assigns extra data each datum. This may be useful when
|
||||
listening to hover, click and selection events. Note
|
||||
that, "scatter" traces also appends customdata items in
|
||||
the markers DOM elements
|
||||
customdatasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`customdata`.
|
||||
dimensions
|
||||
The dimensions (variables) of the parallel coordinates
|
||||
chart. 2..60 dimensions are supported.
|
||||
dimensiondefaults
|
||||
When used in a template (as
|
||||
layout.template.data.parcoords.dimensiondefaults), sets
|
||||
the default property values to use for elements of
|
||||
parcoords.dimensions
|
||||
domain
|
||||
:class:`plotly.graph_objects.parcoords.Domain` instance
|
||||
or dict with compatible properties
|
||||
ids
|
||||
Assigns id labels to each datum. These ids for object
|
||||
constancy of data points during animation. Should be an
|
||||
array of strings, not numbers or any other type.
|
||||
idssrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`ids`.
|
||||
labelangle
|
||||
Sets the angle of the labels with respect to the
|
||||
horizontal. For example, a `tickangle` of -90 draws the
|
||||
labels vertically. Tilted labels with "labelangle" may
|
||||
be positioned better inside margins when
|
||||
`labelposition` is set to "bottom".
|
||||
labelfont
|
||||
Sets the font for the `dimension` labels.
|
||||
labelside
|
||||
Specifies the location of the `label`. "top" positions
|
||||
labels above, next to the title "bottom" positions
|
||||
labels below the graph Tilted labels with "labelangle"
|
||||
may be positioned better inside margins when
|
||||
`labelposition` is set to "bottom".
|
||||
legend
|
||||
Sets the reference to a legend to show this trace in.
|
||||
References to these legends are "legend", "legend2",
|
||||
"legend3", etc. Settings for these legends are set in
|
||||
the layout, under `layout.legend`, `layout.legend2`,
|
||||
etc.
|
||||
legendgrouptitle
|
||||
:class:`plotly.graph_objects.parcoords.Legendgrouptitle
|
||||
` instance or dict with compatible properties
|
||||
legendrank
|
||||
Sets the legend rank for this trace. Items and groups
|
||||
with smaller ranks are presented on top/left side while
|
||||
with "reversed" `legend.traceorder` they are on
|
||||
bottom/right side. The default legendrank is 1000, so
|
||||
that you can use ranks less than 1000 to place certain
|
||||
items before all unranked items, and ranks greater than
|
||||
1000 to go after all unranked items. When having
|
||||
unranked or equal rank items shapes would be displayed
|
||||
after traces i.e. according to their order in data and
|
||||
layout.
|
||||
legendwidth
|
||||
Sets the width (in px or fraction) of the legend for
|
||||
this trace.
|
||||
line
|
||||
:class:`plotly.graph_objects.parcoords.Line` instance
|
||||
or dict with compatible properties
|
||||
meta
|
||||
Assigns extra meta information associated with this
|
||||
trace that can be used in various text attributes.
|
||||
Attributes such as trace `name`, graph, axis and
|
||||
colorbar `title.text`, annotation `text`
|
||||
`rangeselector`, `updatemenues` and `sliders` `label`
|
||||
text all support `meta`. To access the trace `meta`
|
||||
values in an attribute in the same trace, simply use
|
||||
`%{meta[i]}` where `i` is the index or key of the
|
||||
`meta` item in question. To access trace `meta` in
|
||||
layout attributes, use `%{data[n[.meta[i]}` where `i`
|
||||
is the index or key of the `meta` and `n` is the trace
|
||||
index.
|
||||
metasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`meta`.
|
||||
name
|
||||
Sets the trace name. The trace name appears as the
|
||||
legend item and on hover.
|
||||
rangefont
|
||||
Sets the font for the `dimension` range values.
|
||||
stream
|
||||
:class:`plotly.graph_objects.parcoords.Stream` instance
|
||||
or dict with compatible properties
|
||||
tickfont
|
||||
Sets the font for the `dimension` tick values.
|
||||
uid
|
||||
Assign an id to this trace, Use this to provide object
|
||||
constancy between traces during animations and
|
||||
transitions.
|
||||
uirevision
|
||||
Controls persistence of some user-driven changes to the
|
||||
trace: `constraintrange` in `parcoords` traces, as well
|
||||
as some `editable: true` modifications such as `name`
|
||||
and `colorbar.title`. Defaults to `layout.uirevision`.
|
||||
Note that other user-driven trace attribute changes are
|
||||
controlled by `layout` attributes: `trace.visible` is
|
||||
controlled by `layout.legend.uirevision`,
|
||||
`selectedpoints` is controlled by
|
||||
`layout.selectionrevision`, and `colorbar.(x|y)`
|
||||
(accessible with `config: {editable: true}`) is
|
||||
controlled by `layout.editrevision`. Trace changes are
|
||||
tracked by `uid`, which only falls back on trace index
|
||||
if no `uid` is provided. So if your app can add/remove
|
||||
traces before the end of the `data` array, such that
|
||||
the same trace has a different index, you can still
|
||||
preserve user-driven changes if you give each trace a
|
||||
`uid` that stays with it as it moves.
|
||||
unselected
|
||||
:class:`plotly.graph_objects.parcoords.Unselected`
|
||||
instance or dict with compatible properties
|
||||
visible
|
||||
Determines whether or not this trace is visible. If
|
||||
"legendonly", the trace is not drawn, but can appear as
|
||||
a legend item (provided that the legend itself is
|
||||
visible).
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
customdata=None,
|
||||
customdatasrc=None,
|
||||
dimensions=None,
|
||||
dimensiondefaults=None,
|
||||
domain=None,
|
||||
ids=None,
|
||||
idssrc=None,
|
||||
labelangle=None,
|
||||
labelfont=None,
|
||||
labelside=None,
|
||||
legend=None,
|
||||
legendgrouptitle=None,
|
||||
legendrank=None,
|
||||
legendwidth=None,
|
||||
line=None,
|
||||
meta=None,
|
||||
metasrc=None,
|
||||
name=None,
|
||||
rangefont=None,
|
||||
stream=None,
|
||||
tickfont=None,
|
||||
uid=None,
|
||||
uirevision=None,
|
||||
unselected=None,
|
||||
visible=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Parcoords object
|
||||
|
||||
Parallel coordinates for multidimensional exploratory data
|
||||
analysis. The samples are specified in `dimensions`. The colors
|
||||
are set in `line.color`.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.Parcoords`
|
||||
customdata
|
||||
Assigns extra data each datum. This may be useful when
|
||||
listening to hover, click and selection events. Note
|
||||
that, "scatter" traces also appends customdata items in
|
||||
the markers DOM elements
|
||||
customdatasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`customdata`.
|
||||
dimensions
|
||||
The dimensions (variables) of the parallel coordinates
|
||||
chart. 2..60 dimensions are supported.
|
||||
dimensiondefaults
|
||||
When used in a template (as
|
||||
layout.template.data.parcoords.dimensiondefaults), sets
|
||||
the default property values to use for elements of
|
||||
parcoords.dimensions
|
||||
domain
|
||||
:class:`plotly.graph_objects.parcoords.Domain` instance
|
||||
or dict with compatible properties
|
||||
ids
|
||||
Assigns id labels to each datum. These ids for object
|
||||
constancy of data points during animation. Should be an
|
||||
array of strings, not numbers or any other type.
|
||||
idssrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`ids`.
|
||||
labelangle
|
||||
Sets the angle of the labels with respect to the
|
||||
horizontal. For example, a `tickangle` of -90 draws the
|
||||
labels vertically. Tilted labels with "labelangle" may
|
||||
be positioned better inside margins when
|
||||
`labelposition` is set to "bottom".
|
||||
labelfont
|
||||
Sets the font for the `dimension` labels.
|
||||
labelside
|
||||
Specifies the location of the `label`. "top" positions
|
||||
labels above, next to the title "bottom" positions
|
||||
labels below the graph Tilted labels with "labelangle"
|
||||
may be positioned better inside margins when
|
||||
`labelposition` is set to "bottom".
|
||||
legend
|
||||
Sets the reference to a legend to show this trace in.
|
||||
References to these legends are "legend", "legend2",
|
||||
"legend3", etc. Settings for these legends are set in
|
||||
the layout, under `layout.legend`, `layout.legend2`,
|
||||
etc.
|
||||
legendgrouptitle
|
||||
:class:`plotly.graph_objects.parcoords.Legendgrouptitle
|
||||
` instance or dict with compatible properties
|
||||
legendrank
|
||||
Sets the legend rank for this trace. Items and groups
|
||||
with smaller ranks are presented on top/left side while
|
||||
with "reversed" `legend.traceorder` they are on
|
||||
bottom/right side. The default legendrank is 1000, so
|
||||
that you can use ranks less than 1000 to place certain
|
||||
items before all unranked items, and ranks greater than
|
||||
1000 to go after all unranked items. When having
|
||||
unranked or equal rank items shapes would be displayed
|
||||
after traces i.e. according to their order in data and
|
||||
layout.
|
||||
legendwidth
|
||||
Sets the width (in px or fraction) of the legend for
|
||||
this trace.
|
||||
line
|
||||
:class:`plotly.graph_objects.parcoords.Line` instance
|
||||
or dict with compatible properties
|
||||
meta
|
||||
Assigns extra meta information associated with this
|
||||
trace that can be used in various text attributes.
|
||||
Attributes such as trace `name`, graph, axis and
|
||||
colorbar `title.text`, annotation `text`
|
||||
`rangeselector`, `updatemenues` and `sliders` `label`
|
||||
text all support `meta`. To access the trace `meta`
|
||||
values in an attribute in the same trace, simply use
|
||||
`%{meta[i]}` where `i` is the index or key of the
|
||||
`meta` item in question. To access trace `meta` in
|
||||
layout attributes, use `%{data[n[.meta[i]}` where `i`
|
||||
is the index or key of the `meta` and `n` is the trace
|
||||
index.
|
||||
metasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`meta`.
|
||||
name
|
||||
Sets the trace name. The trace name appears as the
|
||||
legend item and on hover.
|
||||
rangefont
|
||||
Sets the font for the `dimension` range values.
|
||||
stream
|
||||
:class:`plotly.graph_objects.parcoords.Stream` instance
|
||||
or dict with compatible properties
|
||||
tickfont
|
||||
Sets the font for the `dimension` tick values.
|
||||
uid
|
||||
Assign an id to this trace, Use this to provide object
|
||||
constancy between traces during animations and
|
||||
transitions.
|
||||
uirevision
|
||||
Controls persistence of some user-driven changes to the
|
||||
trace: `constraintrange` in `parcoords` traces, as well
|
||||
as some `editable: true` modifications such as `name`
|
||||
and `colorbar.title`. Defaults to `layout.uirevision`.
|
||||
Note that other user-driven trace attribute changes are
|
||||
controlled by `layout` attributes: `trace.visible` is
|
||||
controlled by `layout.legend.uirevision`,
|
||||
`selectedpoints` is controlled by
|
||||
`layout.selectionrevision`, and `colorbar.(x|y)`
|
||||
(accessible with `config: {editable: true}`) is
|
||||
controlled by `layout.editrevision`. Trace changes are
|
||||
tracked by `uid`, which only falls back on trace index
|
||||
if no `uid` is provided. So if your app can add/remove
|
||||
traces before the end of the `data` array, such that
|
||||
the same trace has a different index, you can still
|
||||
preserve user-driven changes if you give each trace a
|
||||
`uid` that stays with it as it moves.
|
||||
unselected
|
||||
:class:`plotly.graph_objects.parcoords.Unselected`
|
||||
instance or dict with compatible properties
|
||||
visible
|
||||
Determines whether or not this trace is visible. If
|
||||
"legendonly", the trace is not drawn, but can appear as
|
||||
a legend item (provided that the legend itself is
|
||||
visible).
|
||||
|
||||
Returns
|
||||
-------
|
||||
Parcoords
|
||||
"""
|
||||
super().__init__("parcoords")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.Parcoords
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.Parcoords`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("customdata", arg, customdata)
|
||||
self._set_property("customdatasrc", arg, customdatasrc)
|
||||
self._set_property("dimensions", arg, dimensions)
|
||||
self._set_property("dimensiondefaults", arg, dimensiondefaults)
|
||||
self._set_property("domain", arg, domain)
|
||||
self._set_property("ids", arg, ids)
|
||||
self._set_property("idssrc", arg, idssrc)
|
||||
self._set_property("labelangle", arg, labelangle)
|
||||
self._set_property("labelfont", arg, labelfont)
|
||||
self._set_property("labelside", arg, labelside)
|
||||
self._set_property("legend", arg, legend)
|
||||
self._set_property("legendgrouptitle", arg, legendgrouptitle)
|
||||
self._set_property("legendrank", arg, legendrank)
|
||||
self._set_property("legendwidth", arg, legendwidth)
|
||||
self._set_property("line", arg, line)
|
||||
self._set_property("meta", arg, meta)
|
||||
self._set_property("metasrc", arg, metasrc)
|
||||
self._set_property("name", arg, name)
|
||||
self._set_property("rangefont", arg, rangefont)
|
||||
self._set_property("stream", arg, stream)
|
||||
self._set_property("tickfont", arg, tickfont)
|
||||
self._set_property("uid", arg, uid)
|
||||
self._set_property("uirevision", arg, uirevision)
|
||||
self._set_property("unselected", arg, unselected)
|
||||
self._set_property("visible", arg, visible)
|
||||
|
||||
self._props["type"] = "parcoords"
|
||||
arg.pop("type", None)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
1871
lib/python3.11/site-packages/plotly/graph_objs/_pie.py
Normal file
1871
lib/python3.11/site-packages/plotly/graph_objs/_pie.py
Normal file
File diff suppressed because it is too large
Load Diff
966
lib/python3.11/site-packages/plotly/graph_objs/_sankey.py
Normal file
966
lib/python3.11/site-packages/plotly/graph_objs/_sankey.py
Normal file
@ -0,0 +1,966 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Sankey(_BaseTraceType):
|
||||
_parent_path_str = ""
|
||||
_path_str = "sankey"
|
||||
_valid_props = {
|
||||
"arrangement",
|
||||
"customdata",
|
||||
"customdatasrc",
|
||||
"domain",
|
||||
"hoverinfo",
|
||||
"hoverlabel",
|
||||
"ids",
|
||||
"idssrc",
|
||||
"legend",
|
||||
"legendgrouptitle",
|
||||
"legendrank",
|
||||
"legendwidth",
|
||||
"link",
|
||||
"meta",
|
||||
"metasrc",
|
||||
"name",
|
||||
"node",
|
||||
"orientation",
|
||||
"selectedpoints",
|
||||
"stream",
|
||||
"textfont",
|
||||
"type",
|
||||
"uid",
|
||||
"uirevision",
|
||||
"valueformat",
|
||||
"valuesuffix",
|
||||
"visible",
|
||||
}
|
||||
|
||||
@property
|
||||
def arrangement(self):
|
||||
"""
|
||||
If value is `snap` (the default), the node arrangement is
|
||||
assisted by automatic snapping of elements to preserve space
|
||||
between nodes specified via `nodepad`. If value is
|
||||
`perpendicular`, the nodes can only move along a line
|
||||
perpendicular to the flow. If value is `freeform`, the nodes
|
||||
can freely move on the plane. If value is `fixed`, the nodes
|
||||
are stationary.
|
||||
|
||||
The 'arrangement' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['snap', 'perpendicular', 'freeform', 'fixed']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["arrangement"]
|
||||
|
||||
@arrangement.setter
|
||||
def arrangement(self, val):
|
||||
self["arrangement"] = val
|
||||
|
||||
@property
|
||||
def customdata(self):
|
||||
"""
|
||||
Assigns extra data each datum. This may be useful when
|
||||
listening to hover, click and selection events. Note that,
|
||||
"scatter" traces also appends customdata items in the markers
|
||||
DOM elements
|
||||
|
||||
The 'customdata' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["customdata"]
|
||||
|
||||
@customdata.setter
|
||||
def customdata(self, val):
|
||||
self["customdata"] = val
|
||||
|
||||
@property
|
||||
def customdatasrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`customdata`.
|
||||
|
||||
The 'customdatasrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["customdatasrc"]
|
||||
|
||||
@customdatasrc.setter
|
||||
def customdatasrc(self, val):
|
||||
self["customdatasrc"] = val
|
||||
|
||||
@property
|
||||
def domain(self):
|
||||
"""
|
||||
The 'domain' property is an instance of Domain
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.sankey.Domain`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Domain constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.sankey.Domain
|
||||
"""
|
||||
return self["domain"]
|
||||
|
||||
@domain.setter
|
||||
def domain(self, val):
|
||||
self["domain"] = val
|
||||
|
||||
@property
|
||||
def hoverinfo(self):
|
||||
"""
|
||||
Determines which trace information appear on hover. If `none`
|
||||
or `skip` are set, no information is displayed upon hovering.
|
||||
But, if `none` is set, click and hover events are still fired.
|
||||
Note that this attribute is superseded by `node.hoverinfo` and
|
||||
`node.hoverinfo` for nodes and links respectively.
|
||||
|
||||
The 'hoverinfo' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of [] joined with '+' characters
|
||||
(e.g. '')
|
||||
OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["hoverinfo"]
|
||||
|
||||
@hoverinfo.setter
|
||||
def hoverinfo(self, val):
|
||||
self["hoverinfo"] = val
|
||||
|
||||
@property
|
||||
def hoverlabel(self):
|
||||
"""
|
||||
The 'hoverlabel' property is an instance of Hoverlabel
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.sankey.Hoverlabel`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Hoverlabel constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.sankey.Hoverlabel
|
||||
"""
|
||||
return self["hoverlabel"]
|
||||
|
||||
@hoverlabel.setter
|
||||
def hoverlabel(self, val):
|
||||
self["hoverlabel"] = val
|
||||
|
||||
@property
|
||||
def ids(self):
|
||||
"""
|
||||
Assigns id labels to each datum. These ids for object constancy
|
||||
of data points during animation. Should be an array of strings,
|
||||
not numbers or any other type.
|
||||
|
||||
The 'ids' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["ids"]
|
||||
|
||||
@ids.setter
|
||||
def ids(self, val):
|
||||
self["ids"] = val
|
||||
|
||||
@property
|
||||
def idssrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `ids`.
|
||||
|
||||
The 'idssrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["idssrc"]
|
||||
|
||||
@idssrc.setter
|
||||
def idssrc(self, val):
|
||||
self["idssrc"] = val
|
||||
|
||||
@property
|
||||
def legend(self):
|
||||
"""
|
||||
Sets the reference to a legend to show this trace in.
|
||||
References to these legends are "legend", "legend2", "legend3",
|
||||
etc. Settings for these legends are set in the layout, under
|
||||
`layout.legend`, `layout.legend2`, etc.
|
||||
|
||||
The 'legend' property is an identifier of a particular
|
||||
subplot, of type 'legend', that may be specified as the string 'legend'
|
||||
optionally followed by an integer >= 1
|
||||
(e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["legend"]
|
||||
|
||||
@legend.setter
|
||||
def legend(self, val):
|
||||
self["legend"] = val
|
||||
|
||||
@property
|
||||
def legendgrouptitle(self):
|
||||
"""
|
||||
The 'legendgrouptitle' property is an instance of Legendgrouptitle
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.sankey.Legendgrouptitle`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Legendgrouptitle constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.sankey.Legendgrouptitle
|
||||
"""
|
||||
return self["legendgrouptitle"]
|
||||
|
||||
@legendgrouptitle.setter
|
||||
def legendgrouptitle(self, val):
|
||||
self["legendgrouptitle"] = val
|
||||
|
||||
@property
|
||||
def legendrank(self):
|
||||
"""
|
||||
Sets the legend rank for this trace. Items and groups with
|
||||
smaller ranks are presented on top/left side while with
|
||||
"reversed" `legend.traceorder` they are on bottom/right side.
|
||||
The default legendrank is 1000, so that you can use ranks less
|
||||
than 1000 to place certain items before all unranked items, and
|
||||
ranks greater than 1000 to go after all unranked items. When
|
||||
having unranked or equal rank items shapes would be displayed
|
||||
after traces i.e. according to their order in data and layout.
|
||||
|
||||
The 'legendrank' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["legendrank"]
|
||||
|
||||
@legendrank.setter
|
||||
def legendrank(self, val):
|
||||
self["legendrank"] = val
|
||||
|
||||
@property
|
||||
def legendwidth(self):
|
||||
"""
|
||||
Sets the width (in px or fraction) of the legend for this
|
||||
trace.
|
||||
|
||||
The 'legendwidth' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["legendwidth"]
|
||||
|
||||
@legendwidth.setter
|
||||
def legendwidth(self, val):
|
||||
self["legendwidth"] = val
|
||||
|
||||
@property
|
||||
def link(self):
|
||||
"""
|
||||
The links of the Sankey plot.
|
||||
|
||||
The 'link' property is an instance of Link
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.sankey.Link`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Link constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.sankey.Link
|
||||
"""
|
||||
return self["link"]
|
||||
|
||||
@link.setter
|
||||
def link(self, val):
|
||||
self["link"] = val
|
||||
|
||||
@property
|
||||
def meta(self):
|
||||
"""
|
||||
Assigns extra meta information associated with this trace that
|
||||
can be used in various text attributes. Attributes such as
|
||||
trace `name`, graph, axis and colorbar `title.text`, annotation
|
||||
`text` `rangeselector`, `updatemenues` and `sliders` `label`
|
||||
text all support `meta`. To access the trace `meta` values in
|
||||
an attribute in the same trace, simply use `%{meta[i]}` where
|
||||
`i` is the index or key of the `meta` item in question. To
|
||||
access trace `meta` in layout attributes, use
|
||||
`%{data[n[.meta[i]}` where `i` is the index or key of the
|
||||
`meta` and `n` is the trace index.
|
||||
|
||||
The 'meta' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["meta"]
|
||||
|
||||
@meta.setter
|
||||
def meta(self, val):
|
||||
self["meta"] = val
|
||||
|
||||
@property
|
||||
def metasrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `meta`.
|
||||
|
||||
The 'metasrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["metasrc"]
|
||||
|
||||
@metasrc.setter
|
||||
def metasrc(self, val):
|
||||
self["metasrc"] = val
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""
|
||||
Sets the trace name. The trace name appears as the legend item
|
||||
and on hover.
|
||||
|
||||
The 'name' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["name"]
|
||||
|
||||
@name.setter
|
||||
def name(self, val):
|
||||
self["name"] = val
|
||||
|
||||
@property
|
||||
def node(self):
|
||||
"""
|
||||
The nodes of the Sankey plot.
|
||||
|
||||
The 'node' property is an instance of Node
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.sankey.Node`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Node constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.sankey.Node
|
||||
"""
|
||||
return self["node"]
|
||||
|
||||
@node.setter
|
||||
def node(self, val):
|
||||
self["node"] = val
|
||||
|
||||
@property
|
||||
def orientation(self):
|
||||
"""
|
||||
Sets the orientation of the Sankey diagram.
|
||||
|
||||
The 'orientation' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['v', 'h']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["orientation"]
|
||||
|
||||
@orientation.setter
|
||||
def orientation(self, val):
|
||||
self["orientation"] = val
|
||||
|
||||
@property
|
||||
def selectedpoints(self):
|
||||
"""
|
||||
Array containing integer indices of selected points. Has an
|
||||
effect only for traces that support selections. Note that an
|
||||
empty array means an empty selection where the `unselected` are
|
||||
turned on for all points, whereas, any other non-array values
|
||||
means no selection all where the `selected` and `unselected`
|
||||
styles have no effect.
|
||||
|
||||
The 'selectedpoints' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["selectedpoints"]
|
||||
|
||||
@selectedpoints.setter
|
||||
def selectedpoints(self, val):
|
||||
self["selectedpoints"] = val
|
||||
|
||||
@property
|
||||
def stream(self):
|
||||
"""
|
||||
The 'stream' property is an instance of Stream
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.sankey.Stream`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Stream constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.sankey.Stream
|
||||
"""
|
||||
return self["stream"]
|
||||
|
||||
@stream.setter
|
||||
def stream(self, val):
|
||||
self["stream"] = val
|
||||
|
||||
@property
|
||||
def textfont(self):
|
||||
"""
|
||||
Sets the font for node labels
|
||||
|
||||
The 'textfont' property is an instance of Textfont
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.sankey.Textfont`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Textfont constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.sankey.Textfont
|
||||
"""
|
||||
return self["textfont"]
|
||||
|
||||
@textfont.setter
|
||||
def textfont(self, val):
|
||||
self["textfont"] = val
|
||||
|
||||
@property
|
||||
def uid(self):
|
||||
"""
|
||||
Assign an id to this trace, Use this to provide object
|
||||
constancy between traces during animations and transitions.
|
||||
|
||||
The 'uid' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["uid"]
|
||||
|
||||
@uid.setter
|
||||
def uid(self, val):
|
||||
self["uid"] = val
|
||||
|
||||
@property
|
||||
def uirevision(self):
|
||||
"""
|
||||
Controls persistence of some user-driven changes to the trace:
|
||||
`constraintrange` in `parcoords` traces, as well as some
|
||||
`editable: true` modifications such as `name` and
|
||||
`colorbar.title`. Defaults to `layout.uirevision`. Note that
|
||||
other user-driven trace attribute changes are controlled by
|
||||
`layout` attributes: `trace.visible` is controlled by
|
||||
`layout.legend.uirevision`, `selectedpoints` is controlled by
|
||||
`layout.selectionrevision`, and `colorbar.(x|y)` (accessible
|
||||
with `config: {editable: true}`) is controlled by
|
||||
`layout.editrevision`. Trace changes are tracked by `uid`,
|
||||
which only falls back on trace index if no `uid` is provided.
|
||||
So if your app can add/remove traces before the end of the
|
||||
`data` array, such that the same trace has a different index,
|
||||
you can still preserve user-driven changes if you give each
|
||||
trace a `uid` that stays with it as it moves.
|
||||
|
||||
The 'uirevision' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["uirevision"]
|
||||
|
||||
@uirevision.setter
|
||||
def uirevision(self, val):
|
||||
self["uirevision"] = val
|
||||
|
||||
@property
|
||||
def valueformat(self):
|
||||
"""
|
||||
Sets the value formatting rule using d3 formatting mini-
|
||||
languages which are very similar to those in Python. For
|
||||
numbers, see:
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
|
||||
|
||||
The 'valueformat' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["valueformat"]
|
||||
|
||||
@valueformat.setter
|
||||
def valueformat(self, val):
|
||||
self["valueformat"] = val
|
||||
|
||||
@property
|
||||
def valuesuffix(self):
|
||||
"""
|
||||
Adds a unit to follow the value in the hover tooltip. Add a
|
||||
space if a separation is necessary from the value.
|
||||
|
||||
The 'valuesuffix' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["valuesuffix"]
|
||||
|
||||
@valuesuffix.setter
|
||||
def valuesuffix(self, val):
|
||||
self["valuesuffix"] = val
|
||||
|
||||
@property
|
||||
def visible(self):
|
||||
"""
|
||||
Determines whether or not this trace is visible. If
|
||||
"legendonly", the trace is not drawn, but can appear as a
|
||||
legend item (provided that the legend itself is visible).
|
||||
|
||||
The 'visible' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
[True, False, 'legendonly']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["visible"]
|
||||
|
||||
@visible.setter
|
||||
def visible(self, val):
|
||||
self["visible"] = val
|
||||
|
||||
@property
|
||||
def type(self):
|
||||
return self._props["type"]
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
arrangement
|
||||
If value is `snap` (the default), the node arrangement
|
||||
is assisted by automatic snapping of elements to
|
||||
preserve space between nodes specified via `nodepad`.
|
||||
If value is `perpendicular`, the nodes can only move
|
||||
along a line perpendicular to the flow. If value is
|
||||
`freeform`, the nodes can freely move on the plane. If
|
||||
value is `fixed`, the nodes are stationary.
|
||||
customdata
|
||||
Assigns extra data each datum. This may be useful when
|
||||
listening to hover, click and selection events. Note
|
||||
that, "scatter" traces also appends customdata items in
|
||||
the markers DOM elements
|
||||
customdatasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`customdata`.
|
||||
domain
|
||||
:class:`plotly.graph_objects.sankey.Domain` instance or
|
||||
dict with compatible properties
|
||||
hoverinfo
|
||||
Determines which trace information appear on hover. If
|
||||
`none` or `skip` are set, no information is displayed
|
||||
upon hovering. But, if `none` is set, click and hover
|
||||
events are still fired. Note that this attribute is
|
||||
superseded by `node.hoverinfo` and `node.hoverinfo` for
|
||||
nodes and links respectively.
|
||||
hoverlabel
|
||||
:class:`plotly.graph_objects.sankey.Hoverlabel`
|
||||
instance or dict with compatible properties
|
||||
ids
|
||||
Assigns id labels to each datum. These ids for object
|
||||
constancy of data points during animation. Should be an
|
||||
array of strings, not numbers or any other type.
|
||||
idssrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`ids`.
|
||||
legend
|
||||
Sets the reference to a legend to show this trace in.
|
||||
References to these legends are "legend", "legend2",
|
||||
"legend3", etc. Settings for these legends are set in
|
||||
the layout, under `layout.legend`, `layout.legend2`,
|
||||
etc.
|
||||
legendgrouptitle
|
||||
:class:`plotly.graph_objects.sankey.Legendgrouptitle`
|
||||
instance or dict with compatible properties
|
||||
legendrank
|
||||
Sets the legend rank for this trace. Items and groups
|
||||
with smaller ranks are presented on top/left side while
|
||||
with "reversed" `legend.traceorder` they are on
|
||||
bottom/right side. The default legendrank is 1000, so
|
||||
that you can use ranks less than 1000 to place certain
|
||||
items before all unranked items, and ranks greater than
|
||||
1000 to go after all unranked items. When having
|
||||
unranked or equal rank items shapes would be displayed
|
||||
after traces i.e. according to their order in data and
|
||||
layout.
|
||||
legendwidth
|
||||
Sets the width (in px or fraction) of the legend for
|
||||
this trace.
|
||||
link
|
||||
The links of the Sankey plot.
|
||||
meta
|
||||
Assigns extra meta information associated with this
|
||||
trace that can be used in various text attributes.
|
||||
Attributes such as trace `name`, graph, axis and
|
||||
colorbar `title.text`, annotation `text`
|
||||
`rangeselector`, `updatemenues` and `sliders` `label`
|
||||
text all support `meta`. To access the trace `meta`
|
||||
values in an attribute in the same trace, simply use
|
||||
`%{meta[i]}` where `i` is the index or key of the
|
||||
`meta` item in question. To access trace `meta` in
|
||||
layout attributes, use `%{data[n[.meta[i]}` where `i`
|
||||
is the index or key of the `meta` and `n` is the trace
|
||||
index.
|
||||
metasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`meta`.
|
||||
name
|
||||
Sets the trace name. The trace name appears as the
|
||||
legend item and on hover.
|
||||
node
|
||||
The nodes of the Sankey plot.
|
||||
orientation
|
||||
Sets the orientation of the Sankey diagram.
|
||||
selectedpoints
|
||||
Array containing integer indices of selected points.
|
||||
Has an effect only for traces that support selections.
|
||||
Note that an empty array means an empty selection where
|
||||
the `unselected` are turned on for all points, whereas,
|
||||
any other non-array values means no selection all where
|
||||
the `selected` and `unselected` styles have no effect.
|
||||
stream
|
||||
:class:`plotly.graph_objects.sankey.Stream` instance or
|
||||
dict with compatible properties
|
||||
textfont
|
||||
Sets the font for node labels
|
||||
uid
|
||||
Assign an id to this trace, Use this to provide object
|
||||
constancy between traces during animations and
|
||||
transitions.
|
||||
uirevision
|
||||
Controls persistence of some user-driven changes to the
|
||||
trace: `constraintrange` in `parcoords` traces, as well
|
||||
as some `editable: true` modifications such as `name`
|
||||
and `colorbar.title`. Defaults to `layout.uirevision`.
|
||||
Note that other user-driven trace attribute changes are
|
||||
controlled by `layout` attributes: `trace.visible` is
|
||||
controlled by `layout.legend.uirevision`,
|
||||
`selectedpoints` is controlled by
|
||||
`layout.selectionrevision`, and `colorbar.(x|y)`
|
||||
(accessible with `config: {editable: true}`) is
|
||||
controlled by `layout.editrevision`. Trace changes are
|
||||
tracked by `uid`, which only falls back on trace index
|
||||
if no `uid` is provided. So if your app can add/remove
|
||||
traces before the end of the `data` array, such that
|
||||
the same trace has a different index, you can still
|
||||
preserve user-driven changes if you give each trace a
|
||||
`uid` that stays with it as it moves.
|
||||
valueformat
|
||||
Sets the value formatting rule using d3 formatting
|
||||
mini-languages which are very similar to those in
|
||||
Python. For numbers, see:
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
|
||||
valuesuffix
|
||||
Adds a unit to follow the value in the hover tooltip.
|
||||
Add a space if a separation is necessary from the
|
||||
value.
|
||||
visible
|
||||
Determines whether or not this trace is visible. If
|
||||
"legendonly", the trace is not drawn, but can appear as
|
||||
a legend item (provided that the legend itself is
|
||||
visible).
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
arrangement=None,
|
||||
customdata=None,
|
||||
customdatasrc=None,
|
||||
domain=None,
|
||||
hoverinfo=None,
|
||||
hoverlabel=None,
|
||||
ids=None,
|
||||
idssrc=None,
|
||||
legend=None,
|
||||
legendgrouptitle=None,
|
||||
legendrank=None,
|
||||
legendwidth=None,
|
||||
link=None,
|
||||
meta=None,
|
||||
metasrc=None,
|
||||
name=None,
|
||||
node=None,
|
||||
orientation=None,
|
||||
selectedpoints=None,
|
||||
stream=None,
|
||||
textfont=None,
|
||||
uid=None,
|
||||
uirevision=None,
|
||||
valueformat=None,
|
||||
valuesuffix=None,
|
||||
visible=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Sankey object
|
||||
|
||||
Sankey plots for network flow data analysis. The nodes are
|
||||
specified in `nodes` and the links between sources and targets
|
||||
in `links`. The colors are set in `nodes[i].color` and
|
||||
`links[i].color`, otherwise defaults are used.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.Sankey`
|
||||
arrangement
|
||||
If value is `snap` (the default), the node arrangement
|
||||
is assisted by automatic snapping of elements to
|
||||
preserve space between nodes specified via `nodepad`.
|
||||
If value is `perpendicular`, the nodes can only move
|
||||
along a line perpendicular to the flow. If value is
|
||||
`freeform`, the nodes can freely move on the plane. If
|
||||
value is `fixed`, the nodes are stationary.
|
||||
customdata
|
||||
Assigns extra data each datum. This may be useful when
|
||||
listening to hover, click and selection events. Note
|
||||
that, "scatter" traces also appends customdata items in
|
||||
the markers DOM elements
|
||||
customdatasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`customdata`.
|
||||
domain
|
||||
:class:`plotly.graph_objects.sankey.Domain` instance or
|
||||
dict with compatible properties
|
||||
hoverinfo
|
||||
Determines which trace information appear on hover. If
|
||||
`none` or `skip` are set, no information is displayed
|
||||
upon hovering. But, if `none` is set, click and hover
|
||||
events are still fired. Note that this attribute is
|
||||
superseded by `node.hoverinfo` and `node.hoverinfo` for
|
||||
nodes and links respectively.
|
||||
hoverlabel
|
||||
:class:`plotly.graph_objects.sankey.Hoverlabel`
|
||||
instance or dict with compatible properties
|
||||
ids
|
||||
Assigns id labels to each datum. These ids for object
|
||||
constancy of data points during animation. Should be an
|
||||
array of strings, not numbers or any other type.
|
||||
idssrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`ids`.
|
||||
legend
|
||||
Sets the reference to a legend to show this trace in.
|
||||
References to these legends are "legend", "legend2",
|
||||
"legend3", etc. Settings for these legends are set in
|
||||
the layout, under `layout.legend`, `layout.legend2`,
|
||||
etc.
|
||||
legendgrouptitle
|
||||
:class:`plotly.graph_objects.sankey.Legendgrouptitle`
|
||||
instance or dict with compatible properties
|
||||
legendrank
|
||||
Sets the legend rank for this trace. Items and groups
|
||||
with smaller ranks are presented on top/left side while
|
||||
with "reversed" `legend.traceorder` they are on
|
||||
bottom/right side. The default legendrank is 1000, so
|
||||
that you can use ranks less than 1000 to place certain
|
||||
items before all unranked items, and ranks greater than
|
||||
1000 to go after all unranked items. When having
|
||||
unranked or equal rank items shapes would be displayed
|
||||
after traces i.e. according to their order in data and
|
||||
layout.
|
||||
legendwidth
|
||||
Sets the width (in px or fraction) of the legend for
|
||||
this trace.
|
||||
link
|
||||
The links of the Sankey plot.
|
||||
meta
|
||||
Assigns extra meta information associated with this
|
||||
trace that can be used in various text attributes.
|
||||
Attributes such as trace `name`, graph, axis and
|
||||
colorbar `title.text`, annotation `text`
|
||||
`rangeselector`, `updatemenues` and `sliders` `label`
|
||||
text all support `meta`. To access the trace `meta`
|
||||
values in an attribute in the same trace, simply use
|
||||
`%{meta[i]}` where `i` is the index or key of the
|
||||
`meta` item in question. To access trace `meta` in
|
||||
layout attributes, use `%{data[n[.meta[i]}` where `i`
|
||||
is the index or key of the `meta` and `n` is the trace
|
||||
index.
|
||||
metasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`meta`.
|
||||
name
|
||||
Sets the trace name. The trace name appears as the
|
||||
legend item and on hover.
|
||||
node
|
||||
The nodes of the Sankey plot.
|
||||
orientation
|
||||
Sets the orientation of the Sankey diagram.
|
||||
selectedpoints
|
||||
Array containing integer indices of selected points.
|
||||
Has an effect only for traces that support selections.
|
||||
Note that an empty array means an empty selection where
|
||||
the `unselected` are turned on for all points, whereas,
|
||||
any other non-array values means no selection all where
|
||||
the `selected` and `unselected` styles have no effect.
|
||||
stream
|
||||
:class:`plotly.graph_objects.sankey.Stream` instance or
|
||||
dict with compatible properties
|
||||
textfont
|
||||
Sets the font for node labels
|
||||
uid
|
||||
Assign an id to this trace, Use this to provide object
|
||||
constancy between traces during animations and
|
||||
transitions.
|
||||
uirevision
|
||||
Controls persistence of some user-driven changes to the
|
||||
trace: `constraintrange` in `parcoords` traces, as well
|
||||
as some `editable: true` modifications such as `name`
|
||||
and `colorbar.title`. Defaults to `layout.uirevision`.
|
||||
Note that other user-driven trace attribute changes are
|
||||
controlled by `layout` attributes: `trace.visible` is
|
||||
controlled by `layout.legend.uirevision`,
|
||||
`selectedpoints` is controlled by
|
||||
`layout.selectionrevision`, and `colorbar.(x|y)`
|
||||
(accessible with `config: {editable: true}`) is
|
||||
controlled by `layout.editrevision`. Trace changes are
|
||||
tracked by `uid`, which only falls back on trace index
|
||||
if no `uid` is provided. So if your app can add/remove
|
||||
traces before the end of the `data` array, such that
|
||||
the same trace has a different index, you can still
|
||||
preserve user-driven changes if you give each trace a
|
||||
`uid` that stays with it as it moves.
|
||||
valueformat
|
||||
Sets the value formatting rule using d3 formatting
|
||||
mini-languages which are very similar to those in
|
||||
Python. For numbers, see:
|
||||
https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
|
||||
valuesuffix
|
||||
Adds a unit to follow the value in the hover tooltip.
|
||||
Add a space if a separation is necessary from the
|
||||
value.
|
||||
visible
|
||||
Determines whether or not this trace is visible. If
|
||||
"legendonly", the trace is not drawn, but can appear as
|
||||
a legend item (provided that the legend itself is
|
||||
visible).
|
||||
|
||||
Returns
|
||||
-------
|
||||
Sankey
|
||||
"""
|
||||
super().__init__("sankey")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.Sankey
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.Sankey`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("arrangement", arg, arrangement)
|
||||
self._set_property("customdata", arg, customdata)
|
||||
self._set_property("customdatasrc", arg, customdatasrc)
|
||||
self._set_property("domain", arg, domain)
|
||||
self._set_property("hoverinfo", arg, hoverinfo)
|
||||
self._set_property("hoverlabel", arg, hoverlabel)
|
||||
self._set_property("ids", arg, ids)
|
||||
self._set_property("idssrc", arg, idssrc)
|
||||
self._set_property("legend", arg, legend)
|
||||
self._set_property("legendgrouptitle", arg, legendgrouptitle)
|
||||
self._set_property("legendrank", arg, legendrank)
|
||||
self._set_property("legendwidth", arg, legendwidth)
|
||||
self._set_property("link", arg, link)
|
||||
self._set_property("meta", arg, meta)
|
||||
self._set_property("metasrc", arg, metasrc)
|
||||
self._set_property("name", arg, name)
|
||||
self._set_property("node", arg, node)
|
||||
self._set_property("orientation", arg, orientation)
|
||||
self._set_property("selectedpoints", arg, selectedpoints)
|
||||
self._set_property("stream", arg, stream)
|
||||
self._set_property("textfont", arg, textfont)
|
||||
self._set_property("uid", arg, uid)
|
||||
self._set_property("uirevision", arg, uirevision)
|
||||
self._set_property("valueformat", arg, valueformat)
|
||||
self._set_property("valuesuffix", arg, valuesuffix)
|
||||
self._set_property("visible", arg, visible)
|
||||
|
||||
self._props["type"] = "sankey"
|
||||
arg.pop("type", None)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
2752
lib/python3.11/site-packages/plotly/graph_objs/_scatter.py
Normal file
2752
lib/python3.11/site-packages/plotly/graph_objs/_scatter.py
Normal file
File diff suppressed because it is too large
Load Diff
1997
lib/python3.11/site-packages/plotly/graph_objs/_scatter3d.py
Normal file
1997
lib/python3.11/site-packages/plotly/graph_objs/_scatter3d.py
Normal file
File diff suppressed because it is too large
Load Diff
1828
lib/python3.11/site-packages/plotly/graph_objs/_scattercarpet.py
Normal file
1828
lib/python3.11/site-packages/plotly/graph_objs/_scattercarpet.py
Normal file
File diff suppressed because it is too large
Load Diff
1875
lib/python3.11/site-packages/plotly/graph_objs/_scattergeo.py
Normal file
1875
lib/python3.11/site-packages/plotly/graph_objs/_scattergeo.py
Normal file
File diff suppressed because it is too large
Load Diff
2289
lib/python3.11/site-packages/plotly/graph_objs/_scattergl.py
Normal file
2289
lib/python3.11/site-packages/plotly/graph_objs/_scattergl.py
Normal file
File diff suppressed because it is too large
Load Diff
1710
lib/python3.11/site-packages/plotly/graph_objs/_scattermap.py
Normal file
1710
lib/python3.11/site-packages/plotly/graph_objs/_scattermap.py
Normal file
File diff suppressed because it is too large
Load Diff
1738
lib/python3.11/site-packages/plotly/graph_objs/_scattermapbox.py
Normal file
1738
lib/python3.11/site-packages/plotly/graph_objs/_scattermapbox.py
Normal file
File diff suppressed because it is too large
Load Diff
1915
lib/python3.11/site-packages/plotly/graph_objs/_scatterpolar.py
Normal file
1915
lib/python3.11/site-packages/plotly/graph_objs/_scatterpolar.py
Normal file
File diff suppressed because it is too large
Load Diff
1876
lib/python3.11/site-packages/plotly/graph_objs/_scatterpolargl.py
Normal file
1876
lib/python3.11/site-packages/plotly/graph_objs/_scatterpolargl.py
Normal file
File diff suppressed because it is too large
Load Diff
1781
lib/python3.11/site-packages/plotly/graph_objs/_scattersmith.py
Normal file
1781
lib/python3.11/site-packages/plotly/graph_objs/_scattersmith.py
Normal file
File diff suppressed because it is too large
Load Diff
1891
lib/python3.11/site-packages/plotly/graph_objs/_scatterternary.py
Normal file
1891
lib/python3.11/site-packages/plotly/graph_objs/_scatterternary.py
Normal file
File diff suppressed because it is too large
Load Diff
1522
lib/python3.11/site-packages/plotly/graph_objs/_splom.py
Normal file
1522
lib/python3.11/site-packages/plotly/graph_objs/_splom.py
Normal file
File diff suppressed because it is too large
Load Diff
2168
lib/python3.11/site-packages/plotly/graph_objs/_streamtube.py
Normal file
2168
lib/python3.11/site-packages/plotly/graph_objs/_streamtube.py
Normal file
File diff suppressed because it is too large
Load Diff
1762
lib/python3.11/site-packages/plotly/graph_objs/_sunburst.py
Normal file
1762
lib/python3.11/site-packages/plotly/graph_objs/_sunburst.py
Normal file
File diff suppressed because it is too large
Load Diff
2140
lib/python3.11/site-packages/plotly/graph_objs/_surface.py
Normal file
2140
lib/python3.11/site-packages/plotly/graph_objs/_surface.py
Normal file
File diff suppressed because it is too large
Load Diff
908
lib/python3.11/site-packages/plotly/graph_objs/_table.py
Normal file
908
lib/python3.11/site-packages/plotly/graph_objs/_table.py
Normal file
@ -0,0 +1,908 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Table(_BaseTraceType):
|
||||
_parent_path_str = ""
|
||||
_path_str = "table"
|
||||
_valid_props = {
|
||||
"cells",
|
||||
"columnorder",
|
||||
"columnordersrc",
|
||||
"columnwidth",
|
||||
"columnwidthsrc",
|
||||
"customdata",
|
||||
"customdatasrc",
|
||||
"domain",
|
||||
"header",
|
||||
"hoverinfo",
|
||||
"hoverinfosrc",
|
||||
"hoverlabel",
|
||||
"ids",
|
||||
"idssrc",
|
||||
"legend",
|
||||
"legendgrouptitle",
|
||||
"legendrank",
|
||||
"legendwidth",
|
||||
"meta",
|
||||
"metasrc",
|
||||
"name",
|
||||
"stream",
|
||||
"type",
|
||||
"uid",
|
||||
"uirevision",
|
||||
"visible",
|
||||
}
|
||||
|
||||
@property
|
||||
def cells(self):
|
||||
"""
|
||||
The 'cells' property is an instance of Cells
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.table.Cells`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Cells constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.table.Cells
|
||||
"""
|
||||
return self["cells"]
|
||||
|
||||
@cells.setter
|
||||
def cells(self, val):
|
||||
self["cells"] = val
|
||||
|
||||
@property
|
||||
def columnorder(self):
|
||||
"""
|
||||
Specifies the rendered order of the data columns; for example,
|
||||
a value `2` at position `0` means that column index `0` in the
|
||||
data will be rendered as the third column, as columns have an
|
||||
index base of zero.
|
||||
|
||||
The 'columnorder' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["columnorder"]
|
||||
|
||||
@columnorder.setter
|
||||
def columnorder(self, val):
|
||||
self["columnorder"] = val
|
||||
|
||||
@property
|
||||
def columnordersrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`columnorder`.
|
||||
|
||||
The 'columnordersrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["columnordersrc"]
|
||||
|
||||
@columnordersrc.setter
|
||||
def columnordersrc(self, val):
|
||||
self["columnordersrc"] = val
|
||||
|
||||
@property
|
||||
def columnwidth(self):
|
||||
"""
|
||||
The width of columns expressed as a ratio. Columns fill the
|
||||
available width in proportion of their specified column widths.
|
||||
|
||||
The 'columnwidth' property is a number and may be specified as:
|
||||
- An int or float
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["columnwidth"]
|
||||
|
||||
@columnwidth.setter
|
||||
def columnwidth(self, val):
|
||||
self["columnwidth"] = val
|
||||
|
||||
@property
|
||||
def columnwidthsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`columnwidth`.
|
||||
|
||||
The 'columnwidthsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["columnwidthsrc"]
|
||||
|
||||
@columnwidthsrc.setter
|
||||
def columnwidthsrc(self, val):
|
||||
self["columnwidthsrc"] = val
|
||||
|
||||
@property
|
||||
def customdata(self):
|
||||
"""
|
||||
Assigns extra data each datum. This may be useful when
|
||||
listening to hover, click and selection events. Note that,
|
||||
"scatter" traces also appends customdata items in the markers
|
||||
DOM elements
|
||||
|
||||
The 'customdata' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["customdata"]
|
||||
|
||||
@customdata.setter
|
||||
def customdata(self, val):
|
||||
self["customdata"] = val
|
||||
|
||||
@property
|
||||
def customdatasrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`customdata`.
|
||||
|
||||
The 'customdatasrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["customdatasrc"]
|
||||
|
||||
@customdatasrc.setter
|
||||
def customdatasrc(self, val):
|
||||
self["customdatasrc"] = val
|
||||
|
||||
@property
|
||||
def domain(self):
|
||||
"""
|
||||
The 'domain' property is an instance of Domain
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.table.Domain`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Domain constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.table.Domain
|
||||
"""
|
||||
return self["domain"]
|
||||
|
||||
@domain.setter
|
||||
def domain(self, val):
|
||||
self["domain"] = val
|
||||
|
||||
@property
|
||||
def header(self):
|
||||
"""
|
||||
The 'header' property is an instance of Header
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.table.Header`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Header constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.table.Header
|
||||
"""
|
||||
return self["header"]
|
||||
|
||||
@header.setter
|
||||
def header(self, val):
|
||||
self["header"] = val
|
||||
|
||||
@property
|
||||
def hoverinfo(self):
|
||||
"""
|
||||
Determines which trace information appear on hover. If `none`
|
||||
or `skip` are set, no information is displayed upon hovering.
|
||||
But, if `none` is set, click and hover events are still fired.
|
||||
|
||||
The 'hoverinfo' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
|
||||
(e.g. 'x+y')
|
||||
OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
|
||||
- A list or array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["hoverinfo"]
|
||||
|
||||
@hoverinfo.setter
|
||||
def hoverinfo(self, val):
|
||||
self["hoverinfo"] = val
|
||||
|
||||
@property
|
||||
def hoverinfosrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`hoverinfo`.
|
||||
|
||||
The 'hoverinfosrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["hoverinfosrc"]
|
||||
|
||||
@hoverinfosrc.setter
|
||||
def hoverinfosrc(self, val):
|
||||
self["hoverinfosrc"] = val
|
||||
|
||||
@property
|
||||
def hoverlabel(self):
|
||||
"""
|
||||
The 'hoverlabel' property is an instance of Hoverlabel
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.table.Hoverlabel`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Hoverlabel constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.table.Hoverlabel
|
||||
"""
|
||||
return self["hoverlabel"]
|
||||
|
||||
@hoverlabel.setter
|
||||
def hoverlabel(self, val):
|
||||
self["hoverlabel"] = val
|
||||
|
||||
@property
|
||||
def ids(self):
|
||||
"""
|
||||
Assigns id labels to each datum. These ids for object constancy
|
||||
of data points during animation. Should be an array of strings,
|
||||
not numbers or any other type.
|
||||
|
||||
The 'ids' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["ids"]
|
||||
|
||||
@ids.setter
|
||||
def ids(self, val):
|
||||
self["ids"] = val
|
||||
|
||||
@property
|
||||
def idssrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `ids`.
|
||||
|
||||
The 'idssrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["idssrc"]
|
||||
|
||||
@idssrc.setter
|
||||
def idssrc(self, val):
|
||||
self["idssrc"] = val
|
||||
|
||||
@property
|
||||
def legend(self):
|
||||
"""
|
||||
Sets the reference to a legend to show this trace in.
|
||||
References to these legends are "legend", "legend2", "legend3",
|
||||
etc. Settings for these legends are set in the layout, under
|
||||
`layout.legend`, `layout.legend2`, etc.
|
||||
|
||||
The 'legend' property is an identifier of a particular
|
||||
subplot, of type 'legend', that may be specified as the string 'legend'
|
||||
optionally followed by an integer >= 1
|
||||
(e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["legend"]
|
||||
|
||||
@legend.setter
|
||||
def legend(self, val):
|
||||
self["legend"] = val
|
||||
|
||||
@property
|
||||
def legendgrouptitle(self):
|
||||
"""
|
||||
The 'legendgrouptitle' property is an instance of Legendgrouptitle
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.table.Legendgrouptitle`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Legendgrouptitle constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.table.Legendgrouptitle
|
||||
"""
|
||||
return self["legendgrouptitle"]
|
||||
|
||||
@legendgrouptitle.setter
|
||||
def legendgrouptitle(self, val):
|
||||
self["legendgrouptitle"] = val
|
||||
|
||||
@property
|
||||
def legendrank(self):
|
||||
"""
|
||||
Sets the legend rank for this trace. Items and groups with
|
||||
smaller ranks are presented on top/left side while with
|
||||
"reversed" `legend.traceorder` they are on bottom/right side.
|
||||
The default legendrank is 1000, so that you can use ranks less
|
||||
than 1000 to place certain items before all unranked items, and
|
||||
ranks greater than 1000 to go after all unranked items. When
|
||||
having unranked or equal rank items shapes would be displayed
|
||||
after traces i.e. according to their order in data and layout.
|
||||
|
||||
The 'legendrank' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["legendrank"]
|
||||
|
||||
@legendrank.setter
|
||||
def legendrank(self, val):
|
||||
self["legendrank"] = val
|
||||
|
||||
@property
|
||||
def legendwidth(self):
|
||||
"""
|
||||
Sets the width (in px or fraction) of the legend for this
|
||||
trace.
|
||||
|
||||
The 'legendwidth' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["legendwidth"]
|
||||
|
||||
@legendwidth.setter
|
||||
def legendwidth(self, val):
|
||||
self["legendwidth"] = val
|
||||
|
||||
@property
|
||||
def meta(self):
|
||||
"""
|
||||
Assigns extra meta information associated with this trace that
|
||||
can be used in various text attributes. Attributes such as
|
||||
trace `name`, graph, axis and colorbar `title.text`, annotation
|
||||
`text` `rangeselector`, `updatemenues` and `sliders` `label`
|
||||
text all support `meta`. To access the trace `meta` values in
|
||||
an attribute in the same trace, simply use `%{meta[i]}` where
|
||||
`i` is the index or key of the `meta` item in question. To
|
||||
access trace `meta` in layout attributes, use
|
||||
`%{data[n[.meta[i]}` where `i` is the index or key of the
|
||||
`meta` and `n` is the trace index.
|
||||
|
||||
The 'meta' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["meta"]
|
||||
|
||||
@meta.setter
|
||||
def meta(self, val):
|
||||
self["meta"] = val
|
||||
|
||||
@property
|
||||
def metasrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `meta`.
|
||||
|
||||
The 'metasrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["metasrc"]
|
||||
|
||||
@metasrc.setter
|
||||
def metasrc(self, val):
|
||||
self["metasrc"] = val
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""
|
||||
Sets the trace name. The trace name appears as the legend item
|
||||
and on hover.
|
||||
|
||||
The 'name' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["name"]
|
||||
|
||||
@name.setter
|
||||
def name(self, val):
|
||||
self["name"] = val
|
||||
|
||||
@property
|
||||
def stream(self):
|
||||
"""
|
||||
The 'stream' property is an instance of Stream
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.table.Stream`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Stream constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.table.Stream
|
||||
"""
|
||||
return self["stream"]
|
||||
|
||||
@stream.setter
|
||||
def stream(self, val):
|
||||
self["stream"] = val
|
||||
|
||||
@property
|
||||
def uid(self):
|
||||
"""
|
||||
Assign an id to this trace, Use this to provide object
|
||||
constancy between traces during animations and transitions.
|
||||
|
||||
The 'uid' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["uid"]
|
||||
|
||||
@uid.setter
|
||||
def uid(self, val):
|
||||
self["uid"] = val
|
||||
|
||||
@property
|
||||
def uirevision(self):
|
||||
"""
|
||||
Controls persistence of some user-driven changes to the trace:
|
||||
`constraintrange` in `parcoords` traces, as well as some
|
||||
`editable: true` modifications such as `name` and
|
||||
`colorbar.title`. Defaults to `layout.uirevision`. Note that
|
||||
other user-driven trace attribute changes are controlled by
|
||||
`layout` attributes: `trace.visible` is controlled by
|
||||
`layout.legend.uirevision`, `selectedpoints` is controlled by
|
||||
`layout.selectionrevision`, and `colorbar.(x|y)` (accessible
|
||||
with `config: {editable: true}`) is controlled by
|
||||
`layout.editrevision`. Trace changes are tracked by `uid`,
|
||||
which only falls back on trace index if no `uid` is provided.
|
||||
So if your app can add/remove traces before the end of the
|
||||
`data` array, such that the same trace has a different index,
|
||||
you can still preserve user-driven changes if you give each
|
||||
trace a `uid` that stays with it as it moves.
|
||||
|
||||
The 'uirevision' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["uirevision"]
|
||||
|
||||
@uirevision.setter
|
||||
def uirevision(self, val):
|
||||
self["uirevision"] = val
|
||||
|
||||
@property
|
||||
def visible(self):
|
||||
"""
|
||||
Determines whether or not this trace is visible. If
|
||||
"legendonly", the trace is not drawn, but can appear as a
|
||||
legend item (provided that the legend itself is visible).
|
||||
|
||||
The 'visible' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
[True, False, 'legendonly']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["visible"]
|
||||
|
||||
@visible.setter
|
||||
def visible(self, val):
|
||||
self["visible"] = val
|
||||
|
||||
@property
|
||||
def type(self):
|
||||
return self._props["type"]
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
cells
|
||||
:class:`plotly.graph_objects.table.Cells` instance or
|
||||
dict with compatible properties
|
||||
columnorder
|
||||
Specifies the rendered order of the data columns; for
|
||||
example, a value `2` at position `0` means that column
|
||||
index `0` in the data will be rendered as the third
|
||||
column, as columns have an index base of zero.
|
||||
columnordersrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`columnorder`.
|
||||
columnwidth
|
||||
The width of columns expressed as a ratio. Columns fill
|
||||
the available width in proportion of their specified
|
||||
column widths.
|
||||
columnwidthsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`columnwidth`.
|
||||
customdata
|
||||
Assigns extra data each datum. This may be useful when
|
||||
listening to hover, click and selection events. Note
|
||||
that, "scatter" traces also appends customdata items in
|
||||
the markers DOM elements
|
||||
customdatasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`customdata`.
|
||||
domain
|
||||
:class:`plotly.graph_objects.table.Domain` instance or
|
||||
dict with compatible properties
|
||||
header
|
||||
:class:`plotly.graph_objects.table.Header` instance or
|
||||
dict with compatible properties
|
||||
hoverinfo
|
||||
Determines which trace information appear on hover. If
|
||||
`none` or `skip` are set, no information is displayed
|
||||
upon hovering. But, if `none` is set, click and hover
|
||||
events are still fired.
|
||||
hoverinfosrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`hoverinfo`.
|
||||
hoverlabel
|
||||
:class:`plotly.graph_objects.table.Hoverlabel` instance
|
||||
or dict with compatible properties
|
||||
ids
|
||||
Assigns id labels to each datum. These ids for object
|
||||
constancy of data points during animation. Should be an
|
||||
array of strings, not numbers or any other type.
|
||||
idssrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`ids`.
|
||||
legend
|
||||
Sets the reference to a legend to show this trace in.
|
||||
References to these legends are "legend", "legend2",
|
||||
"legend3", etc. Settings for these legends are set in
|
||||
the layout, under `layout.legend`, `layout.legend2`,
|
||||
etc.
|
||||
legendgrouptitle
|
||||
:class:`plotly.graph_objects.table.Legendgrouptitle`
|
||||
instance or dict with compatible properties
|
||||
legendrank
|
||||
Sets the legend rank for this trace. Items and groups
|
||||
with smaller ranks are presented on top/left side while
|
||||
with "reversed" `legend.traceorder` they are on
|
||||
bottom/right side. The default legendrank is 1000, so
|
||||
that you can use ranks less than 1000 to place certain
|
||||
items before all unranked items, and ranks greater than
|
||||
1000 to go after all unranked items. When having
|
||||
unranked or equal rank items shapes would be displayed
|
||||
after traces i.e. according to their order in data and
|
||||
layout.
|
||||
legendwidth
|
||||
Sets the width (in px or fraction) of the legend for
|
||||
this trace.
|
||||
meta
|
||||
Assigns extra meta information associated with this
|
||||
trace that can be used in various text attributes.
|
||||
Attributes such as trace `name`, graph, axis and
|
||||
colorbar `title.text`, annotation `text`
|
||||
`rangeselector`, `updatemenues` and `sliders` `label`
|
||||
text all support `meta`. To access the trace `meta`
|
||||
values in an attribute in the same trace, simply use
|
||||
`%{meta[i]}` where `i` is the index or key of the
|
||||
`meta` item in question. To access trace `meta` in
|
||||
layout attributes, use `%{data[n[.meta[i]}` where `i`
|
||||
is the index or key of the `meta` and `n` is the trace
|
||||
index.
|
||||
metasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`meta`.
|
||||
name
|
||||
Sets the trace name. The trace name appears as the
|
||||
legend item and on hover.
|
||||
stream
|
||||
:class:`plotly.graph_objects.table.Stream` instance or
|
||||
dict with compatible properties
|
||||
uid
|
||||
Assign an id to this trace, Use this to provide object
|
||||
constancy between traces during animations and
|
||||
transitions.
|
||||
uirevision
|
||||
Controls persistence of some user-driven changes to the
|
||||
trace: `constraintrange` in `parcoords` traces, as well
|
||||
as some `editable: true` modifications such as `name`
|
||||
and `colorbar.title`. Defaults to `layout.uirevision`.
|
||||
Note that other user-driven trace attribute changes are
|
||||
controlled by `layout` attributes: `trace.visible` is
|
||||
controlled by `layout.legend.uirevision`,
|
||||
`selectedpoints` is controlled by
|
||||
`layout.selectionrevision`, and `colorbar.(x|y)`
|
||||
(accessible with `config: {editable: true}`) is
|
||||
controlled by `layout.editrevision`. Trace changes are
|
||||
tracked by `uid`, which only falls back on trace index
|
||||
if no `uid` is provided. So if your app can add/remove
|
||||
traces before the end of the `data` array, such that
|
||||
the same trace has a different index, you can still
|
||||
preserve user-driven changes if you give each trace a
|
||||
`uid` that stays with it as it moves.
|
||||
visible
|
||||
Determines whether or not this trace is visible. If
|
||||
"legendonly", the trace is not drawn, but can appear as
|
||||
a legend item (provided that the legend itself is
|
||||
visible).
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
cells=None,
|
||||
columnorder=None,
|
||||
columnordersrc=None,
|
||||
columnwidth=None,
|
||||
columnwidthsrc=None,
|
||||
customdata=None,
|
||||
customdatasrc=None,
|
||||
domain=None,
|
||||
header=None,
|
||||
hoverinfo=None,
|
||||
hoverinfosrc=None,
|
||||
hoverlabel=None,
|
||||
ids=None,
|
||||
idssrc=None,
|
||||
legend=None,
|
||||
legendgrouptitle=None,
|
||||
legendrank=None,
|
||||
legendwidth=None,
|
||||
meta=None,
|
||||
metasrc=None,
|
||||
name=None,
|
||||
stream=None,
|
||||
uid=None,
|
||||
uirevision=None,
|
||||
visible=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Table object
|
||||
|
||||
Table view for detailed data viewing. The data are arranged in
|
||||
a grid of rows and columns. Most styling can be specified for
|
||||
columns, rows or individual cells. Table is using a column-
|
||||
major order, ie. the grid is represented as a vector of column
|
||||
vectors.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.Table`
|
||||
cells
|
||||
:class:`plotly.graph_objects.table.Cells` instance or
|
||||
dict with compatible properties
|
||||
columnorder
|
||||
Specifies the rendered order of the data columns; for
|
||||
example, a value `2` at position `0` means that column
|
||||
index `0` in the data will be rendered as the third
|
||||
column, as columns have an index base of zero.
|
||||
columnordersrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`columnorder`.
|
||||
columnwidth
|
||||
The width of columns expressed as a ratio. Columns fill
|
||||
the available width in proportion of their specified
|
||||
column widths.
|
||||
columnwidthsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`columnwidth`.
|
||||
customdata
|
||||
Assigns extra data each datum. This may be useful when
|
||||
listening to hover, click and selection events. Note
|
||||
that, "scatter" traces also appends customdata items in
|
||||
the markers DOM elements
|
||||
customdatasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`customdata`.
|
||||
domain
|
||||
:class:`plotly.graph_objects.table.Domain` instance or
|
||||
dict with compatible properties
|
||||
header
|
||||
:class:`plotly.graph_objects.table.Header` instance or
|
||||
dict with compatible properties
|
||||
hoverinfo
|
||||
Determines which trace information appear on hover. If
|
||||
`none` or `skip` are set, no information is displayed
|
||||
upon hovering. But, if `none` is set, click and hover
|
||||
events are still fired.
|
||||
hoverinfosrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`hoverinfo`.
|
||||
hoverlabel
|
||||
:class:`plotly.graph_objects.table.Hoverlabel` instance
|
||||
or dict with compatible properties
|
||||
ids
|
||||
Assigns id labels to each datum. These ids for object
|
||||
constancy of data points during animation. Should be an
|
||||
array of strings, not numbers or any other type.
|
||||
idssrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`ids`.
|
||||
legend
|
||||
Sets the reference to a legend to show this trace in.
|
||||
References to these legends are "legend", "legend2",
|
||||
"legend3", etc. Settings for these legends are set in
|
||||
the layout, under `layout.legend`, `layout.legend2`,
|
||||
etc.
|
||||
legendgrouptitle
|
||||
:class:`plotly.graph_objects.table.Legendgrouptitle`
|
||||
instance or dict with compatible properties
|
||||
legendrank
|
||||
Sets the legend rank for this trace. Items and groups
|
||||
with smaller ranks are presented on top/left side while
|
||||
with "reversed" `legend.traceorder` they are on
|
||||
bottom/right side. The default legendrank is 1000, so
|
||||
that you can use ranks less than 1000 to place certain
|
||||
items before all unranked items, and ranks greater than
|
||||
1000 to go after all unranked items. When having
|
||||
unranked or equal rank items shapes would be displayed
|
||||
after traces i.e. according to their order in data and
|
||||
layout.
|
||||
legendwidth
|
||||
Sets the width (in px or fraction) of the legend for
|
||||
this trace.
|
||||
meta
|
||||
Assigns extra meta information associated with this
|
||||
trace that can be used in various text attributes.
|
||||
Attributes such as trace `name`, graph, axis and
|
||||
colorbar `title.text`, annotation `text`
|
||||
`rangeselector`, `updatemenues` and `sliders` `label`
|
||||
text all support `meta`. To access the trace `meta`
|
||||
values in an attribute in the same trace, simply use
|
||||
`%{meta[i]}` where `i` is the index or key of the
|
||||
`meta` item in question. To access trace `meta` in
|
||||
layout attributes, use `%{data[n[.meta[i]}` where `i`
|
||||
is the index or key of the `meta` and `n` is the trace
|
||||
index.
|
||||
metasrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`meta`.
|
||||
name
|
||||
Sets the trace name. The trace name appears as the
|
||||
legend item and on hover.
|
||||
stream
|
||||
:class:`plotly.graph_objects.table.Stream` instance or
|
||||
dict with compatible properties
|
||||
uid
|
||||
Assign an id to this trace, Use this to provide object
|
||||
constancy between traces during animations and
|
||||
transitions.
|
||||
uirevision
|
||||
Controls persistence of some user-driven changes to the
|
||||
trace: `constraintrange` in `parcoords` traces, as well
|
||||
as some `editable: true` modifications such as `name`
|
||||
and `colorbar.title`. Defaults to `layout.uirevision`.
|
||||
Note that other user-driven trace attribute changes are
|
||||
controlled by `layout` attributes: `trace.visible` is
|
||||
controlled by `layout.legend.uirevision`,
|
||||
`selectedpoints` is controlled by
|
||||
`layout.selectionrevision`, and `colorbar.(x|y)`
|
||||
(accessible with `config: {editable: true}`) is
|
||||
controlled by `layout.editrevision`. Trace changes are
|
||||
tracked by `uid`, which only falls back on trace index
|
||||
if no `uid` is provided. So if your app can add/remove
|
||||
traces before the end of the `data` array, such that
|
||||
the same trace has a different index, you can still
|
||||
preserve user-driven changes if you give each trace a
|
||||
`uid` that stays with it as it moves.
|
||||
visible
|
||||
Determines whether or not this trace is visible. If
|
||||
"legendonly", the trace is not drawn, but can appear as
|
||||
a legend item (provided that the legend itself is
|
||||
visible).
|
||||
|
||||
Returns
|
||||
-------
|
||||
Table
|
||||
"""
|
||||
super().__init__("table")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.Table
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.Table`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("cells", arg, cells)
|
||||
self._set_property("columnorder", arg, columnorder)
|
||||
self._set_property("columnordersrc", arg, columnordersrc)
|
||||
self._set_property("columnwidth", arg, columnwidth)
|
||||
self._set_property("columnwidthsrc", arg, columnwidthsrc)
|
||||
self._set_property("customdata", arg, customdata)
|
||||
self._set_property("customdatasrc", arg, customdatasrc)
|
||||
self._set_property("domain", arg, domain)
|
||||
self._set_property("header", arg, header)
|
||||
self._set_property("hoverinfo", arg, hoverinfo)
|
||||
self._set_property("hoverinfosrc", arg, hoverinfosrc)
|
||||
self._set_property("hoverlabel", arg, hoverlabel)
|
||||
self._set_property("ids", arg, ids)
|
||||
self._set_property("idssrc", arg, idssrc)
|
||||
self._set_property("legend", arg, legend)
|
||||
self._set_property("legendgrouptitle", arg, legendgrouptitle)
|
||||
self._set_property("legendrank", arg, legendrank)
|
||||
self._set_property("legendwidth", arg, legendwidth)
|
||||
self._set_property("meta", arg, meta)
|
||||
self._set_property("metasrc", arg, metasrc)
|
||||
self._set_property("name", arg, name)
|
||||
self._set_property("stream", arg, stream)
|
||||
self._set_property("uid", arg, uid)
|
||||
self._set_property("uirevision", arg, uirevision)
|
||||
self._set_property("visible", arg, visible)
|
||||
|
||||
self._props["type"] = "table"
|
||||
arg.pop("type", None)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
1740
lib/python3.11/site-packages/plotly/graph_objs/_treemap.py
Normal file
1740
lib/python3.11/site-packages/plotly/graph_objs/_treemap.py
Normal file
File diff suppressed because it is too large
Load Diff
2266
lib/python3.11/site-packages/plotly/graph_objs/_violin.py
Normal file
2266
lib/python3.11/site-packages/plotly/graph_objs/_violin.py
Normal file
File diff suppressed because it is too large
Load Diff
2213
lib/python3.11/site-packages/plotly/graph_objs/_volume.py
Normal file
2213
lib/python3.11/site-packages/plotly/graph_objs/_volume.py
Normal file
File diff suppressed because it is too large
Load Diff
2582
lib/python3.11/site-packages/plotly/graph_objs/_waterfall.py
Normal file
2582
lib/python3.11/site-packages/plotly/graph_objs/_waterfall.py
Normal file
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,40 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._error_x import ErrorX
|
||||
from ._error_y import ErrorY
|
||||
from ._hoverlabel import Hoverlabel
|
||||
from ._insidetextfont import Insidetextfont
|
||||
from ._legendgrouptitle import Legendgrouptitle
|
||||
from ._marker import Marker
|
||||
from ._outsidetextfont import Outsidetextfont
|
||||
from ._selected import Selected
|
||||
from ._stream import Stream
|
||||
from ._textfont import Textfont
|
||||
from ._unselected import Unselected
|
||||
from . import hoverlabel
|
||||
from . import legendgrouptitle
|
||||
from . import marker
|
||||
from . import selected
|
||||
from . import unselected
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"],
|
||||
[
|
||||
"._error_x.ErrorX",
|
||||
"._error_y.ErrorY",
|
||||
"._hoverlabel.Hoverlabel",
|
||||
"._insidetextfont.Insidetextfont",
|
||||
"._legendgrouptitle.Legendgrouptitle",
|
||||
"._marker.Marker",
|
||||
"._outsidetextfont.Outsidetextfont",
|
||||
"._selected.Selected",
|
||||
"._stream.Stream",
|
||||
"._textfont.Textfont",
|
||||
"._unselected.Unselected",
|
||||
],
|
||||
)
|
||||
502
lib/python3.11/site-packages/plotly/graph_objs/bar/_error_x.py
Normal file
502
lib/python3.11/site-packages/plotly/graph_objs/bar/_error_x.py
Normal file
@ -0,0 +1,502 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class ErrorX(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar"
|
||||
_path_str = "bar.error_x"
|
||||
_valid_props = {
|
||||
"array",
|
||||
"arrayminus",
|
||||
"arrayminussrc",
|
||||
"arraysrc",
|
||||
"color",
|
||||
"copy_ystyle",
|
||||
"symmetric",
|
||||
"thickness",
|
||||
"traceref",
|
||||
"tracerefminus",
|
||||
"type",
|
||||
"value",
|
||||
"valueminus",
|
||||
"visible",
|
||||
"width",
|
||||
}
|
||||
|
||||
@property
|
||||
def array(self):
|
||||
"""
|
||||
Sets the data corresponding the length of each error bar.
|
||||
Values are plotted relative to the underlying data.
|
||||
|
||||
The 'array' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["array"]
|
||||
|
||||
@array.setter
|
||||
def array(self, val):
|
||||
self["array"] = val
|
||||
|
||||
@property
|
||||
def arrayminus(self):
|
||||
"""
|
||||
Sets the data corresponding the length of each error bar in the
|
||||
bottom (left) direction for vertical (horizontal) bars Values
|
||||
are plotted relative to the underlying data.
|
||||
|
||||
The 'arrayminus' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["arrayminus"]
|
||||
|
||||
@arrayminus.setter
|
||||
def arrayminus(self, val):
|
||||
self["arrayminus"] = val
|
||||
|
||||
@property
|
||||
def arrayminussrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`arrayminus`.
|
||||
|
||||
The 'arrayminussrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["arrayminussrc"]
|
||||
|
||||
@arrayminussrc.setter
|
||||
def arrayminussrc(self, val):
|
||||
self["arrayminussrc"] = val
|
||||
|
||||
@property
|
||||
def arraysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `array`.
|
||||
|
||||
The 'arraysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["arraysrc"]
|
||||
|
||||
@arraysrc.setter
|
||||
def arraysrc(self, val):
|
||||
self["arraysrc"] = val
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the stroke color of the error bars.
|
||||
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def copy_ystyle(self):
|
||||
"""
|
||||
The 'copy_ystyle' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["copy_ystyle"]
|
||||
|
||||
@copy_ystyle.setter
|
||||
def copy_ystyle(self, val):
|
||||
self["copy_ystyle"] = val
|
||||
|
||||
@property
|
||||
def symmetric(self):
|
||||
"""
|
||||
Determines whether or not the error bars have the same length
|
||||
in both direction (top/bottom for vertical bars, left/right for
|
||||
horizontal bars.
|
||||
|
||||
The 'symmetric' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["symmetric"]
|
||||
|
||||
@symmetric.setter
|
||||
def symmetric(self, val):
|
||||
self["symmetric"] = val
|
||||
|
||||
@property
|
||||
def thickness(self):
|
||||
"""
|
||||
Sets the thickness (in px) of the error bars.
|
||||
|
||||
The 'thickness' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["thickness"]
|
||||
|
||||
@thickness.setter
|
||||
def thickness(self, val):
|
||||
self["thickness"] = val
|
||||
|
||||
@property
|
||||
def traceref(self):
|
||||
"""
|
||||
The 'traceref' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [0, 9223372036854775807]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["traceref"]
|
||||
|
||||
@traceref.setter
|
||||
def traceref(self, val):
|
||||
self["traceref"] = val
|
||||
|
||||
@property
|
||||
def tracerefminus(self):
|
||||
"""
|
||||
The 'tracerefminus' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [0, 9223372036854775807]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["tracerefminus"]
|
||||
|
||||
@tracerefminus.setter
|
||||
def tracerefminus(self, val):
|
||||
self["tracerefminus"] = val
|
||||
|
||||
@property
|
||||
def type(self):
|
||||
"""
|
||||
Determines the rule used to generate the error bars. If
|
||||
"constant", the bar lengths are of a constant value. Set this
|
||||
constant in `value`. If "percent", the bar lengths correspond
|
||||
to a percentage of underlying data. Set this percentage in
|
||||
`value`. If "sqrt", the bar lengths correspond to the square of
|
||||
the underlying data. If "data", the bar lengths are set with
|
||||
data set `array`.
|
||||
|
||||
The 'type' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['percent', 'constant', 'sqrt', 'data']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["type"]
|
||||
|
||||
@type.setter
|
||||
def type(self, val):
|
||||
self["type"] = val
|
||||
|
||||
@property
|
||||
def value(self):
|
||||
"""
|
||||
Sets the value of either the percentage (if `type` is set to
|
||||
"percent") or the constant (if `type` is set to "constant")
|
||||
corresponding to the lengths of the error bars.
|
||||
|
||||
The 'value' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["value"]
|
||||
|
||||
@value.setter
|
||||
def value(self, val):
|
||||
self["value"] = val
|
||||
|
||||
@property
|
||||
def valueminus(self):
|
||||
"""
|
||||
Sets the value of either the percentage (if `type` is set to
|
||||
"percent") or the constant (if `type` is set to "constant")
|
||||
corresponding to the lengths of the error bars in the bottom
|
||||
(left) direction for vertical (horizontal) bars
|
||||
|
||||
The 'valueminus' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["valueminus"]
|
||||
|
||||
@valueminus.setter
|
||||
def valueminus(self, val):
|
||||
self["valueminus"] = val
|
||||
|
||||
@property
|
||||
def visible(self):
|
||||
"""
|
||||
Determines whether or not this set of error bars is visible.
|
||||
|
||||
The 'visible' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["visible"]
|
||||
|
||||
@visible.setter
|
||||
def visible(self, val):
|
||||
self["visible"] = val
|
||||
|
||||
@property
|
||||
def width(self):
|
||||
"""
|
||||
Sets the width (in px) of the cross-bar at both ends of the
|
||||
error bars.
|
||||
|
||||
The 'width' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["width"]
|
||||
|
||||
@width.setter
|
||||
def width(self, val):
|
||||
self["width"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
array
|
||||
Sets the data corresponding the length of each error
|
||||
bar. Values are plotted relative to the underlying
|
||||
data.
|
||||
arrayminus
|
||||
Sets the data corresponding the length of each error
|
||||
bar in the bottom (left) direction for vertical
|
||||
(horizontal) bars Values are plotted relative to the
|
||||
underlying data.
|
||||
arrayminussrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`arrayminus`.
|
||||
arraysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`array`.
|
||||
color
|
||||
Sets the stroke color of the error bars.
|
||||
copy_ystyle
|
||||
|
||||
symmetric
|
||||
Determines whether or not the error bars have the same
|
||||
length in both direction (top/bottom for vertical bars,
|
||||
left/right for horizontal bars.
|
||||
thickness
|
||||
Sets the thickness (in px) of the error bars.
|
||||
traceref
|
||||
|
||||
tracerefminus
|
||||
|
||||
type
|
||||
Determines the rule used to generate the error bars. If
|
||||
"constant", the bar lengths are of a constant value.
|
||||
Set this constant in `value`. If "percent", the bar
|
||||
lengths correspond to a percentage of underlying data.
|
||||
Set this percentage in `value`. If "sqrt", the bar
|
||||
lengths correspond to the square of the underlying
|
||||
data. If "data", the bar lengths are set with data set
|
||||
`array`.
|
||||
value
|
||||
Sets the value of either the percentage (if `type` is
|
||||
set to "percent") or the constant (if `type` is set to
|
||||
"constant") corresponding to the lengths of the error
|
||||
bars.
|
||||
valueminus
|
||||
Sets the value of either the percentage (if `type` is
|
||||
set to "percent") or the constant (if `type` is set to
|
||||
"constant") corresponding to the lengths of the error
|
||||
bars in the bottom (left) direction for vertical
|
||||
(horizontal) bars
|
||||
visible
|
||||
Determines whether or not this set of error bars is
|
||||
visible.
|
||||
width
|
||||
Sets the width (in px) of the cross-bar at both ends of
|
||||
the error bars.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
array=None,
|
||||
arrayminus=None,
|
||||
arrayminussrc=None,
|
||||
arraysrc=None,
|
||||
color=None,
|
||||
copy_ystyle=None,
|
||||
symmetric=None,
|
||||
thickness=None,
|
||||
traceref=None,
|
||||
tracerefminus=None,
|
||||
type=None,
|
||||
value=None,
|
||||
valueminus=None,
|
||||
visible=None,
|
||||
width=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new ErrorX object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.bar.ErrorX`
|
||||
array
|
||||
Sets the data corresponding the length of each error
|
||||
bar. Values are plotted relative to the underlying
|
||||
data.
|
||||
arrayminus
|
||||
Sets the data corresponding the length of each error
|
||||
bar in the bottom (left) direction for vertical
|
||||
(horizontal) bars Values are plotted relative to the
|
||||
underlying data.
|
||||
arrayminussrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`arrayminus`.
|
||||
arraysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`array`.
|
||||
color
|
||||
Sets the stroke color of the error bars.
|
||||
copy_ystyle
|
||||
|
||||
symmetric
|
||||
Determines whether or not the error bars have the same
|
||||
length in both direction (top/bottom for vertical bars,
|
||||
left/right for horizontal bars.
|
||||
thickness
|
||||
Sets the thickness (in px) of the error bars.
|
||||
traceref
|
||||
|
||||
tracerefminus
|
||||
|
||||
type
|
||||
Determines the rule used to generate the error bars. If
|
||||
"constant", the bar lengths are of a constant value.
|
||||
Set this constant in `value`. If "percent", the bar
|
||||
lengths correspond to a percentage of underlying data.
|
||||
Set this percentage in `value`. If "sqrt", the bar
|
||||
lengths correspond to the square of the underlying
|
||||
data. If "data", the bar lengths are set with data set
|
||||
`array`.
|
||||
value
|
||||
Sets the value of either the percentage (if `type` is
|
||||
set to "percent") or the constant (if `type` is set to
|
||||
"constant") corresponding to the lengths of the error
|
||||
bars.
|
||||
valueminus
|
||||
Sets the value of either the percentage (if `type` is
|
||||
set to "percent") or the constant (if `type` is set to
|
||||
"constant") corresponding to the lengths of the error
|
||||
bars in the bottom (left) direction for vertical
|
||||
(horizontal) bars
|
||||
visible
|
||||
Determines whether or not this set of error bars is
|
||||
visible.
|
||||
width
|
||||
Sets the width (in px) of the cross-bar at both ends of
|
||||
the error bars.
|
||||
|
||||
Returns
|
||||
-------
|
||||
ErrorX
|
||||
"""
|
||||
super().__init__("error_x")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.ErrorX
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.ErrorX`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("array", arg, array)
|
||||
self._set_property("arrayminus", arg, arrayminus)
|
||||
self._set_property("arrayminussrc", arg, arrayminussrc)
|
||||
self._set_property("arraysrc", arg, arraysrc)
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("copy_ystyle", arg, copy_ystyle)
|
||||
self._set_property("symmetric", arg, symmetric)
|
||||
self._set_property("thickness", arg, thickness)
|
||||
self._set_property("traceref", arg, traceref)
|
||||
self._set_property("tracerefminus", arg, tracerefminus)
|
||||
self._set_property("type", arg, type)
|
||||
self._set_property("value", arg, value)
|
||||
self._set_property("valueminus", arg, valueminus)
|
||||
self._set_property("visible", arg, visible)
|
||||
self._set_property("width", arg, width)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
479
lib/python3.11/site-packages/plotly/graph_objs/bar/_error_y.py
Normal file
479
lib/python3.11/site-packages/plotly/graph_objs/bar/_error_y.py
Normal file
@ -0,0 +1,479 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class ErrorY(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar"
|
||||
_path_str = "bar.error_y"
|
||||
_valid_props = {
|
||||
"array",
|
||||
"arrayminus",
|
||||
"arrayminussrc",
|
||||
"arraysrc",
|
||||
"color",
|
||||
"symmetric",
|
||||
"thickness",
|
||||
"traceref",
|
||||
"tracerefminus",
|
||||
"type",
|
||||
"value",
|
||||
"valueminus",
|
||||
"visible",
|
||||
"width",
|
||||
}
|
||||
|
||||
@property
|
||||
def array(self):
|
||||
"""
|
||||
Sets the data corresponding the length of each error bar.
|
||||
Values are plotted relative to the underlying data.
|
||||
|
||||
The 'array' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["array"]
|
||||
|
||||
@array.setter
|
||||
def array(self, val):
|
||||
self["array"] = val
|
||||
|
||||
@property
|
||||
def arrayminus(self):
|
||||
"""
|
||||
Sets the data corresponding the length of each error bar in the
|
||||
bottom (left) direction for vertical (horizontal) bars Values
|
||||
are plotted relative to the underlying data.
|
||||
|
||||
The 'arrayminus' property is an array that may be specified as a tuple,
|
||||
list, numpy array, or pandas Series
|
||||
|
||||
Returns
|
||||
-------
|
||||
numpy.ndarray
|
||||
"""
|
||||
return self["arrayminus"]
|
||||
|
||||
@arrayminus.setter
|
||||
def arrayminus(self, val):
|
||||
self["arrayminus"] = val
|
||||
|
||||
@property
|
||||
def arrayminussrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`arrayminus`.
|
||||
|
||||
The 'arrayminussrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["arrayminussrc"]
|
||||
|
||||
@arrayminussrc.setter
|
||||
def arrayminussrc(self, val):
|
||||
self["arrayminussrc"] = val
|
||||
|
||||
@property
|
||||
def arraysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `array`.
|
||||
|
||||
The 'arraysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["arraysrc"]
|
||||
|
||||
@arraysrc.setter
|
||||
def arraysrc(self, val):
|
||||
self["arraysrc"] = val
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the stroke color of the error bars.
|
||||
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def symmetric(self):
|
||||
"""
|
||||
Determines whether or not the error bars have the same length
|
||||
in both direction (top/bottom for vertical bars, left/right for
|
||||
horizontal bars.
|
||||
|
||||
The 'symmetric' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["symmetric"]
|
||||
|
||||
@symmetric.setter
|
||||
def symmetric(self, val):
|
||||
self["symmetric"] = val
|
||||
|
||||
@property
|
||||
def thickness(self):
|
||||
"""
|
||||
Sets the thickness (in px) of the error bars.
|
||||
|
||||
The 'thickness' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["thickness"]
|
||||
|
||||
@thickness.setter
|
||||
def thickness(self, val):
|
||||
self["thickness"] = val
|
||||
|
||||
@property
|
||||
def traceref(self):
|
||||
"""
|
||||
The 'traceref' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [0, 9223372036854775807]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["traceref"]
|
||||
|
||||
@traceref.setter
|
||||
def traceref(self, val):
|
||||
self["traceref"] = val
|
||||
|
||||
@property
|
||||
def tracerefminus(self):
|
||||
"""
|
||||
The 'tracerefminus' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [0, 9223372036854775807]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["tracerefminus"]
|
||||
|
||||
@tracerefminus.setter
|
||||
def tracerefminus(self, val):
|
||||
self["tracerefminus"] = val
|
||||
|
||||
@property
|
||||
def type(self):
|
||||
"""
|
||||
Determines the rule used to generate the error bars. If
|
||||
"constant", the bar lengths are of a constant value. Set this
|
||||
constant in `value`. If "percent", the bar lengths correspond
|
||||
to a percentage of underlying data. Set this percentage in
|
||||
`value`. If "sqrt", the bar lengths correspond to the square of
|
||||
the underlying data. If "data", the bar lengths are set with
|
||||
data set `array`.
|
||||
|
||||
The 'type' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['percent', 'constant', 'sqrt', 'data']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["type"]
|
||||
|
||||
@type.setter
|
||||
def type(self, val):
|
||||
self["type"] = val
|
||||
|
||||
@property
|
||||
def value(self):
|
||||
"""
|
||||
Sets the value of either the percentage (if `type` is set to
|
||||
"percent") or the constant (if `type` is set to "constant")
|
||||
corresponding to the lengths of the error bars.
|
||||
|
||||
The 'value' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["value"]
|
||||
|
||||
@value.setter
|
||||
def value(self, val):
|
||||
self["value"] = val
|
||||
|
||||
@property
|
||||
def valueminus(self):
|
||||
"""
|
||||
Sets the value of either the percentage (if `type` is set to
|
||||
"percent") or the constant (if `type` is set to "constant")
|
||||
corresponding to the lengths of the error bars in the bottom
|
||||
(left) direction for vertical (horizontal) bars
|
||||
|
||||
The 'valueminus' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["valueminus"]
|
||||
|
||||
@valueminus.setter
|
||||
def valueminus(self, val):
|
||||
self["valueminus"] = val
|
||||
|
||||
@property
|
||||
def visible(self):
|
||||
"""
|
||||
Determines whether or not this set of error bars is visible.
|
||||
|
||||
The 'visible' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["visible"]
|
||||
|
||||
@visible.setter
|
||||
def visible(self, val):
|
||||
self["visible"] = val
|
||||
|
||||
@property
|
||||
def width(self):
|
||||
"""
|
||||
Sets the width (in px) of the cross-bar at both ends of the
|
||||
error bars.
|
||||
|
||||
The 'width' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["width"]
|
||||
|
||||
@width.setter
|
||||
def width(self, val):
|
||||
self["width"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
array
|
||||
Sets the data corresponding the length of each error
|
||||
bar. Values are plotted relative to the underlying
|
||||
data.
|
||||
arrayminus
|
||||
Sets the data corresponding the length of each error
|
||||
bar in the bottom (left) direction for vertical
|
||||
(horizontal) bars Values are plotted relative to the
|
||||
underlying data.
|
||||
arrayminussrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`arrayminus`.
|
||||
arraysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`array`.
|
||||
color
|
||||
Sets the stroke color of the error bars.
|
||||
symmetric
|
||||
Determines whether or not the error bars have the same
|
||||
length in both direction (top/bottom for vertical bars,
|
||||
left/right for horizontal bars.
|
||||
thickness
|
||||
Sets the thickness (in px) of the error bars.
|
||||
traceref
|
||||
|
||||
tracerefminus
|
||||
|
||||
type
|
||||
Determines the rule used to generate the error bars. If
|
||||
"constant", the bar lengths are of a constant value.
|
||||
Set this constant in `value`. If "percent", the bar
|
||||
lengths correspond to a percentage of underlying data.
|
||||
Set this percentage in `value`. If "sqrt", the bar
|
||||
lengths correspond to the square of the underlying
|
||||
data. If "data", the bar lengths are set with data set
|
||||
`array`.
|
||||
value
|
||||
Sets the value of either the percentage (if `type` is
|
||||
set to "percent") or the constant (if `type` is set to
|
||||
"constant") corresponding to the lengths of the error
|
||||
bars.
|
||||
valueminus
|
||||
Sets the value of either the percentage (if `type` is
|
||||
set to "percent") or the constant (if `type` is set to
|
||||
"constant") corresponding to the lengths of the error
|
||||
bars in the bottom (left) direction for vertical
|
||||
(horizontal) bars
|
||||
visible
|
||||
Determines whether or not this set of error bars is
|
||||
visible.
|
||||
width
|
||||
Sets the width (in px) of the cross-bar at both ends of
|
||||
the error bars.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
array=None,
|
||||
arrayminus=None,
|
||||
arrayminussrc=None,
|
||||
arraysrc=None,
|
||||
color=None,
|
||||
symmetric=None,
|
||||
thickness=None,
|
||||
traceref=None,
|
||||
tracerefminus=None,
|
||||
type=None,
|
||||
value=None,
|
||||
valueminus=None,
|
||||
visible=None,
|
||||
width=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new ErrorY object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.bar.ErrorY`
|
||||
array
|
||||
Sets the data corresponding the length of each error
|
||||
bar. Values are plotted relative to the underlying
|
||||
data.
|
||||
arrayminus
|
||||
Sets the data corresponding the length of each error
|
||||
bar in the bottom (left) direction for vertical
|
||||
(horizontal) bars Values are plotted relative to the
|
||||
underlying data.
|
||||
arrayminussrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`arrayminus`.
|
||||
arraysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`array`.
|
||||
color
|
||||
Sets the stroke color of the error bars.
|
||||
symmetric
|
||||
Determines whether or not the error bars have the same
|
||||
length in both direction (top/bottom for vertical bars,
|
||||
left/right for horizontal bars.
|
||||
thickness
|
||||
Sets the thickness (in px) of the error bars.
|
||||
traceref
|
||||
|
||||
tracerefminus
|
||||
|
||||
type
|
||||
Determines the rule used to generate the error bars. If
|
||||
"constant", the bar lengths are of a constant value.
|
||||
Set this constant in `value`. If "percent", the bar
|
||||
lengths correspond to a percentage of underlying data.
|
||||
Set this percentage in `value`. If "sqrt", the bar
|
||||
lengths correspond to the square of the underlying
|
||||
data. If "data", the bar lengths are set with data set
|
||||
`array`.
|
||||
value
|
||||
Sets the value of either the percentage (if `type` is
|
||||
set to "percent") or the constant (if `type` is set to
|
||||
"constant") corresponding to the lengths of the error
|
||||
bars.
|
||||
valueminus
|
||||
Sets the value of either the percentage (if `type` is
|
||||
set to "percent") or the constant (if `type` is set to
|
||||
"constant") corresponding to the lengths of the error
|
||||
bars in the bottom (left) direction for vertical
|
||||
(horizontal) bars
|
||||
visible
|
||||
Determines whether or not this set of error bars is
|
||||
visible.
|
||||
width
|
||||
Sets the width (in px) of the cross-bar at both ends of
|
||||
the error bars.
|
||||
|
||||
Returns
|
||||
-------
|
||||
ErrorY
|
||||
"""
|
||||
super().__init__("error_y")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.ErrorY
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.ErrorY`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("array", arg, array)
|
||||
self._set_property("arrayminus", arg, arrayminus)
|
||||
self._set_property("arrayminussrc", arg, arrayminussrc)
|
||||
self._set_property("arraysrc", arg, arraysrc)
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("symmetric", arg, symmetric)
|
||||
self._set_property("thickness", arg, thickness)
|
||||
self._set_property("traceref", arg, traceref)
|
||||
self._set_property("tracerefminus", arg, tracerefminus)
|
||||
self._set_property("type", arg, type)
|
||||
self._set_property("value", arg, value)
|
||||
self._set_property("valueminus", arg, valueminus)
|
||||
self._set_property("visible", arg, visible)
|
||||
self._set_property("width", arg, width)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,366 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Hoverlabel(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar"
|
||||
_path_str = "bar.hoverlabel"
|
||||
_valid_props = {
|
||||
"align",
|
||||
"alignsrc",
|
||||
"bgcolor",
|
||||
"bgcolorsrc",
|
||||
"bordercolor",
|
||||
"bordercolorsrc",
|
||||
"font",
|
||||
"namelength",
|
||||
"namelengthsrc",
|
||||
"showarrow",
|
||||
}
|
||||
|
||||
@property
|
||||
def align(self):
|
||||
"""
|
||||
Sets the horizontal alignment of the text content within hover
|
||||
label box. Has an effect only if the hover label text spans
|
||||
more two or more lines
|
||||
|
||||
The 'align' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['left', 'right', 'auto']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["align"]
|
||||
|
||||
@align.setter
|
||||
def align(self, val):
|
||||
self["align"] = val
|
||||
|
||||
@property
|
||||
def alignsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `align`.
|
||||
|
||||
The 'alignsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["alignsrc"]
|
||||
|
||||
@alignsrc.setter
|
||||
def alignsrc(self, val):
|
||||
self["alignsrc"] = val
|
||||
|
||||
@property
|
||||
def bgcolor(self):
|
||||
"""
|
||||
Sets the background color of the hover labels for this trace
|
||||
|
||||
The 'bgcolor' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["bgcolor"]
|
||||
|
||||
@bgcolor.setter
|
||||
def bgcolor(self, val):
|
||||
self["bgcolor"] = val
|
||||
|
||||
@property
|
||||
def bgcolorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `bgcolor`.
|
||||
|
||||
The 'bgcolorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["bgcolorsrc"]
|
||||
|
||||
@bgcolorsrc.setter
|
||||
def bgcolorsrc(self, val):
|
||||
self["bgcolorsrc"] = val
|
||||
|
||||
@property
|
||||
def bordercolor(self):
|
||||
"""
|
||||
Sets the border color of the hover labels for this trace.
|
||||
|
||||
The 'bordercolor' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["bordercolor"]
|
||||
|
||||
@bordercolor.setter
|
||||
def bordercolor(self, val):
|
||||
self["bordercolor"] = val
|
||||
|
||||
@property
|
||||
def bordercolorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bordercolor`.
|
||||
|
||||
The 'bordercolorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["bordercolorsrc"]
|
||||
|
||||
@bordercolorsrc.setter
|
||||
def bordercolorsrc(self, val):
|
||||
self["bordercolorsrc"] = val
|
||||
|
||||
@property
|
||||
def font(self):
|
||||
"""
|
||||
Sets the font used in hover labels.
|
||||
|
||||
The 'font' property is an instance of Font
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.bar.hoverlabel.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.bar.hoverlabel.Font
|
||||
"""
|
||||
return self["font"]
|
||||
|
||||
@font.setter
|
||||
def font(self, val):
|
||||
self["font"] = val
|
||||
|
||||
@property
|
||||
def namelength(self):
|
||||
"""
|
||||
Sets the default length (in number of characters) of the trace
|
||||
name in the hover labels for all traces. -1 shows the whole
|
||||
name regardless of length. 0-3 shows the first 0-3 characters,
|
||||
and an integer >3 will show the whole name if it is less than
|
||||
that many characters, but if it is longer, will truncate to
|
||||
`namelength - 3` characters and add an ellipsis.
|
||||
|
||||
The 'namelength' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [-1, 9223372036854775807]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|numpy.ndarray
|
||||
"""
|
||||
return self["namelength"]
|
||||
|
||||
@namelength.setter
|
||||
def namelength(self, val):
|
||||
self["namelength"] = val
|
||||
|
||||
@property
|
||||
def namelengthsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`namelength`.
|
||||
|
||||
The 'namelengthsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["namelengthsrc"]
|
||||
|
||||
@namelengthsrc.setter
|
||||
def namelengthsrc(self, val):
|
||||
self["namelengthsrc"] = val
|
||||
|
||||
@property
|
||||
def showarrow(self):
|
||||
"""
|
||||
Sets whether or not to show the hover label arrow/triangle
|
||||
pointing to the data point.
|
||||
|
||||
The 'showarrow' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["showarrow"]
|
||||
|
||||
@showarrow.setter
|
||||
def showarrow(self, val):
|
||||
self["showarrow"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
align
|
||||
Sets the horizontal alignment of the text content
|
||||
within hover label box. Has an effect only if the hover
|
||||
label text spans more two or more lines
|
||||
alignsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`align`.
|
||||
bgcolor
|
||||
Sets the background color of the hover labels for this
|
||||
trace
|
||||
bgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bgcolor`.
|
||||
bordercolor
|
||||
Sets the border color of the hover labels for this
|
||||
trace.
|
||||
bordercolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bordercolor`.
|
||||
font
|
||||
Sets the font used in hover labels.
|
||||
namelength
|
||||
Sets the default length (in number of characters) of
|
||||
the trace name in the hover labels for all traces. -1
|
||||
shows the whole name regardless of length. 0-3 shows
|
||||
the first 0-3 characters, and an integer >3 will show
|
||||
the whole name if it is less than that many characters,
|
||||
but if it is longer, will truncate to `namelength - 3`
|
||||
characters and add an ellipsis.
|
||||
namelengthsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`namelength`.
|
||||
showarrow
|
||||
Sets whether or not to show the hover label
|
||||
arrow/triangle pointing to the data point.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
align=None,
|
||||
alignsrc=None,
|
||||
bgcolor=None,
|
||||
bgcolorsrc=None,
|
||||
bordercolor=None,
|
||||
bordercolorsrc=None,
|
||||
font=None,
|
||||
namelength=None,
|
||||
namelengthsrc=None,
|
||||
showarrow=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Hoverlabel object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.bar.Hoverlabel`
|
||||
align
|
||||
Sets the horizontal alignment of the text content
|
||||
within hover label box. Has an effect only if the hover
|
||||
label text spans more two or more lines
|
||||
alignsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`align`.
|
||||
bgcolor
|
||||
Sets the background color of the hover labels for this
|
||||
trace
|
||||
bgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bgcolor`.
|
||||
bordercolor
|
||||
Sets the border color of the hover labels for this
|
||||
trace.
|
||||
bordercolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bordercolor`.
|
||||
font
|
||||
Sets the font used in hover labels.
|
||||
namelength
|
||||
Sets the default length (in number of characters) of
|
||||
the trace name in the hover labels for all traces. -1
|
||||
shows the whole name regardless of length. 0-3 shows
|
||||
the first 0-3 characters, and an integer >3 will show
|
||||
the whole name if it is less than that many characters,
|
||||
but if it is longer, will truncate to `namelength - 3`
|
||||
characters and add an ellipsis.
|
||||
namelengthsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`namelength`.
|
||||
showarrow
|
||||
Sets whether or not to show the hover label
|
||||
arrow/triangle pointing to the data point.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Hoverlabel
|
||||
"""
|
||||
super().__init__("hoverlabel")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.Hoverlabel
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.Hoverlabel`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("align", arg, align)
|
||||
self._set_property("alignsrc", arg, alignsrc)
|
||||
self._set_property("bgcolor", arg, bgcolor)
|
||||
self._set_property("bgcolorsrc", arg, bgcolorsrc)
|
||||
self._set_property("bordercolor", arg, bordercolor)
|
||||
self._set_property("bordercolorsrc", arg, bordercolorsrc)
|
||||
self._set_property("font", arg, font)
|
||||
self._set_property("namelength", arg, namelength)
|
||||
self._set_property("namelengthsrc", arg, namelengthsrc)
|
||||
self._set_property("showarrow", arg, showarrow)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,587 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Insidetextfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar"
|
||||
_path_str = "bar.insidetextfont"
|
||||
_valid_props = {
|
||||
"color",
|
||||
"colorsrc",
|
||||
"family",
|
||||
"familysrc",
|
||||
"lineposition",
|
||||
"linepositionsrc",
|
||||
"shadow",
|
||||
"shadowsrc",
|
||||
"size",
|
||||
"sizesrc",
|
||||
"style",
|
||||
"stylesrc",
|
||||
"textcase",
|
||||
"textcasesrc",
|
||||
"variant",
|
||||
"variantsrc",
|
||||
"weight",
|
||||
"weightsrc",
|
||||
}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def colorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `color`.
|
||||
|
||||
The 'colorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["colorsrc"]
|
||||
|
||||
@colorsrc.setter
|
||||
def colorsrc(self, val):
|
||||
self["colorsrc"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser can only apply a font if it is
|
||||
available on the system where it runs. Provide multiple font
|
||||
families, separated by commas, to indicate the order in which
|
||||
to apply fonts if they aren't available.
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def familysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `family`.
|
||||
|
||||
The 'familysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["familysrc"]
|
||||
|
||||
@familysrc.setter
|
||||
def familysrc(self, val):
|
||||
self["familysrc"] = val
|
||||
|
||||
@property
|
||||
def lineposition(self):
|
||||
"""
|
||||
Sets the kind of decoration line(s) with text, such as an
|
||||
"under", "over" or "through" as well as combinations e.g.
|
||||
"under+over", etc.
|
||||
|
||||
The 'lineposition' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['under', 'over', 'through'] joined with '+' characters
|
||||
(e.g. 'under+over')
|
||||
OR exactly one of ['none'] (e.g. 'none')
|
||||
- A list or array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["lineposition"]
|
||||
|
||||
@lineposition.setter
|
||||
def lineposition(self, val):
|
||||
self["lineposition"] = val
|
||||
|
||||
@property
|
||||
def linepositionsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
|
||||
The 'linepositionsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["linepositionsrc"]
|
||||
|
||||
@linepositionsrc.setter
|
||||
def linepositionsrc(self, val):
|
||||
self["linepositionsrc"] = val
|
||||
|
||||
@property
|
||||
def shadow(self):
|
||||
"""
|
||||
Sets the shape and color of the shadow behind text. "auto"
|
||||
places minimal shadow and applies contrast text font color. See
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
|
||||
for additional options.
|
||||
|
||||
The 'shadow' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["shadow"]
|
||||
|
||||
@shadow.setter
|
||||
def shadow(self, val):
|
||||
self["shadow"] = val
|
||||
|
||||
@property
|
||||
def shadowsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `shadow`.
|
||||
|
||||
The 'shadowsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shadowsrc"]
|
||||
|
||||
@shadowsrc.setter
|
||||
def shadowsrc(self, val):
|
||||
self["shadowsrc"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def sizesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `size`.
|
||||
|
||||
The 'sizesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["sizesrc"]
|
||||
|
||||
@sizesrc.setter
|
||||
def sizesrc(self, val):
|
||||
self["sizesrc"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
Sets whether a font should be styled with a normal or italic
|
||||
face from its family.
|
||||
|
||||
The 'style' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'italic']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def stylesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `style`.
|
||||
|
||||
The 'stylesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["stylesrc"]
|
||||
|
||||
@stylesrc.setter
|
||||
def stylesrc(self, val):
|
||||
self["stylesrc"] = val
|
||||
|
||||
@property
|
||||
def textcase(self):
|
||||
"""
|
||||
Sets capitalization of text. It can be used to make text appear
|
||||
in all-uppercase or all-lowercase, or with each word
|
||||
capitalized.
|
||||
|
||||
The 'textcase' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'word caps', 'upper', 'lower']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["textcase"]
|
||||
|
||||
@textcase.setter
|
||||
def textcase(self, val):
|
||||
self["textcase"] = val
|
||||
|
||||
@property
|
||||
def textcasesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `textcase`.
|
||||
|
||||
The 'textcasesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["textcasesrc"]
|
||||
|
||||
@textcasesrc.setter
|
||||
def textcasesrc(self, val):
|
||||
self["textcasesrc"] = val
|
||||
|
||||
@property
|
||||
def variant(self):
|
||||
"""
|
||||
Sets the variant of the font.
|
||||
|
||||
The 'variant' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'small-caps', 'all-small-caps',
|
||||
'all-petite-caps', 'petite-caps', 'unicase']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["variant"]
|
||||
|
||||
@variant.setter
|
||||
def variant(self, val):
|
||||
self["variant"] = val
|
||||
|
||||
@property
|
||||
def variantsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `variant`.
|
||||
|
||||
The 'variantsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["variantsrc"]
|
||||
|
||||
@variantsrc.setter
|
||||
def variantsrc(self, val):
|
||||
self["variantsrc"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
The 'weight' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [1, 1000]
|
||||
OR exactly one of ['normal', 'bold'] (e.g. 'bold')
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|numpy.ndarray
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def weightsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `weight`.
|
||||
|
||||
The 'weightsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["weightsrc"]
|
||||
|
||||
@weightsrc.setter
|
||||
def weightsrc(self, val):
|
||||
self["weightsrc"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
familysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`family`.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
linepositionsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
shadowsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shadow`.
|
||||
size
|
||||
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
stylesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`style`.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
textcasesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`textcase`.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
variantsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`variant`.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
weightsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`weight`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
colorsrc=None,
|
||||
family=None,
|
||||
familysrc=None,
|
||||
lineposition=None,
|
||||
linepositionsrc=None,
|
||||
shadow=None,
|
||||
shadowsrc=None,
|
||||
size=None,
|
||||
sizesrc=None,
|
||||
style=None,
|
||||
stylesrc=None,
|
||||
textcase=None,
|
||||
textcasesrc=None,
|
||||
variant=None,
|
||||
variantsrc=None,
|
||||
weight=None,
|
||||
weightsrc=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Insidetextfont object
|
||||
|
||||
Sets the font used for `text` lying inside the bar.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.bar.Insidetextfont`
|
||||
color
|
||||
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
familysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`family`.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
linepositionsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
shadowsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shadow`.
|
||||
size
|
||||
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
stylesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`style`.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
textcasesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`textcase`.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
variantsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`variant`.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
weightsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`weight`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Insidetextfont
|
||||
"""
|
||||
super().__init__("insidetextfont")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.Insidetextfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.Insidetextfont`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("colorsrc", arg, colorsrc)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("familysrc", arg, familysrc)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("linepositionsrc", arg, linepositionsrc)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("shadowsrc", arg, shadowsrc)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("sizesrc", arg, sizesrc)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("stylesrc", arg, stylesrc)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("textcasesrc", arg, textcasesrc)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("variantsrc", arg, variantsrc)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._set_property("weightsrc", arg, weightsrc)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,104 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Legendgrouptitle(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar"
|
||||
_path_str = "bar.legendgrouptitle"
|
||||
_valid_props = {"font", "text"}
|
||||
|
||||
@property
|
||||
def font(self):
|
||||
"""
|
||||
Sets this legend group's title font.
|
||||
|
||||
The 'font' property is an instance of Font
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.bar.legendgrouptitle.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.bar.legendgrouptitle.Font
|
||||
"""
|
||||
return self["font"]
|
||||
|
||||
@font.setter
|
||||
def font(self, val):
|
||||
self["font"] = val
|
||||
|
||||
@property
|
||||
def text(self):
|
||||
"""
|
||||
Sets the title of the legend group.
|
||||
|
||||
The 'text' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["text"]
|
||||
|
||||
@text.setter
|
||||
def text(self, val):
|
||||
self["text"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
font
|
||||
Sets this legend group's title font.
|
||||
text
|
||||
Sets the title of the legend group.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, font=None, text=None, **kwargs):
|
||||
"""
|
||||
Construct a new Legendgrouptitle object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.bar.Legendgrouptitle`
|
||||
font
|
||||
Sets this legend group's title font.
|
||||
text
|
||||
Sets the title of the legend group.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Legendgrouptitle
|
||||
"""
|
||||
super().__init__("legendgrouptitle")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.Legendgrouptitle
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.Legendgrouptitle`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("font", arg, font)
|
||||
self._set_property("text", arg, text)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
685
lib/python3.11/site-packages/plotly/graph_objs/bar/_marker.py
Normal file
685
lib/python3.11/site-packages/plotly/graph_objs/bar/_marker.py
Normal file
@ -0,0 +1,685 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Marker(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar"
|
||||
_path_str = "bar.marker"
|
||||
_valid_props = {
|
||||
"autocolorscale",
|
||||
"cauto",
|
||||
"cmax",
|
||||
"cmid",
|
||||
"cmin",
|
||||
"color",
|
||||
"coloraxis",
|
||||
"colorbar",
|
||||
"colorscale",
|
||||
"colorsrc",
|
||||
"cornerradius",
|
||||
"line",
|
||||
"opacity",
|
||||
"opacitysrc",
|
||||
"pattern",
|
||||
"reversescale",
|
||||
"showscale",
|
||||
}
|
||||
|
||||
@property
|
||||
def autocolorscale(self):
|
||||
"""
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`marker.colorscale`. Has an effect only if in `marker.color` is
|
||||
set to a numerical array. In case `colorscale` is unspecified
|
||||
or `autocolorscale` is true, the default palette will be chosen
|
||||
according to whether numbers in the `color` array are all
|
||||
positive, all negative or mixed.
|
||||
|
||||
The 'autocolorscale' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["autocolorscale"]
|
||||
|
||||
@autocolorscale.setter
|
||||
def autocolorscale(self, val):
|
||||
self["autocolorscale"] = val
|
||||
|
||||
@property
|
||||
def cauto(self):
|
||||
"""
|
||||
Determines whether or not the color domain is computed with
|
||||
respect to the input data (here in `marker.color`) or the
|
||||
bounds set in `marker.cmin` and `marker.cmax` Has an effect
|
||||
only if in `marker.color` is set to a numerical array. Defaults
|
||||
to `false` when `marker.cmin` and `marker.cmax` are set by the
|
||||
user.
|
||||
|
||||
The 'cauto' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["cauto"]
|
||||
|
||||
@cauto.setter
|
||||
def cauto(self, val):
|
||||
self["cauto"] = val
|
||||
|
||||
@property
|
||||
def cmax(self):
|
||||
"""
|
||||
Sets the upper bound of the color domain. Has an effect only if
|
||||
in `marker.color` is set to a numerical array. Value should
|
||||
have the same units as in `marker.color` and if set,
|
||||
`marker.cmin` must be set as well.
|
||||
|
||||
The 'cmax' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["cmax"]
|
||||
|
||||
@cmax.setter
|
||||
def cmax(self, val):
|
||||
self["cmax"] = val
|
||||
|
||||
@property
|
||||
def cmid(self):
|
||||
"""
|
||||
Sets the mid-point of the color domain by scaling `marker.cmin`
|
||||
and/or `marker.cmax` to be equidistant to this point. Has an
|
||||
effect only if in `marker.color` is set to a numerical array.
|
||||
Value should have the same units as in `marker.color`. Has no
|
||||
effect when `marker.cauto` is `false`.
|
||||
|
||||
The 'cmid' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["cmid"]
|
||||
|
||||
@cmid.setter
|
||||
def cmid(self, val):
|
||||
self["cmid"] = val
|
||||
|
||||
@property
|
||||
def cmin(self):
|
||||
"""
|
||||
Sets the lower bound of the color domain. Has an effect only if
|
||||
in `marker.color` is set to a numerical array. Value should
|
||||
have the same units as in `marker.color` and if set,
|
||||
`marker.cmax` must be set as well.
|
||||
|
||||
The 'cmin' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["cmin"]
|
||||
|
||||
@cmin.setter
|
||||
def cmin(self, val):
|
||||
self["cmin"] = val
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the marker color. It accepts either a specific color or an
|
||||
array of numbers that are mapped to the colorscale relative to
|
||||
the max and min values of the array or relative to
|
||||
`marker.cmin` and `marker.cmax` if set.
|
||||
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A number that will be interpreted as a color
|
||||
according to bar.marker.colorscale
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def coloraxis(self):
|
||||
"""
|
||||
Sets a reference to a shared color axis. References to these
|
||||
shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
|
||||
etc. Settings for these shared color axes are set in the
|
||||
layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
|
||||
Note that multiple color scales can be linked to the same color
|
||||
axis.
|
||||
|
||||
The 'coloraxis' property is an identifier of a particular
|
||||
subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
|
||||
optionally followed by an integer >= 1
|
||||
(e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["coloraxis"]
|
||||
|
||||
@coloraxis.setter
|
||||
def coloraxis(self, val):
|
||||
self["coloraxis"] = val
|
||||
|
||||
@property
|
||||
def colorbar(self):
|
||||
"""
|
||||
The 'colorbar' property is an instance of ColorBar
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.bar.marker.ColorBar`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the ColorBar constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.bar.marker.ColorBar
|
||||
"""
|
||||
return self["colorbar"]
|
||||
|
||||
@colorbar.setter
|
||||
def colorbar(self, val):
|
||||
self["colorbar"] = val
|
||||
|
||||
@property
|
||||
def colorscale(self):
|
||||
"""
|
||||
Sets the colorscale. Has an effect only if in `marker.color` is
|
||||
set to a numerical array. The colorscale must be an array
|
||||
containing arrays mapping a normalized value to an rgb, rgba,
|
||||
hex, hsl, hsv, or named color string. At minimum, a mapping for
|
||||
the lowest (0) and highest (1) values are required. For
|
||||
example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To
|
||||
control the bounds of the colorscale in color space, use
|
||||
`marker.cmin` and `marker.cmax`. Alternatively, `colorscale`
|
||||
may be a palette name string of the following list: Blackbody,B
|
||||
luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic
|
||||
,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
|
||||
|
||||
The 'colorscale' property is a colorscale and may be
|
||||
specified as:
|
||||
- A list of colors that will be spaced evenly to create the colorscale.
|
||||
Many predefined colorscale lists are included in the sequential, diverging,
|
||||
and cyclical modules in the plotly.colors package.
|
||||
- A list of 2-element lists where the first element is the
|
||||
normalized color level value (starting at 0 and ending at 1),
|
||||
and the second item is a valid color string.
|
||||
(e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
|
||||
- One of the following named colorscales:
|
||||
['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
|
||||
'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
|
||||
'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
|
||||
'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
|
||||
'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
|
||||
'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
|
||||
'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
|
||||
'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
|
||||
'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
|
||||
'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
|
||||
'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
|
||||
'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
|
||||
'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
|
||||
'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
|
||||
'ylorrd'].
|
||||
Appending '_r' to a named colorscale reverses it.
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["colorscale"]
|
||||
|
||||
@colorscale.setter
|
||||
def colorscale(self, val):
|
||||
self["colorscale"] = val
|
||||
|
||||
@property
|
||||
def colorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `color`.
|
||||
|
||||
The 'colorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["colorsrc"]
|
||||
|
||||
@colorsrc.setter
|
||||
def colorsrc(self, val):
|
||||
self["colorsrc"] = val
|
||||
|
||||
@property
|
||||
def cornerradius(self):
|
||||
"""
|
||||
Sets the rounding of corners. May be an integer number of
|
||||
pixels, or a percentage of bar width (as a string ending in %).
|
||||
Defaults to `layout.barcornerradius`. In stack or relative
|
||||
barmode, the first trace to set cornerradius is used for the
|
||||
whole stack.
|
||||
|
||||
The 'cornerradius' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["cornerradius"]
|
||||
|
||||
@cornerradius.setter
|
||||
def cornerradius(self, val):
|
||||
self["cornerradius"] = val
|
||||
|
||||
@property
|
||||
def line(self):
|
||||
"""
|
||||
The 'line' property is an instance of Line
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.bar.marker.Line`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Line constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.bar.marker.Line
|
||||
"""
|
||||
return self["line"]
|
||||
|
||||
@line.setter
|
||||
def line(self, val):
|
||||
self["line"] = val
|
||||
|
||||
@property
|
||||
def opacity(self):
|
||||
"""
|
||||
Sets the opacity of the bars.
|
||||
|
||||
The 'opacity' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["opacity"]
|
||||
|
||||
@opacity.setter
|
||||
def opacity(self, val):
|
||||
self["opacity"] = val
|
||||
|
||||
@property
|
||||
def opacitysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `opacity`.
|
||||
|
||||
The 'opacitysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["opacitysrc"]
|
||||
|
||||
@opacitysrc.setter
|
||||
def opacitysrc(self, val):
|
||||
self["opacitysrc"] = val
|
||||
|
||||
@property
|
||||
def pattern(self):
|
||||
"""
|
||||
Sets the pattern within the marker.
|
||||
|
||||
The 'pattern' property is an instance of Pattern
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.bar.marker.Pattern`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Pattern constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.bar.marker.Pattern
|
||||
"""
|
||||
return self["pattern"]
|
||||
|
||||
@pattern.setter
|
||||
def pattern(self, val):
|
||||
self["pattern"] = val
|
||||
|
||||
@property
|
||||
def reversescale(self):
|
||||
"""
|
||||
Reverses the color mapping if true. Has an effect only if in
|
||||
`marker.color` is set to a numerical array. If true,
|
||||
`marker.cmin` will correspond to the last color in the array
|
||||
and `marker.cmax` will correspond to the first color.
|
||||
|
||||
The 'reversescale' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["reversescale"]
|
||||
|
||||
@reversescale.setter
|
||||
def reversescale(self, val):
|
||||
self["reversescale"] = val
|
||||
|
||||
@property
|
||||
def showscale(self):
|
||||
"""
|
||||
Determines whether or not a colorbar is displayed for this
|
||||
trace. Has an effect only if in `marker.color` is set to a
|
||||
numerical array.
|
||||
|
||||
The 'showscale' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["showscale"]
|
||||
|
||||
@showscale.setter
|
||||
def showscale(self, val):
|
||||
self["showscale"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
autocolorscale
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`marker.colorscale`. Has an effect only if in
|
||||
`marker.color` is set to a numerical array. In case
|
||||
`colorscale` is unspecified or `autocolorscale` is
|
||||
true, the default palette will be chosen according to
|
||||
whether numbers in the `color` array are all positive,
|
||||
all negative or mixed.
|
||||
cauto
|
||||
Determines whether or not the color domain is computed
|
||||
with respect to the input data (here in `marker.color`)
|
||||
or the bounds set in `marker.cmin` and `marker.cmax`
|
||||
Has an effect only if in `marker.color` is set to a
|
||||
numerical array. Defaults to `false` when `marker.cmin`
|
||||
and `marker.cmax` are set by the user.
|
||||
cmax
|
||||
Sets the upper bound of the color domain. Has an effect
|
||||
only if in `marker.color` is set to a numerical array.
|
||||
Value should have the same units as in `marker.color`
|
||||
and if set, `marker.cmin` must be set as well.
|
||||
cmid
|
||||
Sets the mid-point of the color domain by scaling
|
||||
`marker.cmin` and/or `marker.cmax` to be equidistant to
|
||||
this point. Has an effect only if in `marker.color` is
|
||||
set to a numerical array. Value should have the same
|
||||
units as in `marker.color`. Has no effect when
|
||||
`marker.cauto` is `false`.
|
||||
cmin
|
||||
Sets the lower bound of the color domain. Has an effect
|
||||
only if in `marker.color` is set to a numerical array.
|
||||
Value should have the same units as in `marker.color`
|
||||
and if set, `marker.cmax` must be set as well.
|
||||
color
|
||||
Sets the marker color. It accepts either a specific
|
||||
color or an array of numbers that are mapped to the
|
||||
colorscale relative to the max and min values of the
|
||||
array or relative to `marker.cmin` and `marker.cmax` if
|
||||
set.
|
||||
coloraxis
|
||||
Sets a reference to a shared color axis. References to
|
||||
these shared color axes are "coloraxis", "coloraxis2",
|
||||
"coloraxis3", etc. Settings for these shared color axes
|
||||
are set in the layout, under `layout.coloraxis`,
|
||||
`layout.coloraxis2`, etc. Note that multiple color
|
||||
scales can be linked to the same color axis.
|
||||
colorbar
|
||||
:class:`plotly.graph_objects.bar.marker.ColorBar`
|
||||
instance or dict with compatible properties
|
||||
colorscale
|
||||
Sets the colorscale. Has an effect only if in
|
||||
`marker.color` is set to a numerical array. The
|
||||
colorscale must be an array containing arrays mapping a
|
||||
normalized value to an rgb, rgba, hex, hsl, hsv, or
|
||||
named color string. At minimum, a mapping for the
|
||||
lowest (0) and highest (1) values are required. For
|
||||
example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
|
||||
To control the bounds of the colorscale in color space,
|
||||
use `marker.cmin` and `marker.cmax`. Alternatively,
|
||||
`colorscale` may be a palette name string of the
|
||||
following list: Blackbody,Bluered,Blues,Cividis,Earth,E
|
||||
lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
|
||||
Bu,Reds,Viridis,YlGnBu,YlOrRd.
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
cornerradius
|
||||
Sets the rounding of corners. May be an integer number
|
||||
of pixels, or a percentage of bar width (as a string
|
||||
ending in %). Defaults to `layout.barcornerradius`. In
|
||||
stack or relative barmode, the first trace to set
|
||||
cornerradius is used for the whole stack.
|
||||
line
|
||||
:class:`plotly.graph_objects.bar.marker.Line` instance
|
||||
or dict with compatible properties
|
||||
opacity
|
||||
Sets the opacity of the bars.
|
||||
opacitysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`opacity`.
|
||||
pattern
|
||||
Sets the pattern within the marker.
|
||||
reversescale
|
||||
Reverses the color mapping if true. Has an effect only
|
||||
if in `marker.color` is set to a numerical array. If
|
||||
true, `marker.cmin` will correspond to the last color
|
||||
in the array and `marker.cmax` will correspond to the
|
||||
first color.
|
||||
showscale
|
||||
Determines whether or not a colorbar is displayed for
|
||||
this trace. Has an effect only if in `marker.color` is
|
||||
set to a numerical array.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
autocolorscale=None,
|
||||
cauto=None,
|
||||
cmax=None,
|
||||
cmid=None,
|
||||
cmin=None,
|
||||
color=None,
|
||||
coloraxis=None,
|
||||
colorbar=None,
|
||||
colorscale=None,
|
||||
colorsrc=None,
|
||||
cornerradius=None,
|
||||
line=None,
|
||||
opacity=None,
|
||||
opacitysrc=None,
|
||||
pattern=None,
|
||||
reversescale=None,
|
||||
showscale=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Marker object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.bar.Marker`
|
||||
autocolorscale
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`marker.colorscale`. Has an effect only if in
|
||||
`marker.color` is set to a numerical array. In case
|
||||
`colorscale` is unspecified or `autocolorscale` is
|
||||
true, the default palette will be chosen according to
|
||||
whether numbers in the `color` array are all positive,
|
||||
all negative or mixed.
|
||||
cauto
|
||||
Determines whether or not the color domain is computed
|
||||
with respect to the input data (here in `marker.color`)
|
||||
or the bounds set in `marker.cmin` and `marker.cmax`
|
||||
Has an effect only if in `marker.color` is set to a
|
||||
numerical array. Defaults to `false` when `marker.cmin`
|
||||
and `marker.cmax` are set by the user.
|
||||
cmax
|
||||
Sets the upper bound of the color domain. Has an effect
|
||||
only if in `marker.color` is set to a numerical array.
|
||||
Value should have the same units as in `marker.color`
|
||||
and if set, `marker.cmin` must be set as well.
|
||||
cmid
|
||||
Sets the mid-point of the color domain by scaling
|
||||
`marker.cmin` and/or `marker.cmax` to be equidistant to
|
||||
this point. Has an effect only if in `marker.color` is
|
||||
set to a numerical array. Value should have the same
|
||||
units as in `marker.color`. Has no effect when
|
||||
`marker.cauto` is `false`.
|
||||
cmin
|
||||
Sets the lower bound of the color domain. Has an effect
|
||||
only if in `marker.color` is set to a numerical array.
|
||||
Value should have the same units as in `marker.color`
|
||||
and if set, `marker.cmax` must be set as well.
|
||||
color
|
||||
Sets the marker color. It accepts either a specific
|
||||
color or an array of numbers that are mapped to the
|
||||
colorscale relative to the max and min values of the
|
||||
array or relative to `marker.cmin` and `marker.cmax` if
|
||||
set.
|
||||
coloraxis
|
||||
Sets a reference to a shared color axis. References to
|
||||
these shared color axes are "coloraxis", "coloraxis2",
|
||||
"coloraxis3", etc. Settings for these shared color axes
|
||||
are set in the layout, under `layout.coloraxis`,
|
||||
`layout.coloraxis2`, etc. Note that multiple color
|
||||
scales can be linked to the same color axis.
|
||||
colorbar
|
||||
:class:`plotly.graph_objects.bar.marker.ColorBar`
|
||||
instance or dict with compatible properties
|
||||
colorscale
|
||||
Sets the colorscale. Has an effect only if in
|
||||
`marker.color` is set to a numerical array. The
|
||||
colorscale must be an array containing arrays mapping a
|
||||
normalized value to an rgb, rgba, hex, hsl, hsv, or
|
||||
named color string. At minimum, a mapping for the
|
||||
lowest (0) and highest (1) values are required. For
|
||||
example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
|
||||
To control the bounds of the colorscale in color space,
|
||||
use `marker.cmin` and `marker.cmax`. Alternatively,
|
||||
`colorscale` may be a palette name string of the
|
||||
following list: Blackbody,Bluered,Blues,Cividis,Earth,E
|
||||
lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
|
||||
Bu,Reds,Viridis,YlGnBu,YlOrRd.
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
cornerradius
|
||||
Sets the rounding of corners. May be an integer number
|
||||
of pixels, or a percentage of bar width (as a string
|
||||
ending in %). Defaults to `layout.barcornerradius`. In
|
||||
stack or relative barmode, the first trace to set
|
||||
cornerradius is used for the whole stack.
|
||||
line
|
||||
:class:`plotly.graph_objects.bar.marker.Line` instance
|
||||
or dict with compatible properties
|
||||
opacity
|
||||
Sets the opacity of the bars.
|
||||
opacitysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`opacity`.
|
||||
pattern
|
||||
Sets the pattern within the marker.
|
||||
reversescale
|
||||
Reverses the color mapping if true. Has an effect only
|
||||
if in `marker.color` is set to a numerical array. If
|
||||
true, `marker.cmin` will correspond to the last color
|
||||
in the array and `marker.cmax` will correspond to the
|
||||
first color.
|
||||
showscale
|
||||
Determines whether or not a colorbar is displayed for
|
||||
this trace. Has an effect only if in `marker.color` is
|
||||
set to a numerical array.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Marker
|
||||
"""
|
||||
super().__init__("marker")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.Marker
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.Marker`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("autocolorscale", arg, autocolorscale)
|
||||
self._set_property("cauto", arg, cauto)
|
||||
self._set_property("cmax", arg, cmax)
|
||||
self._set_property("cmid", arg, cmid)
|
||||
self._set_property("cmin", arg, cmin)
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("coloraxis", arg, coloraxis)
|
||||
self._set_property("colorbar", arg, colorbar)
|
||||
self._set_property("colorscale", arg, colorscale)
|
||||
self._set_property("colorsrc", arg, colorsrc)
|
||||
self._set_property("cornerradius", arg, cornerradius)
|
||||
self._set_property("line", arg, line)
|
||||
self._set_property("opacity", arg, opacity)
|
||||
self._set_property("opacitysrc", arg, opacitysrc)
|
||||
self._set_property("pattern", arg, pattern)
|
||||
self._set_property("reversescale", arg, reversescale)
|
||||
self._set_property("showscale", arg, showscale)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,587 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Outsidetextfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar"
|
||||
_path_str = "bar.outsidetextfont"
|
||||
_valid_props = {
|
||||
"color",
|
||||
"colorsrc",
|
||||
"family",
|
||||
"familysrc",
|
||||
"lineposition",
|
||||
"linepositionsrc",
|
||||
"shadow",
|
||||
"shadowsrc",
|
||||
"size",
|
||||
"sizesrc",
|
||||
"style",
|
||||
"stylesrc",
|
||||
"textcase",
|
||||
"textcasesrc",
|
||||
"variant",
|
||||
"variantsrc",
|
||||
"weight",
|
||||
"weightsrc",
|
||||
}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def colorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `color`.
|
||||
|
||||
The 'colorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["colorsrc"]
|
||||
|
||||
@colorsrc.setter
|
||||
def colorsrc(self, val):
|
||||
self["colorsrc"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser can only apply a font if it is
|
||||
available on the system where it runs. Provide multiple font
|
||||
families, separated by commas, to indicate the order in which
|
||||
to apply fonts if they aren't available.
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def familysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `family`.
|
||||
|
||||
The 'familysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["familysrc"]
|
||||
|
||||
@familysrc.setter
|
||||
def familysrc(self, val):
|
||||
self["familysrc"] = val
|
||||
|
||||
@property
|
||||
def lineposition(self):
|
||||
"""
|
||||
Sets the kind of decoration line(s) with text, such as an
|
||||
"under", "over" or "through" as well as combinations e.g.
|
||||
"under+over", etc.
|
||||
|
||||
The 'lineposition' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['under', 'over', 'through'] joined with '+' characters
|
||||
(e.g. 'under+over')
|
||||
OR exactly one of ['none'] (e.g. 'none')
|
||||
- A list or array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["lineposition"]
|
||||
|
||||
@lineposition.setter
|
||||
def lineposition(self, val):
|
||||
self["lineposition"] = val
|
||||
|
||||
@property
|
||||
def linepositionsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
|
||||
The 'linepositionsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["linepositionsrc"]
|
||||
|
||||
@linepositionsrc.setter
|
||||
def linepositionsrc(self, val):
|
||||
self["linepositionsrc"] = val
|
||||
|
||||
@property
|
||||
def shadow(self):
|
||||
"""
|
||||
Sets the shape and color of the shadow behind text. "auto"
|
||||
places minimal shadow and applies contrast text font color. See
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
|
||||
for additional options.
|
||||
|
||||
The 'shadow' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["shadow"]
|
||||
|
||||
@shadow.setter
|
||||
def shadow(self, val):
|
||||
self["shadow"] = val
|
||||
|
||||
@property
|
||||
def shadowsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `shadow`.
|
||||
|
||||
The 'shadowsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shadowsrc"]
|
||||
|
||||
@shadowsrc.setter
|
||||
def shadowsrc(self, val):
|
||||
self["shadowsrc"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def sizesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `size`.
|
||||
|
||||
The 'sizesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["sizesrc"]
|
||||
|
||||
@sizesrc.setter
|
||||
def sizesrc(self, val):
|
||||
self["sizesrc"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
Sets whether a font should be styled with a normal or italic
|
||||
face from its family.
|
||||
|
||||
The 'style' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'italic']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def stylesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `style`.
|
||||
|
||||
The 'stylesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["stylesrc"]
|
||||
|
||||
@stylesrc.setter
|
||||
def stylesrc(self, val):
|
||||
self["stylesrc"] = val
|
||||
|
||||
@property
|
||||
def textcase(self):
|
||||
"""
|
||||
Sets capitalization of text. It can be used to make text appear
|
||||
in all-uppercase or all-lowercase, or with each word
|
||||
capitalized.
|
||||
|
||||
The 'textcase' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'word caps', 'upper', 'lower']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["textcase"]
|
||||
|
||||
@textcase.setter
|
||||
def textcase(self, val):
|
||||
self["textcase"] = val
|
||||
|
||||
@property
|
||||
def textcasesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `textcase`.
|
||||
|
||||
The 'textcasesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["textcasesrc"]
|
||||
|
||||
@textcasesrc.setter
|
||||
def textcasesrc(self, val):
|
||||
self["textcasesrc"] = val
|
||||
|
||||
@property
|
||||
def variant(self):
|
||||
"""
|
||||
Sets the variant of the font.
|
||||
|
||||
The 'variant' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'small-caps', 'all-small-caps',
|
||||
'all-petite-caps', 'petite-caps', 'unicase']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["variant"]
|
||||
|
||||
@variant.setter
|
||||
def variant(self, val):
|
||||
self["variant"] = val
|
||||
|
||||
@property
|
||||
def variantsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `variant`.
|
||||
|
||||
The 'variantsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["variantsrc"]
|
||||
|
||||
@variantsrc.setter
|
||||
def variantsrc(self, val):
|
||||
self["variantsrc"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
The 'weight' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [1, 1000]
|
||||
OR exactly one of ['normal', 'bold'] (e.g. 'bold')
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|numpy.ndarray
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def weightsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `weight`.
|
||||
|
||||
The 'weightsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["weightsrc"]
|
||||
|
||||
@weightsrc.setter
|
||||
def weightsrc(self, val):
|
||||
self["weightsrc"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
familysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`family`.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
linepositionsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
shadowsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shadow`.
|
||||
size
|
||||
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
stylesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`style`.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
textcasesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`textcase`.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
variantsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`variant`.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
weightsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`weight`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
colorsrc=None,
|
||||
family=None,
|
||||
familysrc=None,
|
||||
lineposition=None,
|
||||
linepositionsrc=None,
|
||||
shadow=None,
|
||||
shadowsrc=None,
|
||||
size=None,
|
||||
sizesrc=None,
|
||||
style=None,
|
||||
stylesrc=None,
|
||||
textcase=None,
|
||||
textcasesrc=None,
|
||||
variant=None,
|
||||
variantsrc=None,
|
||||
weight=None,
|
||||
weightsrc=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Outsidetextfont object
|
||||
|
||||
Sets the font used for `text` lying outside the bar.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.bar.Outsidetextfont`
|
||||
color
|
||||
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
familysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`family`.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
linepositionsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
shadowsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shadow`.
|
||||
size
|
||||
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
stylesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`style`.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
textcasesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`textcase`.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
variantsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`variant`.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
weightsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`weight`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Outsidetextfont
|
||||
"""
|
||||
super().__init__("outsidetextfont")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.Outsidetextfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.Outsidetextfont`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("colorsrc", arg, colorsrc)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("familysrc", arg, familysrc)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("linepositionsrc", arg, linepositionsrc)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("shadowsrc", arg, shadowsrc)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("sizesrc", arg, sizesrc)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("stylesrc", arg, stylesrc)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("textcasesrc", arg, textcasesrc)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("variantsrc", arg, variantsrc)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._set_property("weightsrc", arg, weightsrc)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
105
lib/python3.11/site-packages/plotly/graph_objs/bar/_selected.py
Normal file
105
lib/python3.11/site-packages/plotly/graph_objs/bar/_selected.py
Normal file
@ -0,0 +1,105 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Selected(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar"
|
||||
_path_str = "bar.selected"
|
||||
_valid_props = {"marker", "textfont"}
|
||||
|
||||
@property
|
||||
def marker(self):
|
||||
"""
|
||||
The 'marker' property is an instance of Marker
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.bar.selected.Marker`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Marker constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.bar.selected.Marker
|
||||
"""
|
||||
return self["marker"]
|
||||
|
||||
@marker.setter
|
||||
def marker(self, val):
|
||||
self["marker"] = val
|
||||
|
||||
@property
|
||||
def textfont(self):
|
||||
"""
|
||||
The 'textfont' property is an instance of Textfont
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.bar.selected.Textfont`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Textfont constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.bar.selected.Textfont
|
||||
"""
|
||||
return self["textfont"]
|
||||
|
||||
@textfont.setter
|
||||
def textfont(self, val):
|
||||
self["textfont"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
marker
|
||||
:class:`plotly.graph_objects.bar.selected.Marker`
|
||||
instance or dict with compatible properties
|
||||
textfont
|
||||
:class:`plotly.graph_objects.bar.selected.Textfont`
|
||||
instance or dict with compatible properties
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
|
||||
"""
|
||||
Construct a new Selected object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.bar.Selected`
|
||||
marker
|
||||
:class:`plotly.graph_objects.bar.selected.Marker`
|
||||
instance or dict with compatible properties
|
||||
textfont
|
||||
:class:`plotly.graph_objects.bar.selected.Textfont`
|
||||
instance or dict with compatible properties
|
||||
|
||||
Returns
|
||||
-------
|
||||
Selected
|
||||
"""
|
||||
super().__init__("selected")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.Selected
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.Selected`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("marker", arg, marker)
|
||||
self._set_property("textfont", arg, textfont)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
113
lib/python3.11/site-packages/plotly/graph_objs/bar/_stream.py
Normal file
113
lib/python3.11/site-packages/plotly/graph_objs/bar/_stream.py
Normal file
@ -0,0 +1,113 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Stream(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar"
|
||||
_path_str = "bar.stream"
|
||||
_valid_props = {"maxpoints", "token"}
|
||||
|
||||
@property
|
||||
def maxpoints(self):
|
||||
"""
|
||||
Sets the maximum number of points to keep on the plots from an
|
||||
incoming stream. If `maxpoints` is set to 50, only the newest
|
||||
50 points will be displayed on the plot.
|
||||
|
||||
The 'maxpoints' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 10000]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["maxpoints"]
|
||||
|
||||
@maxpoints.setter
|
||||
def maxpoints(self, val):
|
||||
self["maxpoints"] = val
|
||||
|
||||
@property
|
||||
def token(self):
|
||||
"""
|
||||
The stream id number links a data trace on a plot with a
|
||||
stream. See https://chart-studio.plotly.com/settings for more
|
||||
details.
|
||||
|
||||
The 'token' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["token"]
|
||||
|
||||
@token.setter
|
||||
def token(self, val):
|
||||
self["token"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
maxpoints
|
||||
Sets the maximum number of points to keep on the plots
|
||||
from an incoming stream. If `maxpoints` is set to 50,
|
||||
only the newest 50 points will be displayed on the
|
||||
plot.
|
||||
token
|
||||
The stream id number links a data trace on a plot with
|
||||
a stream. See https://chart-studio.plotly.com/settings
|
||||
for more details.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
|
||||
"""
|
||||
Construct a new Stream object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.bar.Stream`
|
||||
maxpoints
|
||||
Sets the maximum number of points to keep on the plots
|
||||
from an incoming stream. If `maxpoints` is set to 50,
|
||||
only the newest 50 points will be displayed on the
|
||||
plot.
|
||||
token
|
||||
The stream id number links a data trace on a plot with
|
||||
a stream. See https://chart-studio.plotly.com/settings
|
||||
for more details.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Stream
|
||||
"""
|
||||
super().__init__("stream")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.Stream
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.Stream`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("maxpoints", arg, maxpoints)
|
||||
self._set_property("token", arg, token)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
586
lib/python3.11/site-packages/plotly/graph_objs/bar/_textfont.py
Normal file
586
lib/python3.11/site-packages/plotly/graph_objs/bar/_textfont.py
Normal file
@ -0,0 +1,586 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Textfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar"
|
||||
_path_str = "bar.textfont"
|
||||
_valid_props = {
|
||||
"color",
|
||||
"colorsrc",
|
||||
"family",
|
||||
"familysrc",
|
||||
"lineposition",
|
||||
"linepositionsrc",
|
||||
"shadow",
|
||||
"shadowsrc",
|
||||
"size",
|
||||
"sizesrc",
|
||||
"style",
|
||||
"stylesrc",
|
||||
"textcase",
|
||||
"textcasesrc",
|
||||
"variant",
|
||||
"variantsrc",
|
||||
"weight",
|
||||
"weightsrc",
|
||||
}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def colorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `color`.
|
||||
|
||||
The 'colorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["colorsrc"]
|
||||
|
||||
@colorsrc.setter
|
||||
def colorsrc(self, val):
|
||||
self["colorsrc"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser can only apply a font if it is
|
||||
available on the system where it runs. Provide multiple font
|
||||
families, separated by commas, to indicate the order in which
|
||||
to apply fonts if they aren't available.
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def familysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `family`.
|
||||
|
||||
The 'familysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["familysrc"]
|
||||
|
||||
@familysrc.setter
|
||||
def familysrc(self, val):
|
||||
self["familysrc"] = val
|
||||
|
||||
@property
|
||||
def lineposition(self):
|
||||
"""
|
||||
Sets the kind of decoration line(s) with text, such as an
|
||||
"under", "over" or "through" as well as combinations e.g.
|
||||
"under+over", etc.
|
||||
|
||||
The 'lineposition' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['under', 'over', 'through'] joined with '+' characters
|
||||
(e.g. 'under+over')
|
||||
OR exactly one of ['none'] (e.g. 'none')
|
||||
- A list or array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["lineposition"]
|
||||
|
||||
@lineposition.setter
|
||||
def lineposition(self, val):
|
||||
self["lineposition"] = val
|
||||
|
||||
@property
|
||||
def linepositionsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
|
||||
The 'linepositionsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["linepositionsrc"]
|
||||
|
||||
@linepositionsrc.setter
|
||||
def linepositionsrc(self, val):
|
||||
self["linepositionsrc"] = val
|
||||
|
||||
@property
|
||||
def shadow(self):
|
||||
"""
|
||||
Sets the shape and color of the shadow behind text. "auto"
|
||||
places minimal shadow and applies contrast text font color. See
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
|
||||
for additional options.
|
||||
|
||||
The 'shadow' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["shadow"]
|
||||
|
||||
@shadow.setter
|
||||
def shadow(self, val):
|
||||
self["shadow"] = val
|
||||
|
||||
@property
|
||||
def shadowsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `shadow`.
|
||||
|
||||
The 'shadowsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shadowsrc"]
|
||||
|
||||
@shadowsrc.setter
|
||||
def shadowsrc(self, val):
|
||||
self["shadowsrc"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def sizesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `size`.
|
||||
|
||||
The 'sizesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["sizesrc"]
|
||||
|
||||
@sizesrc.setter
|
||||
def sizesrc(self, val):
|
||||
self["sizesrc"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
Sets whether a font should be styled with a normal or italic
|
||||
face from its family.
|
||||
|
||||
The 'style' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'italic']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def stylesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `style`.
|
||||
|
||||
The 'stylesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["stylesrc"]
|
||||
|
||||
@stylesrc.setter
|
||||
def stylesrc(self, val):
|
||||
self["stylesrc"] = val
|
||||
|
||||
@property
|
||||
def textcase(self):
|
||||
"""
|
||||
Sets capitalization of text. It can be used to make text appear
|
||||
in all-uppercase or all-lowercase, or with each word
|
||||
capitalized.
|
||||
|
||||
The 'textcase' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'word caps', 'upper', 'lower']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["textcase"]
|
||||
|
||||
@textcase.setter
|
||||
def textcase(self, val):
|
||||
self["textcase"] = val
|
||||
|
||||
@property
|
||||
def textcasesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `textcase`.
|
||||
|
||||
The 'textcasesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["textcasesrc"]
|
||||
|
||||
@textcasesrc.setter
|
||||
def textcasesrc(self, val):
|
||||
self["textcasesrc"] = val
|
||||
|
||||
@property
|
||||
def variant(self):
|
||||
"""
|
||||
Sets the variant of the font.
|
||||
|
||||
The 'variant' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'small-caps', 'all-small-caps',
|
||||
'all-petite-caps', 'petite-caps', 'unicase']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["variant"]
|
||||
|
||||
@variant.setter
|
||||
def variant(self, val):
|
||||
self["variant"] = val
|
||||
|
||||
@property
|
||||
def variantsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `variant`.
|
||||
|
||||
The 'variantsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["variantsrc"]
|
||||
|
||||
@variantsrc.setter
|
||||
def variantsrc(self, val):
|
||||
self["variantsrc"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
The 'weight' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [1, 1000]
|
||||
OR exactly one of ['normal', 'bold'] (e.g. 'bold')
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|numpy.ndarray
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def weightsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `weight`.
|
||||
|
||||
The 'weightsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["weightsrc"]
|
||||
|
||||
@weightsrc.setter
|
||||
def weightsrc(self, val):
|
||||
self["weightsrc"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
familysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`family`.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
linepositionsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
shadowsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shadow`.
|
||||
size
|
||||
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
stylesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`style`.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
textcasesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`textcase`.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
variantsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`variant`.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
weightsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`weight`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
colorsrc=None,
|
||||
family=None,
|
||||
familysrc=None,
|
||||
lineposition=None,
|
||||
linepositionsrc=None,
|
||||
shadow=None,
|
||||
shadowsrc=None,
|
||||
size=None,
|
||||
sizesrc=None,
|
||||
style=None,
|
||||
stylesrc=None,
|
||||
textcase=None,
|
||||
textcasesrc=None,
|
||||
variant=None,
|
||||
variantsrc=None,
|
||||
weight=None,
|
||||
weightsrc=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Textfont object
|
||||
|
||||
Sets the font used for `text`.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.bar.Textfont`
|
||||
color
|
||||
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
familysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`family`.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
linepositionsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
shadowsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shadow`.
|
||||
size
|
||||
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
stylesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`style`.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
textcasesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`textcase`.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
variantsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`variant`.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
weightsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`weight`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Textfont
|
||||
"""
|
||||
super().__init__("textfont")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.Textfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.Textfont`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("colorsrc", arg, colorsrc)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("familysrc", arg, familysrc)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("linepositionsrc", arg, linepositionsrc)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("shadowsrc", arg, shadowsrc)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("sizesrc", arg, sizesrc)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("stylesrc", arg, stylesrc)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("textcasesrc", arg, textcasesrc)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("variantsrc", arg, variantsrc)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._set_property("weightsrc", arg, weightsrc)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,106 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Unselected(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar"
|
||||
_path_str = "bar.unselected"
|
||||
_valid_props = {"marker", "textfont"}
|
||||
|
||||
@property
|
||||
def marker(self):
|
||||
"""
|
||||
The 'marker' property is an instance of Marker
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.bar.unselected.Marker`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Marker constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.bar.unselected.Marker
|
||||
"""
|
||||
return self["marker"]
|
||||
|
||||
@marker.setter
|
||||
def marker(self, val):
|
||||
self["marker"] = val
|
||||
|
||||
@property
|
||||
def textfont(self):
|
||||
"""
|
||||
The 'textfont' property is an instance of Textfont
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.bar.unselected.Textfont`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Textfont constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.bar.unselected.Textfont
|
||||
"""
|
||||
return self["textfont"]
|
||||
|
||||
@textfont.setter
|
||||
def textfont(self, val):
|
||||
self["textfont"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
marker
|
||||
:class:`plotly.graph_objects.bar.unselected.Marker`
|
||||
instance or dict with compatible properties
|
||||
textfont
|
||||
:class:`plotly.graph_objects.bar.unselected.Textfont`
|
||||
instance or dict with compatible properties
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
|
||||
"""
|
||||
Construct a new Unselected object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.bar.Unselected`
|
||||
marker
|
||||
:class:`plotly.graph_objects.bar.unselected.Marker`
|
||||
instance or dict with compatible properties
|
||||
textfont
|
||||
:class:`plotly.graph_objects.bar.unselected.Textfont`
|
||||
instance or dict with compatible properties
|
||||
|
||||
Returns
|
||||
-------
|
||||
Unselected
|
||||
"""
|
||||
super().__init__("unselected")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.Unselected
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.Unselected`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("marker", arg, marker)
|
||||
self._set_property("textfont", arg, textfont)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,9 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._font import Font
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"])
|
||||
@ -0,0 +1,587 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar.hoverlabel"
|
||||
_path_str = "bar.hoverlabel.font"
|
||||
_valid_props = {
|
||||
"color",
|
||||
"colorsrc",
|
||||
"family",
|
||||
"familysrc",
|
||||
"lineposition",
|
||||
"linepositionsrc",
|
||||
"shadow",
|
||||
"shadowsrc",
|
||||
"size",
|
||||
"sizesrc",
|
||||
"style",
|
||||
"stylesrc",
|
||||
"textcase",
|
||||
"textcasesrc",
|
||||
"variant",
|
||||
"variantsrc",
|
||||
"weight",
|
||||
"weightsrc",
|
||||
}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def colorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `color`.
|
||||
|
||||
The 'colorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["colorsrc"]
|
||||
|
||||
@colorsrc.setter
|
||||
def colorsrc(self, val):
|
||||
self["colorsrc"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser can only apply a font if it is
|
||||
available on the system where it runs. Provide multiple font
|
||||
families, separated by commas, to indicate the order in which
|
||||
to apply fonts if they aren't available.
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def familysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `family`.
|
||||
|
||||
The 'familysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["familysrc"]
|
||||
|
||||
@familysrc.setter
|
||||
def familysrc(self, val):
|
||||
self["familysrc"] = val
|
||||
|
||||
@property
|
||||
def lineposition(self):
|
||||
"""
|
||||
Sets the kind of decoration line(s) with text, such as an
|
||||
"under", "over" or "through" as well as combinations e.g.
|
||||
"under+over", etc.
|
||||
|
||||
The 'lineposition' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['under', 'over', 'through'] joined with '+' characters
|
||||
(e.g. 'under+over')
|
||||
OR exactly one of ['none'] (e.g. 'none')
|
||||
- A list or array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["lineposition"]
|
||||
|
||||
@lineposition.setter
|
||||
def lineposition(self, val):
|
||||
self["lineposition"] = val
|
||||
|
||||
@property
|
||||
def linepositionsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
|
||||
The 'linepositionsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["linepositionsrc"]
|
||||
|
||||
@linepositionsrc.setter
|
||||
def linepositionsrc(self, val):
|
||||
self["linepositionsrc"] = val
|
||||
|
||||
@property
|
||||
def shadow(self):
|
||||
"""
|
||||
Sets the shape and color of the shadow behind text. "auto"
|
||||
places minimal shadow and applies contrast text font color. See
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
|
||||
for additional options.
|
||||
|
||||
The 'shadow' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["shadow"]
|
||||
|
||||
@shadow.setter
|
||||
def shadow(self, val):
|
||||
self["shadow"] = val
|
||||
|
||||
@property
|
||||
def shadowsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `shadow`.
|
||||
|
||||
The 'shadowsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shadowsrc"]
|
||||
|
||||
@shadowsrc.setter
|
||||
def shadowsrc(self, val):
|
||||
self["shadowsrc"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def sizesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `size`.
|
||||
|
||||
The 'sizesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["sizesrc"]
|
||||
|
||||
@sizesrc.setter
|
||||
def sizesrc(self, val):
|
||||
self["sizesrc"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
Sets whether a font should be styled with a normal or italic
|
||||
face from its family.
|
||||
|
||||
The 'style' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'italic']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def stylesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `style`.
|
||||
|
||||
The 'stylesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["stylesrc"]
|
||||
|
||||
@stylesrc.setter
|
||||
def stylesrc(self, val):
|
||||
self["stylesrc"] = val
|
||||
|
||||
@property
|
||||
def textcase(self):
|
||||
"""
|
||||
Sets capitalization of text. It can be used to make text appear
|
||||
in all-uppercase or all-lowercase, or with each word
|
||||
capitalized.
|
||||
|
||||
The 'textcase' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'word caps', 'upper', 'lower']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["textcase"]
|
||||
|
||||
@textcase.setter
|
||||
def textcase(self, val):
|
||||
self["textcase"] = val
|
||||
|
||||
@property
|
||||
def textcasesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `textcase`.
|
||||
|
||||
The 'textcasesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["textcasesrc"]
|
||||
|
||||
@textcasesrc.setter
|
||||
def textcasesrc(self, val):
|
||||
self["textcasesrc"] = val
|
||||
|
||||
@property
|
||||
def variant(self):
|
||||
"""
|
||||
Sets the variant of the font.
|
||||
|
||||
The 'variant' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'small-caps', 'all-small-caps',
|
||||
'all-petite-caps', 'petite-caps', 'unicase']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["variant"]
|
||||
|
||||
@variant.setter
|
||||
def variant(self, val):
|
||||
self["variant"] = val
|
||||
|
||||
@property
|
||||
def variantsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `variant`.
|
||||
|
||||
The 'variantsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["variantsrc"]
|
||||
|
||||
@variantsrc.setter
|
||||
def variantsrc(self, val):
|
||||
self["variantsrc"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
The 'weight' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [1, 1000]
|
||||
OR exactly one of ['normal', 'bold'] (e.g. 'bold')
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|numpy.ndarray
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def weightsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `weight`.
|
||||
|
||||
The 'weightsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["weightsrc"]
|
||||
|
||||
@weightsrc.setter
|
||||
def weightsrc(self, val):
|
||||
self["weightsrc"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
familysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`family`.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
linepositionsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
shadowsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shadow`.
|
||||
size
|
||||
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
stylesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`style`.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
textcasesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`textcase`.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
variantsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`variant`.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
weightsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`weight`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
colorsrc=None,
|
||||
family=None,
|
||||
familysrc=None,
|
||||
lineposition=None,
|
||||
linepositionsrc=None,
|
||||
shadow=None,
|
||||
shadowsrc=None,
|
||||
size=None,
|
||||
sizesrc=None,
|
||||
style=None,
|
||||
stylesrc=None,
|
||||
textcase=None,
|
||||
textcasesrc=None,
|
||||
variant=None,
|
||||
variantsrc=None,
|
||||
weight=None,
|
||||
weightsrc=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Font object
|
||||
|
||||
Sets the font used in hover labels.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.bar.hoverlabel.Font`
|
||||
color
|
||||
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
familysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`family`.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
linepositionsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
shadowsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shadow`.
|
||||
size
|
||||
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
stylesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`style`.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
textcasesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`textcase`.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
variantsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`variant`.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
weightsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`weight`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Font
|
||||
"""
|
||||
super().__init__("font")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.hoverlabel.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.hoverlabel.Font`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("colorsrc", arg, colorsrc)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("familysrc", arg, familysrc)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("linepositionsrc", arg, linepositionsrc)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("shadowsrc", arg, shadowsrc)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("sizesrc", arg, sizesrc)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("stylesrc", arg, stylesrc)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("textcasesrc", arg, textcasesrc)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("variantsrc", arg, variantsrc)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._set_property("weightsrc", arg, weightsrc)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,9 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._font import Font
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"])
|
||||
@ -0,0 +1,334 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar.legendgrouptitle"
|
||||
_path_str = "bar.legendgrouptitle.font"
|
||||
_valid_props = {
|
||||
"color",
|
||||
"family",
|
||||
"lineposition",
|
||||
"shadow",
|
||||
"size",
|
||||
"style",
|
||||
"textcase",
|
||||
"variant",
|
||||
"weight",
|
||||
}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser can only apply a font if it is
|
||||
available on the system where it runs. Provide multiple font
|
||||
families, separated by commas, to indicate the order in which
|
||||
to apply fonts if they aren't available.
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def lineposition(self):
|
||||
"""
|
||||
Sets the kind of decoration line(s) with text, such as an
|
||||
"under", "over" or "through" as well as combinations e.g.
|
||||
"under+over", etc.
|
||||
|
||||
The 'lineposition' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['under', 'over', 'through'] joined with '+' characters
|
||||
(e.g. 'under+over')
|
||||
OR exactly one of ['none'] (e.g. 'none')
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["lineposition"]
|
||||
|
||||
@lineposition.setter
|
||||
def lineposition(self, val):
|
||||
self["lineposition"] = val
|
||||
|
||||
@property
|
||||
def shadow(self):
|
||||
"""
|
||||
Sets the shape and color of the shadow behind text. "auto"
|
||||
places minimal shadow and applies contrast text font color. See
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
|
||||
for additional options.
|
||||
|
||||
The 'shadow' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shadow"]
|
||||
|
||||
@shadow.setter
|
||||
def shadow(self, val):
|
||||
self["shadow"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
Sets whether a font should be styled with a normal or italic
|
||||
face from its family.
|
||||
|
||||
The 'style' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'italic']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def textcase(self):
|
||||
"""
|
||||
Sets capitalization of text. It can be used to make text appear
|
||||
in all-uppercase or all-lowercase, or with each word
|
||||
capitalized.
|
||||
|
||||
The 'textcase' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'word caps', 'upper', 'lower']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["textcase"]
|
||||
|
||||
@textcase.setter
|
||||
def textcase(self, val):
|
||||
self["textcase"] = val
|
||||
|
||||
@property
|
||||
def variant(self):
|
||||
"""
|
||||
Sets the variant of the font.
|
||||
|
||||
The 'variant' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'small-caps', 'all-small-caps',
|
||||
'all-petite-caps', 'petite-caps', 'unicase']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["variant"]
|
||||
|
||||
@variant.setter
|
||||
def variant(self, val):
|
||||
self["variant"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
The 'weight' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [1, 1000]
|
||||
OR exactly one of ['normal', 'bold'] (e.g. 'bold')
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
family=None,
|
||||
lineposition=None,
|
||||
shadow=None,
|
||||
size=None,
|
||||
style=None,
|
||||
textcase=None,
|
||||
variant=None,
|
||||
weight=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Font object
|
||||
|
||||
Sets this legend group's title font.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.bar.legendgrouptitle.Font`
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Font
|
||||
"""
|
||||
super().__init__("font")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.legendgrouptitle.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.legendgrouptitle.Font`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,16 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._colorbar import ColorBar
|
||||
from ._line import Line
|
||||
from ._pattern import Pattern
|
||||
from . import colorbar
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".colorbar"],
|
||||
["._colorbar.ColorBar", "._line.Line", "._pattern.Pattern"],
|
||||
)
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,546 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Line(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar.marker"
|
||||
_path_str = "bar.marker.line"
|
||||
_valid_props = {
|
||||
"autocolorscale",
|
||||
"cauto",
|
||||
"cmax",
|
||||
"cmid",
|
||||
"cmin",
|
||||
"color",
|
||||
"coloraxis",
|
||||
"colorscale",
|
||||
"colorsrc",
|
||||
"reversescale",
|
||||
"width",
|
||||
"widthsrc",
|
||||
}
|
||||
|
||||
@property
|
||||
def autocolorscale(self):
|
||||
"""
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`marker.line.colorscale`. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. In case
|
||||
`colorscale` is unspecified or `autocolorscale` is true, the
|
||||
default palette will be chosen according to whether numbers in
|
||||
the `color` array are all positive, all negative or mixed.
|
||||
|
||||
The 'autocolorscale' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["autocolorscale"]
|
||||
|
||||
@autocolorscale.setter
|
||||
def autocolorscale(self, val):
|
||||
self["autocolorscale"] = val
|
||||
|
||||
@property
|
||||
def cauto(self):
|
||||
"""
|
||||
Determines whether or not the color domain is computed with
|
||||
respect to the input data (here in `marker.line.color`) or the
|
||||
bounds set in `marker.line.cmin` and `marker.line.cmax` Has an
|
||||
effect only if in `marker.line.color` is set to a numerical
|
||||
array. Defaults to `false` when `marker.line.cmin` and
|
||||
`marker.line.cmax` are set by the user.
|
||||
|
||||
The 'cauto' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["cauto"]
|
||||
|
||||
@cauto.setter
|
||||
def cauto(self, val):
|
||||
self["cauto"] = val
|
||||
|
||||
@property
|
||||
def cmax(self):
|
||||
"""
|
||||
Sets the upper bound of the color domain. Has an effect only if
|
||||
in `marker.line.color` is set to a numerical array. Value
|
||||
should have the same units as in `marker.line.color` and if
|
||||
set, `marker.line.cmin` must be set as well.
|
||||
|
||||
The 'cmax' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["cmax"]
|
||||
|
||||
@cmax.setter
|
||||
def cmax(self, val):
|
||||
self["cmax"] = val
|
||||
|
||||
@property
|
||||
def cmid(self):
|
||||
"""
|
||||
Sets the mid-point of the color domain by scaling
|
||||
`marker.line.cmin` and/or `marker.line.cmax` to be equidistant
|
||||
to this point. Has an effect only if in `marker.line.color` is
|
||||
set to a numerical array. Value should have the same units as
|
||||
in `marker.line.color`. Has no effect when `marker.line.cauto`
|
||||
is `false`.
|
||||
|
||||
The 'cmid' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["cmid"]
|
||||
|
||||
@cmid.setter
|
||||
def cmid(self, val):
|
||||
self["cmid"] = val
|
||||
|
||||
@property
|
||||
def cmin(self):
|
||||
"""
|
||||
Sets the lower bound of the color domain. Has an effect only if
|
||||
in `marker.line.color` is set to a numerical array. Value
|
||||
should have the same units as in `marker.line.color` and if
|
||||
set, `marker.line.cmax` must be set as well.
|
||||
|
||||
The 'cmin' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["cmin"]
|
||||
|
||||
@cmin.setter
|
||||
def cmin(self, val):
|
||||
self["cmin"] = val
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the marker.line color. It accepts either a specific color
|
||||
or an array of numbers that are mapped to the colorscale
|
||||
relative to the max and min values of the array or relative to
|
||||
`marker.line.cmin` and `marker.line.cmax` if set.
|
||||
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A number that will be interpreted as a color
|
||||
according to bar.marker.line.colorscale
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def coloraxis(self):
|
||||
"""
|
||||
Sets a reference to a shared color axis. References to these
|
||||
shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
|
||||
etc. Settings for these shared color axes are set in the
|
||||
layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
|
||||
Note that multiple color scales can be linked to the same color
|
||||
axis.
|
||||
|
||||
The 'coloraxis' property is an identifier of a particular
|
||||
subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
|
||||
optionally followed by an integer >= 1
|
||||
(e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["coloraxis"]
|
||||
|
||||
@coloraxis.setter
|
||||
def coloraxis(self, val):
|
||||
self["coloraxis"] = val
|
||||
|
||||
@property
|
||||
def colorscale(self):
|
||||
"""
|
||||
Sets the colorscale. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. The colorscale
|
||||
must be an array containing arrays mapping a normalized value
|
||||
to an rgb, rgba, hex, hsl, hsv, or named color string. At
|
||||
minimum, a mapping for the lowest (0) and highest (1) values
|
||||
are required. For example, `[[0, 'rgb(0,0,255)'], [1,
|
||||
'rgb(255,0,0)']]`. To control the bounds of the colorscale in
|
||||
color space, use `marker.line.cmin` and `marker.line.cmax`.
|
||||
Alternatively, `colorscale` may be a palette name string of the
|
||||
following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,
|
||||
Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,
|
||||
YlGnBu,YlOrRd.
|
||||
|
||||
The 'colorscale' property is a colorscale and may be
|
||||
specified as:
|
||||
- A list of colors that will be spaced evenly to create the colorscale.
|
||||
Many predefined colorscale lists are included in the sequential, diverging,
|
||||
and cyclical modules in the plotly.colors package.
|
||||
- A list of 2-element lists where the first element is the
|
||||
normalized color level value (starting at 0 and ending at 1),
|
||||
and the second item is a valid color string.
|
||||
(e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
|
||||
- One of the following named colorscales:
|
||||
['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
|
||||
'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
|
||||
'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
|
||||
'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
|
||||
'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
|
||||
'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
|
||||
'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
|
||||
'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
|
||||
'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
|
||||
'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
|
||||
'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
|
||||
'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
|
||||
'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
|
||||
'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
|
||||
'ylorrd'].
|
||||
Appending '_r' to a named colorscale reverses it.
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["colorscale"]
|
||||
|
||||
@colorscale.setter
|
||||
def colorscale(self, val):
|
||||
self["colorscale"] = val
|
||||
|
||||
@property
|
||||
def colorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `color`.
|
||||
|
||||
The 'colorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["colorsrc"]
|
||||
|
||||
@colorsrc.setter
|
||||
def colorsrc(self, val):
|
||||
self["colorsrc"] = val
|
||||
|
||||
@property
|
||||
def reversescale(self):
|
||||
"""
|
||||
Reverses the color mapping if true. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. If true,
|
||||
`marker.line.cmin` will correspond to the last color in the
|
||||
array and `marker.line.cmax` will correspond to the first
|
||||
color.
|
||||
|
||||
The 'reversescale' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["reversescale"]
|
||||
|
||||
@reversescale.setter
|
||||
def reversescale(self, val):
|
||||
self["reversescale"] = val
|
||||
|
||||
@property
|
||||
def width(self):
|
||||
"""
|
||||
Sets the width (in px) of the lines bounding the marker points.
|
||||
|
||||
The 'width' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["width"]
|
||||
|
||||
@width.setter
|
||||
def width(self, val):
|
||||
self["width"] = val
|
||||
|
||||
@property
|
||||
def widthsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `width`.
|
||||
|
||||
The 'widthsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["widthsrc"]
|
||||
|
||||
@widthsrc.setter
|
||||
def widthsrc(self, val):
|
||||
self["widthsrc"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
autocolorscale
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`marker.line.colorscale`. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. In
|
||||
case `colorscale` is unspecified or `autocolorscale` is
|
||||
true, the default palette will be chosen according to
|
||||
whether numbers in the `color` array are all positive,
|
||||
all negative or mixed.
|
||||
cauto
|
||||
Determines whether or not the color domain is computed
|
||||
with respect to the input data (here in
|
||||
`marker.line.color`) or the bounds set in
|
||||
`marker.line.cmin` and `marker.line.cmax` Has an effect
|
||||
only if in `marker.line.color` is set to a numerical
|
||||
array. Defaults to `false` when `marker.line.cmin` and
|
||||
`marker.line.cmax` are set by the user.
|
||||
cmax
|
||||
Sets the upper bound of the color domain. Has an effect
|
||||
only if in `marker.line.color` is set to a numerical
|
||||
array. Value should have the same units as in
|
||||
`marker.line.color` and if set, `marker.line.cmin` must
|
||||
be set as well.
|
||||
cmid
|
||||
Sets the mid-point of the color domain by scaling
|
||||
`marker.line.cmin` and/or `marker.line.cmax` to be
|
||||
equidistant to this point. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. Value
|
||||
should have the same units as in `marker.line.color`.
|
||||
Has no effect when `marker.line.cauto` is `false`.
|
||||
cmin
|
||||
Sets the lower bound of the color domain. Has an effect
|
||||
only if in `marker.line.color` is set to a numerical
|
||||
array. Value should have the same units as in
|
||||
`marker.line.color` and if set, `marker.line.cmax` must
|
||||
be set as well.
|
||||
color
|
||||
Sets the marker.line color. It accepts either a
|
||||
specific color or an array of numbers that are mapped
|
||||
to the colorscale relative to the max and min values of
|
||||
the array or relative to `marker.line.cmin` and
|
||||
`marker.line.cmax` if set.
|
||||
coloraxis
|
||||
Sets a reference to a shared color axis. References to
|
||||
these shared color axes are "coloraxis", "coloraxis2",
|
||||
"coloraxis3", etc. Settings for these shared color axes
|
||||
are set in the layout, under `layout.coloraxis`,
|
||||
`layout.coloraxis2`, etc. Note that multiple color
|
||||
scales can be linked to the same color axis.
|
||||
colorscale
|
||||
Sets the colorscale. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. The
|
||||
colorscale must be an array containing arrays mapping a
|
||||
normalized value to an rgb, rgba, hex, hsl, hsv, or
|
||||
named color string. At minimum, a mapping for the
|
||||
lowest (0) and highest (1) values are required. For
|
||||
example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
|
||||
To control the bounds of the colorscale in color space,
|
||||
use `marker.line.cmin` and `marker.line.cmax`.
|
||||
Alternatively, `colorscale` may be a palette name
|
||||
string of the following list: Blackbody,Bluered,Blues,C
|
||||
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
|
||||
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
reversescale
|
||||
Reverses the color mapping if true. Has an effect only
|
||||
if in `marker.line.color` is set to a numerical array.
|
||||
If true, `marker.line.cmin` will correspond to the last
|
||||
color in the array and `marker.line.cmax` will
|
||||
correspond to the first color.
|
||||
width
|
||||
Sets the width (in px) of the lines bounding the marker
|
||||
points.
|
||||
widthsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`width`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
autocolorscale=None,
|
||||
cauto=None,
|
||||
cmax=None,
|
||||
cmid=None,
|
||||
cmin=None,
|
||||
color=None,
|
||||
coloraxis=None,
|
||||
colorscale=None,
|
||||
colorsrc=None,
|
||||
reversescale=None,
|
||||
width=None,
|
||||
widthsrc=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Line object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.bar.marker.Line`
|
||||
autocolorscale
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`marker.line.colorscale`. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. In
|
||||
case `colorscale` is unspecified or `autocolorscale` is
|
||||
true, the default palette will be chosen according to
|
||||
whether numbers in the `color` array are all positive,
|
||||
all negative or mixed.
|
||||
cauto
|
||||
Determines whether or not the color domain is computed
|
||||
with respect to the input data (here in
|
||||
`marker.line.color`) or the bounds set in
|
||||
`marker.line.cmin` and `marker.line.cmax` Has an effect
|
||||
only if in `marker.line.color` is set to a numerical
|
||||
array. Defaults to `false` when `marker.line.cmin` and
|
||||
`marker.line.cmax` are set by the user.
|
||||
cmax
|
||||
Sets the upper bound of the color domain. Has an effect
|
||||
only if in `marker.line.color` is set to a numerical
|
||||
array. Value should have the same units as in
|
||||
`marker.line.color` and if set, `marker.line.cmin` must
|
||||
be set as well.
|
||||
cmid
|
||||
Sets the mid-point of the color domain by scaling
|
||||
`marker.line.cmin` and/or `marker.line.cmax` to be
|
||||
equidistant to this point. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. Value
|
||||
should have the same units as in `marker.line.color`.
|
||||
Has no effect when `marker.line.cauto` is `false`.
|
||||
cmin
|
||||
Sets the lower bound of the color domain. Has an effect
|
||||
only if in `marker.line.color` is set to a numerical
|
||||
array. Value should have the same units as in
|
||||
`marker.line.color` and if set, `marker.line.cmax` must
|
||||
be set as well.
|
||||
color
|
||||
Sets the marker.line color. It accepts either a
|
||||
specific color or an array of numbers that are mapped
|
||||
to the colorscale relative to the max and min values of
|
||||
the array or relative to `marker.line.cmin` and
|
||||
`marker.line.cmax` if set.
|
||||
coloraxis
|
||||
Sets a reference to a shared color axis. References to
|
||||
these shared color axes are "coloraxis", "coloraxis2",
|
||||
"coloraxis3", etc. Settings for these shared color axes
|
||||
are set in the layout, under `layout.coloraxis`,
|
||||
`layout.coloraxis2`, etc. Note that multiple color
|
||||
scales can be linked to the same color axis.
|
||||
colorscale
|
||||
Sets the colorscale. Has an effect only if in
|
||||
`marker.line.color` is set to a numerical array. The
|
||||
colorscale must be an array containing arrays mapping a
|
||||
normalized value to an rgb, rgba, hex, hsl, hsv, or
|
||||
named color string. At minimum, a mapping for the
|
||||
lowest (0) and highest (1) values are required. For
|
||||
example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
|
||||
To control the bounds of the colorscale in color space,
|
||||
use `marker.line.cmin` and `marker.line.cmax`.
|
||||
Alternatively, `colorscale` may be a palette name
|
||||
string of the following list: Blackbody,Bluered,Blues,C
|
||||
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
|
||||
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
reversescale
|
||||
Reverses the color mapping if true. Has an effect only
|
||||
if in `marker.line.color` is set to a numerical array.
|
||||
If true, `marker.line.cmin` will correspond to the last
|
||||
color in the array and `marker.line.cmax` will
|
||||
correspond to the first color.
|
||||
width
|
||||
Sets the width (in px) of the lines bounding the marker
|
||||
points.
|
||||
widthsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`width`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Line
|
||||
"""
|
||||
super().__init__("line")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.marker.Line
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.marker.Line`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("autocolorscale", arg, autocolorscale)
|
||||
self._set_property("cauto", arg, cauto)
|
||||
self._set_property("cmax", arg, cmax)
|
||||
self._set_property("cmid", arg, cmid)
|
||||
self._set_property("cmin", arg, cmin)
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("coloraxis", arg, coloraxis)
|
||||
self._set_property("colorscale", arg, colorscale)
|
||||
self._set_property("colorsrc", arg, colorsrc)
|
||||
self._set_property("reversescale", arg, reversescale)
|
||||
self._set_property("width", arg, width)
|
||||
self._set_property("widthsrc", arg, widthsrc)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,495 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Pattern(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar.marker"
|
||||
_path_str = "bar.marker.pattern"
|
||||
_valid_props = {
|
||||
"bgcolor",
|
||||
"bgcolorsrc",
|
||||
"fgcolor",
|
||||
"fgcolorsrc",
|
||||
"fgopacity",
|
||||
"fillmode",
|
||||
"path",
|
||||
"pathsrc",
|
||||
"shape",
|
||||
"shapesrc",
|
||||
"size",
|
||||
"sizesrc",
|
||||
"solidity",
|
||||
"soliditysrc",
|
||||
}
|
||||
|
||||
@property
|
||||
def bgcolor(self):
|
||||
"""
|
||||
When there is no colorscale sets the color of background
|
||||
pattern fill. Defaults to a `marker.color` background when
|
||||
`fillmode` is "overlay". Otherwise, defaults to a transparent
|
||||
background.
|
||||
|
||||
The 'bgcolor' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["bgcolor"]
|
||||
|
||||
@bgcolor.setter
|
||||
def bgcolor(self, val):
|
||||
self["bgcolor"] = val
|
||||
|
||||
@property
|
||||
def bgcolorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `bgcolor`.
|
||||
|
||||
The 'bgcolorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["bgcolorsrc"]
|
||||
|
||||
@bgcolorsrc.setter
|
||||
def bgcolorsrc(self, val):
|
||||
self["bgcolorsrc"] = val
|
||||
|
||||
@property
|
||||
def fgcolor(self):
|
||||
"""
|
||||
When there is no colorscale sets the color of foreground
|
||||
pattern fill. Defaults to a `marker.color` background when
|
||||
`fillmode` is "replace". Otherwise, defaults to dark grey or
|
||||
white to increase contrast with the `bgcolor`.
|
||||
|
||||
The 'fgcolor' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["fgcolor"]
|
||||
|
||||
@fgcolor.setter
|
||||
def fgcolor(self, val):
|
||||
self["fgcolor"] = val
|
||||
|
||||
@property
|
||||
def fgcolorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `fgcolor`.
|
||||
|
||||
The 'fgcolorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["fgcolorsrc"]
|
||||
|
||||
@fgcolorsrc.setter
|
||||
def fgcolorsrc(self, val):
|
||||
self["fgcolorsrc"] = val
|
||||
|
||||
@property
|
||||
def fgopacity(self):
|
||||
"""
|
||||
Sets the opacity of the foreground pattern fill. Defaults to a
|
||||
0.5 when `fillmode` is "overlay". Otherwise, defaults to 1.
|
||||
|
||||
The 'fgopacity' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["fgopacity"]
|
||||
|
||||
@fgopacity.setter
|
||||
def fgopacity(self, val):
|
||||
self["fgopacity"] = val
|
||||
|
||||
@property
|
||||
def fillmode(self):
|
||||
"""
|
||||
Determines whether `marker.color` should be used as a default
|
||||
to `bgcolor` or a `fgcolor`.
|
||||
|
||||
The 'fillmode' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['replace', 'overlay']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["fillmode"]
|
||||
|
||||
@fillmode.setter
|
||||
def fillmode(self, val):
|
||||
self["fillmode"] = val
|
||||
|
||||
@property
|
||||
def path(self):
|
||||
"""
|
||||
Sets a custom path for pattern fill. Use with no `shape` or
|
||||
`solidity`, provide an SVG path string for the regions of the
|
||||
square from (0,0) to (`size`,`size`) to color.
|
||||
|
||||
The 'path' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["path"]
|
||||
|
||||
@path.setter
|
||||
def path(self, val):
|
||||
self["path"] = val
|
||||
|
||||
@property
|
||||
def pathsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `path`.
|
||||
|
||||
The 'pathsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["pathsrc"]
|
||||
|
||||
@pathsrc.setter
|
||||
def pathsrc(self, val):
|
||||
self["pathsrc"] = val
|
||||
|
||||
@property
|
||||
def shape(self):
|
||||
"""
|
||||
Sets the shape of the pattern fill. By default, no pattern is
|
||||
used for filling the area.
|
||||
|
||||
The 'shape' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['', '/', '\\', 'x', '-', '|', '+', '.']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["shape"]
|
||||
|
||||
@shape.setter
|
||||
def shape(self, val):
|
||||
self["shape"] = val
|
||||
|
||||
@property
|
||||
def shapesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `shape`.
|
||||
|
||||
The 'shapesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shapesrc"]
|
||||
|
||||
@shapesrc.setter
|
||||
def shapesrc(self, val):
|
||||
self["shapesrc"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
Sets the size of unit squares of the pattern fill in pixels,
|
||||
which corresponds to the interval of repetition of the pattern.
|
||||
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, inf]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def sizesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `size`.
|
||||
|
||||
The 'sizesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["sizesrc"]
|
||||
|
||||
@sizesrc.setter
|
||||
def sizesrc(self, val):
|
||||
self["sizesrc"] = val
|
||||
|
||||
@property
|
||||
def solidity(self):
|
||||
"""
|
||||
Sets the solidity of the pattern fill. Solidity is roughly the
|
||||
fraction of the area filled by the pattern. Solidity of 0 shows
|
||||
only the background color without pattern and solidty of 1
|
||||
shows only the foreground color without pattern.
|
||||
|
||||
The 'solidity' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["solidity"]
|
||||
|
||||
@solidity.setter
|
||||
def solidity(self, val):
|
||||
self["solidity"] = val
|
||||
|
||||
@property
|
||||
def soliditysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `solidity`.
|
||||
|
||||
The 'soliditysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["soliditysrc"]
|
||||
|
||||
@soliditysrc.setter
|
||||
def soliditysrc(self, val):
|
||||
self["soliditysrc"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
bgcolor
|
||||
When there is no colorscale sets the color of
|
||||
background pattern fill. Defaults to a `marker.color`
|
||||
background when `fillmode` is "overlay". Otherwise,
|
||||
defaults to a transparent background.
|
||||
bgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bgcolor`.
|
||||
fgcolor
|
||||
When there is no colorscale sets the color of
|
||||
foreground pattern fill. Defaults to a `marker.color`
|
||||
background when `fillmode` is "replace". Otherwise,
|
||||
defaults to dark grey or white to increase contrast
|
||||
with the `bgcolor`.
|
||||
fgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`fgcolor`.
|
||||
fgopacity
|
||||
Sets the opacity of the foreground pattern fill.
|
||||
Defaults to a 0.5 when `fillmode` is "overlay".
|
||||
Otherwise, defaults to 1.
|
||||
fillmode
|
||||
Determines whether `marker.color` should be used as a
|
||||
default to `bgcolor` or a `fgcolor`.
|
||||
path
|
||||
Sets a custom path for pattern fill. Use with no
|
||||
`shape` or `solidity`, provide an SVG path string for
|
||||
the regions of the square from (0,0) to (`size`,`size`)
|
||||
to color.
|
||||
pathsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`path`.
|
||||
shape
|
||||
Sets the shape of the pattern fill. By default, no
|
||||
pattern is used for filling the area.
|
||||
shapesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shape`.
|
||||
size
|
||||
Sets the size of unit squares of the pattern fill in
|
||||
pixels, which corresponds to the interval of repetition
|
||||
of the pattern.
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
solidity
|
||||
Sets the solidity of the pattern fill. Solidity is
|
||||
roughly the fraction of the area filled by the pattern.
|
||||
Solidity of 0 shows only the background color without
|
||||
pattern and solidty of 1 shows only the foreground
|
||||
color without pattern.
|
||||
soliditysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`solidity`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
bgcolor=None,
|
||||
bgcolorsrc=None,
|
||||
fgcolor=None,
|
||||
fgcolorsrc=None,
|
||||
fgopacity=None,
|
||||
fillmode=None,
|
||||
path=None,
|
||||
pathsrc=None,
|
||||
shape=None,
|
||||
shapesrc=None,
|
||||
size=None,
|
||||
sizesrc=None,
|
||||
solidity=None,
|
||||
soliditysrc=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Pattern object
|
||||
|
||||
Sets the pattern within the marker.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.bar.marker.Pattern`
|
||||
bgcolor
|
||||
When there is no colorscale sets the color of
|
||||
background pattern fill. Defaults to a `marker.color`
|
||||
background when `fillmode` is "overlay". Otherwise,
|
||||
defaults to a transparent background.
|
||||
bgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bgcolor`.
|
||||
fgcolor
|
||||
When there is no colorscale sets the color of
|
||||
foreground pattern fill. Defaults to a `marker.color`
|
||||
background when `fillmode` is "replace". Otherwise,
|
||||
defaults to dark grey or white to increase contrast
|
||||
with the `bgcolor`.
|
||||
fgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`fgcolor`.
|
||||
fgopacity
|
||||
Sets the opacity of the foreground pattern fill.
|
||||
Defaults to a 0.5 when `fillmode` is "overlay".
|
||||
Otherwise, defaults to 1.
|
||||
fillmode
|
||||
Determines whether `marker.color` should be used as a
|
||||
default to `bgcolor` or a `fgcolor`.
|
||||
path
|
||||
Sets a custom path for pattern fill. Use with no
|
||||
`shape` or `solidity`, provide an SVG path string for
|
||||
the regions of the square from (0,0) to (`size`,`size`)
|
||||
to color.
|
||||
pathsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`path`.
|
||||
shape
|
||||
Sets the shape of the pattern fill. By default, no
|
||||
pattern is used for filling the area.
|
||||
shapesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shape`.
|
||||
size
|
||||
Sets the size of unit squares of the pattern fill in
|
||||
pixels, which corresponds to the interval of repetition
|
||||
of the pattern.
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
solidity
|
||||
Sets the solidity of the pattern fill. Solidity is
|
||||
roughly the fraction of the area filled by the pattern.
|
||||
Solidity of 0 shows only the background color without
|
||||
pattern and solidty of 1 shows only the foreground
|
||||
color without pattern.
|
||||
soliditysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`solidity`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Pattern
|
||||
"""
|
||||
super().__init__("pattern")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.marker.Pattern
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.marker.Pattern`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("bgcolor", arg, bgcolor)
|
||||
self._set_property("bgcolorsrc", arg, bgcolorsrc)
|
||||
self._set_property("fgcolor", arg, fgcolor)
|
||||
self._set_property("fgcolorsrc", arg, fgcolorsrc)
|
||||
self._set_property("fgopacity", arg, fgopacity)
|
||||
self._set_property("fillmode", arg, fillmode)
|
||||
self._set_property("path", arg, path)
|
||||
self._set_property("pathsrc", arg, pathsrc)
|
||||
self._set_property("shape", arg, shape)
|
||||
self._set_property("shapesrc", arg, shapesrc)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("sizesrc", arg, sizesrc)
|
||||
self._set_property("solidity", arg, solidity)
|
||||
self._set_property("soliditysrc", arg, soliditysrc)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,16 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._tickfont import Tickfont
|
||||
from ._tickformatstop import Tickformatstop
|
||||
from ._title import Title
|
||||
from . import title
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".title"],
|
||||
["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"],
|
||||
)
|
||||
@ -0,0 +1,334 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Tickfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar.marker.colorbar"
|
||||
_path_str = "bar.marker.colorbar.tickfont"
|
||||
_valid_props = {
|
||||
"color",
|
||||
"family",
|
||||
"lineposition",
|
||||
"shadow",
|
||||
"size",
|
||||
"style",
|
||||
"textcase",
|
||||
"variant",
|
||||
"weight",
|
||||
}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser can only apply a font if it is
|
||||
available on the system where it runs. Provide multiple font
|
||||
families, separated by commas, to indicate the order in which
|
||||
to apply fonts if they aren't available.
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def lineposition(self):
|
||||
"""
|
||||
Sets the kind of decoration line(s) with text, such as an
|
||||
"under", "over" or "through" as well as combinations e.g.
|
||||
"under+over", etc.
|
||||
|
||||
The 'lineposition' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['under', 'over', 'through'] joined with '+' characters
|
||||
(e.g. 'under+over')
|
||||
OR exactly one of ['none'] (e.g. 'none')
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["lineposition"]
|
||||
|
||||
@lineposition.setter
|
||||
def lineposition(self, val):
|
||||
self["lineposition"] = val
|
||||
|
||||
@property
|
||||
def shadow(self):
|
||||
"""
|
||||
Sets the shape and color of the shadow behind text. "auto"
|
||||
places minimal shadow and applies contrast text font color. See
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
|
||||
for additional options.
|
||||
|
||||
The 'shadow' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shadow"]
|
||||
|
||||
@shadow.setter
|
||||
def shadow(self, val):
|
||||
self["shadow"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
Sets whether a font should be styled with a normal or italic
|
||||
face from its family.
|
||||
|
||||
The 'style' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'italic']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def textcase(self):
|
||||
"""
|
||||
Sets capitalization of text. It can be used to make text appear
|
||||
in all-uppercase or all-lowercase, or with each word
|
||||
capitalized.
|
||||
|
||||
The 'textcase' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'word caps', 'upper', 'lower']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["textcase"]
|
||||
|
||||
@textcase.setter
|
||||
def textcase(self, val):
|
||||
self["textcase"] = val
|
||||
|
||||
@property
|
||||
def variant(self):
|
||||
"""
|
||||
Sets the variant of the font.
|
||||
|
||||
The 'variant' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'small-caps', 'all-small-caps',
|
||||
'all-petite-caps', 'petite-caps', 'unicase']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["variant"]
|
||||
|
||||
@variant.setter
|
||||
def variant(self, val):
|
||||
self["variant"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
The 'weight' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [1, 1000]
|
||||
OR exactly one of ['normal', 'bold'] (e.g. 'bold')
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
family=None,
|
||||
lineposition=None,
|
||||
shadow=None,
|
||||
size=None,
|
||||
style=None,
|
||||
textcase=None,
|
||||
variant=None,
|
||||
weight=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Tickfont object
|
||||
|
||||
Sets the color bar's tick label font
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.bar.marker.colorbar.Tickfont`
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Tickfont
|
||||
"""
|
||||
super().__init__("tickfont")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.marker.colorbar.Tickfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.marker.colorbar.Tickfont`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,241 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Tickformatstop(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar.marker.colorbar"
|
||||
_path_str = "bar.marker.colorbar.tickformatstop"
|
||||
_valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"}
|
||||
|
||||
@property
|
||||
def dtickrange(self):
|
||||
"""
|
||||
range [*min*, *max*], where "min", "max" - dtick values which
|
||||
describe some zoom level, it is possible to omit "min" or "max"
|
||||
value by passing "null"
|
||||
|
||||
The 'dtickrange' property is an info array that may be specified as:
|
||||
|
||||
* a list or tuple of 2 elements where:
|
||||
(0) The 'dtickrange[0]' property accepts values of any type
|
||||
(1) The 'dtickrange[1]' property accepts values of any type
|
||||
|
||||
Returns
|
||||
-------
|
||||
list
|
||||
"""
|
||||
return self["dtickrange"]
|
||||
|
||||
@dtickrange.setter
|
||||
def dtickrange(self, val):
|
||||
self["dtickrange"] = val
|
||||
|
||||
@property
|
||||
def enabled(self):
|
||||
"""
|
||||
Determines whether or not this stop is used. If `false`, this
|
||||
stop is ignored even within its `dtickrange`.
|
||||
|
||||
The 'enabled' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["enabled"]
|
||||
|
||||
@enabled.setter
|
||||
def enabled(self, val):
|
||||
self["enabled"] = val
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""
|
||||
When used in a template, named items are created in the output
|
||||
figure in addition to any items the figure already has in this
|
||||
array. You can modify these items in the output figure by
|
||||
making your own item with `templateitemname` matching this
|
||||
`name` alongside your modifications (including `visible: false`
|
||||
or `enabled: false` to hide it). Has no effect outside of a
|
||||
template.
|
||||
|
||||
The 'name' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["name"]
|
||||
|
||||
@name.setter
|
||||
def name(self, val):
|
||||
self["name"] = val
|
||||
|
||||
@property
|
||||
def templateitemname(self):
|
||||
"""
|
||||
Used to refer to a named item in this array in the template.
|
||||
Named items from the template will be created even without a
|
||||
matching item in the input figure, but you can modify one by
|
||||
making an item with `templateitemname` matching its `name`,
|
||||
alongside your modifications (including `visible: false` or
|
||||
`enabled: false` to hide it). If there is no template or no
|
||||
matching item, this item will be hidden unless you explicitly
|
||||
show it with `visible: true`.
|
||||
|
||||
The 'templateitemname' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["templateitemname"]
|
||||
|
||||
@templateitemname.setter
|
||||
def templateitemname(self, val):
|
||||
self["templateitemname"] = val
|
||||
|
||||
@property
|
||||
def value(self):
|
||||
"""
|
||||
string - dtickformat for described zoom level, the same as
|
||||
"tickformat"
|
||||
|
||||
The 'value' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["value"]
|
||||
|
||||
@value.setter
|
||||
def value(self, val):
|
||||
self["value"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
dtickrange
|
||||
range [*min*, *max*], where "min", "max" - dtick values
|
||||
which describe some zoom level, it is possible to omit
|
||||
"min" or "max" value by passing "null"
|
||||
enabled
|
||||
Determines whether or not this stop is used. If
|
||||
`false`, this stop is ignored even within its
|
||||
`dtickrange`.
|
||||
name
|
||||
When used in a template, named items are created in the
|
||||
output figure in addition to any items the figure
|
||||
already has in this array. You can modify these items
|
||||
in the output figure by making your own item with
|
||||
`templateitemname` matching this `name` alongside your
|
||||
modifications (including `visible: false` or `enabled:
|
||||
false` to hide it). Has no effect outside of a
|
||||
template.
|
||||
templateitemname
|
||||
Used to refer to a named item in this array in the
|
||||
template. Named items from the template will be created
|
||||
even without a matching item in the input figure, but
|
||||
you can modify one by making an item with
|
||||
`templateitemname` matching its `name`, alongside your
|
||||
modifications (including `visible: false` or `enabled:
|
||||
false` to hide it). If there is no template or no
|
||||
matching item, this item will be hidden unless you
|
||||
explicitly show it with `visible: true`.
|
||||
value
|
||||
string - dtickformat for described zoom level, the same
|
||||
as "tickformat"
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
dtickrange=None,
|
||||
enabled=None,
|
||||
name=None,
|
||||
templateitemname=None,
|
||||
value=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Tickformatstop object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.bar.marker.col
|
||||
orbar.Tickformatstop`
|
||||
dtickrange
|
||||
range [*min*, *max*], where "min", "max" - dtick values
|
||||
which describe some zoom level, it is possible to omit
|
||||
"min" or "max" value by passing "null"
|
||||
enabled
|
||||
Determines whether or not this stop is used. If
|
||||
`false`, this stop is ignored even within its
|
||||
`dtickrange`.
|
||||
name
|
||||
When used in a template, named items are created in the
|
||||
output figure in addition to any items the figure
|
||||
already has in this array. You can modify these items
|
||||
in the output figure by making your own item with
|
||||
`templateitemname` matching this `name` alongside your
|
||||
modifications (including `visible: false` or `enabled:
|
||||
false` to hide it). Has no effect outside of a
|
||||
template.
|
||||
templateitemname
|
||||
Used to refer to a named item in this array in the
|
||||
template. Named items from the template will be created
|
||||
even without a matching item in the input figure, but
|
||||
you can modify one by making an item with
|
||||
`templateitemname` matching its `name`, alongside your
|
||||
modifications (including `visible: false` or `enabled:
|
||||
false` to hide it). If there is no template or no
|
||||
matching item, this item will be hidden unless you
|
||||
explicitly show it with `visible: true`.
|
||||
value
|
||||
string - dtickformat for described zoom level, the same
|
||||
as "tickformat"
|
||||
|
||||
Returns
|
||||
-------
|
||||
Tickformatstop
|
||||
"""
|
||||
super().__init__("tickformatstops")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.marker.colorbar.Tickformatstop
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.marker.colorbar.Tickformatstop`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("dtickrange", arg, dtickrange)
|
||||
self._set_property("enabled", arg, enabled)
|
||||
self._set_property("name", arg, name)
|
||||
self._set_property("templateitemname", arg, templateitemname)
|
||||
self._set_property("value", arg, value)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,136 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Title(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar.marker.colorbar"
|
||||
_path_str = "bar.marker.colorbar.title"
|
||||
_valid_props = {"font", "side", "text"}
|
||||
|
||||
@property
|
||||
def font(self):
|
||||
"""
|
||||
Sets this color bar's title font.
|
||||
|
||||
The 'font' property is an instance of Font
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.bar.marker.colorbar.title.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.bar.marker.colorbar.title.Font
|
||||
"""
|
||||
return self["font"]
|
||||
|
||||
@font.setter
|
||||
def font(self, val):
|
||||
self["font"] = val
|
||||
|
||||
@property
|
||||
def side(self):
|
||||
"""
|
||||
Determines the location of color bar's title with respect to
|
||||
the color bar. Defaults to "top" when `orientation` if "v" and
|
||||
defaults to "right" when `orientation` if "h".
|
||||
|
||||
The 'side' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['right', 'top', 'bottom']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["side"]
|
||||
|
||||
@side.setter
|
||||
def side(self, val):
|
||||
self["side"] = val
|
||||
|
||||
@property
|
||||
def text(self):
|
||||
"""
|
||||
Sets the title of the color bar.
|
||||
|
||||
The 'text' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["text"]
|
||||
|
||||
@text.setter
|
||||
def text(self, val):
|
||||
self["text"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
font
|
||||
Sets this color bar's title font.
|
||||
side
|
||||
Determines the location of color bar's title with
|
||||
respect to the color bar. Defaults to "top" when
|
||||
`orientation` if "v" and defaults to "right" when
|
||||
`orientation` if "h".
|
||||
text
|
||||
Sets the title of the color bar.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, font=None, side=None, text=None, **kwargs):
|
||||
"""
|
||||
Construct a new Title object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.bar.marker.colorbar.Title`
|
||||
font
|
||||
Sets this color bar's title font.
|
||||
side
|
||||
Determines the location of color bar's title with
|
||||
respect to the color bar. Defaults to "top" when
|
||||
`orientation` if "v" and defaults to "right" when
|
||||
`orientation` if "h".
|
||||
text
|
||||
Sets the title of the color bar.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Title
|
||||
"""
|
||||
super().__init__("title")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.marker.colorbar.Title
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.marker.colorbar.Title`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("font", arg, font)
|
||||
self._set_property("side", arg, side)
|
||||
self._set_property("text", arg, text)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,9 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._font import Font
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"])
|
||||
@ -0,0 +1,334 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar.marker.colorbar.title"
|
||||
_path_str = "bar.marker.colorbar.title.font"
|
||||
_valid_props = {
|
||||
"color",
|
||||
"family",
|
||||
"lineposition",
|
||||
"shadow",
|
||||
"size",
|
||||
"style",
|
||||
"textcase",
|
||||
"variant",
|
||||
"weight",
|
||||
}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser can only apply a font if it is
|
||||
available on the system where it runs. Provide multiple font
|
||||
families, separated by commas, to indicate the order in which
|
||||
to apply fonts if they aren't available.
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def lineposition(self):
|
||||
"""
|
||||
Sets the kind of decoration line(s) with text, such as an
|
||||
"under", "over" or "through" as well as combinations e.g.
|
||||
"under+over", etc.
|
||||
|
||||
The 'lineposition' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['under', 'over', 'through'] joined with '+' characters
|
||||
(e.g. 'under+over')
|
||||
OR exactly one of ['none'] (e.g. 'none')
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["lineposition"]
|
||||
|
||||
@lineposition.setter
|
||||
def lineposition(self, val):
|
||||
self["lineposition"] = val
|
||||
|
||||
@property
|
||||
def shadow(self):
|
||||
"""
|
||||
Sets the shape and color of the shadow behind text. "auto"
|
||||
places minimal shadow and applies contrast text font color. See
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
|
||||
for additional options.
|
||||
|
||||
The 'shadow' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shadow"]
|
||||
|
||||
@shadow.setter
|
||||
def shadow(self, val):
|
||||
self["shadow"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
Sets whether a font should be styled with a normal or italic
|
||||
face from its family.
|
||||
|
||||
The 'style' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'italic']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def textcase(self):
|
||||
"""
|
||||
Sets capitalization of text. It can be used to make text appear
|
||||
in all-uppercase or all-lowercase, or with each word
|
||||
capitalized.
|
||||
|
||||
The 'textcase' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'word caps', 'upper', 'lower']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["textcase"]
|
||||
|
||||
@textcase.setter
|
||||
def textcase(self, val):
|
||||
self["textcase"] = val
|
||||
|
||||
@property
|
||||
def variant(self):
|
||||
"""
|
||||
Sets the variant of the font.
|
||||
|
||||
The 'variant' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'small-caps', 'all-small-caps',
|
||||
'all-petite-caps', 'petite-caps', 'unicase']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["variant"]
|
||||
|
||||
@variant.setter
|
||||
def variant(self, val):
|
||||
self["variant"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
The 'weight' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [1, 1000]
|
||||
OR exactly one of ['normal', 'bold'] (e.g. 'bold')
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
family=None,
|
||||
lineposition=None,
|
||||
shadow=None,
|
||||
size=None,
|
||||
style=None,
|
||||
textcase=None,
|
||||
variant=None,
|
||||
weight=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Font object
|
||||
|
||||
Sets this color bar's title font.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.bar.marker.col
|
||||
orbar.title.Font`
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Font
|
||||
"""
|
||||
super().__init__("font")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.marker.colorbar.title.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.marker.colorbar.title.Font`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,12 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._marker import Marker
|
||||
from ._textfont import Textfont
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__, [], ["._marker.Marker", "._textfont.Textfont"]
|
||||
)
|
||||
@ -0,0 +1,104 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Marker(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar.selected"
|
||||
_path_str = "bar.selected.marker"
|
||||
_valid_props = {"color", "opacity"}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the marker color of selected points.
|
||||
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def opacity(self):
|
||||
"""
|
||||
Sets the marker opacity of selected points.
|
||||
|
||||
The 'opacity' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["opacity"]
|
||||
|
||||
@opacity.setter
|
||||
def opacity(self, val):
|
||||
self["opacity"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
Sets the marker color of selected points.
|
||||
opacity
|
||||
Sets the marker opacity of selected points.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, color=None, opacity=None, **kwargs):
|
||||
"""
|
||||
Construct a new Marker object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.bar.selected.Marker`
|
||||
color
|
||||
Sets the marker color of selected points.
|
||||
opacity
|
||||
Sets the marker opacity of selected points.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Marker
|
||||
"""
|
||||
super().__init__("marker")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.selected.Marker
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.selected.Marker`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("opacity", arg, opacity)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,81 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Textfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar.selected"
|
||||
_path_str = "bar.selected.textfont"
|
||||
_valid_props = {"color"}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the text font color of selected points.
|
||||
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
Sets the text font color of selected points.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, color=None, **kwargs):
|
||||
"""
|
||||
Construct a new Textfont object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.bar.selected.Textfont`
|
||||
color
|
||||
Sets the text font color of selected points.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Textfont
|
||||
"""
|
||||
super().__init__("textfont")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.selected.Textfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.selected.Textfont`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,12 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._marker import Marker
|
||||
from ._textfont import Textfont
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__, [], ["._marker.Marker", "._textfont.Textfont"]
|
||||
)
|
||||
@ -0,0 +1,110 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Marker(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar.unselected"
|
||||
_path_str = "bar.unselected.marker"
|
||||
_valid_props = {"color", "opacity"}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the marker color of unselected points, applied only when a
|
||||
selection exists.
|
||||
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def opacity(self):
|
||||
"""
|
||||
Sets the marker opacity of unselected points, applied only when
|
||||
a selection exists.
|
||||
|
||||
The 'opacity' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["opacity"]
|
||||
|
||||
@opacity.setter
|
||||
def opacity(self, val):
|
||||
self["opacity"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
Sets the marker color of unselected points, applied
|
||||
only when a selection exists.
|
||||
opacity
|
||||
Sets the marker opacity of unselected points, applied
|
||||
only when a selection exists.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, color=None, opacity=None, **kwargs):
|
||||
"""
|
||||
Construct a new Marker object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.bar.unselected.Marker`
|
||||
color
|
||||
Sets the marker color of unselected points, applied
|
||||
only when a selection exists.
|
||||
opacity
|
||||
Sets the marker opacity of unselected points, applied
|
||||
only when a selection exists.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Marker
|
||||
"""
|
||||
super().__init__("marker")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.unselected.Marker
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.unselected.Marker`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("opacity", arg, opacity)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,84 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Textfont(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "bar.unselected"
|
||||
_path_str = "bar.unselected.textfont"
|
||||
_valid_props = {"color"}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the text font color of unselected points, applied only
|
||||
when a selection exists.
|
||||
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
Sets the text font color of unselected points, applied
|
||||
only when a selection exists.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, color=None, **kwargs):
|
||||
"""
|
||||
Construct a new Textfont object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.bar.unselected.Textfont`
|
||||
color
|
||||
Sets the text font color of unselected points, applied
|
||||
only when a selection exists.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Textfont
|
||||
"""
|
||||
super().__init__("textfont")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.bar.unselected.Textfont
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.bar.unselected.Textfont`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,30 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._hoverlabel import Hoverlabel
|
||||
from ._legendgrouptitle import Legendgrouptitle
|
||||
from ._marker import Marker
|
||||
from ._selected import Selected
|
||||
from ._stream import Stream
|
||||
from ._unselected import Unselected
|
||||
from . import hoverlabel
|
||||
from . import legendgrouptitle
|
||||
from . import marker
|
||||
from . import selected
|
||||
from . import unselected
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"],
|
||||
[
|
||||
"._hoverlabel.Hoverlabel",
|
||||
"._legendgrouptitle.Legendgrouptitle",
|
||||
"._marker.Marker",
|
||||
"._selected.Selected",
|
||||
"._stream.Stream",
|
||||
"._unselected.Unselected",
|
||||
],
|
||||
)
|
||||
@ -0,0 +1,366 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Hoverlabel(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "barpolar"
|
||||
_path_str = "barpolar.hoverlabel"
|
||||
_valid_props = {
|
||||
"align",
|
||||
"alignsrc",
|
||||
"bgcolor",
|
||||
"bgcolorsrc",
|
||||
"bordercolor",
|
||||
"bordercolorsrc",
|
||||
"font",
|
||||
"namelength",
|
||||
"namelengthsrc",
|
||||
"showarrow",
|
||||
}
|
||||
|
||||
@property
|
||||
def align(self):
|
||||
"""
|
||||
Sets the horizontal alignment of the text content within hover
|
||||
label box. Has an effect only if the hover label text spans
|
||||
more two or more lines
|
||||
|
||||
The 'align' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['left', 'right', 'auto']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["align"]
|
||||
|
||||
@align.setter
|
||||
def align(self, val):
|
||||
self["align"] = val
|
||||
|
||||
@property
|
||||
def alignsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `align`.
|
||||
|
||||
The 'alignsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["alignsrc"]
|
||||
|
||||
@alignsrc.setter
|
||||
def alignsrc(self, val):
|
||||
self["alignsrc"] = val
|
||||
|
||||
@property
|
||||
def bgcolor(self):
|
||||
"""
|
||||
Sets the background color of the hover labels for this trace
|
||||
|
||||
The 'bgcolor' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["bgcolor"]
|
||||
|
||||
@bgcolor.setter
|
||||
def bgcolor(self, val):
|
||||
self["bgcolor"] = val
|
||||
|
||||
@property
|
||||
def bgcolorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `bgcolor`.
|
||||
|
||||
The 'bgcolorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["bgcolorsrc"]
|
||||
|
||||
@bgcolorsrc.setter
|
||||
def bgcolorsrc(self, val):
|
||||
self["bgcolorsrc"] = val
|
||||
|
||||
@property
|
||||
def bordercolor(self):
|
||||
"""
|
||||
Sets the border color of the hover labels for this trace.
|
||||
|
||||
The 'bordercolor' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["bordercolor"]
|
||||
|
||||
@bordercolor.setter
|
||||
def bordercolor(self, val):
|
||||
self["bordercolor"] = val
|
||||
|
||||
@property
|
||||
def bordercolorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bordercolor`.
|
||||
|
||||
The 'bordercolorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["bordercolorsrc"]
|
||||
|
||||
@bordercolorsrc.setter
|
||||
def bordercolorsrc(self, val):
|
||||
self["bordercolorsrc"] = val
|
||||
|
||||
@property
|
||||
def font(self):
|
||||
"""
|
||||
Sets the font used in hover labels.
|
||||
|
||||
The 'font' property is an instance of Font
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.barpolar.hoverlabel.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.barpolar.hoverlabel.Font
|
||||
"""
|
||||
return self["font"]
|
||||
|
||||
@font.setter
|
||||
def font(self, val):
|
||||
self["font"] = val
|
||||
|
||||
@property
|
||||
def namelength(self):
|
||||
"""
|
||||
Sets the default length (in number of characters) of the trace
|
||||
name in the hover labels for all traces. -1 shows the whole
|
||||
name regardless of length. 0-3 shows the first 0-3 characters,
|
||||
and an integer >3 will show the whole name if it is less than
|
||||
that many characters, but if it is longer, will truncate to
|
||||
`namelength - 3` characters and add an ellipsis.
|
||||
|
||||
The 'namelength' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [-1, 9223372036854775807]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|numpy.ndarray
|
||||
"""
|
||||
return self["namelength"]
|
||||
|
||||
@namelength.setter
|
||||
def namelength(self, val):
|
||||
self["namelength"] = val
|
||||
|
||||
@property
|
||||
def namelengthsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`namelength`.
|
||||
|
||||
The 'namelengthsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["namelengthsrc"]
|
||||
|
||||
@namelengthsrc.setter
|
||||
def namelengthsrc(self, val):
|
||||
self["namelengthsrc"] = val
|
||||
|
||||
@property
|
||||
def showarrow(self):
|
||||
"""
|
||||
Sets whether or not to show the hover label arrow/triangle
|
||||
pointing to the data point.
|
||||
|
||||
The 'showarrow' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["showarrow"]
|
||||
|
||||
@showarrow.setter
|
||||
def showarrow(self, val):
|
||||
self["showarrow"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
align
|
||||
Sets the horizontal alignment of the text content
|
||||
within hover label box. Has an effect only if the hover
|
||||
label text spans more two or more lines
|
||||
alignsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`align`.
|
||||
bgcolor
|
||||
Sets the background color of the hover labels for this
|
||||
trace
|
||||
bgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bgcolor`.
|
||||
bordercolor
|
||||
Sets the border color of the hover labels for this
|
||||
trace.
|
||||
bordercolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bordercolor`.
|
||||
font
|
||||
Sets the font used in hover labels.
|
||||
namelength
|
||||
Sets the default length (in number of characters) of
|
||||
the trace name in the hover labels for all traces. -1
|
||||
shows the whole name regardless of length. 0-3 shows
|
||||
the first 0-3 characters, and an integer >3 will show
|
||||
the whole name if it is less than that many characters,
|
||||
but if it is longer, will truncate to `namelength - 3`
|
||||
characters and add an ellipsis.
|
||||
namelengthsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`namelength`.
|
||||
showarrow
|
||||
Sets whether or not to show the hover label
|
||||
arrow/triangle pointing to the data point.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
align=None,
|
||||
alignsrc=None,
|
||||
bgcolor=None,
|
||||
bgcolorsrc=None,
|
||||
bordercolor=None,
|
||||
bordercolorsrc=None,
|
||||
font=None,
|
||||
namelength=None,
|
||||
namelengthsrc=None,
|
||||
showarrow=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Hoverlabel object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.barpolar.Hoverlabel`
|
||||
align
|
||||
Sets the horizontal alignment of the text content
|
||||
within hover label box. Has an effect only if the hover
|
||||
label text spans more two or more lines
|
||||
alignsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`align`.
|
||||
bgcolor
|
||||
Sets the background color of the hover labels for this
|
||||
trace
|
||||
bgcolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bgcolor`.
|
||||
bordercolor
|
||||
Sets the border color of the hover labels for this
|
||||
trace.
|
||||
bordercolorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`bordercolor`.
|
||||
font
|
||||
Sets the font used in hover labels.
|
||||
namelength
|
||||
Sets the default length (in number of characters) of
|
||||
the trace name in the hover labels for all traces. -1
|
||||
shows the whole name regardless of length. 0-3 shows
|
||||
the first 0-3 characters, and an integer >3 will show
|
||||
the whole name if it is less than that many characters,
|
||||
but if it is longer, will truncate to `namelength - 3`
|
||||
characters and add an ellipsis.
|
||||
namelengthsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`namelength`.
|
||||
showarrow
|
||||
Sets whether or not to show the hover label
|
||||
arrow/triangle pointing to the data point.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Hoverlabel
|
||||
"""
|
||||
super().__init__("hoverlabel")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.barpolar.Hoverlabel
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.barpolar.Hoverlabel`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("align", arg, align)
|
||||
self._set_property("alignsrc", arg, alignsrc)
|
||||
self._set_property("bgcolor", arg, bgcolor)
|
||||
self._set_property("bgcolorsrc", arg, bgcolorsrc)
|
||||
self._set_property("bordercolor", arg, bordercolor)
|
||||
self._set_property("bordercolorsrc", arg, bordercolorsrc)
|
||||
self._set_property("font", arg, font)
|
||||
self._set_property("namelength", arg, namelength)
|
||||
self._set_property("namelengthsrc", arg, namelengthsrc)
|
||||
self._set_property("showarrow", arg, showarrow)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,104 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Legendgrouptitle(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "barpolar"
|
||||
_path_str = "barpolar.legendgrouptitle"
|
||||
_valid_props = {"font", "text"}
|
||||
|
||||
@property
|
||||
def font(self):
|
||||
"""
|
||||
Sets this legend group's title font.
|
||||
|
||||
The 'font' property is an instance of Font
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.barpolar.legendgrouptitle.Font`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Font constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.barpolar.legendgrouptitle.Font
|
||||
"""
|
||||
return self["font"]
|
||||
|
||||
@font.setter
|
||||
def font(self, val):
|
||||
self["font"] = val
|
||||
|
||||
@property
|
||||
def text(self):
|
||||
"""
|
||||
Sets the title of the legend group.
|
||||
|
||||
The 'text' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["text"]
|
||||
|
||||
@text.setter
|
||||
def text(self, val):
|
||||
self["text"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
font
|
||||
Sets this legend group's title font.
|
||||
text
|
||||
Sets the title of the legend group.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, font=None, text=None, **kwargs):
|
||||
"""
|
||||
Construct a new Legendgrouptitle object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.barpolar.Legendgrouptitle`
|
||||
font
|
||||
Sets this legend group's title font.
|
||||
text
|
||||
Sets the title of the legend group.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Legendgrouptitle
|
||||
"""
|
||||
super().__init__("legendgrouptitle")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.barpolar.Legendgrouptitle
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.barpolar.Legendgrouptitle`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("font", arg, font)
|
||||
self._set_property("text", arg, text)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,650 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Marker(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "barpolar"
|
||||
_path_str = "barpolar.marker"
|
||||
_valid_props = {
|
||||
"autocolorscale",
|
||||
"cauto",
|
||||
"cmax",
|
||||
"cmid",
|
||||
"cmin",
|
||||
"color",
|
||||
"coloraxis",
|
||||
"colorbar",
|
||||
"colorscale",
|
||||
"colorsrc",
|
||||
"line",
|
||||
"opacity",
|
||||
"opacitysrc",
|
||||
"pattern",
|
||||
"reversescale",
|
||||
"showscale",
|
||||
}
|
||||
|
||||
@property
|
||||
def autocolorscale(self):
|
||||
"""
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`marker.colorscale`. Has an effect only if in `marker.color` is
|
||||
set to a numerical array. In case `colorscale` is unspecified
|
||||
or `autocolorscale` is true, the default palette will be chosen
|
||||
according to whether numbers in the `color` array are all
|
||||
positive, all negative or mixed.
|
||||
|
||||
The 'autocolorscale' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["autocolorscale"]
|
||||
|
||||
@autocolorscale.setter
|
||||
def autocolorscale(self, val):
|
||||
self["autocolorscale"] = val
|
||||
|
||||
@property
|
||||
def cauto(self):
|
||||
"""
|
||||
Determines whether or not the color domain is computed with
|
||||
respect to the input data (here in `marker.color`) or the
|
||||
bounds set in `marker.cmin` and `marker.cmax` Has an effect
|
||||
only if in `marker.color` is set to a numerical array. Defaults
|
||||
to `false` when `marker.cmin` and `marker.cmax` are set by the
|
||||
user.
|
||||
|
||||
The 'cauto' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["cauto"]
|
||||
|
||||
@cauto.setter
|
||||
def cauto(self, val):
|
||||
self["cauto"] = val
|
||||
|
||||
@property
|
||||
def cmax(self):
|
||||
"""
|
||||
Sets the upper bound of the color domain. Has an effect only if
|
||||
in `marker.color` is set to a numerical array. Value should
|
||||
have the same units as in `marker.color` and if set,
|
||||
`marker.cmin` must be set as well.
|
||||
|
||||
The 'cmax' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["cmax"]
|
||||
|
||||
@cmax.setter
|
||||
def cmax(self, val):
|
||||
self["cmax"] = val
|
||||
|
||||
@property
|
||||
def cmid(self):
|
||||
"""
|
||||
Sets the mid-point of the color domain by scaling `marker.cmin`
|
||||
and/or `marker.cmax` to be equidistant to this point. Has an
|
||||
effect only if in `marker.color` is set to a numerical array.
|
||||
Value should have the same units as in `marker.color`. Has no
|
||||
effect when `marker.cauto` is `false`.
|
||||
|
||||
The 'cmid' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["cmid"]
|
||||
|
||||
@cmid.setter
|
||||
def cmid(self, val):
|
||||
self["cmid"] = val
|
||||
|
||||
@property
|
||||
def cmin(self):
|
||||
"""
|
||||
Sets the lower bound of the color domain. Has an effect only if
|
||||
in `marker.color` is set to a numerical array. Value should
|
||||
have the same units as in `marker.color` and if set,
|
||||
`marker.cmax` must be set as well.
|
||||
|
||||
The 'cmin' property is a number and may be specified as:
|
||||
- An int or float
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["cmin"]
|
||||
|
||||
@cmin.setter
|
||||
def cmin(self, val):
|
||||
self["cmin"] = val
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Sets the marker color. It accepts either a specific color or an
|
||||
array of numbers that are mapped to the colorscale relative to
|
||||
the max and min values of the array or relative to
|
||||
`marker.cmin` and `marker.cmax` if set.
|
||||
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A number that will be interpreted as a color
|
||||
according to barpolar.marker.colorscale
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def coloraxis(self):
|
||||
"""
|
||||
Sets a reference to a shared color axis. References to these
|
||||
shared color axes are "coloraxis", "coloraxis2", "coloraxis3",
|
||||
etc. Settings for these shared color axes are set in the
|
||||
layout, under `layout.coloraxis`, `layout.coloraxis2`, etc.
|
||||
Note that multiple color scales can be linked to the same color
|
||||
axis.
|
||||
|
||||
The 'coloraxis' property is an identifier of a particular
|
||||
subplot, of type 'coloraxis', that may be specified as the string 'coloraxis'
|
||||
optionally followed by an integer >= 1
|
||||
(e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.)
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["coloraxis"]
|
||||
|
||||
@coloraxis.setter
|
||||
def coloraxis(self, val):
|
||||
self["coloraxis"] = val
|
||||
|
||||
@property
|
||||
def colorbar(self):
|
||||
"""
|
||||
The 'colorbar' property is an instance of ColorBar
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.barpolar.marker.ColorBar`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the ColorBar constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.barpolar.marker.ColorBar
|
||||
"""
|
||||
return self["colorbar"]
|
||||
|
||||
@colorbar.setter
|
||||
def colorbar(self, val):
|
||||
self["colorbar"] = val
|
||||
|
||||
@property
|
||||
def colorscale(self):
|
||||
"""
|
||||
Sets the colorscale. Has an effect only if in `marker.color` is
|
||||
set to a numerical array. The colorscale must be an array
|
||||
containing arrays mapping a normalized value to an rgb, rgba,
|
||||
hex, hsl, hsv, or named color string. At minimum, a mapping for
|
||||
the lowest (0) and highest (1) values are required. For
|
||||
example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To
|
||||
control the bounds of the colorscale in color space, use
|
||||
`marker.cmin` and `marker.cmax`. Alternatively, `colorscale`
|
||||
may be a palette name string of the following list: Blackbody,B
|
||||
luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic
|
||||
,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
|
||||
|
||||
The 'colorscale' property is a colorscale and may be
|
||||
specified as:
|
||||
- A list of colors that will be spaced evenly to create the colorscale.
|
||||
Many predefined colorscale lists are included in the sequential, diverging,
|
||||
and cyclical modules in the plotly.colors package.
|
||||
- A list of 2-element lists where the first element is the
|
||||
normalized color level value (starting at 0 and ending at 1),
|
||||
and the second item is a valid color string.
|
||||
(e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
|
||||
- One of the following named colorscales:
|
||||
['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance',
|
||||
'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg',
|
||||
'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl',
|
||||
'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric',
|
||||
'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys',
|
||||
'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet',
|
||||
'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges',
|
||||
'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl',
|
||||
'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn',
|
||||
'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu',
|
||||
'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar',
|
||||
'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn',
|
||||
'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid',
|
||||
'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr',
|
||||
'ylorrd'].
|
||||
Appending '_r' to a named colorscale reverses it.
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["colorscale"]
|
||||
|
||||
@colorscale.setter
|
||||
def colorscale(self, val):
|
||||
self["colorscale"] = val
|
||||
|
||||
@property
|
||||
def colorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `color`.
|
||||
|
||||
The 'colorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["colorsrc"]
|
||||
|
||||
@colorsrc.setter
|
||||
def colorsrc(self, val):
|
||||
self["colorsrc"] = val
|
||||
|
||||
@property
|
||||
def line(self):
|
||||
"""
|
||||
The 'line' property is an instance of Line
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.barpolar.marker.Line`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Line constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.barpolar.marker.Line
|
||||
"""
|
||||
return self["line"]
|
||||
|
||||
@line.setter
|
||||
def line(self, val):
|
||||
self["line"] = val
|
||||
|
||||
@property
|
||||
def opacity(self):
|
||||
"""
|
||||
Sets the opacity of the bars.
|
||||
|
||||
The 'opacity' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 1]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["opacity"]
|
||||
|
||||
@opacity.setter
|
||||
def opacity(self, val):
|
||||
self["opacity"] = val
|
||||
|
||||
@property
|
||||
def opacitysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `opacity`.
|
||||
|
||||
The 'opacitysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["opacitysrc"]
|
||||
|
||||
@opacitysrc.setter
|
||||
def opacitysrc(self, val):
|
||||
self["opacitysrc"] = val
|
||||
|
||||
@property
|
||||
def pattern(self):
|
||||
"""
|
||||
Sets the pattern within the marker.
|
||||
|
||||
The 'pattern' property is an instance of Pattern
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.barpolar.marker.Pattern`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Pattern constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.barpolar.marker.Pattern
|
||||
"""
|
||||
return self["pattern"]
|
||||
|
||||
@pattern.setter
|
||||
def pattern(self, val):
|
||||
self["pattern"] = val
|
||||
|
||||
@property
|
||||
def reversescale(self):
|
||||
"""
|
||||
Reverses the color mapping if true. Has an effect only if in
|
||||
`marker.color` is set to a numerical array. If true,
|
||||
`marker.cmin` will correspond to the last color in the array
|
||||
and `marker.cmax` will correspond to the first color.
|
||||
|
||||
The 'reversescale' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["reversescale"]
|
||||
|
||||
@reversescale.setter
|
||||
def reversescale(self, val):
|
||||
self["reversescale"] = val
|
||||
|
||||
@property
|
||||
def showscale(self):
|
||||
"""
|
||||
Determines whether or not a colorbar is displayed for this
|
||||
trace. Has an effect only if in `marker.color` is set to a
|
||||
numerical array.
|
||||
|
||||
The 'showscale' property must be specified as a bool
|
||||
(either True, or False)
|
||||
|
||||
Returns
|
||||
-------
|
||||
bool
|
||||
"""
|
||||
return self["showscale"]
|
||||
|
||||
@showscale.setter
|
||||
def showscale(self, val):
|
||||
self["showscale"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
autocolorscale
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`marker.colorscale`. Has an effect only if in
|
||||
`marker.color` is set to a numerical array. In case
|
||||
`colorscale` is unspecified or `autocolorscale` is
|
||||
true, the default palette will be chosen according to
|
||||
whether numbers in the `color` array are all positive,
|
||||
all negative or mixed.
|
||||
cauto
|
||||
Determines whether or not the color domain is computed
|
||||
with respect to the input data (here in `marker.color`)
|
||||
or the bounds set in `marker.cmin` and `marker.cmax`
|
||||
Has an effect only if in `marker.color` is set to a
|
||||
numerical array. Defaults to `false` when `marker.cmin`
|
||||
and `marker.cmax` are set by the user.
|
||||
cmax
|
||||
Sets the upper bound of the color domain. Has an effect
|
||||
only if in `marker.color` is set to a numerical array.
|
||||
Value should have the same units as in `marker.color`
|
||||
and if set, `marker.cmin` must be set as well.
|
||||
cmid
|
||||
Sets the mid-point of the color domain by scaling
|
||||
`marker.cmin` and/or `marker.cmax` to be equidistant to
|
||||
this point. Has an effect only if in `marker.color` is
|
||||
set to a numerical array. Value should have the same
|
||||
units as in `marker.color`. Has no effect when
|
||||
`marker.cauto` is `false`.
|
||||
cmin
|
||||
Sets the lower bound of the color domain. Has an effect
|
||||
only if in `marker.color` is set to a numerical array.
|
||||
Value should have the same units as in `marker.color`
|
||||
and if set, `marker.cmax` must be set as well.
|
||||
color
|
||||
Sets the marker color. It accepts either a specific
|
||||
color or an array of numbers that are mapped to the
|
||||
colorscale relative to the max and min values of the
|
||||
array or relative to `marker.cmin` and `marker.cmax` if
|
||||
set.
|
||||
coloraxis
|
||||
Sets a reference to a shared color axis. References to
|
||||
these shared color axes are "coloraxis", "coloraxis2",
|
||||
"coloraxis3", etc. Settings for these shared color axes
|
||||
are set in the layout, under `layout.coloraxis`,
|
||||
`layout.coloraxis2`, etc. Note that multiple color
|
||||
scales can be linked to the same color axis.
|
||||
colorbar
|
||||
:class:`plotly.graph_objects.barpolar.marker.ColorBar`
|
||||
instance or dict with compatible properties
|
||||
colorscale
|
||||
Sets the colorscale. Has an effect only if in
|
||||
`marker.color` is set to a numerical array. The
|
||||
colorscale must be an array containing arrays mapping a
|
||||
normalized value to an rgb, rgba, hex, hsl, hsv, or
|
||||
named color string. At minimum, a mapping for the
|
||||
lowest (0) and highest (1) values are required. For
|
||||
example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
|
||||
To control the bounds of the colorscale in color space,
|
||||
use `marker.cmin` and `marker.cmax`. Alternatively,
|
||||
`colorscale` may be a palette name string of the
|
||||
following list: Blackbody,Bluered,Blues,Cividis,Earth,E
|
||||
lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
|
||||
Bu,Reds,Viridis,YlGnBu,YlOrRd.
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
line
|
||||
:class:`plotly.graph_objects.barpolar.marker.Line`
|
||||
instance or dict with compatible properties
|
||||
opacity
|
||||
Sets the opacity of the bars.
|
||||
opacitysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`opacity`.
|
||||
pattern
|
||||
Sets the pattern within the marker.
|
||||
reversescale
|
||||
Reverses the color mapping if true. Has an effect only
|
||||
if in `marker.color` is set to a numerical array. If
|
||||
true, `marker.cmin` will correspond to the last color
|
||||
in the array and `marker.cmax` will correspond to the
|
||||
first color.
|
||||
showscale
|
||||
Determines whether or not a colorbar is displayed for
|
||||
this trace. Has an effect only if in `marker.color` is
|
||||
set to a numerical array.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
autocolorscale=None,
|
||||
cauto=None,
|
||||
cmax=None,
|
||||
cmid=None,
|
||||
cmin=None,
|
||||
color=None,
|
||||
coloraxis=None,
|
||||
colorbar=None,
|
||||
colorscale=None,
|
||||
colorsrc=None,
|
||||
line=None,
|
||||
opacity=None,
|
||||
opacitysrc=None,
|
||||
pattern=None,
|
||||
reversescale=None,
|
||||
showscale=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Marker object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.barpolar.Marker`
|
||||
autocolorscale
|
||||
Determines whether the colorscale is a default palette
|
||||
(`autocolorscale: true`) or the palette determined by
|
||||
`marker.colorscale`. Has an effect only if in
|
||||
`marker.color` is set to a numerical array. In case
|
||||
`colorscale` is unspecified or `autocolorscale` is
|
||||
true, the default palette will be chosen according to
|
||||
whether numbers in the `color` array are all positive,
|
||||
all negative or mixed.
|
||||
cauto
|
||||
Determines whether or not the color domain is computed
|
||||
with respect to the input data (here in `marker.color`)
|
||||
or the bounds set in `marker.cmin` and `marker.cmax`
|
||||
Has an effect only if in `marker.color` is set to a
|
||||
numerical array. Defaults to `false` when `marker.cmin`
|
||||
and `marker.cmax` are set by the user.
|
||||
cmax
|
||||
Sets the upper bound of the color domain. Has an effect
|
||||
only if in `marker.color` is set to a numerical array.
|
||||
Value should have the same units as in `marker.color`
|
||||
and if set, `marker.cmin` must be set as well.
|
||||
cmid
|
||||
Sets the mid-point of the color domain by scaling
|
||||
`marker.cmin` and/or `marker.cmax` to be equidistant to
|
||||
this point. Has an effect only if in `marker.color` is
|
||||
set to a numerical array. Value should have the same
|
||||
units as in `marker.color`. Has no effect when
|
||||
`marker.cauto` is `false`.
|
||||
cmin
|
||||
Sets the lower bound of the color domain. Has an effect
|
||||
only if in `marker.color` is set to a numerical array.
|
||||
Value should have the same units as in `marker.color`
|
||||
and if set, `marker.cmax` must be set as well.
|
||||
color
|
||||
Sets the marker color. It accepts either a specific
|
||||
color or an array of numbers that are mapped to the
|
||||
colorscale relative to the max and min values of the
|
||||
array or relative to `marker.cmin` and `marker.cmax` if
|
||||
set.
|
||||
coloraxis
|
||||
Sets a reference to a shared color axis. References to
|
||||
these shared color axes are "coloraxis", "coloraxis2",
|
||||
"coloraxis3", etc. Settings for these shared color axes
|
||||
are set in the layout, under `layout.coloraxis`,
|
||||
`layout.coloraxis2`, etc. Note that multiple color
|
||||
scales can be linked to the same color axis.
|
||||
colorbar
|
||||
:class:`plotly.graph_objects.barpolar.marker.ColorBar`
|
||||
instance or dict with compatible properties
|
||||
colorscale
|
||||
Sets the colorscale. Has an effect only if in
|
||||
`marker.color` is set to a numerical array. The
|
||||
colorscale must be an array containing arrays mapping a
|
||||
normalized value to an rgb, rgba, hex, hsl, hsv, or
|
||||
named color string. At minimum, a mapping for the
|
||||
lowest (0) and highest (1) values are required. For
|
||||
example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`.
|
||||
To control the bounds of the colorscale in color space,
|
||||
use `marker.cmin` and `marker.cmax`. Alternatively,
|
||||
`colorscale` may be a palette name string of the
|
||||
following list: Blackbody,Bluered,Blues,Cividis,Earth,E
|
||||
lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd
|
||||
Bu,Reds,Viridis,YlGnBu,YlOrRd.
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
line
|
||||
:class:`plotly.graph_objects.barpolar.marker.Line`
|
||||
instance or dict with compatible properties
|
||||
opacity
|
||||
Sets the opacity of the bars.
|
||||
opacitysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`opacity`.
|
||||
pattern
|
||||
Sets the pattern within the marker.
|
||||
reversescale
|
||||
Reverses the color mapping if true. Has an effect only
|
||||
if in `marker.color` is set to a numerical array. If
|
||||
true, `marker.cmin` will correspond to the last color
|
||||
in the array and `marker.cmax` will correspond to the
|
||||
first color.
|
||||
showscale
|
||||
Determines whether or not a colorbar is displayed for
|
||||
this trace. Has an effect only if in `marker.color` is
|
||||
set to a numerical array.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Marker
|
||||
"""
|
||||
super().__init__("marker")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.barpolar.Marker
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.barpolar.Marker`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("autocolorscale", arg, autocolorscale)
|
||||
self._set_property("cauto", arg, cauto)
|
||||
self._set_property("cmax", arg, cmax)
|
||||
self._set_property("cmid", arg, cmid)
|
||||
self._set_property("cmin", arg, cmin)
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("coloraxis", arg, coloraxis)
|
||||
self._set_property("colorbar", arg, colorbar)
|
||||
self._set_property("colorscale", arg, colorscale)
|
||||
self._set_property("colorsrc", arg, colorsrc)
|
||||
self._set_property("line", arg, line)
|
||||
self._set_property("opacity", arg, opacity)
|
||||
self._set_property("opacitysrc", arg, opacitysrc)
|
||||
self._set_property("pattern", arg, pattern)
|
||||
self._set_property("reversescale", arg, reversescale)
|
||||
self._set_property("showscale", arg, showscale)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,106 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Selected(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "barpolar"
|
||||
_path_str = "barpolar.selected"
|
||||
_valid_props = {"marker", "textfont"}
|
||||
|
||||
@property
|
||||
def marker(self):
|
||||
"""
|
||||
The 'marker' property is an instance of Marker
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.barpolar.selected.Marker`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Marker constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.barpolar.selected.Marker
|
||||
"""
|
||||
return self["marker"]
|
||||
|
||||
@marker.setter
|
||||
def marker(self, val):
|
||||
self["marker"] = val
|
||||
|
||||
@property
|
||||
def textfont(self):
|
||||
"""
|
||||
The 'textfont' property is an instance of Textfont
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.barpolar.selected.Textfont`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Textfont constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.barpolar.selected.Textfont
|
||||
"""
|
||||
return self["textfont"]
|
||||
|
||||
@textfont.setter
|
||||
def textfont(self, val):
|
||||
self["textfont"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
marker
|
||||
:class:`plotly.graph_objects.barpolar.selected.Marker`
|
||||
instance or dict with compatible properties
|
||||
textfont
|
||||
:class:`plotly.graph_objects.barpolar.selected.Textfont
|
||||
` instance or dict with compatible properties
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
|
||||
"""
|
||||
Construct a new Selected object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.barpolar.Selected`
|
||||
marker
|
||||
:class:`plotly.graph_objects.barpolar.selected.Marker`
|
||||
instance or dict with compatible properties
|
||||
textfont
|
||||
:class:`plotly.graph_objects.barpolar.selected.Textfont
|
||||
` instance or dict with compatible properties
|
||||
|
||||
Returns
|
||||
-------
|
||||
Selected
|
||||
"""
|
||||
super().__init__("selected")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.barpolar.Selected
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.barpolar.Selected`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("marker", arg, marker)
|
||||
self._set_property("textfont", arg, textfont)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,114 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Stream(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "barpolar"
|
||||
_path_str = "barpolar.stream"
|
||||
_valid_props = {"maxpoints", "token"}
|
||||
|
||||
@property
|
||||
def maxpoints(self):
|
||||
"""
|
||||
Sets the maximum number of points to keep on the plots from an
|
||||
incoming stream. If `maxpoints` is set to 50, only the newest
|
||||
50 points will be displayed on the plot.
|
||||
|
||||
The 'maxpoints' property is a number and may be specified as:
|
||||
- An int or float in the interval [0, 10000]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["maxpoints"]
|
||||
|
||||
@maxpoints.setter
|
||||
def maxpoints(self, val):
|
||||
self["maxpoints"] = val
|
||||
|
||||
@property
|
||||
def token(self):
|
||||
"""
|
||||
The stream id number links a data trace on a plot with a
|
||||
stream. See https://chart-studio.plotly.com/settings for more
|
||||
details.
|
||||
|
||||
The 'token' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["token"]
|
||||
|
||||
@token.setter
|
||||
def token(self, val):
|
||||
self["token"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
maxpoints
|
||||
Sets the maximum number of points to keep on the plots
|
||||
from an incoming stream. If `maxpoints` is set to 50,
|
||||
only the newest 50 points will be displayed on the
|
||||
plot.
|
||||
token
|
||||
The stream id number links a data trace on a plot with
|
||||
a stream. See https://chart-studio.plotly.com/settings
|
||||
for more details.
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, maxpoints=None, token=None, **kwargs):
|
||||
"""
|
||||
Construct a new Stream object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.barpolar.Stream`
|
||||
maxpoints
|
||||
Sets the maximum number of points to keep on the plots
|
||||
from an incoming stream. If `maxpoints` is set to 50,
|
||||
only the newest 50 points will be displayed on the
|
||||
plot.
|
||||
token
|
||||
The stream id number links a data trace on a plot with
|
||||
a stream. See https://chart-studio.plotly.com/settings
|
||||
for more details.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Stream
|
||||
"""
|
||||
super().__init__("stream")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.barpolar.Stream
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.barpolar.Stream`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("maxpoints", arg, maxpoints)
|
||||
self._set_property("token", arg, token)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,106 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Unselected(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "barpolar"
|
||||
_path_str = "barpolar.unselected"
|
||||
_valid_props = {"marker", "textfont"}
|
||||
|
||||
@property
|
||||
def marker(self):
|
||||
"""
|
||||
The 'marker' property is an instance of Marker
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.barpolar.unselected.Marker`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Marker constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.barpolar.unselected.Marker
|
||||
"""
|
||||
return self["marker"]
|
||||
|
||||
@marker.setter
|
||||
def marker(self, val):
|
||||
self["marker"] = val
|
||||
|
||||
@property
|
||||
def textfont(self):
|
||||
"""
|
||||
The 'textfont' property is an instance of Textfont
|
||||
that may be specified as:
|
||||
- An instance of :class:`plotly.graph_objs.barpolar.unselected.Textfont`
|
||||
- A dict of string/value properties that will be passed
|
||||
to the Textfont constructor
|
||||
|
||||
Returns
|
||||
-------
|
||||
plotly.graph_objs.barpolar.unselected.Textfont
|
||||
"""
|
||||
return self["textfont"]
|
||||
|
||||
@textfont.setter
|
||||
def textfont(self, val):
|
||||
self["textfont"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
marker
|
||||
:class:`plotly.graph_objects.barpolar.unselected.Marker
|
||||
` instance or dict with compatible properties
|
||||
textfont
|
||||
:class:`plotly.graph_objects.barpolar.unselected.Textfo
|
||||
nt` instance or dict with compatible properties
|
||||
"""
|
||||
|
||||
def __init__(self, arg=None, marker=None, textfont=None, **kwargs):
|
||||
"""
|
||||
Construct a new Unselected object
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.barpolar.Unselected`
|
||||
marker
|
||||
:class:`plotly.graph_objects.barpolar.unselected.Marker
|
||||
` instance or dict with compatible properties
|
||||
textfont
|
||||
:class:`plotly.graph_objects.barpolar.unselected.Textfo
|
||||
nt` instance or dict with compatible properties
|
||||
|
||||
Returns
|
||||
-------
|
||||
Unselected
|
||||
"""
|
||||
super().__init__("unselected")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.barpolar.Unselected
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.barpolar.Unselected`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("marker", arg, marker)
|
||||
self._set_property("textfont", arg, textfont)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,9 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._font import Font
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"])
|
||||
@ -0,0 +1,587 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "barpolar.hoverlabel"
|
||||
_path_str = "barpolar.hoverlabel.font"
|
||||
_valid_props = {
|
||||
"color",
|
||||
"colorsrc",
|
||||
"family",
|
||||
"familysrc",
|
||||
"lineposition",
|
||||
"linepositionsrc",
|
||||
"shadow",
|
||||
"shadowsrc",
|
||||
"size",
|
||||
"sizesrc",
|
||||
"style",
|
||||
"stylesrc",
|
||||
"textcase",
|
||||
"textcasesrc",
|
||||
"variant",
|
||||
"variantsrc",
|
||||
"weight",
|
||||
"weightsrc",
|
||||
}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
- A list or array of any of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def colorsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `color`.
|
||||
|
||||
The 'colorsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["colorsrc"]
|
||||
|
||||
@colorsrc.setter
|
||||
def colorsrc(self, val):
|
||||
self["colorsrc"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser can only apply a font if it is
|
||||
available on the system where it runs. Provide multiple font
|
||||
families, separated by commas, to indicate the order in which
|
||||
to apply fonts if they aren't available.
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def familysrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `family`.
|
||||
|
||||
The 'familysrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["familysrc"]
|
||||
|
||||
@familysrc.setter
|
||||
def familysrc(self, val):
|
||||
self["familysrc"] = val
|
||||
|
||||
@property
|
||||
def lineposition(self):
|
||||
"""
|
||||
Sets the kind of decoration line(s) with text, such as an
|
||||
"under", "over" or "through" as well as combinations e.g.
|
||||
"under+over", etc.
|
||||
|
||||
The 'lineposition' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['under', 'over', 'through'] joined with '+' characters
|
||||
(e.g. 'under+over')
|
||||
OR exactly one of ['none'] (e.g. 'none')
|
||||
- A list or array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["lineposition"]
|
||||
|
||||
@lineposition.setter
|
||||
def lineposition(self, val):
|
||||
self["lineposition"] = val
|
||||
|
||||
@property
|
||||
def linepositionsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
|
||||
The 'linepositionsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["linepositionsrc"]
|
||||
|
||||
@linepositionsrc.setter
|
||||
def linepositionsrc(self, val):
|
||||
self["linepositionsrc"] = val
|
||||
|
||||
@property
|
||||
def shadow(self):
|
||||
"""
|
||||
Sets the shape and color of the shadow behind text. "auto"
|
||||
places minimal shadow and applies contrast text font color. See
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
|
||||
for additional options.
|
||||
|
||||
The 'shadow' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
str|numpy.ndarray
|
||||
"""
|
||||
return self["shadow"]
|
||||
|
||||
@shadow.setter
|
||||
def shadow(self, val):
|
||||
self["shadow"] = val
|
||||
|
||||
@property
|
||||
def shadowsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `shadow`.
|
||||
|
||||
The 'shadowsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shadowsrc"]
|
||||
|
||||
@shadowsrc.setter
|
||||
def shadowsrc(self, val):
|
||||
self["shadowsrc"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float|numpy.ndarray
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def sizesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `size`.
|
||||
|
||||
The 'sizesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["sizesrc"]
|
||||
|
||||
@sizesrc.setter
|
||||
def sizesrc(self, val):
|
||||
self["sizesrc"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
Sets whether a font should be styled with a normal or italic
|
||||
face from its family.
|
||||
|
||||
The 'style' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'italic']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def stylesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `style`.
|
||||
|
||||
The 'stylesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["stylesrc"]
|
||||
|
||||
@stylesrc.setter
|
||||
def stylesrc(self, val):
|
||||
self["stylesrc"] = val
|
||||
|
||||
@property
|
||||
def textcase(self):
|
||||
"""
|
||||
Sets capitalization of text. It can be used to make text appear
|
||||
in all-uppercase or all-lowercase, or with each word
|
||||
capitalized.
|
||||
|
||||
The 'textcase' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'word caps', 'upper', 'lower']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["textcase"]
|
||||
|
||||
@textcase.setter
|
||||
def textcase(self, val):
|
||||
self["textcase"] = val
|
||||
|
||||
@property
|
||||
def textcasesrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `textcase`.
|
||||
|
||||
The 'textcasesrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["textcasesrc"]
|
||||
|
||||
@textcasesrc.setter
|
||||
def textcasesrc(self, val):
|
||||
self["textcasesrc"] = val
|
||||
|
||||
@property
|
||||
def variant(self):
|
||||
"""
|
||||
Sets the variant of the font.
|
||||
|
||||
The 'variant' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'small-caps', 'all-small-caps',
|
||||
'all-petite-caps', 'petite-caps', 'unicase']
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any|numpy.ndarray
|
||||
"""
|
||||
return self["variant"]
|
||||
|
||||
@variant.setter
|
||||
def variant(self, val):
|
||||
self["variant"] = val
|
||||
|
||||
@property
|
||||
def variantsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `variant`.
|
||||
|
||||
The 'variantsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["variantsrc"]
|
||||
|
||||
@variantsrc.setter
|
||||
def variantsrc(self, val):
|
||||
self["variantsrc"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
The 'weight' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [1, 1000]
|
||||
OR exactly one of ['normal', 'bold'] (e.g. 'bold')
|
||||
- A tuple, list, or one-dimensional numpy array of the above
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|numpy.ndarray
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def weightsrc(self):
|
||||
"""
|
||||
Sets the source reference on Chart Studio Cloud for `weight`.
|
||||
|
||||
The 'weightsrc' property must be specified as a string or
|
||||
as a plotly.grid_objs.Column object
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["weightsrc"]
|
||||
|
||||
@weightsrc.setter
|
||||
def weightsrc(self, val):
|
||||
self["weightsrc"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
familysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`family`.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
linepositionsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
shadowsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shadow`.
|
||||
size
|
||||
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
stylesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`style`.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
textcasesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`textcase`.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
variantsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`variant`.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
weightsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`weight`.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
colorsrc=None,
|
||||
family=None,
|
||||
familysrc=None,
|
||||
lineposition=None,
|
||||
linepositionsrc=None,
|
||||
shadow=None,
|
||||
shadowsrc=None,
|
||||
size=None,
|
||||
sizesrc=None,
|
||||
style=None,
|
||||
stylesrc=None,
|
||||
textcase=None,
|
||||
textcasesrc=None,
|
||||
variant=None,
|
||||
variantsrc=None,
|
||||
weight=None,
|
||||
weightsrc=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Font object
|
||||
|
||||
Sets the font used in hover labels.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of
|
||||
:class:`plotly.graph_objs.barpolar.hoverlabel.Font`
|
||||
color
|
||||
|
||||
colorsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`color`.
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
familysrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`family`.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
linepositionsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`lineposition`.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
shadowsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`shadow`.
|
||||
size
|
||||
|
||||
sizesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`size`.
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
stylesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`style`.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
textcasesrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`textcase`.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
variantsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`variant`.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
weightsrc
|
||||
Sets the source reference on Chart Studio Cloud for
|
||||
`weight`.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Font
|
||||
"""
|
||||
super().__init__("font")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.barpolar.hoverlabel.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.barpolar.hoverlabel.Font`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("colorsrc", arg, colorsrc)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("familysrc", arg, familysrc)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("linepositionsrc", arg, linepositionsrc)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("shadowsrc", arg, shadowsrc)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("sizesrc", arg, sizesrc)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("stylesrc", arg, stylesrc)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("textcasesrc", arg, textcasesrc)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("variantsrc", arg, variantsrc)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._set_property("weightsrc", arg, weightsrc)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,9 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._font import Font
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"])
|
||||
@ -0,0 +1,334 @@
|
||||
# --- THIS FILE IS AUTO-GENERATED ---
|
||||
# Modifications will be overwitten the next time code generation run.
|
||||
|
||||
from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType
|
||||
import copy as _copy
|
||||
|
||||
|
||||
class Font(_BaseTraceHierarchyType):
|
||||
_parent_path_str = "barpolar.legendgrouptitle"
|
||||
_path_str = "barpolar.legendgrouptitle.font"
|
||||
_valid_props = {
|
||||
"color",
|
||||
"family",
|
||||
"lineposition",
|
||||
"shadow",
|
||||
"size",
|
||||
"style",
|
||||
"textcase",
|
||||
"variant",
|
||||
"weight",
|
||||
}
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
The 'color' property is a color and may be specified as:
|
||||
- A hex string (e.g. '#ff0000')
|
||||
- An rgb/rgba string (e.g. 'rgb(255,0,0)')
|
||||
- An hsl/hsla string (e.g. 'hsl(0,100%,50%)')
|
||||
- An hsv/hsva string (e.g. 'hsv(0,100%,100%)')
|
||||
- A named CSS color: see https://plotly.com/python/css-colors/ for a list
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["color"]
|
||||
|
||||
@color.setter
|
||||
def color(self, val):
|
||||
self["color"] = val
|
||||
|
||||
@property
|
||||
def family(self):
|
||||
"""
|
||||
HTML font family - the typeface that will be applied by the web
|
||||
browser. The web browser can only apply a font if it is
|
||||
available on the system where it runs. Provide multiple font
|
||||
families, separated by commas, to indicate the order in which
|
||||
to apply fonts if they aren't available.
|
||||
|
||||
The 'family' property is a string and must be specified as:
|
||||
- A non-empty string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["family"]
|
||||
|
||||
@family.setter
|
||||
def family(self, val):
|
||||
self["family"] = val
|
||||
|
||||
@property
|
||||
def lineposition(self):
|
||||
"""
|
||||
Sets the kind of decoration line(s) with text, such as an
|
||||
"under", "over" or "through" as well as combinations e.g.
|
||||
"under+over", etc.
|
||||
|
||||
The 'lineposition' property is a flaglist and may be specified
|
||||
as a string containing:
|
||||
- Any combination of ['under', 'over', 'through'] joined with '+' characters
|
||||
(e.g. 'under+over')
|
||||
OR exactly one of ['none'] (e.g. 'none')
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["lineposition"]
|
||||
|
||||
@lineposition.setter
|
||||
def lineposition(self, val):
|
||||
self["lineposition"] = val
|
||||
|
||||
@property
|
||||
def shadow(self):
|
||||
"""
|
||||
Sets the shape and color of the shadow behind text. "auto"
|
||||
places minimal shadow and applies contrast text font color. See
|
||||
https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow
|
||||
for additional options.
|
||||
|
||||
The 'shadow' property is a string and must be specified as:
|
||||
- A string
|
||||
- A number that will be converted to a string
|
||||
|
||||
Returns
|
||||
-------
|
||||
str
|
||||
"""
|
||||
return self["shadow"]
|
||||
|
||||
@shadow.setter
|
||||
def shadow(self, val):
|
||||
self["shadow"] = val
|
||||
|
||||
@property
|
||||
def size(self):
|
||||
"""
|
||||
The 'size' property is a number and may be specified as:
|
||||
- An int or float in the interval [1, inf]
|
||||
|
||||
Returns
|
||||
-------
|
||||
int|float
|
||||
"""
|
||||
return self["size"]
|
||||
|
||||
@size.setter
|
||||
def size(self, val):
|
||||
self["size"] = val
|
||||
|
||||
@property
|
||||
def style(self):
|
||||
"""
|
||||
Sets whether a font should be styled with a normal or italic
|
||||
face from its family.
|
||||
|
||||
The 'style' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'italic']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["style"]
|
||||
|
||||
@style.setter
|
||||
def style(self, val):
|
||||
self["style"] = val
|
||||
|
||||
@property
|
||||
def textcase(self):
|
||||
"""
|
||||
Sets capitalization of text. It can be used to make text appear
|
||||
in all-uppercase or all-lowercase, or with each word
|
||||
capitalized.
|
||||
|
||||
The 'textcase' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'word caps', 'upper', 'lower']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["textcase"]
|
||||
|
||||
@textcase.setter
|
||||
def textcase(self, val):
|
||||
self["textcase"] = val
|
||||
|
||||
@property
|
||||
def variant(self):
|
||||
"""
|
||||
Sets the variant of the font.
|
||||
|
||||
The 'variant' property is an enumeration that may be specified as:
|
||||
- One of the following enumeration values:
|
||||
['normal', 'small-caps', 'all-small-caps',
|
||||
'all-petite-caps', 'petite-caps', 'unicase']
|
||||
|
||||
Returns
|
||||
-------
|
||||
Any
|
||||
"""
|
||||
return self["variant"]
|
||||
|
||||
@variant.setter
|
||||
def variant(self, val):
|
||||
self["variant"] = val
|
||||
|
||||
@property
|
||||
def weight(self):
|
||||
"""
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
The 'weight' property is a integer and may be specified as:
|
||||
- An int (or float that will be cast to an int)
|
||||
in the interval [1, 1000]
|
||||
OR exactly one of ['normal', 'bold'] (e.g. 'bold')
|
||||
|
||||
Returns
|
||||
-------
|
||||
int
|
||||
"""
|
||||
return self["weight"]
|
||||
|
||||
@weight.setter
|
||||
def weight(self, val):
|
||||
self["weight"] = val
|
||||
|
||||
@property
|
||||
def _prop_descriptions(self):
|
||||
return """\
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
arg=None,
|
||||
color=None,
|
||||
family=None,
|
||||
lineposition=None,
|
||||
shadow=None,
|
||||
size=None,
|
||||
style=None,
|
||||
textcase=None,
|
||||
variant=None,
|
||||
weight=None,
|
||||
**kwargs,
|
||||
):
|
||||
"""
|
||||
Construct a new Font object
|
||||
|
||||
Sets this legend group's title font.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
arg
|
||||
dict of properties compatible with this constructor or
|
||||
an instance of :class:`plotly.graph_objs.barpolar.legen
|
||||
dgrouptitle.Font`
|
||||
color
|
||||
|
||||
family
|
||||
HTML font family - the typeface that will be applied by
|
||||
the web browser. The web browser can only apply a font
|
||||
if it is available on the system where it runs. Provide
|
||||
multiple font families, separated by commas, to
|
||||
indicate the order in which to apply fonts if they
|
||||
aren't available.
|
||||
lineposition
|
||||
Sets the kind of decoration line(s) with text, such as
|
||||
an "under", "over" or "through" as well as combinations
|
||||
e.g. "under+over", etc.
|
||||
shadow
|
||||
Sets the shape and color of the shadow behind text.
|
||||
"auto" places minimal shadow and applies contrast text
|
||||
font color. See https://developer.mozilla.org/en-
|
||||
US/docs/Web/CSS/text-shadow for additional options.
|
||||
size
|
||||
|
||||
style
|
||||
Sets whether a font should be styled with a normal or
|
||||
italic face from its family.
|
||||
textcase
|
||||
Sets capitalization of text. It can be used to make
|
||||
text appear in all-uppercase or all-lowercase, or with
|
||||
each word capitalized.
|
||||
variant
|
||||
Sets the variant of the font.
|
||||
weight
|
||||
Sets the weight (or boldness) of the font.
|
||||
|
||||
Returns
|
||||
-------
|
||||
Font
|
||||
"""
|
||||
super().__init__("font")
|
||||
if "_parent" in kwargs:
|
||||
self._parent = kwargs["_parent"]
|
||||
return
|
||||
|
||||
if arg is None:
|
||||
arg = {}
|
||||
elif isinstance(arg, self.__class__):
|
||||
arg = arg.to_plotly_json()
|
||||
elif isinstance(arg, dict):
|
||||
arg = _copy.copy(arg)
|
||||
else:
|
||||
raise ValueError("""\
|
||||
The first argument to the plotly.graph_objs.barpolar.legendgrouptitle.Font
|
||||
constructor must be a dict or
|
||||
an instance of :class:`plotly.graph_objs.barpolar.legendgrouptitle.Font`""")
|
||||
|
||||
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
||||
self._validate = kwargs.pop("_validate", True)
|
||||
|
||||
self._set_property("color", arg, color)
|
||||
self._set_property("family", arg, family)
|
||||
self._set_property("lineposition", arg, lineposition)
|
||||
self._set_property("shadow", arg, shadow)
|
||||
self._set_property("size", arg, size)
|
||||
self._set_property("style", arg, style)
|
||||
self._set_property("textcase", arg, textcase)
|
||||
self._set_property("variant", arg, variant)
|
||||
self._set_property("weight", arg, weight)
|
||||
self._process_kwargs(**dict(arg, **kwargs))
|
||||
self._skip_invalid = False
|
||||
@ -0,0 +1,16 @@
|
||||
import sys
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from ._colorbar import ColorBar
|
||||
from ._line import Line
|
||||
from ._pattern import Pattern
|
||||
from . import colorbar
|
||||
else:
|
||||
from _plotly_utils.importers import relative_import
|
||||
|
||||
__all__, __getattr__, __dir__ = relative_import(
|
||||
__name__,
|
||||
[".colorbar"],
|
||||
["._colorbar.ColorBar", "._line.Line", "._pattern.Pattern"],
|
||||
)
|
||||
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user