2619 lines
90 KiB
Python
2619 lines
90 KiB
Python
# --- 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 Contour(_BaseTraceType):
|
|
_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",
|
|
}
|
|
|
|
@property
|
|
def autocolorscale(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
|
|
"""
|
|
return self["autocolorscale"]
|
|
|
|
@autocolorscale.setter
|
|
def autocolorscale(self, val):
|
|
self["autocolorscale"] = val
|
|
|
|
@property
|
|
def autocontour(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
|
|
"""
|
|
return self["autocontour"]
|
|
|
|
@autocontour.setter
|
|
def autocontour(self, val):
|
|
self["autocontour"] = 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.contour.ColorBar`
|
|
- A dict of string/value properties that will be passed
|
|
to the ColorBar constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.contour.ColorBar
|
|
"""
|
|
return self["colorbar"]
|
|
|
|
@colorbar.setter
|
|
def colorbar(self, val):
|
|
self["colorbar"] = val
|
|
|
|
@property
|
|
def colorscale(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
|
|
"""
|
|
return self["colorscale"]
|
|
|
|
@colorscale.setter
|
|
def colorscale(self, val):
|
|
self["colorscale"] = val
|
|
|
|
@property
|
|
def connectgaps(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
|
|
"""
|
|
return self["connectgaps"]
|
|
|
|
@connectgaps.setter
|
|
def connectgaps(self, val):
|
|
self["connectgaps"] = val
|
|
|
|
@property
|
|
def contours(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
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.contour.Contours
|
|
"""
|
|
return self["contours"]
|
|
|
|
@contours.setter
|
|
def contours(self, val):
|
|
self["contours"] = 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 dx(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
|
|
"""
|
|
return self["dx"]
|
|
|
|
@dx.setter
|
|
def dx(self, val):
|
|
self["dx"] = val
|
|
|
|
@property
|
|
def dy(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
|
|
"""
|
|
return self["dy"]
|
|
|
|
@dy.setter
|
|
def dy(self, val):
|
|
self["dy"] = val
|
|
|
|
@property
|
|
def fillcolor(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: see https://plotly.com/python/css-colors/ for a list
|
|
- A number that will be interpreted as a color
|
|
according to contour.colorscale
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["fillcolor"]
|
|
|
|
@fillcolor.setter
|
|
def fillcolor(self, val):
|
|
self["fillcolor"] = 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.contour.Hoverlabel`
|
|
- A dict of string/value properties that will be passed
|
|
to the Hoverlabel constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.contour.Hoverlabel
|
|
"""
|
|
return self["hoverlabel"]
|
|
|
|
@hoverlabel.setter
|
|
def hoverlabel(self, val):
|
|
self["hoverlabel"] = val
|
|
|
|
@property
|
|
def hoverongaps(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
|
|
"""
|
|
return self["hoverongaps"]
|
|
|
|
@hoverongaps.setter
|
|
def hoverongaps(self, val):
|
|
self["hoverongaps"] = 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. 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
|
|
"""
|
|
return self["hovertemplate"]
|
|
|
|
@hovertemplate.setter
|
|
def hovertemplate(self, val):
|
|
self["hovertemplate"] = val
|
|
|
|
@property
|
|
def hovertemplatesrc(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
|
|
"""
|
|
return self["hovertemplatesrc"]
|
|
|
|
@hovertemplatesrc.setter
|
|
def hovertemplatesrc(self, val):
|
|
self["hovertemplatesrc"] = val
|
|
|
|
@property
|
|
def hovertext(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
|
|
"""
|
|
return self["hovertext"]
|
|
|
|
@hovertext.setter
|
|
def hovertext(self, val):
|
|
self["hovertext"] = val
|
|
|
|
@property
|
|
def hovertextsrc(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
|
|
"""
|
|
return self["hovertextsrc"]
|
|
|
|
@hovertextsrc.setter
|
|
def hovertextsrc(self, val):
|
|
self["hovertextsrc"] = 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 legendgroup(self):
|
|
"""
|
|
Sets the legend group for this trace. Traces and shapes part of
|
|
the same legend group hide/show at the same time when toggling
|
|
legend items.
|
|
|
|
The 'legendgroup' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["legendgroup"]
|
|
|
|
@legendgroup.setter
|
|
def legendgroup(self, val):
|
|
self["legendgroup"] = 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.contour.Legendgrouptitle`
|
|
- A dict of string/value properties that will be passed
|
|
to the Legendgrouptitle constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.contour.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.contour.Line`
|
|
- A dict of string/value properties that will be passed
|
|
to the Line constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.contour.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 ncontours(self):
|
|
"""
|
|
Sets the maximum number of contour levels. The actual number of
|
|
contours will be chosen automatically to be less than or equal
|
|
to the value of `ncontours`. Has an effect only if
|
|
`autocontour` is True or if `contours.size` is missing.
|
|
|
|
The 'ncontours' 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]
|
|
|
|
Returns
|
|
-------
|
|
int
|
|
"""
|
|
return self["ncontours"]
|
|
|
|
@ncontours.setter
|
|
def ncontours(self, val):
|
|
self["ncontours"] = val
|
|
|
|
@property
|
|
def opacity(self):
|
|
"""
|
|
Sets the opacity of the trace.
|
|
|
|
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 reversescale(self):
|
|
"""
|
|
Reverses the color mapping if true. If true, `zmin` will
|
|
correspond to the last color in the array and `zmax` 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 showlegend(self):
|
|
"""
|
|
Determines whether or not an item corresponding to this trace
|
|
is shown in the legend.
|
|
|
|
The 'showlegend' property must be specified as a bool
|
|
(either True, or False)
|
|
|
|
Returns
|
|
-------
|
|
bool
|
|
"""
|
|
return self["showlegend"]
|
|
|
|
@showlegend.setter
|
|
def showlegend(self, val):
|
|
self["showlegend"] = val
|
|
|
|
@property
|
|
def showscale(self):
|
|
"""
|
|
Determines whether or not a colorbar is displayed for this
|
|
trace.
|
|
|
|
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 stream(self):
|
|
"""
|
|
The 'stream' property is an instance of Stream
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.contour.Stream`
|
|
- A dict of string/value properties that will be passed
|
|
to the Stream constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.contour.Stream
|
|
"""
|
|
return self["stream"]
|
|
|
|
@stream.setter
|
|
def stream(self, val):
|
|
self["stream"] = val
|
|
|
|
@property
|
|
def text(self):
|
|
"""
|
|
Sets the text elements associated with each z value.
|
|
|
|
The 'text' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["text"]
|
|
|
|
@text.setter
|
|
def text(self, val):
|
|
self["text"] = val
|
|
|
|
@property
|
|
def textfont(self):
|
|
"""
|
|
For this trace it only has an effect if `coloring` is set to
|
|
"heatmap". Sets the text font.
|
|
|
|
The 'textfont' property is an instance of Textfont
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.contour.Textfont`
|
|
- A dict of string/value properties that will be passed
|
|
to the Textfont constructor
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.contour.Textfont
|
|
"""
|
|
return self["textfont"]
|
|
|
|
@textfont.setter
|
|
def textfont(self, val):
|
|
self["textfont"] = val
|
|
|
|
@property
|
|
def textsrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `text`.
|
|
|
|
The 'textsrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["textsrc"]
|
|
|
|
@textsrc.setter
|
|
def textsrc(self, val):
|
|
self["textsrc"] = val
|
|
|
|
@property
|
|
def texttemplate(self):
|
|
"""
|
|
For this trace it only has an effect if `coloring` is set to
|
|
"heatmap". Template string used for rendering the information
|
|
text that appear on points. Note that this will override
|
|
`textinfo`. Variables are inserted using %{variable}, for
|
|
example "y: %{y}". 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. Every attributes that can be specified per-
|
|
point (the ones that are `arrayOk: true`) are available.
|
|
Finally, the template string has access to variables `x`, `y`,
|
|
`z` and `text`.
|
|
|
|
The 'texttemplate' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["texttemplate"]
|
|
|
|
@texttemplate.setter
|
|
def texttemplate(self, val):
|
|
self["texttemplate"] = val
|
|
|
|
@property
|
|
def transpose(self):
|
|
"""
|
|
Transposes the z data.
|
|
|
|
The 'transpose' property must be specified as a bool
|
|
(either True, or False)
|
|
|
|
Returns
|
|
-------
|
|
bool
|
|
"""
|
|
return self["transpose"]
|
|
|
|
@transpose.setter
|
|
def transpose(self, val):
|
|
self["transpose"] = 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 x(self):
|
|
"""
|
|
Sets the x coordinates.
|
|
|
|
The 'x' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["x"]
|
|
|
|
@x.setter
|
|
def x(self, val):
|
|
self["x"] = val
|
|
|
|
@property
|
|
def x0(self):
|
|
"""
|
|
Alternate to `x`. Builds a linear space of x coordinates. Use
|
|
with `dx` where `x0` is the starting coordinate and `dx` the
|
|
step.
|
|
|
|
The 'x0' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["x0"]
|
|
|
|
@x0.setter
|
|
def x0(self, val):
|
|
self["x0"] = val
|
|
|
|
@property
|
|
def xaxis(self):
|
|
"""
|
|
Sets a reference between this trace's x coordinates and a 2D
|
|
cartesian x axis. If "x" (the default value), the x coordinates
|
|
refer to `layout.xaxis`. If "x2", the x coordinates refer to
|
|
`layout.xaxis2`, and so on.
|
|
|
|
The 'xaxis' property is an identifier of a particular
|
|
subplot, of type 'x', that may be specified as the string 'x'
|
|
optionally followed by an integer >= 1
|
|
(e.g. 'x', 'x1', 'x2', 'x3', etc.)
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["xaxis"]
|
|
|
|
@xaxis.setter
|
|
def xaxis(self, val):
|
|
self["xaxis"] = val
|
|
|
|
@property
|
|
def xcalendar(self):
|
|
"""
|
|
Sets the calendar system to use with `x` date data.
|
|
|
|
The 'xcalendar' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['chinese', 'coptic', 'discworld', 'ethiopian',
|
|
'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
|
|
'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
|
|
'thai', 'ummalqura']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["xcalendar"]
|
|
|
|
@xcalendar.setter
|
|
def xcalendar(self, val):
|
|
self["xcalendar"] = val
|
|
|
|
@property
|
|
def xhoverformat(self):
|
|
"""
|
|
Sets the hover text formatting rulefor `x` 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. 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*By default the values
|
|
are formatted using `xaxis.hoverformat`.
|
|
|
|
The 'xhoverformat' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["xhoverformat"]
|
|
|
|
@xhoverformat.setter
|
|
def xhoverformat(self, val):
|
|
self["xhoverformat"] = val
|
|
|
|
@property
|
|
def xperiod(self):
|
|
"""
|
|
Only relevant when the axis `type` is "date". Sets the period
|
|
positioning in milliseconds or "M<n>" on the x axis. Special
|
|
values in the form of "M<n>" could be used to declare the
|
|
number of months. In this case `n` must be a positive integer.
|
|
|
|
The 'xperiod' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["xperiod"]
|
|
|
|
@xperiod.setter
|
|
def xperiod(self, val):
|
|
self["xperiod"] = val
|
|
|
|
@property
|
|
def xperiod0(self):
|
|
"""
|
|
Only relevant when the axis `type` is "date". Sets the base for
|
|
period positioning in milliseconds or date string on the x0
|
|
axis. When `x0period` is round number of weeks, the `x0period0`
|
|
by default would be on a Sunday i.e. 2000-01-02, otherwise it
|
|
would be at 2000-01-01.
|
|
|
|
The 'xperiod0' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["xperiod0"]
|
|
|
|
@xperiod0.setter
|
|
def xperiod0(self, val):
|
|
self["xperiod0"] = val
|
|
|
|
@property
|
|
def xperiodalignment(self):
|
|
"""
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
alignment of data points on the x axis.
|
|
|
|
The 'xperiodalignment' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['start', 'middle', 'end']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["xperiodalignment"]
|
|
|
|
@xperiodalignment.setter
|
|
def xperiodalignment(self, val):
|
|
self["xperiodalignment"] = val
|
|
|
|
@property
|
|
def xsrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `x`.
|
|
|
|
The 'xsrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["xsrc"]
|
|
|
|
@xsrc.setter
|
|
def xsrc(self, val):
|
|
self["xsrc"] = val
|
|
|
|
@property
|
|
def xtype(self):
|
|
"""
|
|
If "array", the heatmap's x coordinates are given by "x" (the
|
|
default behavior when `x` is provided). If "scaled", the
|
|
heatmap's x coordinates are given by "x0" and "dx" (the default
|
|
behavior when `x` is not provided).
|
|
|
|
The 'xtype' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['array', 'scaled']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["xtype"]
|
|
|
|
@xtype.setter
|
|
def xtype(self, val):
|
|
self["xtype"] = val
|
|
|
|
@property
|
|
def y(self):
|
|
"""
|
|
Sets the y coordinates.
|
|
|
|
The 'y' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["y"]
|
|
|
|
@y.setter
|
|
def y(self, val):
|
|
self["y"] = val
|
|
|
|
@property
|
|
def y0(self):
|
|
"""
|
|
Alternate to `y`. Builds a linear space of y coordinates. Use
|
|
with `dy` where `y0` is the starting coordinate and `dy` the
|
|
step.
|
|
|
|
The 'y0' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["y0"]
|
|
|
|
@y0.setter
|
|
def y0(self, val):
|
|
self["y0"] = val
|
|
|
|
@property
|
|
def yaxis(self):
|
|
"""
|
|
Sets a reference between this trace's y coordinates and a 2D
|
|
cartesian y axis. If "y" (the default value), the y coordinates
|
|
refer to `layout.yaxis`. If "y2", the y coordinates refer to
|
|
`layout.yaxis2`, and so on.
|
|
|
|
The 'yaxis' property is an identifier of a particular
|
|
subplot, of type 'y', that may be specified as the string 'y'
|
|
optionally followed by an integer >= 1
|
|
(e.g. 'y', 'y1', 'y2', 'y3', etc.)
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["yaxis"]
|
|
|
|
@yaxis.setter
|
|
def yaxis(self, val):
|
|
self["yaxis"] = val
|
|
|
|
@property
|
|
def ycalendar(self):
|
|
"""
|
|
Sets the calendar system to use with `y` date data.
|
|
|
|
The 'ycalendar' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['chinese', 'coptic', 'discworld', 'ethiopian',
|
|
'gregorian', 'hebrew', 'islamic', 'jalali', 'julian',
|
|
'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan',
|
|
'thai', 'ummalqura']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["ycalendar"]
|
|
|
|
@ycalendar.setter
|
|
def ycalendar(self, val):
|
|
self["ycalendar"] = val
|
|
|
|
@property
|
|
def yhoverformat(self):
|
|
"""
|
|
Sets the hover text formatting rulefor `y` 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. 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*By default the values
|
|
are formatted using `yaxis.hoverformat`.
|
|
|
|
The 'yhoverformat' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["yhoverformat"]
|
|
|
|
@yhoverformat.setter
|
|
def yhoverformat(self, val):
|
|
self["yhoverformat"] = val
|
|
|
|
@property
|
|
def yperiod(self):
|
|
"""
|
|
Only relevant when the axis `type` is "date". Sets the period
|
|
positioning in milliseconds or "M<n>" on the y axis. Special
|
|
values in the form of "M<n>" could be used to declare the
|
|
number of months. In this case `n` must be a positive integer.
|
|
|
|
The 'yperiod' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["yperiod"]
|
|
|
|
@yperiod.setter
|
|
def yperiod(self, val):
|
|
self["yperiod"] = val
|
|
|
|
@property
|
|
def yperiod0(self):
|
|
"""
|
|
Only relevant when the axis `type` is "date". Sets the base for
|
|
period positioning in milliseconds or date string on the y0
|
|
axis. When `y0period` is round number of weeks, the `y0period0`
|
|
by default would be on a Sunday i.e. 2000-01-02, otherwise it
|
|
would be at 2000-01-01.
|
|
|
|
The 'yperiod0' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["yperiod0"]
|
|
|
|
@yperiod0.setter
|
|
def yperiod0(self, val):
|
|
self["yperiod0"] = val
|
|
|
|
@property
|
|
def yperiodalignment(self):
|
|
"""
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
alignment of data points on the y axis.
|
|
|
|
The 'yperiodalignment' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['start', 'middle', 'end']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["yperiodalignment"]
|
|
|
|
@yperiodalignment.setter
|
|
def yperiodalignment(self, val):
|
|
self["yperiodalignment"] = val
|
|
|
|
@property
|
|
def ysrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `y`.
|
|
|
|
The 'ysrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["ysrc"]
|
|
|
|
@ysrc.setter
|
|
def ysrc(self, val):
|
|
self["ysrc"] = val
|
|
|
|
@property
|
|
def ytype(self):
|
|
"""
|
|
If "array", the heatmap's y coordinates are given by "y" (the
|
|
default behavior when `y` is provided) If "scaled", the
|
|
heatmap's y coordinates are given by "y0" and "dy" (the default
|
|
behavior when `y` is not provided)
|
|
|
|
The 'ytype' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['array', 'scaled']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["ytype"]
|
|
|
|
@ytype.setter
|
|
def ytype(self, val):
|
|
self["ytype"] = val
|
|
|
|
@property
|
|
def z(self):
|
|
"""
|
|
Sets the z data.
|
|
|
|
The 'z' property is an array that may be specified as a tuple,
|
|
list, numpy array, or pandas Series
|
|
|
|
Returns
|
|
-------
|
|
numpy.ndarray
|
|
"""
|
|
return self["z"]
|
|
|
|
@z.setter
|
|
def z(self, val):
|
|
self["z"] = val
|
|
|
|
@property
|
|
def zauto(self):
|
|
"""
|
|
Determines whether or not the color domain is computed with
|
|
respect to the input data (here in `z`) or the bounds set in
|
|
`zmin` and `zmax` Defaults to `false` when `zmin` and `zmax`
|
|
are set by the user.
|
|
|
|
The 'zauto' property must be specified as a bool
|
|
(either True, or False)
|
|
|
|
Returns
|
|
-------
|
|
bool
|
|
"""
|
|
return self["zauto"]
|
|
|
|
@zauto.setter
|
|
def zauto(self, val):
|
|
self["zauto"] = val
|
|
|
|
@property
|
|
def zhoverformat(self):
|
|
"""
|
|
Sets the hover text formatting rulefor `z` 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.By
|
|
default the values are formatted using generic number format.
|
|
|
|
The 'zhoverformat' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["zhoverformat"]
|
|
|
|
@zhoverformat.setter
|
|
def zhoverformat(self, val):
|
|
self["zhoverformat"] = val
|
|
|
|
@property
|
|
def zmax(self):
|
|
"""
|
|
Sets the upper bound of the color domain. Value should have the
|
|
same units as in `z` and if set, `zmin` must be set as well.
|
|
|
|
The 'zmax' property is a number and may be specified as:
|
|
- An int or float
|
|
|
|
Returns
|
|
-------
|
|
int|float
|
|
"""
|
|
return self["zmax"]
|
|
|
|
@zmax.setter
|
|
def zmax(self, val):
|
|
self["zmax"] = val
|
|
|
|
@property
|
|
def zmid(self):
|
|
"""
|
|
Sets the mid-point of the color domain by scaling `zmin` and/or
|
|
`zmax` to be equidistant to this point. Value should have the
|
|
same units as in `z`. Has no effect when `zauto` is `false`.
|
|
|
|
The 'zmid' property is a number and may be specified as:
|
|
- An int or float
|
|
|
|
Returns
|
|
-------
|
|
int|float
|
|
"""
|
|
return self["zmid"]
|
|
|
|
@zmid.setter
|
|
def zmid(self, val):
|
|
self["zmid"] = val
|
|
|
|
@property
|
|
def zmin(self):
|
|
"""
|
|
Sets the lower bound of the color domain. Value should have the
|
|
same units as in `z` and if set, `zmax` must be set as well.
|
|
|
|
The 'zmin' property is a number and may be specified as:
|
|
- An int or float
|
|
|
|
Returns
|
|
-------
|
|
int|float
|
|
"""
|
|
return self["zmin"]
|
|
|
|
@zmin.setter
|
|
def zmin(self, val):
|
|
self["zmin"] = val
|
|
|
|
@property
|
|
def zorder(self):
|
|
"""
|
|
Sets the layer on which this trace is displayed, relative to
|
|
other SVG traces on the same subplot. SVG traces with higher
|
|
`zorder` appear in front of those with lower `zorder`.
|
|
|
|
The 'zorder' property is a integer and may be specified as:
|
|
- An int (or float that will be cast to an int)
|
|
|
|
Returns
|
|
-------
|
|
int
|
|
"""
|
|
return self["zorder"]
|
|
|
|
@zorder.setter
|
|
def zorder(self, val):
|
|
self["zorder"] = val
|
|
|
|
@property
|
|
def zsrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `z`.
|
|
|
|
The 'zsrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["zsrc"]
|
|
|
|
@zsrc.setter
|
|
def zsrc(self, val):
|
|
self["zsrc"] = val
|
|
|
|
@property
|
|
def type(self):
|
|
return self._props["type"]
|
|
|
|
@property
|
|
def _prop_descriptions(self):
|
|
return """\
|
|
autocolorscale
|
|
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.
|
|
autocontour
|
|
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`.
|
|
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.contour.ColorBar` instance
|
|
or dict with compatible properties
|
|
colorscale
|
|
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,C
|
|
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
|
|
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
|
|
connectgaps
|
|
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.
|
|
contours
|
|
:class:`plotly.graph_objects.contour.Contours` instance
|
|
or dict with compatible properties
|
|
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`.
|
|
dx
|
|
Sets the x coordinate step. See `x0` for more info.
|
|
dy
|
|
Sets the y coordinate step. See `y0` for more info.
|
|
fillcolor
|
|
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.
|
|
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.contour.Hoverlabel`
|
|
instance or dict with compatible properties
|
|
hoverongaps
|
|
Determines whether or not gaps (i.e. {nan} or missing
|
|
values) in the `z` data have hover labels associated
|
|
with them.
|
|
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. 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>`.
|
|
hovertemplatesrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hovertemplate`.
|
|
hovertext
|
|
Same as `text`.
|
|
hovertextsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hovertext`.
|
|
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.
|
|
legendgroup
|
|
Sets the legend group for this trace. Traces and shapes
|
|
part of the same legend group hide/show at the same
|
|
time when toggling legend items.
|
|
legendgrouptitle
|
|
:class:`plotly.graph_objects.contour.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.contour.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.
|
|
ncontours
|
|
Sets the maximum number of contour levels. The actual
|
|
number of contours will be chosen automatically to be
|
|
less than or equal to the value of `ncontours`. Has an
|
|
effect only if `autocontour` is True or if
|
|
`contours.size` is missing.
|
|
opacity
|
|
Sets the opacity of the trace.
|
|
reversescale
|
|
Reverses the color mapping if true. If true, `zmin`
|
|
will correspond to the last color in the array and
|
|
`zmax` will correspond to the first color.
|
|
showlegend
|
|
Determines whether or not an item corresponding to this
|
|
trace is shown in the legend.
|
|
showscale
|
|
Determines whether or not a colorbar is displayed for
|
|
this trace.
|
|
stream
|
|
:class:`plotly.graph_objects.contour.Stream` instance
|
|
or dict with compatible properties
|
|
text
|
|
Sets the text elements associated with each z value.
|
|
textfont
|
|
For this trace it only has an effect if `coloring` is
|
|
set to "heatmap". Sets the text font.
|
|
textsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`text`.
|
|
texttemplate
|
|
For this trace it only has an effect if `coloring` is
|
|
set to "heatmap". Template string used for rendering
|
|
the information text that appear on points. Note that
|
|
this will override `textinfo`. Variables are inserted
|
|
using %{variable}, for example "y: %{y}". 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. Every attributes that can be
|
|
specified per-point (the ones that are `arrayOk: true`)
|
|
are available. Finally, the template string has access
|
|
to variables `x`, `y`, `z` and `text`.
|
|
transpose
|
|
Transposes the z data.
|
|
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).
|
|
x
|
|
Sets the x coordinates.
|
|
x0
|
|
Alternate to `x`. Builds a linear space of x
|
|
coordinates. Use with `dx` where `x0` is the starting
|
|
coordinate and `dx` the step.
|
|
xaxis
|
|
Sets a reference between this trace's x coordinates and
|
|
a 2D cartesian x axis. If "x" (the default value), the
|
|
x coordinates refer to `layout.xaxis`. If "x2", the x
|
|
coordinates refer to `layout.xaxis2`, and so on.
|
|
xcalendar
|
|
Sets the calendar system to use with `x` date data.
|
|
xhoverformat
|
|
Sets the hover text formatting rulefor `x` 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.
|
|
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*By default the values are
|
|
formatted using `xaxis.hoverformat`.
|
|
xperiod
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
period positioning in milliseconds or "M<n>" on the x
|
|
axis. Special values in the form of "M<n>" could be
|
|
used to declare the number of months. In this case `n`
|
|
must be a positive integer.
|
|
xperiod0
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
base for period positioning in milliseconds or date
|
|
string on the x0 axis. When `x0period` is round number
|
|
of weeks, the `x0period0` by default would be on a
|
|
Sunday i.e. 2000-01-02, otherwise it would be at
|
|
2000-01-01.
|
|
xperiodalignment
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
alignment of data points on the x axis.
|
|
xsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`x`.
|
|
xtype
|
|
If "array", the heatmap's x coordinates are given by
|
|
"x" (the default behavior when `x` is provided). If
|
|
"scaled", the heatmap's x coordinates are given by "x0"
|
|
and "dx" (the default behavior when `x` is not
|
|
provided).
|
|
y
|
|
Sets the y coordinates.
|
|
y0
|
|
Alternate to `y`. Builds a linear space of y
|
|
coordinates. Use with `dy` where `y0` is the starting
|
|
coordinate and `dy` the step.
|
|
yaxis
|
|
Sets a reference between this trace's y coordinates and
|
|
a 2D cartesian y axis. If "y" (the default value), the
|
|
y coordinates refer to `layout.yaxis`. If "y2", the y
|
|
coordinates refer to `layout.yaxis2`, and so on.
|
|
ycalendar
|
|
Sets the calendar system to use with `y` date data.
|
|
yhoverformat
|
|
Sets the hover text formatting rulefor `y` 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.
|
|
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*By default the values are
|
|
formatted using `yaxis.hoverformat`.
|
|
yperiod
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
period positioning in milliseconds or "M<n>" on the y
|
|
axis. Special values in the form of "M<n>" could be
|
|
used to declare the number of months. In this case `n`
|
|
must be a positive integer.
|
|
yperiod0
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
base for period positioning in milliseconds or date
|
|
string on the y0 axis. When `y0period` is round number
|
|
of weeks, the `y0period0` by default would be on a
|
|
Sunday i.e. 2000-01-02, otherwise it would be at
|
|
2000-01-01.
|
|
yperiodalignment
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
alignment of data points on the y axis.
|
|
ysrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`y`.
|
|
ytype
|
|
If "array", the heatmap's y coordinates are given by
|
|
"y" (the default behavior when `y` is provided) If
|
|
"scaled", the heatmap's y coordinates are given by "y0"
|
|
and "dy" (the default behavior when `y` is not
|
|
provided)
|
|
z
|
|
Sets the z data.
|
|
zauto
|
|
Determines whether or not the color domain is computed
|
|
with respect to the input data (here in `z`) or the
|
|
bounds set in `zmin` and `zmax` Defaults to `false`
|
|
when `zmin` and `zmax` are set by the user.
|
|
zhoverformat
|
|
Sets the hover text formatting rulefor `z` using d3
|
|
formatting mini-languages which are very similar to
|
|
those in Python. For numbers, see: https://github.com/d
|
|
3/d3-format/tree/v1.4.5#d3-format.By default the values
|
|
are formatted using generic number format.
|
|
zmax
|
|
Sets the upper bound of the color domain. Value should
|
|
have the same units as in `z` and if set, `zmin` must
|
|
be set as well.
|
|
zmid
|
|
Sets the mid-point of the color domain by scaling
|
|
`zmin` and/or `zmax` to be equidistant to this point.
|
|
Value should have the same units as in `z`. Has no
|
|
effect when `zauto` is `false`.
|
|
zmin
|
|
Sets the lower bound of the color domain. Value should
|
|
have the same units as in `z` and if set, `zmax` must
|
|
be set as well.
|
|
zorder
|
|
Sets the layer on which this trace is displayed,
|
|
relative to other SVG traces on the same subplot. SVG
|
|
traces with higher `zorder` appear in front of those
|
|
with lower `zorder`.
|
|
zsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`z`.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
arg=None,
|
|
autocolorscale=None,
|
|
autocontour=None,
|
|
coloraxis=None,
|
|
colorbar=None,
|
|
colorscale=None,
|
|
connectgaps=None,
|
|
contours=None,
|
|
customdata=None,
|
|
customdatasrc=None,
|
|
dx=None,
|
|
dy=None,
|
|
fillcolor=None,
|
|
hoverinfo=None,
|
|
hoverinfosrc=None,
|
|
hoverlabel=None,
|
|
hoverongaps=None,
|
|
hovertemplate=None,
|
|
hovertemplatesrc=None,
|
|
hovertext=None,
|
|
hovertextsrc=None,
|
|
ids=None,
|
|
idssrc=None,
|
|
legend=None,
|
|
legendgroup=None,
|
|
legendgrouptitle=None,
|
|
legendrank=None,
|
|
legendwidth=None,
|
|
line=None,
|
|
meta=None,
|
|
metasrc=None,
|
|
name=None,
|
|
ncontours=None,
|
|
opacity=None,
|
|
reversescale=None,
|
|
showlegend=None,
|
|
showscale=None,
|
|
stream=None,
|
|
text=None,
|
|
textfont=None,
|
|
textsrc=None,
|
|
texttemplate=None,
|
|
transpose=None,
|
|
uid=None,
|
|
uirevision=None,
|
|
visible=None,
|
|
x=None,
|
|
x0=None,
|
|
xaxis=None,
|
|
xcalendar=None,
|
|
xhoverformat=None,
|
|
xperiod=None,
|
|
xperiod0=None,
|
|
xperiodalignment=None,
|
|
xsrc=None,
|
|
xtype=None,
|
|
y=None,
|
|
y0=None,
|
|
yaxis=None,
|
|
ycalendar=None,
|
|
yhoverformat=None,
|
|
yperiod=None,
|
|
yperiod0=None,
|
|
yperiodalignment=None,
|
|
ysrc=None,
|
|
ytype=None,
|
|
z=None,
|
|
zauto=None,
|
|
zhoverformat=None,
|
|
zmax=None,
|
|
zmid=None,
|
|
zmin=None,
|
|
zorder=None,
|
|
zsrc=None,
|
|
**kwargs,
|
|
):
|
|
"""
|
|
Construct a new Contour object
|
|
|
|
The data from which contour lines are computed is set in `z`.
|
|
Data in `z` must be a 2D list of numbers. Say that `z` has N
|
|
rows and M columns, then by default, these N rows correspond to
|
|
N y coordinates (set in `y` or auto-generated) and the M
|
|
columns correspond to M x coordinates (set in `x` or auto-
|
|
generated). By setting `transpose` to True, the above behavior
|
|
is flipped.
|
|
|
|
Parameters
|
|
----------
|
|
arg
|
|
dict of properties compatible with this constructor or
|
|
an instance of :class:`plotly.graph_objs.Contour`
|
|
autocolorscale
|
|
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.
|
|
autocontour
|
|
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`.
|
|
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.contour.ColorBar` instance
|
|
or dict with compatible properties
|
|
colorscale
|
|
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,C
|
|
ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl
|
|
and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
|
|
connectgaps
|
|
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.
|
|
contours
|
|
:class:`plotly.graph_objects.contour.Contours` instance
|
|
or dict with compatible properties
|
|
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`.
|
|
dx
|
|
Sets the x coordinate step. See `x0` for more info.
|
|
dy
|
|
Sets the y coordinate step. See `y0` for more info.
|
|
fillcolor
|
|
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.
|
|
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.contour.Hoverlabel`
|
|
instance or dict with compatible properties
|
|
hoverongaps
|
|
Determines whether or not gaps (i.e. {nan} or missing
|
|
values) in the `z` data have hover labels associated
|
|
with them.
|
|
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. 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>`.
|
|
hovertemplatesrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hovertemplate`.
|
|
hovertext
|
|
Same as `text`.
|
|
hovertextsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`hovertext`.
|
|
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.
|
|
legendgroup
|
|
Sets the legend group for this trace. Traces and shapes
|
|
part of the same legend group hide/show at the same
|
|
time when toggling legend items.
|
|
legendgrouptitle
|
|
:class:`plotly.graph_objects.contour.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.contour.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.
|
|
ncontours
|
|
Sets the maximum number of contour levels. The actual
|
|
number of contours will be chosen automatically to be
|
|
less than or equal to the value of `ncontours`. Has an
|
|
effect only if `autocontour` is True or if
|
|
`contours.size` is missing.
|
|
opacity
|
|
Sets the opacity of the trace.
|
|
reversescale
|
|
Reverses the color mapping if true. If true, `zmin`
|
|
will correspond to the last color in the array and
|
|
`zmax` will correspond to the first color.
|
|
showlegend
|
|
Determines whether or not an item corresponding to this
|
|
trace is shown in the legend.
|
|
showscale
|
|
Determines whether or not a colorbar is displayed for
|
|
this trace.
|
|
stream
|
|
:class:`plotly.graph_objects.contour.Stream` instance
|
|
or dict with compatible properties
|
|
text
|
|
Sets the text elements associated with each z value.
|
|
textfont
|
|
For this trace it only has an effect if `coloring` is
|
|
set to "heatmap". Sets the text font.
|
|
textsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`text`.
|
|
texttemplate
|
|
For this trace it only has an effect if `coloring` is
|
|
set to "heatmap". Template string used for rendering
|
|
the information text that appear on points. Note that
|
|
this will override `textinfo`. Variables are inserted
|
|
using %{variable}, for example "y: %{y}". 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. Every attributes that can be
|
|
specified per-point (the ones that are `arrayOk: true`)
|
|
are available. Finally, the template string has access
|
|
to variables `x`, `y`, `z` and `text`.
|
|
transpose
|
|
Transposes the z data.
|
|
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).
|
|
x
|
|
Sets the x coordinates.
|
|
x0
|
|
Alternate to `x`. Builds a linear space of x
|
|
coordinates. Use with `dx` where `x0` is the starting
|
|
coordinate and `dx` the step.
|
|
xaxis
|
|
Sets a reference between this trace's x coordinates and
|
|
a 2D cartesian x axis. If "x" (the default value), the
|
|
x coordinates refer to `layout.xaxis`. If "x2", the x
|
|
coordinates refer to `layout.xaxis2`, and so on.
|
|
xcalendar
|
|
Sets the calendar system to use with `x` date data.
|
|
xhoverformat
|
|
Sets the hover text formatting rulefor `x` 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.
|
|
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*By default the values are
|
|
formatted using `xaxis.hoverformat`.
|
|
xperiod
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
period positioning in milliseconds or "M<n>" on the x
|
|
axis. Special values in the form of "M<n>" could be
|
|
used to declare the number of months. In this case `n`
|
|
must be a positive integer.
|
|
xperiod0
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
base for period positioning in milliseconds or date
|
|
string on the x0 axis. When `x0period` is round number
|
|
of weeks, the `x0period0` by default would be on a
|
|
Sunday i.e. 2000-01-02, otherwise it would be at
|
|
2000-01-01.
|
|
xperiodalignment
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
alignment of data points on the x axis.
|
|
xsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`x`.
|
|
xtype
|
|
If "array", the heatmap's x coordinates are given by
|
|
"x" (the default behavior when `x` is provided). If
|
|
"scaled", the heatmap's x coordinates are given by "x0"
|
|
and "dx" (the default behavior when `x` is not
|
|
provided).
|
|
y
|
|
Sets the y coordinates.
|
|
y0
|
|
Alternate to `y`. Builds a linear space of y
|
|
coordinates. Use with `dy` where `y0` is the starting
|
|
coordinate and `dy` the step.
|
|
yaxis
|
|
Sets a reference between this trace's y coordinates and
|
|
a 2D cartesian y axis. If "y" (the default value), the
|
|
y coordinates refer to `layout.yaxis`. If "y2", the y
|
|
coordinates refer to `layout.yaxis2`, and so on.
|
|
ycalendar
|
|
Sets the calendar system to use with `y` date data.
|
|
yhoverformat
|
|
Sets the hover text formatting rulefor `y` 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.
|
|
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*By default the values are
|
|
formatted using `yaxis.hoverformat`.
|
|
yperiod
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
period positioning in milliseconds or "M<n>" on the y
|
|
axis. Special values in the form of "M<n>" could be
|
|
used to declare the number of months. In this case `n`
|
|
must be a positive integer.
|
|
yperiod0
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
base for period positioning in milliseconds or date
|
|
string on the y0 axis. When `y0period` is round number
|
|
of weeks, the `y0period0` by default would be on a
|
|
Sunday i.e. 2000-01-02, otherwise it would be at
|
|
2000-01-01.
|
|
yperiodalignment
|
|
Only relevant when the axis `type` is "date". Sets the
|
|
alignment of data points on the y axis.
|
|
ysrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`y`.
|
|
ytype
|
|
If "array", the heatmap's y coordinates are given by
|
|
"y" (the default behavior when `y` is provided) If
|
|
"scaled", the heatmap's y coordinates are given by "y0"
|
|
and "dy" (the default behavior when `y` is not
|
|
provided)
|
|
z
|
|
Sets the z data.
|
|
zauto
|
|
Determines whether or not the color domain is computed
|
|
with respect to the input data (here in `z`) or the
|
|
bounds set in `zmin` and `zmax` Defaults to `false`
|
|
when `zmin` and `zmax` are set by the user.
|
|
zhoverformat
|
|
Sets the hover text formatting rulefor `z` using d3
|
|
formatting mini-languages which are very similar to
|
|
those in Python. For numbers, see: https://github.com/d
|
|
3/d3-format/tree/v1.4.5#d3-format.By default the values
|
|
are formatted using generic number format.
|
|
zmax
|
|
Sets the upper bound of the color domain. Value should
|
|
have the same units as in `z` and if set, `zmin` must
|
|
be set as well.
|
|
zmid
|
|
Sets the mid-point of the color domain by scaling
|
|
`zmin` and/or `zmax` to be equidistant to this point.
|
|
Value should have the same units as in `z`. Has no
|
|
effect when `zauto` is `false`.
|
|
zmin
|
|
Sets the lower bound of the color domain. Value should
|
|
have the same units as in `z` and if set, `zmax` must
|
|
be set as well.
|
|
zorder
|
|
Sets the layer on which this trace is displayed,
|
|
relative to other SVG traces on the same subplot. SVG
|
|
traces with higher `zorder` appear in front of those
|
|
with lower `zorder`.
|
|
zsrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`z`.
|
|
|
|
Returns
|
|
-------
|
|
Contour
|
|
"""
|
|
super().__init__("contour")
|
|
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.Contour
|
|
constructor must be a dict or
|
|
an instance of :class:`plotly.graph_objs.Contour`""")
|
|
|
|
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
|
self._validate = kwargs.pop("_validate", True)
|
|
|
|
self._set_property("autocolorscale", arg, autocolorscale)
|
|
self._set_property("autocontour", arg, autocontour)
|
|
self._set_property("coloraxis", arg, coloraxis)
|
|
self._set_property("colorbar", arg, colorbar)
|
|
self._set_property("colorscale", arg, colorscale)
|
|
self._set_property("connectgaps", arg, connectgaps)
|
|
self._set_property("contours", arg, contours)
|
|
self._set_property("customdata", arg, customdata)
|
|
self._set_property("customdatasrc", arg, customdatasrc)
|
|
self._set_property("dx", arg, dx)
|
|
self._set_property("dy", arg, dy)
|
|
self._set_property("fillcolor", arg, fillcolor)
|
|
self._set_property("hoverinfo", arg, hoverinfo)
|
|
self._set_property("hoverinfosrc", arg, hoverinfosrc)
|
|
self._set_property("hoverlabel", arg, hoverlabel)
|
|
self._set_property("hoverongaps", arg, hoverongaps)
|
|
self._set_property("hovertemplate", arg, hovertemplate)
|
|
self._set_property("hovertemplatesrc", arg, hovertemplatesrc)
|
|
self._set_property("hovertext", arg, hovertext)
|
|
self._set_property("hovertextsrc", arg, hovertextsrc)
|
|
self._set_property("ids", arg, ids)
|
|
self._set_property("idssrc", arg, idssrc)
|
|
self._set_property("legend", arg, legend)
|
|
self._set_property("legendgroup", arg, legendgroup)
|
|
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("ncontours", arg, ncontours)
|
|
self._set_property("opacity", arg, opacity)
|
|
self._set_property("reversescale", arg, reversescale)
|
|
self._set_property("showlegend", arg, showlegend)
|
|
self._set_property("showscale", arg, showscale)
|
|
self._set_property("stream", arg, stream)
|
|
self._set_property("text", arg, text)
|
|
self._set_property("textfont", arg, textfont)
|
|
self._set_property("textsrc", arg, textsrc)
|
|
self._set_property("texttemplate", arg, texttemplate)
|
|
self._set_property("transpose", arg, transpose)
|
|
self._set_property("uid", arg, uid)
|
|
self._set_property("uirevision", arg, uirevision)
|
|
self._set_property("visible", arg, visible)
|
|
self._set_property("x", arg, x)
|
|
self._set_property("x0", arg, x0)
|
|
self._set_property("xaxis", arg, xaxis)
|
|
self._set_property("xcalendar", arg, xcalendar)
|
|
self._set_property("xhoverformat", arg, xhoverformat)
|
|
self._set_property("xperiod", arg, xperiod)
|
|
self._set_property("xperiod0", arg, xperiod0)
|
|
self._set_property("xperiodalignment", arg, xperiodalignment)
|
|
self._set_property("xsrc", arg, xsrc)
|
|
self._set_property("xtype", arg, xtype)
|
|
self._set_property("y", arg, y)
|
|
self._set_property("y0", arg, y0)
|
|
self._set_property("yaxis", arg, yaxis)
|
|
self._set_property("ycalendar", arg, ycalendar)
|
|
self._set_property("yhoverformat", arg, yhoverformat)
|
|
self._set_property("yperiod", arg, yperiod)
|
|
self._set_property("yperiod0", arg, yperiod0)
|
|
self._set_property("yperiodalignment", arg, yperiodalignment)
|
|
self._set_property("ysrc", arg, ysrc)
|
|
self._set_property("ytype", arg, ytype)
|
|
self._set_property("z", arg, z)
|
|
self._set_property("zauto", arg, zauto)
|
|
self._set_property("zhoverformat", arg, zhoverformat)
|
|
self._set_property("zmax", arg, zmax)
|
|
self._set_property("zmid", arg, zmid)
|
|
self._set_property("zmin", arg, zmin)
|
|
self._set_property("zorder", arg, zorder)
|
|
self._set_property("zsrc", arg, zsrc)
|
|
|
|
self._props["type"] = "contour"
|
|
arg.pop("type", None)
|
|
self._process_kwargs(**dict(arg, **kwargs))
|
|
self._skip_invalid = False
|