mirror of
https://github.com/aykhans/AzSuicideDataVisualization.git
synced 2025-07-01 14:07:48 +00:00
555 lines
21 KiB
Python
555 lines
21 KiB
Python
from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType
|
|
import copy as _copy
|
|
|
|
|
|
class Modebar(_BaseLayoutHierarchyType):
|
|
|
|
# class properties
|
|
# --------------------
|
|
_parent_path_str = "layout"
|
|
_path_str = "layout.modebar"
|
|
_valid_props = {
|
|
"activecolor",
|
|
"add",
|
|
"addsrc",
|
|
"bgcolor",
|
|
"color",
|
|
"orientation",
|
|
"remove",
|
|
"removesrc",
|
|
"uirevision",
|
|
}
|
|
|
|
# activecolor
|
|
# -----------
|
|
@property
|
|
def activecolor(self):
|
|
"""
|
|
Sets the color of the active or hovered on icons in the
|
|
modebar.
|
|
|
|
The 'activecolor' 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:
|
|
aliceblue, antiquewhite, aqua, aquamarine, azure,
|
|
beige, bisque, black, blanchedalmond, blue,
|
|
blueviolet, brown, burlywood, cadetblue,
|
|
chartreuse, chocolate, coral, cornflowerblue,
|
|
cornsilk, crimson, cyan, darkblue, darkcyan,
|
|
darkgoldenrod, darkgray, darkgrey, darkgreen,
|
|
darkkhaki, darkmagenta, darkolivegreen, darkorange,
|
|
darkorchid, darkred, darksalmon, darkseagreen,
|
|
darkslateblue, darkslategray, darkslategrey,
|
|
darkturquoise, darkviolet, deeppink, deepskyblue,
|
|
dimgray, dimgrey, dodgerblue, firebrick,
|
|
floralwhite, forestgreen, fuchsia, gainsboro,
|
|
ghostwhite, gold, goldenrod, gray, grey, green,
|
|
greenyellow, honeydew, hotpink, indianred, indigo,
|
|
ivory, khaki, lavender, lavenderblush, lawngreen,
|
|
lemonchiffon, lightblue, lightcoral, lightcyan,
|
|
lightgoldenrodyellow, lightgray, lightgrey,
|
|
lightgreen, lightpink, lightsalmon, lightseagreen,
|
|
lightskyblue, lightslategray, lightslategrey,
|
|
lightsteelblue, lightyellow, lime, limegreen,
|
|
linen, magenta, maroon, mediumaquamarine,
|
|
mediumblue, mediumorchid, mediumpurple,
|
|
mediumseagreen, mediumslateblue, mediumspringgreen,
|
|
mediumturquoise, mediumvioletred, midnightblue,
|
|
mintcream, mistyrose, moccasin, navajowhite, navy,
|
|
oldlace, olive, olivedrab, orange, orangered,
|
|
orchid, palegoldenrod, palegreen, paleturquoise,
|
|
palevioletred, papayawhip, peachpuff, peru, pink,
|
|
plum, powderblue, purple, red, rosybrown,
|
|
royalblue, rebeccapurple, saddlebrown, salmon,
|
|
sandybrown, seagreen, seashell, sienna, silver,
|
|
skyblue, slateblue, slategray, slategrey, snow,
|
|
springgreen, steelblue, tan, teal, thistle, tomato,
|
|
turquoise, violet, wheat, white, whitesmoke,
|
|
yellow, yellowgreen
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["activecolor"]
|
|
|
|
@activecolor.setter
|
|
def activecolor(self, val):
|
|
self["activecolor"] = val
|
|
|
|
# add
|
|
# ---
|
|
@property
|
|
def add(self):
|
|
"""
|
|
Determines which predefined modebar buttons to add. Please note
|
|
that these buttons will only be shown if they are compatible
|
|
with all trace types used in a graph. Similar to
|
|
`config.modeBarButtonsToAdd` option. This may include
|
|
"v1hovermode", "hoverclosest", "hovercompare", "togglehover",
|
|
"togglespikelines", "drawline", "drawopenpath",
|
|
"drawclosedpath", "drawcircle", "drawrect", "eraseshape".
|
|
|
|
The 'add' 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["add"]
|
|
|
|
@add.setter
|
|
def add(self, val):
|
|
self["add"] = val
|
|
|
|
# addsrc
|
|
# ------
|
|
@property
|
|
def addsrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `add`.
|
|
|
|
The 'addsrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["addsrc"]
|
|
|
|
@addsrc.setter
|
|
def addsrc(self, val):
|
|
self["addsrc"] = val
|
|
|
|
# bgcolor
|
|
# -------
|
|
@property
|
|
def bgcolor(self):
|
|
"""
|
|
Sets the background color of the modebar.
|
|
|
|
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:
|
|
aliceblue, antiquewhite, aqua, aquamarine, azure,
|
|
beige, bisque, black, blanchedalmond, blue,
|
|
blueviolet, brown, burlywood, cadetblue,
|
|
chartreuse, chocolate, coral, cornflowerblue,
|
|
cornsilk, crimson, cyan, darkblue, darkcyan,
|
|
darkgoldenrod, darkgray, darkgrey, darkgreen,
|
|
darkkhaki, darkmagenta, darkolivegreen, darkorange,
|
|
darkorchid, darkred, darksalmon, darkseagreen,
|
|
darkslateblue, darkslategray, darkslategrey,
|
|
darkturquoise, darkviolet, deeppink, deepskyblue,
|
|
dimgray, dimgrey, dodgerblue, firebrick,
|
|
floralwhite, forestgreen, fuchsia, gainsboro,
|
|
ghostwhite, gold, goldenrod, gray, grey, green,
|
|
greenyellow, honeydew, hotpink, indianred, indigo,
|
|
ivory, khaki, lavender, lavenderblush, lawngreen,
|
|
lemonchiffon, lightblue, lightcoral, lightcyan,
|
|
lightgoldenrodyellow, lightgray, lightgrey,
|
|
lightgreen, lightpink, lightsalmon, lightseagreen,
|
|
lightskyblue, lightslategray, lightslategrey,
|
|
lightsteelblue, lightyellow, lime, limegreen,
|
|
linen, magenta, maroon, mediumaquamarine,
|
|
mediumblue, mediumorchid, mediumpurple,
|
|
mediumseagreen, mediumslateblue, mediumspringgreen,
|
|
mediumturquoise, mediumvioletred, midnightblue,
|
|
mintcream, mistyrose, moccasin, navajowhite, navy,
|
|
oldlace, olive, olivedrab, orange, orangered,
|
|
orchid, palegoldenrod, palegreen, paleturquoise,
|
|
palevioletred, papayawhip, peachpuff, peru, pink,
|
|
plum, powderblue, purple, red, rosybrown,
|
|
royalblue, rebeccapurple, saddlebrown, salmon,
|
|
sandybrown, seagreen, seashell, sienna, silver,
|
|
skyblue, slateblue, slategray, slategrey, snow,
|
|
springgreen, steelblue, tan, teal, thistle, tomato,
|
|
turquoise, violet, wheat, white, whitesmoke,
|
|
yellow, yellowgreen
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["bgcolor"]
|
|
|
|
@bgcolor.setter
|
|
def bgcolor(self, val):
|
|
self["bgcolor"] = val
|
|
|
|
# color
|
|
# -----
|
|
@property
|
|
def color(self):
|
|
"""
|
|
Sets the color of the icons in the modebar.
|
|
|
|
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:
|
|
aliceblue, antiquewhite, aqua, aquamarine, azure,
|
|
beige, bisque, black, blanchedalmond, blue,
|
|
blueviolet, brown, burlywood, cadetblue,
|
|
chartreuse, chocolate, coral, cornflowerblue,
|
|
cornsilk, crimson, cyan, darkblue, darkcyan,
|
|
darkgoldenrod, darkgray, darkgrey, darkgreen,
|
|
darkkhaki, darkmagenta, darkolivegreen, darkorange,
|
|
darkorchid, darkred, darksalmon, darkseagreen,
|
|
darkslateblue, darkslategray, darkslategrey,
|
|
darkturquoise, darkviolet, deeppink, deepskyblue,
|
|
dimgray, dimgrey, dodgerblue, firebrick,
|
|
floralwhite, forestgreen, fuchsia, gainsboro,
|
|
ghostwhite, gold, goldenrod, gray, grey, green,
|
|
greenyellow, honeydew, hotpink, indianred, indigo,
|
|
ivory, khaki, lavender, lavenderblush, lawngreen,
|
|
lemonchiffon, lightblue, lightcoral, lightcyan,
|
|
lightgoldenrodyellow, lightgray, lightgrey,
|
|
lightgreen, lightpink, lightsalmon, lightseagreen,
|
|
lightskyblue, lightslategray, lightslategrey,
|
|
lightsteelblue, lightyellow, lime, limegreen,
|
|
linen, magenta, maroon, mediumaquamarine,
|
|
mediumblue, mediumorchid, mediumpurple,
|
|
mediumseagreen, mediumslateblue, mediumspringgreen,
|
|
mediumturquoise, mediumvioletred, midnightblue,
|
|
mintcream, mistyrose, moccasin, navajowhite, navy,
|
|
oldlace, olive, olivedrab, orange, orangered,
|
|
orchid, palegoldenrod, palegreen, paleturquoise,
|
|
palevioletred, papayawhip, peachpuff, peru, pink,
|
|
plum, powderblue, purple, red, rosybrown,
|
|
royalblue, rebeccapurple, saddlebrown, salmon,
|
|
sandybrown, seagreen, seashell, sienna, silver,
|
|
skyblue, slateblue, slategray, slategrey, snow,
|
|
springgreen, steelblue, tan, teal, thistle, tomato,
|
|
turquoise, violet, wheat, white, whitesmoke,
|
|
yellow, yellowgreen
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["color"]
|
|
|
|
@color.setter
|
|
def color(self, val):
|
|
self["color"] = val
|
|
|
|
# orientation
|
|
# -----------
|
|
@property
|
|
def orientation(self):
|
|
"""
|
|
Sets the orientation of the modebar.
|
|
|
|
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
|
|
|
|
# remove
|
|
# ------
|
|
@property
|
|
def remove(self):
|
|
"""
|
|
Determines which predefined modebar buttons to remove. Similar
|
|
to `config.modeBarButtonsToRemove` option. This may include
|
|
"autoScale2d", "autoscale", "editInChartStudio",
|
|
"editinchartstudio", "hoverCompareCartesian", "hovercompare",
|
|
"lasso", "lasso2d", "orbitRotation", "orbitrotation", "pan",
|
|
"pan2d", "pan3d", "reset", "resetCameraDefault3d",
|
|
"resetCameraLastSave3d", "resetGeo", "resetSankeyGroup",
|
|
"resetScale2d", "resetViewMapbox", "resetViews",
|
|
"resetcameradefault", "resetcameralastsave",
|
|
"resetsankeygroup", "resetscale", "resetview", "resetviews",
|
|
"select", "select2d", "sendDataToCloud", "senddatatocloud",
|
|
"tableRotation", "tablerotation", "toImage", "toggleHover",
|
|
"toggleSpikelines", "togglehover", "togglespikelines",
|
|
"toimage", "zoom", "zoom2d", "zoom3d", "zoomIn2d", "zoomInGeo",
|
|
"zoomInMapbox", "zoomOut2d", "zoomOutGeo", "zoomOutMapbox",
|
|
"zoomin", "zoomout".
|
|
|
|
The 'remove' 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["remove"]
|
|
|
|
@remove.setter
|
|
def remove(self, val):
|
|
self["remove"] = val
|
|
|
|
# removesrc
|
|
# ---------
|
|
@property
|
|
def removesrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `remove`.
|
|
|
|
The 'removesrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["removesrc"]
|
|
|
|
@removesrc.setter
|
|
def removesrc(self, val):
|
|
self["removesrc"] = val
|
|
|
|
# uirevision
|
|
# ----------
|
|
@property
|
|
def uirevision(self):
|
|
"""
|
|
Controls persistence of user-driven changes related to the
|
|
modebar, including `hovermode`, `dragmode`, and `showspikes` at
|
|
both the root level and inside subplots. Defaults to
|
|
`layout.uirevision`.
|
|
|
|
The 'uirevision' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["uirevision"]
|
|
|
|
@uirevision.setter
|
|
def uirevision(self, val):
|
|
self["uirevision"] = val
|
|
|
|
# Self properties description
|
|
# ---------------------------
|
|
@property
|
|
def _prop_descriptions(self):
|
|
return """\
|
|
activecolor
|
|
Sets the color of the active or hovered on icons in the
|
|
modebar.
|
|
add
|
|
Determines which predefined modebar buttons to add.
|
|
Please note that these buttons will only be shown if
|
|
they are compatible with all trace types used in a
|
|
graph. Similar to `config.modeBarButtonsToAdd` option.
|
|
This may include "v1hovermode", "hoverclosest",
|
|
"hovercompare", "togglehover", "togglespikelines",
|
|
"drawline", "drawopenpath", "drawclosedpath",
|
|
"drawcircle", "drawrect", "eraseshape".
|
|
addsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`add`.
|
|
bgcolor
|
|
Sets the background color of the modebar.
|
|
color
|
|
Sets the color of the icons in the modebar.
|
|
orientation
|
|
Sets the orientation of the modebar.
|
|
remove
|
|
Determines which predefined modebar buttons to remove.
|
|
Similar to `config.modeBarButtonsToRemove` option. This
|
|
may include "autoScale2d", "autoscale",
|
|
"editInChartStudio", "editinchartstudio",
|
|
"hoverCompareCartesian", "hovercompare", "lasso",
|
|
"lasso2d", "orbitRotation", "orbitrotation", "pan",
|
|
"pan2d", "pan3d", "reset", "resetCameraDefault3d",
|
|
"resetCameraLastSave3d", "resetGeo",
|
|
"resetSankeyGroup", "resetScale2d", "resetViewMapbox",
|
|
"resetViews", "resetcameradefault",
|
|
"resetcameralastsave", "resetsankeygroup",
|
|
"resetscale", "resetview", "resetviews", "select",
|
|
"select2d", "sendDataToCloud", "senddatatocloud",
|
|
"tableRotation", "tablerotation", "toImage",
|
|
"toggleHover", "toggleSpikelines", "togglehover",
|
|
"togglespikelines", "toimage", "zoom", "zoom2d",
|
|
"zoom3d", "zoomIn2d", "zoomInGeo", "zoomInMapbox",
|
|
"zoomOut2d", "zoomOutGeo", "zoomOutMapbox", "zoomin",
|
|
"zoomout".
|
|
removesrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`remove`.
|
|
uirevision
|
|
Controls persistence of user-driven changes related to
|
|
the modebar, including `hovermode`, `dragmode`, and
|
|
`showspikes` at both the root level and inside
|
|
subplots. Defaults to `layout.uirevision`.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
arg=None,
|
|
activecolor=None,
|
|
add=None,
|
|
addsrc=None,
|
|
bgcolor=None,
|
|
color=None,
|
|
orientation=None,
|
|
remove=None,
|
|
removesrc=None,
|
|
uirevision=None,
|
|
**kwargs,
|
|
):
|
|
"""
|
|
Construct a new Modebar object
|
|
|
|
Parameters
|
|
----------
|
|
arg
|
|
dict of properties compatible with this constructor or
|
|
an instance of
|
|
:class:`plotly.graph_objs.layout.Modebar`
|
|
activecolor
|
|
Sets the color of the active or hovered on icons in the
|
|
modebar.
|
|
add
|
|
Determines which predefined modebar buttons to add.
|
|
Please note that these buttons will only be shown if
|
|
they are compatible with all trace types used in a
|
|
graph. Similar to `config.modeBarButtonsToAdd` option.
|
|
This may include "v1hovermode", "hoverclosest",
|
|
"hovercompare", "togglehover", "togglespikelines",
|
|
"drawline", "drawopenpath", "drawclosedpath",
|
|
"drawcircle", "drawrect", "eraseshape".
|
|
addsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`add`.
|
|
bgcolor
|
|
Sets the background color of the modebar.
|
|
color
|
|
Sets the color of the icons in the modebar.
|
|
orientation
|
|
Sets the orientation of the modebar.
|
|
remove
|
|
Determines which predefined modebar buttons to remove.
|
|
Similar to `config.modeBarButtonsToRemove` option. This
|
|
may include "autoScale2d", "autoscale",
|
|
"editInChartStudio", "editinchartstudio",
|
|
"hoverCompareCartesian", "hovercompare", "lasso",
|
|
"lasso2d", "orbitRotation", "orbitrotation", "pan",
|
|
"pan2d", "pan3d", "reset", "resetCameraDefault3d",
|
|
"resetCameraLastSave3d", "resetGeo",
|
|
"resetSankeyGroup", "resetScale2d", "resetViewMapbox",
|
|
"resetViews", "resetcameradefault",
|
|
"resetcameralastsave", "resetsankeygroup",
|
|
"resetscale", "resetview", "resetviews", "select",
|
|
"select2d", "sendDataToCloud", "senddatatocloud",
|
|
"tableRotation", "tablerotation", "toImage",
|
|
"toggleHover", "toggleSpikelines", "togglehover",
|
|
"togglespikelines", "toimage", "zoom", "zoom2d",
|
|
"zoom3d", "zoomIn2d", "zoomInGeo", "zoomInMapbox",
|
|
"zoomOut2d", "zoomOutGeo", "zoomOutMapbox", "zoomin",
|
|
"zoomout".
|
|
removesrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`remove`.
|
|
uirevision
|
|
Controls persistence of user-driven changes related to
|
|
the modebar, including `hovermode`, `dragmode`, and
|
|
`showspikes` at both the root level and inside
|
|
subplots. Defaults to `layout.uirevision`.
|
|
|
|
Returns
|
|
-------
|
|
Modebar
|
|
"""
|
|
super(Modebar, self).__init__("modebar")
|
|
|
|
if "_parent" in kwargs:
|
|
self._parent = kwargs["_parent"]
|
|
return
|
|
|
|
# Validate arg
|
|
# ------------
|
|
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.layout.Modebar
|
|
constructor must be a dict or
|
|
an instance of :class:`plotly.graph_objs.layout.Modebar`"""
|
|
)
|
|
|
|
# Handle skip_invalid
|
|
# -------------------
|
|
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
|
self._validate = kwargs.pop("_validate", True)
|
|
|
|
# Populate data dict with properties
|
|
# ----------------------------------
|
|
_v = arg.pop("activecolor", None)
|
|
_v = activecolor if activecolor is not None else _v
|
|
if _v is not None:
|
|
self["activecolor"] = _v
|
|
_v = arg.pop("add", None)
|
|
_v = add if add is not None else _v
|
|
if _v is not None:
|
|
self["add"] = _v
|
|
_v = arg.pop("addsrc", None)
|
|
_v = addsrc if addsrc is not None else _v
|
|
if _v is not None:
|
|
self["addsrc"] = _v
|
|
_v = arg.pop("bgcolor", None)
|
|
_v = bgcolor if bgcolor is not None else _v
|
|
if _v is not None:
|
|
self["bgcolor"] = _v
|
|
_v = arg.pop("color", None)
|
|
_v = color if color is not None else _v
|
|
if _v is not None:
|
|
self["color"] = _v
|
|
_v = arg.pop("orientation", None)
|
|
_v = orientation if orientation is not None else _v
|
|
if _v is not None:
|
|
self["orientation"] = _v
|
|
_v = arg.pop("remove", None)
|
|
_v = remove if remove is not None else _v
|
|
if _v is not None:
|
|
self["remove"] = _v
|
|
_v = arg.pop("removesrc", None)
|
|
_v = removesrc if removesrc is not None else _v
|
|
if _v is not None:
|
|
self["removesrc"] = _v
|
|
_v = arg.pop("uirevision", None)
|
|
_v = uirevision if uirevision is not None else _v
|
|
if _v is not None:
|
|
self["uirevision"] = _v
|
|
|
|
# Process unknown kwargs
|
|
# ----------------------
|
|
self._process_kwargs(**dict(arg, **kwargs))
|
|
|
|
# Reset skip_invalid
|
|
# ------------------
|
|
self._skip_invalid = False
|