GeezerVison is showing plotly.com — plotly.graph_objects.contourcarpet package — 7.1.0 documentation
plotly.graph_objects.contourcarpet package¶
-
class
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, tickvals=None, tickwidth=None, title=None, x=None, xanchor=None, xpad=None, xref=None, y=None, yanchor=None, ypad=None, yref=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseTraceHierarchyType
-
property
bgcolor¶
Sets the color of padded area.
- The ‘bgcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
bordercolor¶
Sets the axis line color.
- The ‘bordercolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
borderwidth¶
Sets the width (in px) or the border enclosing this color bar.
- The ‘borderwidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
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
- Returns
-
- Return type
Any
-
property
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. “SI” uses prefixes from “femto” f (10^-15) to “tera” T
(10^12). SI extended covers instead the full SI range from
“quecto” q (10^-30) to “quetta” Q (10^30). If “SI” or SI
extended is used and the exponent is beyond the above ranges,
the formatting rule will automatically be switched to the power
notation.
- The ‘exponentformat’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘none’, ‘e’, ‘E’, ‘power’, ‘SI’, ‘B’, ‘SI extended’]
- Returns
-
- Return type
Any
-
property
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
- Returns
-
- Return type
Any
-
property
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.
- The ‘len’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
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.
- The ‘lenmode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘fraction’, ‘pixels’]
- Returns
-
- Return type
Any
-
property
minexponent¶
Hide SI prefix for 10^n if |n| is below this number. This only
has an effect when tickformat is “SI” or “B”.
- The ‘minexponent’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
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”.
- The ‘nticks’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
property
orientation¶
Sets the orientation of the colorbar.
- The ‘orientation’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘h’, ‘v’]
- Returns
-
- Return type
Any
-
property
outlinecolor¶
Sets the axis line color.
- The ‘outlinecolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
outlinewidth¶
Sets the width (in px) of the axis line.
- The ‘outlinewidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
separatethousands¶
If “true”, even 4-digit integers are separated
- The ‘separatethousands’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
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.
- The ‘showexponent’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]
- Returns
-
- Return type
Any
-
property
showticklabels¶
Determines whether or not the tick labels are drawn.
- The ‘showticklabels’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
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.
- The ‘showtickprefix’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]
- Returns
-
- Return type
Any
-
property
showticksuffix¶
Same as showtickprefix but for tick suffixes.
- The ‘showticksuffix’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘all’, ‘first’, ‘last’, ‘none’]
- Returns
-
- Return type
Any
-
property
thickness¶
Sets the thickness of the color bar This measure excludes the
size of the padding, ticks and labels.
- The ‘thickness’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
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.
- The ‘thicknessmode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘fraction’, ‘pixels’]
- Returns
-
- Return type
Any
-
property
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
- Returns
-
- Return type
Any
-
property
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).
- Returns
-
- Return type
int|float
-
property
tickcolor¶
Sets the tick color.
- The ‘tickcolor’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
tickfont¶
Sets the color bar’s tick label font
The ‘tickfont’ property is an instance of Tickfont
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.contourcarpet.colorbar.Tickfont
-
property
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”
- The ‘tickformat’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
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:
- Returns
-
- Return type
plotly.graph_objects.contourcarpet.colorbar.Tickformatstop
-
property
tickformatstops¶
The ‘tickformatstops’ property is a tuple of instances of
Tickformatstop that may be specified as:
- Returns
-
- Return type
tuple[plotly.graph_objects.contourcarpet.colorbar.Tickformatstop]
-
property
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.
- The ‘ticklabeloverflow’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘allow’, ‘hide past div’, ‘hide past domain’]
- Returns
-
- Return type
Any
-
property
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”.
- The ‘ticklabelposition’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘outside’, ‘inside’, ‘outside top’, ‘inside top’,
‘outside left’, ‘inside left’, ‘outside right’, ‘inside
right’, ‘outside bottom’, ‘inside bottom’]
- Returns
-
- Return type
Any
-
property
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”.
- The ‘ticklabelstep’ property is an integer and may be specified as:
-
- Returns
-
- Return type
int
-
property
ticklen¶
Sets the tick length (in px).
- The ‘ticklen’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
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).
- The ‘tickmode’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘auto’, ‘linear’, ‘array’]
- Returns
-
- Return type
Any
-
property
tickprefix¶
Sets a tick label prefix.
- The ‘tickprefix’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
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.
- The ‘ticks’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘outside’, ‘inside’, ‘’]
- Returns
-
- Return type
Any
-
property
ticksuffix¶
Sets a tick label suffix.
- The ‘ticksuffix’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
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
- Returns
-
- Return type
numpy.ndarray
-
property
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
- Returns
-
- Return type
numpy.ndarray
-
property
tickwidth¶
Sets the tick width (in px).
- The ‘tickwidth’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
title¶
The ‘title’ property is an instance of Title
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.contourcarpet.colorbar.Title
-
property
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”.
- The ‘x’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
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”.
- The ‘xanchor’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘left’, ‘center’, ‘right’]
- Returns
-
- Return type
Any
-
property
xpad¶
Sets the amount of padding (in px) along the x direction.
- The ‘xpad’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
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.
- The ‘xref’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘container’, ‘paper’]
- Returns
-
- Return type
Any
-
property
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”.
- The ‘y’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
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”.
- The ‘yanchor’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘top’, ‘middle’, ‘bottom’]
- Returns
-
- Return type
Any
-
property
ypad¶
Sets the amount of padding (in px) along the y direction.
- The ‘ypad’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
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.
- The ‘yref’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘container’, ‘paper’]
- Returns
-
- Return type
Any
-
class
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)¶
Bases: plotly.basedatatypes.BaseTraceHierarchyType
-
property
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.
- The ‘coloring’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘fill’, ‘lines’, ‘none’]
- Returns
-
- Return type
Any
-
property
end¶
Sets the end contour level value. Must be more than
contours.start
- The ‘end’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
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:
- Returns
-
- Return type
plotly.graph_objects.contourcarpet.contours.Labelfont
-
property
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.
- The ‘labelformat’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
property
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.
- The ‘operation’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘=’, ‘<’, ‘>=’, ‘>’, ‘<=’, ‘[]’, ‘()’, ‘[)’, ‘(]’, ‘][‘,
‘)(‘, ‘](‘, ‘)[‘]
- Returns
-
- Return type
Any
-
property
showlabels¶
Determines whether to label the contour lines with their
values.
- The ‘showlabels’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
showlines¶
Determines whether or not the contour lines are drawn. Has an
effect only if contours.coloring is set to “fill”.
- The ‘showlines’ property is a boolean and must be specified as:
-
- Returns
-
- Return type
bool
-
property
size¶
Sets the step between each contour level. Must be positive.
- The ‘size’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
start¶
Sets the starting contour level value. Must be less than
contours.end
- The ‘start’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
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.
- The ‘type’ property is an enumeration that may be specified as:
- One of the following enumeration values:
[‘levels’, ‘constraint’]
- Returns
-
- Return type
Any
-
property
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
- Returns
-
- Return type
Any
-
class
plotly.graph_objects.contourcarpet.Legendgrouptitle(arg=None, font=None, text=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseTraceHierarchyType
-
property
font¶
Sets this legend group’s title font.
The ‘font’ property is an instance of Font
that may be specified as:
- Returns
-
- Return type
plotly.graph_objects.contourcarpet.legendgrouptitle.Font
-
property
text¶
Sets the title of the legend group.
- The ‘text’ property is a string and must be specified as:
-
- Returns
-
- Return type
str
-
class
plotly.graph_objects.contourcarpet.Line(arg=None, color=None, dash=None, smoothing=None, width=None, **kwargs)¶
Bases: plotly.basedatatypes.BaseTraceHierarchyType
-
property
color¶
Sets the color of the contour level. Has no effect if
contours.coloring is set to “lines”.
- The ‘color’ property is a color and may be specified as a string in the following formats:
hex or short hex (e.g. ‘#d3d3d3’, ‘#d3d’) hex or short hex with alpha (e.g. ‘#d3d3d380’, ‘#d3d8’) rgb (e.g. ‘rgb(255, 0, 0)’, ‘rgb(255 0 0)’) rgba (e.g. ‘rgba(255, 0, 0, 0.5)’, ‘rgba(255 0 0 / 0.5)’) hsl (e.g. ‘hsl(0, 100%, 50%)’, ‘hsl(0deg 100% 50%)’) hsla (e.g. ‘hsla(0, 100%, 50%, 0.5)’, ‘hsla(0deg 100% 50% / 0.5)’) hwb (e.g. ‘hwb(0 0% 100%)’) lab/lch/oklab/oklch (e.g. ‘oklch(0.7 0.15 180)’) color (e.g. ‘color(display-p3 1 0 0)’) named colors (full list: https://www.w3.org/TR/css-color-4/#named-color) Any other supported CSS 4 color format: https://www.w3.org/TR/css-color-4/
- Returns
-
- Return type
str
-
property
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”).
- The ‘dash’ property is an enumeration that may be specified as:
- One of the following dash styles:
[‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]
- A string containing a dash length list in pixels or percentages
(e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)
- Returns
-
- Return type
str
-
property
smoothing¶
Sets the amount of smoothing for the contour lines, where 0
corresponds to no smoothing.
- The ‘smoothing’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
-
property
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”.
- The ‘width’ property is a number and may be specified as:
-
- Returns
-
- Return type
int|float
|
