2213 lines
76 KiB
Python
2213 lines
76 KiB
Python
|
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
|
|||
|
import copy as _copy
|
|||
|
|
|||
|
|
|||
|
class Heatmapgl(_BaseTraceType):
|
|||
|
|
|||
|
# class properties
|
|||
|
# --------------------
|
|||
|
_parent_path_str = ""
|
|||
|
_path_str = "heatmapgl"
|
|||
|
_valid_props = {
|
|||
|
"autocolorscale",
|
|||
|
"coloraxis",
|
|||
|
"colorbar",
|
|||
|
"colorscale",
|
|||
|
"customdata",
|
|||
|
"customdatasrc",
|
|||
|
"dx",
|
|||
|
"dy",
|
|||
|
"hoverinfo",
|
|||
|
"hoverinfosrc",
|
|||
|
"hoverlabel",
|
|||
|
"ids",
|
|||
|
"idssrc",
|
|||
|
"legend",
|
|||
|
"legendgrouptitle",
|
|||
|
"legendrank",
|
|||
|
"legendwidth",
|
|||
|
"meta",
|
|||
|
"metasrc",
|
|||
|
"name",
|
|||
|
"opacity",
|
|||
|
"reversescale",
|
|||
|
"showscale",
|
|||
|
"stream",
|
|||
|
"text",
|
|||
|
"textsrc",
|
|||
|
"transpose",
|
|||
|
"type",
|
|||
|
"uid",
|
|||
|
"uirevision",
|
|||
|
"visible",
|
|||
|
"x",
|
|||
|
"x0",
|
|||
|
"xaxis",
|
|||
|
"xsrc",
|
|||
|
"xtype",
|
|||
|
"y",
|
|||
|
"y0",
|
|||
|
"yaxis",
|
|||
|
"ysrc",
|
|||
|
"ytype",
|
|||
|
"z",
|
|||
|
"zauto",
|
|||
|
"zmax",
|
|||
|
"zmid",
|
|||
|
"zmin",
|
|||
|
"zsmooth",
|
|||
|
"zsrc",
|
|||
|
}
|
|||
|
|
|||
|
# autocolorscale
|
|||
|
# --------------
|
|||
|
@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
|
|||
|
|
|||
|
# coloraxis
|
|||
|
# ---------
|
|||
|
@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
|
|||
|
|
|||
|
# colorbar
|
|||
|
# --------
|
|||
|
@property
|
|||
|
def colorbar(self):
|
|||
|
"""
|
|||
|
The 'colorbar' property is an instance of ColorBar
|
|||
|
that may be specified as:
|
|||
|
- An instance of :class:`plotly.graph_objs.heatmapgl.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.heatmap
|
|||
|
gl.colorbar.Tickformatstop` instances or dicts
|
|||
|
with compatible properties
|
|||
|
tickformatstopdefaults
|
|||
|
When used in a template (as layout.template.dat
|
|||
|
a.heatmapgl.colorbar.tickformatstopdefaults),
|
|||
|
sets the default property values to use for
|
|||
|
elements of heatmapgl.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.heatmapgl.colorbar
|
|||
|
.Title` instance or dict with compatible
|
|||
|
properties
|
|||
|
titlefont
|
|||
|
Deprecated: Please use
|
|||
|
heatmapgl.colorbar.title.font instead. Sets
|
|||
|
this color bar's title font. Note that the
|
|||
|
title's font used to be set by the now
|
|||
|
deprecated `titlefont` attribute.
|
|||
|
titleside
|
|||
|
Deprecated: Please use
|
|||
|
heatmapgl.colorbar.title.side instead.
|
|||
|
Determines the location of color bar's title
|
|||
|
with respect to the color bar. Defaults to
|
|||
|
"top" when `orientation` if "v" and defaults
|
|||
|
to "right" when `orientation` if "h". Note that
|
|||
|
the title's location used to be set by the now
|
|||
|
deprecated `titleside` attribute.
|
|||
|
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.heatmapgl.ColorBar
|
|||
|
"""
|
|||
|
return self["colorbar"]
|
|||
|
|
|||
|
@colorbar.setter
|
|||
|
def colorbar(self, val):
|
|||
|
self["colorbar"] = val
|
|||
|
|
|||
|
# colorscale
|
|||
|
# ----------
|
|||
|
@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
|
|||
|
|
|||
|
# customdata
|
|||
|
# ----------
|
|||
|
@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
|
|||
|
|
|||
|
# customdatasrc
|
|||
|
# -------------
|
|||
|
@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
|
|||
|
|
|||
|
# dx
|
|||
|
# --
|
|||
|
@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
|
|||
|
|
|||
|
# dy
|
|||
|
# --
|
|||
|
@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
|
|||
|
|
|||
|
# hoverinfo
|
|||
|
# ---------
|
|||
|
@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
|
|||
|
|
|||
|
# hoverinfosrc
|
|||
|
# ------------
|
|||
|
@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
|
|||
|
|
|||
|
# hoverlabel
|
|||
|
# ----------
|
|||
|
@property
|
|||
|
def hoverlabel(self):
|
|||
|
"""
|
|||
|
The 'hoverlabel' property is an instance of Hoverlabel
|
|||
|
that may be specified as:
|
|||
|
- An instance of :class:`plotly.graph_objs.heatmapgl.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.heatmapgl.Hoverlabel
|
|||
|
"""
|
|||
|
return self["hoverlabel"]
|
|||
|
|
|||
|
@hoverlabel.setter
|
|||
|
def hoverlabel(self, val):
|
|||
|
self["hoverlabel"] = val
|
|||
|
|
|||
|
# ids
|
|||
|
# ---
|
|||
|
@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
|
|||
|
|
|||
|
# idssrc
|
|||
|
# ------
|
|||
|
@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
|
|||
|
|
|||
|
# legend
|
|||
|
# ------
|
|||
|
@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
|
|||
|
|
|||
|
# legendgrouptitle
|
|||
|
# ----------------
|
|||
|
@property
|
|||
|
def legendgrouptitle(self):
|
|||
|
"""
|
|||
|
The 'legendgrouptitle' property is an instance of Legendgrouptitle
|
|||
|
that may be specified as:
|
|||
|
- An instance of :class:`plotly.graph_objs.heatmapgl.Legendgrouptitle`
|
|||
|
- A dict of string/value properties that will be passed
|
|||
|
to the Legendgrouptitle constructor
|
|||
|
|
|||
|
Supported dict properties:
|
|||
|
|
|||
|
font
|
|||
|
Sets this legend group's title font.
|
|||
|
text
|
|||
|
Sets the title of the legend group.
|
|||
|
|
|||
|
Returns
|
|||
|
-------
|
|||
|
plotly.graph_objs.heatmapgl.Legendgrouptitle
|
|||
|
"""
|
|||
|
return self["legendgrouptitle"]
|
|||
|
|
|||
|
@legendgrouptitle.setter
|
|||
|
def legendgrouptitle(self, val):
|
|||
|
self["legendgrouptitle"] = val
|
|||
|
|
|||
|
# legendrank
|
|||
|
# ----------
|
|||
|
@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
|
|||
|
|
|||
|
# legendwidth
|
|||
|
# -----------
|
|||
|
@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
|
|||
|
|
|||
|
# meta
|
|||
|
# ----
|
|||
|
@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
|
|||
|
|
|||
|
# metasrc
|
|||
|
# -------
|
|||
|
@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
|
|||
|
|
|||
|
# name
|
|||
|
# ----
|
|||
|
@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
|
|||
|
|
|||
|
# opacity
|
|||
|
# -------
|
|||
|
@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
|
|||
|
|
|||
|
# reversescale
|
|||
|
# ------------
|
|||
|
@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
|
|||
|
|
|||
|
# showscale
|
|||
|
# ---------
|
|||
|
@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
|
|||
|
|
|||
|
# stream
|
|||
|
# ------
|
|||
|
@property
|
|||
|
def stream(self):
|
|||
|
"""
|
|||
|
The 'stream' property is an instance of Stream
|
|||
|
that may be specified as:
|
|||
|
- An instance of :class:`plotly.graph_objs.heatmapgl.Stream`
|
|||
|
- A dict of string/value properties that will be passed
|
|||
|
to the Stream constructor
|
|||
|
|
|||
|
Supported dict properties:
|
|||
|
|
|||
|
maxpoints
|
|||
|
Sets the maximum number of points to keep on
|
|||
|
the plots from an incoming stream. If
|
|||
|
`maxpoints` is set to 50, only the newest 50
|
|||
|
points will be displayed on the plot.
|
|||
|
token
|
|||
|
The stream id number links a data trace on a
|
|||
|
plot with a stream. See https://chart-
|
|||
|
studio.plotly.com/settings for more details.
|
|||
|
|
|||
|
Returns
|
|||
|
-------
|
|||
|
plotly.graph_objs.heatmapgl.Stream
|
|||
|
"""
|
|||
|
return self["stream"]
|
|||
|
|
|||
|
@stream.setter
|
|||
|
def stream(self, val):
|
|||
|
self["stream"] = val
|
|||
|
|
|||
|
# text
|
|||
|
# ----
|
|||
|
@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
|
|||
|
|
|||
|
# textsrc
|
|||
|
# -------
|
|||
|
@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
|
|||
|
|
|||
|
# transpose
|
|||
|
# ---------
|
|||
|
@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
|
|||
|
|
|||
|
# uid
|
|||
|
# ---
|
|||
|
@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
|
|||
|
|
|||
|
# uirevision
|
|||
|
# ----------
|
|||
|
@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
|
|||
|
|
|||
|
# visible
|
|||
|
# -------
|
|||
|
@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
|
|||
|
|
|||
|
# x
|
|||
|
# -
|
|||
|
@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
|
|||
|
|
|||
|
# x0
|
|||
|
# --
|
|||
|
@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
|
|||
|
|
|||
|
# xaxis
|
|||
|
# -----
|
|||
|
@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
|
|||
|
|
|||
|
# xsrc
|
|||
|
# ----
|
|||
|
@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
|
|||
|
|
|||
|
# xtype
|
|||
|
# -----
|
|||
|
@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
|
|||
|
|
|||
|
# y
|
|||
|
# -
|
|||
|
@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
|
|||
|
|
|||
|
# y0
|
|||
|
# --
|
|||
|
@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
|
|||
|
|
|||
|
# yaxis
|
|||
|
# -----
|
|||
|
@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
|
|||
|
|
|||
|
# ysrc
|
|||
|
# ----
|
|||
|
@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
|
|||
|
|
|||
|
# ytype
|
|||
|
# -----
|
|||
|
@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
|
|||
|
|
|||
|
# z
|
|||
|
# -
|
|||
|
@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
|
|||
|
|
|||
|
# zauto
|
|||
|
# -----
|
|||
|
@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
|
|||
|
|
|||
|
# zmax
|
|||
|
# ----
|
|||
|
@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
|
|||
|
|
|||
|
# zmid
|
|||
|
# ----
|
|||
|
@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
|
|||
|
|
|||
|
# zmin
|
|||
|
# ----
|
|||
|
@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
|
|||
|
|
|||
|
# zsmooth
|
|||
|
# -------
|
|||
|
@property
|
|||
|
def zsmooth(self):
|
|||
|
"""
|
|||
|
Picks a smoothing algorithm use to smooth `z` data.
|
|||
|
|
|||
|
The 'zsmooth' property is an enumeration that may be specified as:
|
|||
|
- One of the following enumeration values:
|
|||
|
['fast', False]
|
|||
|
|
|||
|
Returns
|
|||
|
-------
|
|||
|
Any
|
|||
|
"""
|
|||
|
return self["zsmooth"]
|
|||
|
|
|||
|
@zsmooth.setter
|
|||
|
def zsmooth(self, val):
|
|||
|
self["zsmooth"] = val
|
|||
|
|
|||
|
# zsrc
|
|||
|
# ----
|
|||
|
@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
|
|||
|
|
|||
|
# type
|
|||
|
# ----
|
|||
|
@property
|
|||
|
def type(self):
|
|||
|
return self._props["type"]
|
|||
|
|
|||
|
# Self properties description
|
|||
|
# ---------------------------
|
|||
|
@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.
|
|||
|
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.heatmapgl.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.
|
|||
|
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.
|
|||
|
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.heatmapgl.Hoverlabel`
|
|||
|
instance or dict with compatible properties
|
|||
|
ids
|
|||
|
Assigns id labels to each datum. These ids for object
|
|||
|
constancy of data points during animation. Should be an
|
|||
|
array of strings, not numbers or any other type.
|
|||
|
idssrc
|
|||
|
Sets the source reference on Chart Studio Cloud for
|
|||
|
`ids`.
|
|||
|
legend
|
|||
|
Sets the reference to a legend to show this trace in.
|
|||
|
References to these legends are "legend", "legend2",
|
|||
|
"legend3", etc. Settings for these legends are set in
|
|||
|
the layout, under `layout.legend`, `layout.legend2`,
|
|||
|
etc.
|
|||
|
legendgrouptitle
|
|||
|
:class:`plotly.graph_objects.heatmapgl.Legendgrouptitle
|
|||
|
` instance or dict with compatible properties
|
|||
|
legendrank
|
|||
|
Sets the legend rank for this trace. Items and groups
|
|||
|
with smaller ranks are presented on top/left side while
|
|||
|
with "reversed" `legend.traceorder` they are on
|
|||
|
bottom/right side. The default legendrank is 1000, so
|
|||
|
that you can use ranks less than 1000 to place certain
|
|||
|
items before all unranked items, and ranks greater than
|
|||
|
1000 to go after all unranked items. When having
|
|||
|
unranked or equal rank items shapes would be displayed
|
|||
|
after traces i.e. according to their order in data and
|
|||
|
layout.
|
|||
|
legendwidth
|
|||
|
Sets the width (in px or fraction) of the legend for
|
|||
|
this trace.
|
|||
|
meta
|
|||
|
Assigns extra meta information associated with this
|
|||
|
trace that can be used in various text attributes.
|
|||
|
Attributes such as trace `name`, graph, axis and
|
|||
|
colorbar `title.text`, annotation `text`
|
|||
|
`rangeselector`, `updatemenues` and `sliders` `label`
|
|||
|
text all support `meta`. To access the trace `meta`
|
|||
|
values in an attribute in the same trace, simply use
|
|||
|
`%{meta[i]}` where `i` is the index or key of the
|
|||
|
`meta` item in question. To access trace `meta` in
|
|||
|
layout attributes, use `%{data[n[.meta[i]}` where `i`
|
|||
|
is the index or key of the `meta` and `n` is the trace
|
|||
|
index.
|
|||
|
metasrc
|
|||
|
Sets the source reference on Chart Studio Cloud for
|
|||
|
`meta`.
|
|||
|
name
|
|||
|
Sets the trace name. The trace name appears as the
|
|||
|
legend item and on hover.
|
|||
|
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.
|
|||
|
showscale
|
|||
|
Determines whether or not a colorbar is displayed for
|
|||
|
this trace.
|
|||
|
stream
|
|||
|
:class:`plotly.graph_objects.heatmapgl.Stream` instance
|
|||
|
or dict with compatible properties
|
|||
|
text
|
|||
|
Sets the text elements associated with each z value.
|
|||
|
textsrc
|
|||
|
Sets the source reference on Chart Studio Cloud for
|
|||
|
`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.
|
|||
|
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.
|
|||
|
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.
|
|||
|
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.
|
|||
|
zsmooth
|
|||
|
Picks a smoothing algorithm use to smooth `z` data.
|
|||
|
zsrc
|
|||
|
Sets the source reference on Chart Studio Cloud for
|
|||
|
`z`.
|
|||
|
"""
|
|||
|
|
|||
|
def __init__(
|
|||
|
self,
|
|||
|
arg=None,
|
|||
|
autocolorscale=None,
|
|||
|
coloraxis=None,
|
|||
|
colorbar=None,
|
|||
|
colorscale=None,
|
|||
|
customdata=None,
|
|||
|
customdatasrc=None,
|
|||
|
dx=None,
|
|||
|
dy=None,
|
|||
|
hoverinfo=None,
|
|||
|
hoverinfosrc=None,
|
|||
|
hoverlabel=None,
|
|||
|
ids=None,
|
|||
|
idssrc=None,
|
|||
|
legend=None,
|
|||
|
legendgrouptitle=None,
|
|||
|
legendrank=None,
|
|||
|
legendwidth=None,
|
|||
|
meta=None,
|
|||
|
metasrc=None,
|
|||
|
name=None,
|
|||
|
opacity=None,
|
|||
|
reversescale=None,
|
|||
|
showscale=None,
|
|||
|
stream=None,
|
|||
|
text=None,
|
|||
|
textsrc=None,
|
|||
|
transpose=None,
|
|||
|
uid=None,
|
|||
|
uirevision=None,
|
|||
|
visible=None,
|
|||
|
x=None,
|
|||
|
x0=None,
|
|||
|
xaxis=None,
|
|||
|
xsrc=None,
|
|||
|
xtype=None,
|
|||
|
y=None,
|
|||
|
y0=None,
|
|||
|
yaxis=None,
|
|||
|
ysrc=None,
|
|||
|
ytype=None,
|
|||
|
z=None,
|
|||
|
zauto=None,
|
|||
|
zmax=None,
|
|||
|
zmid=None,
|
|||
|
zmin=None,
|
|||
|
zsmooth=None,
|
|||
|
zsrc=None,
|
|||
|
**kwargs,
|
|||
|
):
|
|||
|
"""
|
|||
|
Construct a new Heatmapgl object
|
|||
|
|
|||
|
"heatmapgl" trace is deprecated! Please consider switching to
|
|||
|
the "heatmap" or "image" trace types. Alternatively you could
|
|||
|
contribute/sponsor rewriting this trace type based on cartesian
|
|||
|
features and using regl framework. WebGL version of the heatmap
|
|||
|
trace type.
|
|||
|
|
|||
|
Parameters
|
|||
|
----------
|
|||
|
arg
|
|||
|
dict of properties compatible with this constructor or
|
|||
|
an instance of :class:`plotly.graph_objs.Heatmapgl`
|
|||
|
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.
|
|||
|
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.heatmapgl.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.
|
|||
|
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.
|
|||
|
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.heatmapgl.Hoverlabel`
|
|||
|
instance or dict with compatible properties
|
|||
|
ids
|
|||
|
Assigns id labels to each datum. These ids for object
|
|||
|
constancy of data points during animation. Should be an
|
|||
|
array of strings, not numbers or any other type.
|
|||
|
idssrc
|
|||
|
Sets the source reference on Chart Studio Cloud for
|
|||
|
`ids`.
|
|||
|
legend
|
|||
|
Sets the reference to a legend to show this trace in.
|
|||
|
References to these legends are "legend", "legend2",
|
|||
|
"legend3", etc. Settings for these legends are set in
|
|||
|
the layout, under `layout.legend`, `layout.legend2`,
|
|||
|
etc.
|
|||
|
legendgrouptitle
|
|||
|
:class:`plotly.graph_objects.heatmapgl.Legendgrouptitle
|
|||
|
` instance or dict with compatible properties
|
|||
|
legendrank
|
|||
|
Sets the legend rank for this trace. Items and groups
|
|||
|
with smaller ranks are presented on top/left side while
|
|||
|
with "reversed" `legend.traceorder` they are on
|
|||
|
bottom/right side. The default legendrank is 1000, so
|
|||
|
that you can use ranks less than 1000 to place certain
|
|||
|
items before all unranked items, and ranks greater than
|
|||
|
1000 to go after all unranked items. When having
|
|||
|
unranked or equal rank items shapes would be displayed
|
|||
|
after traces i.e. according to their order in data and
|
|||
|
layout.
|
|||
|
legendwidth
|
|||
|
Sets the width (in px or fraction) of the legend for
|
|||
|
this trace.
|
|||
|
meta
|
|||
|
Assigns extra meta information associated with this
|
|||
|
trace that can be used in various text attributes.
|
|||
|
Attributes such as trace `name`, graph, axis and
|
|||
|
colorbar `title.text`, annotation `text`
|
|||
|
`rangeselector`, `updatemenues` and `sliders` `label`
|
|||
|
text all support `meta`. To access the trace `meta`
|
|||
|
values in an attribute in the same trace, simply use
|
|||
|
`%{meta[i]}` where `i` is the index or key of the
|
|||
|
`meta` item in question. To access trace `meta` in
|
|||
|
layout attributes, use `%{data[n[.meta[i]}` where `i`
|
|||
|
is the index or key of the `meta` and `n` is the trace
|
|||
|
index.
|
|||
|
metasrc
|
|||
|
Sets the source reference on Chart Studio Cloud for
|
|||
|
`meta`.
|
|||
|
name
|
|||
|
Sets the trace name. The trace name appears as the
|
|||
|
legend item and on hover.
|
|||
|
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.
|
|||
|
showscale
|
|||
|
Determines whether or not a colorbar is displayed for
|
|||
|
this trace.
|
|||
|
stream
|
|||
|
:class:`plotly.graph_objects.heatmapgl.Stream` instance
|
|||
|
or dict with compatible properties
|
|||
|
text
|
|||
|
Sets the text elements associated with each z value.
|
|||
|
textsrc
|
|||
|
Sets the source reference on Chart Studio Cloud for
|
|||
|
`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.
|
|||
|
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.
|
|||
|
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.
|
|||
|
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.
|
|||
|
zsmooth
|
|||
|
Picks a smoothing algorithm use to smooth `z` data.
|
|||
|
zsrc
|
|||
|
Sets the source reference on Chart Studio Cloud for
|
|||
|
`z`.
|
|||
|
|
|||
|
Returns
|
|||
|
-------
|
|||
|
Heatmapgl
|
|||
|
"""
|
|||
|
super(Heatmapgl, self).__init__("heatmapgl")
|
|||
|
|
|||
|
if "_parent" in kwargs:
|
|||
|
self._parent = kwargs["_parent"]
|
|||
|
return
|
|||
|
|
|||
|
# Validate arg
|
|||
|
# ------------
|
|||
|
if arg is None:
|
|||
|
arg = {}
|
|||
|
elif isinstance(arg, self.__class__):
|
|||
|
arg = arg.to_plotly_json()
|
|||
|
elif isinstance(arg, dict):
|
|||
|
arg = _copy.copy(arg)
|
|||
|
else:
|
|||
|
raise ValueError(
|
|||
|
"""\
|
|||
|
The first argument to the plotly.graph_objs.Heatmapgl
|
|||
|
constructor must be a dict or
|
|||
|
an instance of :class:`plotly.graph_objs.Heatmapgl`"""
|
|||
|
)
|
|||
|
|
|||
|
# Handle skip_invalid
|
|||
|
# -------------------
|
|||
|
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
|||
|
self._validate = kwargs.pop("_validate", True)
|
|||
|
|
|||
|
# Populate data dict with properties
|
|||
|
# ----------------------------------
|
|||
|
_v = arg.pop("autocolorscale", None)
|
|||
|
_v = autocolorscale if autocolorscale is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["autocolorscale"] = _v
|
|||
|
_v = arg.pop("coloraxis", None)
|
|||
|
_v = coloraxis if coloraxis is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["coloraxis"] = _v
|
|||
|
_v = arg.pop("colorbar", None)
|
|||
|
_v = colorbar if colorbar is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["colorbar"] = _v
|
|||
|
_v = arg.pop("colorscale", None)
|
|||
|
_v = colorscale if colorscale is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["colorscale"] = _v
|
|||
|
_v = arg.pop("customdata", None)
|
|||
|
_v = customdata if customdata is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["customdata"] = _v
|
|||
|
_v = arg.pop("customdatasrc", None)
|
|||
|
_v = customdatasrc if customdatasrc is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["customdatasrc"] = _v
|
|||
|
_v = arg.pop("dx", None)
|
|||
|
_v = dx if dx is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["dx"] = _v
|
|||
|
_v = arg.pop("dy", None)
|
|||
|
_v = dy if dy is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["dy"] = _v
|
|||
|
_v = arg.pop("hoverinfo", None)
|
|||
|
_v = hoverinfo if hoverinfo is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["hoverinfo"] = _v
|
|||
|
_v = arg.pop("hoverinfosrc", None)
|
|||
|
_v = hoverinfosrc if hoverinfosrc is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["hoverinfosrc"] = _v
|
|||
|
_v = arg.pop("hoverlabel", None)
|
|||
|
_v = hoverlabel if hoverlabel is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["hoverlabel"] = _v
|
|||
|
_v = arg.pop("ids", None)
|
|||
|
_v = ids if ids is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["ids"] = _v
|
|||
|
_v = arg.pop("idssrc", None)
|
|||
|
_v = idssrc if idssrc is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["idssrc"] = _v
|
|||
|
_v = arg.pop("legend", None)
|
|||
|
_v = legend if legend is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["legend"] = _v
|
|||
|
_v = arg.pop("legendgrouptitle", None)
|
|||
|
_v = legendgrouptitle if legendgrouptitle is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["legendgrouptitle"] = _v
|
|||
|
_v = arg.pop("legendrank", None)
|
|||
|
_v = legendrank if legendrank is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["legendrank"] = _v
|
|||
|
_v = arg.pop("legendwidth", None)
|
|||
|
_v = legendwidth if legendwidth is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["legendwidth"] = _v
|
|||
|
_v = arg.pop("meta", None)
|
|||
|
_v = meta if meta is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["meta"] = _v
|
|||
|
_v = arg.pop("metasrc", None)
|
|||
|
_v = metasrc if metasrc is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["metasrc"] = _v
|
|||
|
_v = arg.pop("name", None)
|
|||
|
_v = name if name is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["name"] = _v
|
|||
|
_v = arg.pop("opacity", None)
|
|||
|
_v = opacity if opacity is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["opacity"] = _v
|
|||
|
_v = arg.pop("reversescale", None)
|
|||
|
_v = reversescale if reversescale is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["reversescale"] = _v
|
|||
|
_v = arg.pop("showscale", None)
|
|||
|
_v = showscale if showscale is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["showscale"] = _v
|
|||
|
_v = arg.pop("stream", None)
|
|||
|
_v = stream if stream is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["stream"] = _v
|
|||
|
_v = arg.pop("text", None)
|
|||
|
_v = text if text is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["text"] = _v
|
|||
|
_v = arg.pop("textsrc", None)
|
|||
|
_v = textsrc if textsrc is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["textsrc"] = _v
|
|||
|
_v = arg.pop("transpose", None)
|
|||
|
_v = transpose if transpose is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["transpose"] = _v
|
|||
|
_v = arg.pop("uid", None)
|
|||
|
_v = uid if uid is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["uid"] = _v
|
|||
|
_v = arg.pop("uirevision", None)
|
|||
|
_v = uirevision if uirevision is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["uirevision"] = _v
|
|||
|
_v = arg.pop("visible", None)
|
|||
|
_v = visible if visible is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["visible"] = _v
|
|||
|
_v = arg.pop("x", None)
|
|||
|
_v = x if x is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["x"] = _v
|
|||
|
_v = arg.pop("x0", None)
|
|||
|
_v = x0 if x0 is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["x0"] = _v
|
|||
|
_v = arg.pop("xaxis", None)
|
|||
|
_v = xaxis if xaxis is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["xaxis"] = _v
|
|||
|
_v = arg.pop("xsrc", None)
|
|||
|
_v = xsrc if xsrc is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["xsrc"] = _v
|
|||
|
_v = arg.pop("xtype", None)
|
|||
|
_v = xtype if xtype is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["xtype"] = _v
|
|||
|
_v = arg.pop("y", None)
|
|||
|
_v = y if y is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["y"] = _v
|
|||
|
_v = arg.pop("y0", None)
|
|||
|
_v = y0 if y0 is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["y0"] = _v
|
|||
|
_v = arg.pop("yaxis", None)
|
|||
|
_v = yaxis if yaxis is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["yaxis"] = _v
|
|||
|
_v = arg.pop("ysrc", None)
|
|||
|
_v = ysrc if ysrc is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["ysrc"] = _v
|
|||
|
_v = arg.pop("ytype", None)
|
|||
|
_v = ytype if ytype is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["ytype"] = _v
|
|||
|
_v = arg.pop("z", None)
|
|||
|
_v = z if z is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["z"] = _v
|
|||
|
_v = arg.pop("zauto", None)
|
|||
|
_v = zauto if zauto is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["zauto"] = _v
|
|||
|
_v = arg.pop("zmax", None)
|
|||
|
_v = zmax if zmax is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["zmax"] = _v
|
|||
|
_v = arg.pop("zmid", None)
|
|||
|
_v = zmid if zmid is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["zmid"] = _v
|
|||
|
_v = arg.pop("zmin", None)
|
|||
|
_v = zmin if zmin is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["zmin"] = _v
|
|||
|
_v = arg.pop("zsmooth", None)
|
|||
|
_v = zsmooth if zsmooth is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["zsmooth"] = _v
|
|||
|
_v = arg.pop("zsrc", None)
|
|||
|
_v = zsrc if zsrc is not None else _v
|
|||
|
if _v is not None:
|
|||
|
self["zsrc"] = _v
|
|||
|
|
|||
|
# Read-only literals
|
|||
|
# ------------------
|
|||
|
|
|||
|
self._props["type"] = "heatmapgl"
|
|||
|
arg.pop("type", None)
|
|||
|
|
|||
|
# Process unknown kwargs
|
|||
|
# ----------------------
|
|||
|
self._process_kwargs(**dict(arg, **kwargs))
|
|||
|
|
|||
|
# Reset skip_invalid
|
|||
|
# ------------------
|
|||
|
self._skip_invalid = False
|