plotly.graph_objects.Contourcarpet¶plotly.graph_objects.Contourcarpet(arg=None, a=None, a0=None, asrc=None, atype=None, autocolorscale=None, autocontour=None, b=None, b0=None, bsrc=None, btype=None, carpet=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=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, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)¶__init__(arg=None, a=None, a0=None, asrc=None, atype=None, autocolorscale=None, autocontour=None, b=None, b0=None, bsrc=None, btype=None, carpet=None, coloraxis=None, colorbar=None, colorscale=None, contours=None, customdata=None, customdatasrc=None, da=None, db=None, fillcolor=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, textsrc=None, transpose=None, uid=None, uirevision=None, visible=None, xaxis=None, yaxis=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zorder=None, zsrc=None, **kwargs)¶Construct a new Contourcarpet object
Plots contours on either the first carpet axis or the carpet
axis with a matching carpet attribute. Data z is
interpreted as matching that of the corresponding carpet axis.
arg – dict of properties compatible with this constructor or
an instance of plotly.graph_objects.Contourcarpet
a – Sets the x coordinates.
a0 – Alternate to x. Builds a linear space of x
coordinates. Use with dx where x0 is the starting
coordinate and dx the step.
asrc – Sets the source reference on Chart Studio Cloud for
a.
atype – 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).
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.
b – Sets the y coordinates.
b0 – Alternate to y. Builds a linear space of y
coordinates. Use with dy where y0 is the starting
coordinate and dy the step.
bsrc – Sets the source reference on Chart Studio Cloud for
b.
btype – 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)
carpet – The carpet of the carpet axes on which this contour
trace lies
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 – plotly.graph_objects.contourcarpet.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.
contours – plotly.graph_objects.contourcarpet.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.
da – Sets the x coordinate step. See x0 for more info.
db – 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.
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 – plotly.graph_objects.contourcarpet.Legendgroupt
itle 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 – plotly.graph_objects.contourcarpet.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 – plotly.graph_objects.contourcarpet.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).
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.
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.
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.
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.
plotly.graph_objects.contourcarpet¶plotly.graph_objects.contourcarpet.ColorBar(arg=None, bgcolor=None, bordercolor=None, borderwidth=None, dtick=None, exponentformat=None, labelalias=None, len=None, lenmode=None, minexponent=None, nticks=None, orientation=None, outlinecolor=None, outlinewidth=None, separatethousands=None, showexponent=None, showticklabels=None, showtickprefix=None, showticksuffix=None, thickness=None, thicknessmode=None, tick0=None, tickangle=None, tickcolor=None, tickfont=None, tickformat=None, tickformatstops=None, tickformatstopdefaults=None, ticklabeloverflow=None, ticklabelposition=None, ticklabelstep=None, ticklen=None, tickmode=None, tickprefix=None, ticks=None, ticksuffix=None, ticktext=None, ticktextsrc=None, tickvals=None, tickvalssrc=None, tickwidth=None, title=None, x=None, xanchor=None, xpad=None, xref=None, y=None, yanchor=None, ypad=None, yref=None, **kwargs)¶bgcolor¶Sets the color of padded area.
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%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
bordercolor¶Sets the axis line color.
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%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
borderwidth¶Sets the width (in px) or the border enclosing this color bar.
An int or float in the interval [0, inf]
int|float
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”
The ‘dtick’ property accepts values of any type
Any
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.
[‘none’, ‘e’, ‘E’, ‘power’, ‘SI’, ‘B’]
Any
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.
The ‘labelalias’ property accepts values of any type
Any
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.
An int or float in the interval [0, inf]
int|float
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.
[‘fraction’, ‘pixels’]
Any
minexponent¶Hide SI prefix for 10^n if |n| is below this number. This only
has an effect when tickformat is “SI” or “B”.
An int or float in the interval [0, inf]
int|float
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”.
An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]
orientation¶Sets the orientation of the colorbar.
[‘h’, ‘v’]
Any
outlinecolor¶Sets the axis line color.
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%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
outlinewidth¶Sets the width (in px) of the axis line.
An int or float in the interval [0, inf]
int|float
separatethousands¶If “true”, even 4-digit integers are separated
The ‘separatethousands’ property must be specified as a bool (either True, or False)
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.
[‘all’, ‘first’, ‘last’, ‘none’]
Any
showticklabels¶Determines whether or not the tick labels are drawn.
The ‘showticklabels’ property must be specified as a bool (either True, or False)
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.
[‘all’, ‘first’, ‘last’, ‘none’]
Any
showticksuffix¶Same as showtickprefix but for tick suffixes.
[‘all’, ‘first’, ‘last’, ‘none’]
Any
thickness¶Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
An int or float in the interval [0, inf]
int|float
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.
[‘fraction’, ‘pixels’]
Any
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.
The ‘tick0’ property accepts values of any type
Any
tickangle¶Sets the angle of the tick labels with respect to the
horizontal. For example, a tickangle of -90 draws the tick
labels vertically.
The ‘tickangle’ property is a angle (in degrees) that may be specified as a number between -180 and 180. Numeric values outside this range are converted to the equivalent value (e.g. 270 is converted to -90).
int|float
tickcolor¶Sets the tick color.
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%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
tickfont¶Sets the color bar’s tick label font
The ‘tickfont’ property is an instance of Tickfont that may be specified as:
An instance of
plotly.graph_objects.contourcarpet.colorbar.TickfontA dict of string/value properties that will be passed to the Tickfont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
tickformat¶Sets the tick label formatting rule using d3 formatting mini- languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. 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”
A string
A number that will be converted to a string
tickformatstopdefaults¶When used in a template (as layout.template.data.contourcarpet. colorbar.tickformatstopdefaults), sets the default property values to use for elements of contourcarpet.colorbar.tickformatstops
The ‘tickformatstopdefaults’ property is an instance of Tickformatstop that may be specified as:
An instance of
plotly.graph_objects.contourcarpet.colorbar.TickformatstopA dict of string/value properties that will be passed to the Tickformatstop constructor
Supported dict properties:
tickformatstops¶The ‘tickformatstops’ property is a tuple of instances of Tickformatstop that may be specified as:
A list or tuple of instances of plotly.graph_objects.contourcarpet.colorbar.Tickformatstop
A list or tuple of dicts of string/value properties that will be passed to the Tickformatstop constructor
Supported dict properties:
- dtickrange
range [min, max], where “min”, “max” - dtick values which describe some zoom level, it is possible to omit “min” or “max” value by passing “null”
- enabled
Determines whether or not this stop is used. If
false, this stop is ignored even within itsdtickrange.- name
When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with
templateitemnamematching thisnamealongside your modifications (includingvisible: falseorenabled: falseto hide it). Has no effect outside of a template.- templateitemname
Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with
templateitemnamematching itsname, alongside your modifications (includingvisible: falseorenabled: falseto hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it withvisible: true.- value
string - dtickformat for described zoom level, the same as “tickformat”
tuple[plotly.graph_objects.contourcarpet.colorbar.Tickformatstop]
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.
[‘allow’, ‘hide past div’, ‘hide past domain’]
Any
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”.
[‘outside’, ‘inside’, ‘outside top’, ‘inside top’, ‘outside left’, ‘inside left’, ‘outside right’, ‘inside right’, ‘outside bottom’, ‘inside bottom’]
Any
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”.
An int (or float that will be cast to an int) in the interval [1, 9223372036854775807]
ticklen¶Sets the tick length (in px).
An int or float in the interval [0, inf]
int|float
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).
[‘auto’, ‘linear’, ‘array’]
Any
tickprefix¶Sets a tick label prefix.
A string
A number that will be converted to a string
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.
[‘outside’, ‘inside’, ‘’]
Any
ticksuffix¶Sets a tick label suffix.
A string
A number that will be converted to a string
ticktext¶Sets the text displayed at the ticks position via tickvals.
Only has an effect if tickmode is set to “array”. Used with
tickvals.
The ‘ticktext’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
ticktextsrc¶Sets the source reference on Chart Studio Cloud for ticktext.
The ‘ticktextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
tickvals¶Sets the values at which ticks on this axis appear. Only has an
effect if tickmode is set to “array”. Used with ticktext.
The ‘tickvals’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series
numpy.ndarray
tickvalssrc¶Sets the source reference on Chart Studio Cloud for tickvals.
The ‘tickvalssrc’ property must be specified as a string or as a plotly.grid_objs.Column object
tickwidth¶Sets the tick width (in px).
An int or float in the interval [0, inf]
int|float
title¶The ‘title’ property is an instance of Title that may be specified as:
An instance of
plotly.graph_objects.contourcarpet.colorbar.TitleA dict of string/value properties that will be passed to the Title constructor
Supported dict properties:
- font
Sets this color bar’s title font.
- side
Determines the location of color bar’s title with respect to the color bar. Defaults to “top” when
orientationif “v” and defaults to “right” whenorientationif “h”.- text
Sets the title of the color bar.
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”.
An int or float
int|float
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”.
[‘left’, ‘center’, ‘right’]
Any
xpad¶Sets the amount of padding (in px) along the x direction.
An int or float in the interval [0, inf]
int|float
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.
[‘container’, ‘paper’]
Any
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”.
An int or float
int|float
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”.
[‘top’, ‘middle’, ‘bottom’]
Any
ypad¶Sets the amount of padding (in px) along the y direction.
An int or float in the interval [0, inf]
int|float
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.
[‘container’, ‘paper’]
Any
plotly.graph_objects.contourcarpet.Contours(arg=None, coloring=None, end=None, labelfont=None, labelformat=None, operation=None, showlabels=None, showlines=None, size=None, start=None, type=None, value=None, **kwargs)¶coloring¶Determines the coloring method showing the contour values. If “fill”, coloring is done evenly between each contour level If “lines”, coloring is done on the contour lines. If “none”, no coloring is applied on this trace.
[‘fill’, ‘lines’, ‘none’]
Any
end¶Sets the end contour level value. Must be more than
contours.start
An int or float
int|float
labelfont¶Sets the font used for labeling the contour levels. The default
color comes from the lines, if shown. The default family and
size come from layout.font.
The ‘labelfont’ property is an instance of Labelfont that may be specified as:
An instance of
plotly.graph_objects.contourcarpet.contours.LabelfontA dict of string/value properties that will be passed to the Labelfont constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
labelformat¶Sets the contour label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
A string
A number that will be converted to a string
operation¶Sets the constraint operation. “=” keeps regions equal to
value “<” and “<=” keep regions less than value “>” and
“>=” keep regions greater than value “[]”, “()”, “[)”, and
“(]” keep regions inside value[0] to value[1] “][“, “)(“,
“](“, “)[” keep regions outside value[0] to value[1]` Open
vs. closed intervals make no difference to constraint display,
but all versions are allowed for consistency with filter
transforms.
[‘=’, ‘<’, ‘>=’, ‘>’, ‘<=’, ‘[]’, ‘()’, ‘[)’, ‘(]’, ‘][‘, ‘)(‘, ‘](‘, ‘)[‘]
Any
showlabels¶Determines whether to label the contour lines with their values.
The ‘showlabels’ property must be specified as a bool (either True, or False)
showlines¶Determines whether or not the contour lines are drawn. Has an
effect only if contours.coloring is set to “fill”.
The ‘showlines’ property must be specified as a bool (either True, or False)
size¶Sets the step between each contour level. Must be positive.
An int or float in the interval [0, inf]
int|float
start¶Sets the starting contour level value. Must be less than
contours.end
An int or float
int|float
type¶If levels, the data is represented as a contour plot with
multiple levels displayed. If constraint, the data is
represented as constraints with the invalid region shaded as
specified by the operation and value parameters.
[‘levels’, ‘constraint’]
Any
value¶Sets the value or values of the constraint boundary. When
operation is set to one of the comparison values
(=,<,>=,>,<=) “value” is expected to be a number. When
operation is set to one of the interval values
([],(),[),(],][,)(,](,)[) “value” is expected to be an array of
two numbers where the first is the lower bound and the second
is the upper bound.
The ‘value’ property accepts values of any type
Any
plotly.graph_objects.contourcarpet.Legendgrouptitle(arg=None, font=None, text=None, **kwargs)¶font¶Sets this legend group’s title font.
The ‘font’ property is an instance of Font that may be specified as:
An instance of
plotly.graph_objects.contourcarpet.legendgrouptitle.FontA dict of string/value properties that will be passed to the Font constructor
Supported dict properties:
color
- family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.
- lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.
- shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.
size
- style
Sets whether a font should be styled with a normal or italic face from its family.
- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- variant
Sets the variant of the font.
- weight
Sets the weight (or boldness) of the font.
plotly.graph_objects.contourcarpet.Line(arg=None, color=None, dash=None, smoothing=None, width=None, **kwargs)¶color¶Sets the color of the contour level. Has no effect if
contours.coloring is set to “lines”.
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%)’)
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
dash¶Sets the dash style of lines. Set to a dash type string (“solid”, “dot”, “dash”, “longdash”, “dashdot”, or “longdashdot”) or a dash length list in px (eg “5px,10px,2px,2px”).
[‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]
(e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)
smoothing¶Sets the amount of smoothing for the contour lines, where 0 corresponds to no smoothing.
An int or float in the interval [0, 1.3]
int|float
width¶Sets the contour line width in (in px) Defaults to 0.5 when
contours.type is “levels”. Defaults to 2 when contour.type
is “constraint”.
An int or float in the interval [0, inf]
int|float
plotly.graph_objects.contourcarpet.Stream(arg=None, maxpoints=None, token=None, **kwargs)¶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.
An int or float in the interval [0, 10000]
int|float
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.
A non-empty string