_contour.py

fromplotly.basedatatypesimportBaseTraceTypeas_BaseTraceType
importcopyas_copy


classContour(_BaseTraceType):

# class properties
# --------------------
_parent_path_str=""
_path_str="contour"
_valid_props= {
"autocolorscale",
"autocontour",
"coloraxis",
"colorbar",
"colorscale",
"connectgaps",
"contours",
"customdata",
"customdatasrc",
"dx",
"dy",
"fillcolor",
"hoverinfo",
"hoverinfosrc",
"hoverlabel",
"hoverongaps",
"hovertemplate",
"hovertemplatesrc",
"hovertext",
"hovertextsrc",
"ids",
"idssrc",
"legend",
"legendgroup",
"legendgrouptitle",
"legendrank",
"legendwidth",
"line",
"meta",
"metasrc",
"name",
"ncontours",
"opacity",
"reversescale",
"showlegend",
"showscale",
"stream",
"text",
"textfont",
"textsrc",
"texttemplate",
"transpose",
"type",
"uid",
"uirevision",
"visible",
"x",
"x0",
"xaxis",
"xcalendar",
"xhoverformat",
"xperiod",
"xperiod0",
"xperiodalignment",
"xsrc",
"xtype",
"y",
"y0",
"yaxis",
"ycalendar",
"yhoverformat",
"yperiod",
"yperiod0",
"yperiodalignment",
"ysrc",
"ytype",
"z",
"zauto",
"zhoverformat",
"zmax",
"zmid",
"zmin",
"zorder",
"zsrc",
 }

# autocolorscale
# --------------
@property
defautocolorscale(self):
"""
 Determines whether the colorscale is a default palette
 (`autocolorscale: true`) or the palette determined by
 `colorscale`. 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
 """
returnself["autocolorscale"]

@autocolorscale.setter
defautocolorscale(self, val):
self["autocolorscale"] =val

# autocontour
# -----------
@property
defautocontour(self):
"""
 Determines whether or not the contour level attributes are
 picked by an algorithm. If True, the number of contour levels
 can be set in `ncontours`. If False, set the contour level
 attributes in `contours`.

 The 'autocontour' property must be specified as a bool
 (either True, or False)

 Returns
 -------
 bool
 """
returnself["autocontour"]

@autocontour.setter
defautocontour(self, val):
self["autocontour"] =val

# coloraxis
# ---------
@property
defcoloraxis(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
 """
returnself["coloraxis"]

@coloraxis.setter
defcoloraxis(self, val):
self["coloraxis"] =val

# colorbar
# --------
@property
defcolorbar(self):
"""
 The 'colorbar' property is an instance of ColorBar
 that may be specified as:
 - An instance of :class:`plotly.graph_objs.contour.ColorBar`
 - A dict of string/value properties that will be passed
 to the ColorBar constructor

 Supported dict properties:

 bgcolor
 Sets the color of padded area.
 bordercolor
 Sets the axis line color.
 borderwidth
 Sets the width (in px) or the border enclosing
 this color bar.
 dtick
 Sets the step in-between ticks on this axis.
 Use with `tick0`. Must be a positive number, or
 special strings available to "log" and "date"
 axes. If the axis `type` is "log", then ticks
 are set every 10^(n*dtick) where n is the tick
 number. For example, to set a tick mark at 1,
 10, 100, 1000, ... set dtick to 1. To set tick
 marks at 1, 100, 10000, ... set dtick to 2. To
 set tick marks at 1, 5, 25, 125, 625, 3125, ...
 set dtick to log_10(5), or 0.69897000433. "log"
 has several special values; "L<f>", where `f`
 is a positive number, gives ticks linearly
 spaced in value (but not position). For example
 `tick0` = 0.1, `dtick` = "L0.5" will put ticks
 at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
 plus small digits between, use "D1" (all
 digits) or "D2" (only 2 and 5). `tick0` is
 ignored for "D1" and "D2". If the axis `type`
 is "date", then you must convert the time to
 milliseconds. For example, to set the interval
 between ticks to one day, set `dtick` to
 86400000.0. "date" also has special values
 "M<n>" gives ticks spaced by a number of
 months. `n` must be a positive integer. To set
 ticks on the 15th of every third month, set
 `tick0` to "2000-01-15" and `dtick` to "M3". To
 set ticks every 4 years, set `dtick` to "M48"
 exponentformat
 Determines a formatting rule for the tick
 exponents. For example, consider the number
 1,000,000,000. If "none", it appears as
 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If
 "power", 1x10^9 (with 9 in a super script). If
 "SI", 1G. If "B", 1B.
 labelalias
 Replacement text for specific tick or hover
 labels. For example using {US: 'USA', CA:
 'Canada'} changes US to USA and CA to Canada.
 The labels we would have shown must match the
 keys exactly, after adding any tickprefix or
 ticksuffix. For negative numbers the minus sign
 symbol used (U+2212) is wider than the regular
 ascii dash. That means you need to use −1
 instead of -1. labelalias can be used with any
 axis type, and both keys (if needed) and values
 (if desired) can include html-like tags or
 MathJax.
 len
 Sets the length of the color bar This measure
 excludes the padding of both ends. That is, the
 color bar length is this length minus the
 padding on both ends.
 lenmode
 Determines whether this color bar's length
 (i.e. the measure in the color variation
 direction) is set in units of plot "fraction"
 or in *pixels. Use `len` to set the value.
 minexponent
 Hide SI prefix for 10^n if |n| is below this
 number. This only has an effect when
 `tickformat` is "SI" or "B".
 nticks
 Specifies the maximum number of ticks for the
 particular axis. The actual number of ticks
 will be chosen automatically to be less than or
 equal to `nticks`. Has an effect only if
 `tickmode` is set to "auto".
 orientation
 Sets the orientation of the colorbar.
 outlinecolor
 Sets the axis line color.
 outlinewidth
 Sets the width (in px) of the axis line.
 separatethousands
 If "true", even 4-digit integers are separated
 showexponent
 If "all", all exponents are shown besides their
 significands. If "first", only the exponent of
 the first tick is shown. If "last", only the
 exponent of the last tick is shown. If "none",
 no exponents appear.
 showticklabels
 Determines whether or not the tick labels are
 drawn.
 showtickprefix
 If "all", all tick labels are displayed with a
 prefix. If "first", only the first tick is
 displayed with a prefix. If "last", only the
 last tick is displayed with a suffix. If
 "none", tick prefixes are hidden.
 showticksuffix
 Same as `showtickprefix` but for tick suffixes.
 thickness
 Sets the thickness of the color bar This
 measure excludes the size of the padding, ticks
 and labels.
 thicknessmode
 Determines whether this color bar's thickness
 (i.e. the measure in the constant color
 direction) is set in units of plot "fraction"
 or in "pixels". Use `thickness` to set the
 value.
 tick0
 Sets the placement of the first tick on this
 axis. Use with `dtick`. If the axis `type` is
 "log", then you must take the log of your
 starting tick (e.g. to set the starting tick to
 100, set the `tick0` to 2) except when
 `dtick`=*L<f>* (see `dtick` for more info). If
 the axis `type` is "date", it should be a date
 string, like date data. If the axis `type` is
 "category", it should be a number, using the
 scale where each category is assigned a serial
 number from zero in the order it appears.
 tickangle
 Sets the angle of the tick labels with respect
 to the horizontal. For example, a `tickangle`
 of -90 draws the tick labels vertically.
 tickcolor
 Sets the tick color.
 tickfont
 Sets the color bar's tick label font
 tickformat
 Sets the tick label formatting rule using d3
 formatting mini-languages which are very
 similar to those in Python. For numbers, see: h
 ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
 format. And for dates see:
 https://github.com/d3/d3-time-
 format/tree/v2.2.3#locale_format. We add two
 items to d3's date formatter: "%h" for half of
 the year as a decimal number as well as "%{n}f"
 for fractional seconds with n digits. For
 example, *2016-10-13 09:15:23.456* with
 tickformat "%H~%M~%S.%2f" would display
 "09~15~23.46"
 tickformatstops
 A tuple of :class:`plotly.graph_objects.contour
 .colorbar.Tickformatstop` instances or dicts
 with compatible properties
 tickformatstopdefaults
 When used in a template (as layout.template.dat
 a.contour.colorbar.tickformatstopdefaults),
 sets the default property values to use for
 elements of contour.colorbar.tickformatstops
 ticklabeloverflow
 Determines how we handle tick labels that would
 overflow either the graph div or the domain of
 the axis. The default value for inside tick
 labels is *hide past domain*. In other cases
 the default is *hide past div*.
 ticklabelposition
 Determines where tick labels are drawn relative
 to the ticks. Left and right options are used
 when `orientation` is "h", top and bottom when
 `orientation` is "v".
 ticklabelstep
 Sets the spacing between tick labels as
 compared to the spacing between ticks. A value
 of 1 (default) means each tick gets a label. A
 value of 2 means shows every 2nd label. A
 larger value n means only every nth tick is
 labeled. `tick0` determines which labels are
 shown. Not implemented for axes with `type`
 "log" or "multicategory", or when `tickmode` is
 "array".
 ticklen
 Sets the tick length (in px).
 tickmode
 Sets the tick mode for this axis. If "auto",
 the number of ticks is set via `nticks`. If
 "linear", the placement of the ticks is
 determined by a starting position `tick0` and a
 tick step `dtick` ("linear" is the default
 value if `tick0` and `dtick` are provided). If
 "array", the placement of the ticks is set via
 `tickvals` and the tick text is `ticktext`.
 ("array" is the default value if `tickvals` is
 provided).
 tickprefix
 Sets a tick label prefix.
 ticks
 Determines whether ticks are drawn or not. If
 "", this axis' ticks are not drawn. If
 "outside" ("inside"), this axis' are drawn
 outside (inside) the axis lines.
 ticksuffix
 Sets a tick label suffix.
 ticktext
 Sets the text displayed at the ticks position
 via `tickvals`. Only has an effect if
 `tickmode` is set to "array". Used with
 `tickvals`.
 ticktextsrc
 Sets the source reference on Chart Studio Cloud
 for `ticktext`.
 tickvals
 Sets the values at which ticks on this axis
 appear. Only has an effect if `tickmode` is set
 to "array". Used with `ticktext`.
 tickvalssrc
 Sets the source reference on Chart Studio Cloud
 for `tickvals`.
 tickwidth
 Sets the tick width (in px).
 title
 :class:`plotly.graph_objects.contour.colorbar.T
 itle` instance or dict with compatible
 properties
 x
 Sets the x position with respect to `xref` of
 the color bar (in plot fraction). When `xref`
 is "paper", defaults to 1.02 when `orientation`
 is "v" and 0.5 when `orientation` is "h". When
 `xref` is "container", defaults to 1 when
 `orientation` is "v" and 0.5 when `orientation`
 is "h". Must be between 0 and 1 if `xref` is
 "container" and between "-2" and 3 if `xref` is
 "paper".
 xanchor
 Sets this color bar's horizontal position
 anchor. This anchor binds the `x` position to
 the "left", "center" or "right" of the color
 bar. Defaults to "left" when `orientation` is
 "v" and "center" when `orientation` is "h".
 xpad
 Sets the amount of padding (in px) along the x
 direction.
 xref
 Sets the container `x` refers to. "container"
 spans the entire `width` of the plot. "paper"
 refers to the width of the plotting area only.
 y
 Sets the y position with respect to `yref` of
 the color bar (in plot fraction). When `yref`
 is "paper", defaults to 0.5 when `orientation`
 is "v" and 1.02 when `orientation` is "h". When
 `yref` is "container", defaults to 0.5 when
 `orientation` is "v" and 1 when `orientation`
 is "h". Must be between 0 and 1 if `yref` is
 "container" and between "-2" and 3 if `yref` is
 "paper".
 yanchor
 Sets this color bar's vertical position anchor
 This anchor binds the `y` position to the
 "top", "middle" or "bottom" of the color bar.
 Defaults to "middle" when `orientation` is "v"
 and "bottom" when `orientation` is "h".
 ypad
 Sets the amount of padding (in px) along the y
 direction.
 yref
 Sets the container `y` refers to. "container"
 spans the entire `height` of the plot. "paper"
 refers to the height of the plotting area only.

 Returns
 -------
 plotly.graph_objs.contour.ColorBar
 """
returnself["colorbar"]

@colorbar.setter
defcolorbar(self, val):
self["colorbar"] =val

# colorscale
# ----------
@property
defcolorscale(self):
"""
 Sets the colorscale. 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 `zmin` and `zmax`.
 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
 """
returnself["colorscale"]

@colorscale.setter
defcolorscale(self, val):
self["colorscale"] =val

# connectgaps
# -----------
@property
defconnectgaps(self):
"""
 Determines whether or not gaps (i.e. {nan} or missing values)
 in the `z` data are filled in. It is defaulted to true if `z`
 is a one dimensional array otherwise it is defaulted to false.

 The 'connectgaps' property must be specified as a bool
 (either True, or False)

 Returns
 -------
 bool
 """
returnself["connectgaps"]

@connectgaps.setter
defconnectgaps(self, val):
self["connectgaps"] =val

# contours
# --------
@property
defcontours(self):
"""
 The 'contours' property is an instance of Contours
 that may be specified as:
 - An instance of :class:`plotly.graph_objs.contour.Contours`
 - A dict of string/value properties that will be passed
 to the Contours constructor

 Supported dict properties:

 coloring
 Determines the coloring method showing the
 contour values. If "fill", coloring is done
 evenly between each contour level If "heatmap",
 a heatmap gradient coloring is applied between
 each contour level. If "lines", coloring is
 done on the contour lines. If "none", no
 coloring is applied on this trace.
 end
 Sets the end contour level value. Must be more
 than `contours.start`
 labelfont
 Sets the font used for labeling the contour
 levels. The default color comes from the lines,
 if shown. The default family and size come from
 `layout.font`.
 labelformat
 Sets the contour label formatting rule using d3
 formatting mini-languages which are very
 similar to those in Python. For numbers, see: h
 ttps://github.com/d3/d3-format/tree/v1.4.5#d3-
 format.
 operation
 Sets the constraint operation. "=" keeps
 regions equal to `value` "<" and "<=" keep
 regions less than `value` ">" and ">=" keep
 regions greater than `value` "[]", "()", "[)",
 and "(]" keep regions inside `value[0]` to
 `value[1]` "][", ")(", "](", ")[" keep regions
 outside `value[0]` to value[1]` Open vs. closed
 intervals make no difference to constraint
 display, but all versions are allowed for
 consistency with filter transforms.
 showlabels
 Determines whether to label the contour lines
 with their values.
 showlines
 Determines whether or not the contour lines are
 drawn. Has an effect only if
 `contours.coloring` is set to "fill".
 size
 Sets the step between each contour level. Must
 be positive.
 start
 Sets the starting contour level value. Must be
 less than `contours.end`
 type
 If `levels`, the data is represented as a
 contour plot with multiple levels displayed. If
 `constraint`, the data is represented as
 constraints with the invalid region shaded as
 specified by the `operation` and `value`
 parameters.
 value
 Sets the value or values of the constraint
 boundary. When `operation` is set to one of the
 comparison values (=,<,>=,>,<=) "value" is
 expected to be a number. When `operation` is
 set to one of the interval values
 ([],(),[),(],][,)(,](,)[) "value" is expected
 to be an array of two numbers where the first
 is the lower bound and the second is the upper
 bound.

 Returns
 -------
 plotly.graph_objs.contour.Contours
 """
returnself["contours"]

@contours.setter
defcontours(self, val):
self["contours"] =val

# customdata
# ----------
@property
defcustomdata(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
 """
returnself["customdata"]

@customdata.setter
defcustomdata(self, val):
self["customdata"] =val

# customdatasrc
# -------------
@property
defcustomdatasrc(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
 """
returnself["customdatasrc"]

@customdatasrc.setter
defcustomdatasrc(self, val):
self["customdatasrc"] =val

# dx
# --
@property
defdx(self):
"""
 Sets the x coordinate step. See `x0` for more info.

 The 'dx' property is a number and may be specified as:
 - An int or float

 Returns
 -------
 int|float
 """
returnself["dx"]

@dx.setter
defdx(self, val):
self["dx"] =val

# dy
# --
@property
defdy(self):
"""
 Sets the y coordinate step. See `y0` for more info.

 The 'dy' property is a number and may be specified as:
 - An int or float

 Returns
 -------
 int|float
 """
returnself["dy"]

@dy.setter
defdy(self, val):
self["dy"] =val

# fillcolor
# ---------
@property
deffillcolor(self):
"""
 Sets the fill color if `contours.type` is "constraint".
 Defaults to a half-transparent variant of the line color,
 marker color, or marker line color, whichever is available.

 The 'fillcolor' 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
 - A number that will be interpreted as a color
 according to contour.colorscale

 Returns
 -------
 str
 """
returnself["fillcolor"]

@fillcolor.setter
deffillcolor(self, val):
self["fillcolor"] =val

# hoverinfo
# ---------
@property
defhoverinfo(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
 """
returnself["hoverinfo"]

@hoverinfo.setter
defhoverinfo(self, val):
self["hoverinfo"] =val

# hoverinfosrc
# ------------
@property
defhoverinfosrc(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
 """
returnself["hoverinfosrc"]

@hoverinfosrc.setter
defhoverinfosrc(self, val):
self["hoverinfosrc"] =val

# hoverlabel
# ----------
@property
defhoverlabel(self):
"""
 The 'hoverlabel' property is an instance of Hoverlabel
 that may be specified as:
 - An instance of :class:`plotly.graph_objs.contour.Hoverlabel`
 - A dict of string/value properties that will be passed
 to the Hoverlabel constructor

 Supported dict properties:

 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`.

 Returns
 -------
 plotly.graph_objs.contour.Hoverlabel
 """
returnself["hoverlabel"]

@hoverlabel.setter
defhoverlabel(self, val):
self["hoverlabel"] =val

# hoverongaps
# -----------
@property
defhoverongaps(self):
"""
 Determines whether or not gaps (i.e. {nan} or missing values)
 in the `z` data have hover labels associated with them.

 The 'hoverongaps' property must be specified as a bool
 (either True, or False)

 Returns
 -------
 bool
 """
returnself["hoverongaps"]

@hoverongaps.setter
defhoverongaps(self, val):
self["hoverongaps"] =val

# hovertemplate
# -------------
@property
defhovertemplate(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. 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
 - A tuple, list, or one-dimensional numpy array of the above

 Returns
 -------
 str|numpy.ndarray
 """
returnself["hovertemplate"]

@hovertemplate.setter
defhovertemplate(self, val):
self["hovertemplate"] =val

# hovertemplatesrc
# ----------------
@property
defhovertemplatesrc(self):
"""
 Sets the source reference on Chart Studio Cloud for
 `hovertemplate`.

 The 'hovertemplatesrc' property must be specified as a string or
 as a plotly.grid_objs.Column object

 Returns
 -------
 str
 """
returnself["hovertemplatesrc"]

@hovertemplatesrc.setter
defhovertemplatesrc(self, val):
self["hovertemplatesrc"] =val

# hovertext
# ---------
@property
defhovertext(self):
"""
 Same as `text`.

 The 'hovertext' property is an array that may be specified as a tuple,
 list, numpy array, or pandas Series

 Returns
 -------
 numpy.ndarray
 """
returnself["hovertext"]

@hovertext.setter
defhovertext(self, val):
self["hovertext"] =val

# hovertextsrc
# ------------
@property
defhovertextsrc(self):
"""
 Sets the source reference on Chart Studio Cloud for
 `hovertext`.

 The 'hovertextsrc' property must be specified as a string or
 as a plotly.grid_objs.Column object

 Returns
 -------
 str
 """
returnself["hovertextsrc"]

@hovertextsrc.setter
defhovertextsrc(self, val):
self["hovertextsrc"] =val

# ids
# ---
@property
defids(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.