plotly.graph_objects
.Volume¶plotly.graph_objects.
Volume
(arg=None, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)¶__init__
(arg=None, autocolorscale=None, caps=None, cauto=None, cmax=None, cmid=None, cmin=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, isomax=None, isomin=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, opacityscale=None, reversescale=None, scene=None, showlegend=None, showscale=None, slices=None, spaceframe=None, stream=None, surface=None, text=None, textsrc=None, uid=None, uirevision=None, value=None, valuehoverformat=None, valuesrc=None, visible=None, x=None, xhoverformat=None, xsrc=None, y=None, yhoverformat=None, ysrc=None, z=None, zhoverformat=None, zsrc=None, **kwargs)¶Construct a new Volume object
Draws volume trace between iso-min and iso-max values with
coordinates given by four 1-dimensional arrays containing the
value
, x
, y
and z
of every vertex of a uniform or non-
uniform 3-D grid. Horizontal or vertical slices, caps as well
as spaceframe between iso-min and iso-max values could also be
drawn using this trace.
arg – dict of properties compatible with this constructor or
an instance of plotly.graph_objects.Volume
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.
caps – plotly.graph_objects.volume.Caps
instance or
dict with compatible properties
cauto – Determines whether or not the color domain is computed
with respect to the input data (here value
) or the
bounds set in cmin
and cmax
Defaults to false
when cmin
and cmax
are set by the user.
cmax – Sets the upper bound of the color domain. Value should
have the same units as value
and if set, cmin
must
be set as well.
cmid – Sets the mid-point of the color domain by scaling
cmin
and/or cmax
to be equidistant to this point.
Value should have the same units as value
. Has no
effect when cauto
is false
.
cmin – Sets the lower bound of the color domain. Value should
have the same units as value
and if set, cmax
must
be set as well.
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.volume.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 cmin
and cmax
.
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.
contour – plotly.graph_objects.volume.Contour
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
.
flatshading – Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections.
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 – plotly.graph_objects.volume.Hoverlabel
instance or dict with compatible properties
hovertemplate – Template string used for rendering the information that
appear on hover box. Note that this will override
hoverinfo
. Variables are inserted using %{variable},
for example “y: %{y}” as well as %{xother}, {%_xother},
{%_xother_}, {%xother_}. When showing info for several
points, “xother” will be added to those with different
x positions from the first point. An underscore before
or after “(x|y)other” will add a space on that side,
only when this field is shown. Numbers are formatted
using d3-format’s syntax %{variable:d3-format}, for
example “Price: %{y:$.2f}”.
https://github.com/d3/d3-format/tree/v1.4.5#d3-format
for details on the formatting syntax. Dates are
formatted using d3-time-format’s syntax
%{variable|d3-time-format}, for example “Day:
%{2019-01-01|%A}”. https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format for details on the
date formatting syntax. The variables available in
hovertemplate
are the ones emitted as event data
described at this link
https://plotly.com/javascript/plotlyjs-events/#event-
data. Additionally, every attributes that can be
specified per-point (the ones that are arrayOk: true
)
are available. Anything contained in tag <extra>
is
displayed in the secondary box, for example
“<extra>{fullData.name}</extra>”. To hide the secondary
box completely, use an empty tag <extra></extra>
.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate
.
hovertext – Same as text
.
hovertextsrc – Sets the source reference on Chart Studio Cloud for
hovertext
.
ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc – Sets the source reference on Chart Studio Cloud for
ids
.
isomax – Sets the maximum boundary for iso-surface plot.
isomin – Sets the minimum boundary for iso-surface plot.
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.volume.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.
lighting – plotly.graph_objects.volume.Lighting
instance
or dict with compatible properties
lightposition – plotly.graph_objects.volume.Lightposition
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.
opacity – Sets the opacity of the surface. Please note that in
the case of using high opacity
values for example a
value greater than or equal to 0.5 on two surfaces (and
0.25 with four surfaces), an overlay of multiple
transparent surfaces may not perfectly be sorted in
depth by the webgl API. This behavior may be improved
in the near future and is subject to change.
opacityscale – Sets the opacityscale. The opacityscale must be an
array containing arrays mapping a normalized value to
an opacity value. At minimum, a mapping for the lowest
(0) and highest (1) values are required. For example,
[[0, 1], [0.5, 0.2], [1, 1]]
means that higher/lower
values would have higher opacity values and those in
the middle would be more transparent Alternatively,
opacityscale
may be a palette name string of the
following list: ‘min’, ‘max’, ‘extremes’ and ‘uniform’.
The default is ‘uniform’.
reversescale – Reverses the color mapping if true. If true, cmin
will correspond to the last color in the array and
cmax
will correspond to the first color.
scene – Sets a reference between this trace’s 3D coordinate
system and a 3D scene. If “scene” (the default value),
the (x,y,z) coordinates refer to layout.scene
. If
“scene2”, the (x,y,z) coordinates refer to
layout.scene2
, and so on.
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.
slices – plotly.graph_objects.volume.Slices
instance or
dict with compatible properties
spaceframe – plotly.graph_objects.volume.Spaceframe
instance or dict with compatible properties
stream – plotly.graph_objects.volume.Stream
instance or
dict with compatible properties
surface – plotly.graph_objects.volume.Surface
instance
or dict with compatible properties
text – Sets the text elements associated with the vertices. If
trace hoverinfo
contains a “text” flag and
“hovertext” is not set, these elements will be seen in
the hover labels.
textsrc – Sets the source reference on Chart Studio Cloud for
text
.
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.
value – Sets the 4th dimension (value) of the vertices.
valuehoverformat – Sets the hover text formatting rulefor value
using
d3 formatting mini-languages which are very similar to
those in Python. For numbers, see: https://github.com/d
3/d3-format/tree/v1.4.5#d3-format.By default the values
are formatted using generic number format.
valuesrc – Sets the source reference on Chart Studio Cloud for
value
.
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 of the vertices on X axis.
xhoverformat – Sets the hover text formatting rulefor x
using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see:
https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
And for dates see: https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format. We add two items to
d3’s date formatter: “%h” for half of the year as a
decimal number as well as “%{n}f” for fractional
seconds with n digits. For example, 2016-10-13
09:15:23.456 with tickformat “%H~%M~%S.%2f” would
display *09~15~23.46*By default the values are
formatted using xaxis.hoverformat
.
xsrc – Sets the source reference on Chart Studio Cloud for
x
.
y – Sets the Y coordinates of the vertices on Y axis.
yhoverformat – Sets the hover text formatting rulefor y
using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see:
https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
And for dates see: https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format. We add two items to
d3’s date formatter: “%h” for half of the year as a
decimal number as well as “%{n}f” for fractional
seconds with n digits. For example, 2016-10-13
09:15:23.456 with tickformat “%H~%M~%S.%2f” would
display *09~15~23.46*By default the values are
formatted using yaxis.hoverformat
.
ysrc – Sets the source reference on Chart Studio Cloud for
y
.
z – Sets the Z coordinates of the vertices on Z axis.
zhoverformat – Sets the hover text formatting rulefor z
using d3
formatting mini-languages which are very similar to
those in Python. For numbers, see:
https://github.com/d3/d3-format/tree/v1.4.5#d3-format.
And for dates see: https://github.com/d3/d3-time-
format/tree/v2.2.3#locale_format. We add two items to
d3’s date formatter: “%h” for half of the year as a
decimal number as well as “%{n}f” for fractional
seconds with n digits. For example, 2016-10-13
09:15:23.456 with tickformat “%H~%M~%S.%2f” would
display *09~15~23.46*By default the values are
formatted using zaxis.hoverformat
.
zsrc – Sets the source reference on Chart Studio Cloud for
z
.
plotly.graph_objects
.volume¶plotly.graph_objects.volume.
Caps
(arg=None, x=None, y=None, z=None, **kwargs)¶x
¶The ‘x’ property is an instance of X that may be specified as:
An instance of
plotly.graph_objects.volume.caps.X
A dict of string/value properties that will be passed to the X constructor
Supported dict properties:
- fill
Sets the fill ratio of the
caps
. The default fill value of thecaps
is 1 meaning that they are entirely shaded. On the other hand Applying afill
ratio less than one would allow the creation of openings parallel to the edges.- show
Sets the fill ratio of the
slices
. The default fill value of the xslices
is 1 meaning that they are entirely shaded. On the other hand Applying afill
ratio less than one would allow the creation of openings parallel to the edges.
y
¶The ‘y’ property is an instance of Y that may be specified as:
An instance of
plotly.graph_objects.volume.caps.Y
A dict of string/value properties that will be passed to the Y constructor
Supported dict properties:
- fill
Sets the fill ratio of the
caps
. The default fill value of thecaps
is 1 meaning that they are entirely shaded. On the other hand Applying afill
ratio less than one would allow the creation of openings parallel to the edges.- show
Sets the fill ratio of the
slices
. The default fill value of the yslices
is 1 meaning that they are entirely shaded. On the other hand Applying afill
ratio less than one would allow the creation of openings parallel to the edges.
z
¶The ‘z’ property is an instance of Z that may be specified as:
An instance of
plotly.graph_objects.volume.caps.Z
A dict of string/value properties that will be passed to the Z constructor
Supported dict properties:
- fill
Sets the fill ratio of the
caps
. The default fill value of thecaps
is 1 meaning that they are entirely shaded. On the other hand Applying afill
ratio less than one would allow the creation of openings parallel to the edges.- show
Sets the fill ratio of the
slices
. The default fill value of the zslices
is 1 meaning that they are entirely shaded. On the other hand Applying afill
ratio less than one would allow the creation of openings parallel to the edges.
plotly.graph_objects.volume.
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.volume.colorbar.Tickfont
A 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.volume.colorbar.tickformatstopdefaults), sets the default property values to use for elements of volume.colorbar.tickformatstops
The ‘tickformatstopdefaults’ property is an instance of Tickformatstop that may be specified as:
An instance of
plotly.graph_objects.volume.colorbar.Tickformatstop
A 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.volume.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
templateitemname
matching thisname
alongside your modifications (includingvisible: false
orenabled: false
to 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
templateitemname
matching itsname
, alongside your modifications (includingvisible: false
orenabled: false
to 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”
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.volume.colorbar.Title
A 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
orientation
if “v” and defaults to “right” whenorientation
if “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.volume.
Contour
(arg=None, color=None, show=None, width=None, **kwargs)¶color
¶Sets the color of the contour 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
show
¶Sets whether or not dynamic contours are shown on hover
The ‘show’ property must be specified as a bool (either True, or False)
width
¶Sets the width of the contour lines.
An int or float in the interval [1, 16]
int|float
plotly.graph_objects.volume.
Hoverlabel
(arg=None, align=None, alignsrc=None, bgcolor=None, bgcolorsrc=None, bordercolor=None, bordercolorsrc=None, font=None, namelength=None, namelengthsrc=None, **kwargs)¶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
[‘left’, ‘right’, ‘auto’]
A tuple, list, or one-dimensional numpy array of the above
Any|numpy.ndarray
alignsrc
¶Sets the source reference on Chart Studio Cloud for align
.
The ‘alignsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
bgcolor
¶Sets the background color of the hover labels for this trace
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
A list or array of any of the above
str|numpy.ndarray
bgcolorsrc
¶Sets the source reference on Chart Studio Cloud for bgcolor
.
The ‘bgcolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
bordercolor
¶Sets the border color of the hover labels for this trace.
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
A list or array of any of the above
str|numpy.ndarray
bordercolorsrc
¶Sets the source reference on Chart Studio Cloud for
bordercolor
.
The ‘bordercolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object
font
¶Sets the font used in hover labels.
The ‘font’ property is an instance of Font that may be specified as:
An instance of
plotly.graph_objects.volume.hoverlabel.Font
A dict of string/value properties that will be passed to the Font constructor
Supported dict properties:
color
- colorsrc
Sets the source reference on Chart Studio Cloud for
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”.
- familysrc
Sets the source reference on Chart Studio Cloud for
family
.- 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.
- linepositionsrc
Sets the source reference on Chart Studio Cloud for
lineposition
.- 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.
- shadowsrc
Sets the source reference on Chart Studio Cloud for
shadow
.size
- sizesrc
Sets the source reference on Chart Studio Cloud for
size
.- style
Sets whether a font should be styled with a normal or italic face from its family.
- stylesrc
Sets the source reference on Chart Studio Cloud for
style
.- textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.
- textcasesrc
Sets the source reference on Chart Studio Cloud for
textcase
.- variant
Sets the variant of the font.
- variantsrc
Sets the source reference on Chart Studio Cloud for
variant
.- weight
Sets the weight (or boldness) of the font.
- weightsrc
Sets the source reference on Chart Studio Cloud for
weight
.
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.
An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807]
A tuple, list, or one-dimensional numpy array of the above
int|numpy.ndarray
plotly.graph_objects.volume.
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.volume.legendgrouptitle.Font
A 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.volume.
Lighting
(arg=None, ambient=None, diffuse=None, facenormalsepsilon=None, fresnel=None, roughness=None, specular=None, vertexnormalsepsilon=None, **kwargs)¶ambient
¶Ambient light increases overall color visibility but can wash out the image.
An int or float in the interval [0, 1]
int|float
diffuse
¶Represents the extent that incident rays are reflected in a range of angles.
An int or float in the interval [0, 1]
int|float
facenormalsepsilon
¶Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
An int or float in the interval [0, 1]
int|float
fresnel
¶Represents the reflectance as a dependency of the viewing angle; e.g. paper is reflective when viewing it from the edge of the paper (almost 90 degrees), causing shine.
An int or float in the interval [0, 5]
int|float
roughness
¶Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
An int or float in the interval [0, 1]
int|float
specular
¶Represents the level that incident rays are reflected in a single direction, causing shine.
An int or float in the interval [0, 2]
int|float
vertexnormalsepsilon
¶Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
An int or float in the interval [0, 1]
int|float
plotly.graph_objects.volume.
Lightposition
(arg=None, x=None, y=None, z=None, **kwargs)¶x
¶Numeric vector, representing the X coordinate for each vertex.
An int or float in the interval [-100000, 100000]
int|float
y
¶Numeric vector, representing the Y coordinate for each vertex.
An int or float in the interval [-100000, 100000]
int|float
z
¶Numeric vector, representing the Z coordinate for each vertex.
An int or float in the interval [-100000, 100000]
int|float
plotly.graph_objects.volume.
Slices
(arg=None, x=None, y=None, z=None, **kwargs)¶x
¶The ‘x’ property is an instance of X that may be specified as:
An instance of
plotly.graph_objects.volume.slices.X
A dict of string/value properties that will be passed to the X constructor
Supported dict properties:
- fill
Sets the fill ratio of the
slices
. The default fill value of theslices
is 1 meaning that they are entirely shaded. On the other hand Applying afill
ratio less than one would allow the creation of openings parallel to the edges.- locations
Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis x except start and end.
- locationssrc
Sets the source reference on Chart Studio Cloud for
locations
.- show
Determines whether or not slice planes about the x dimension are drawn.
y
¶The ‘y’ property is an instance of Y that may be specified as:
An instance of
plotly.graph_objects.volume.slices.Y
A dict of string/value properties that will be passed to the Y constructor
Supported dict properties:
- fill
Sets the fill ratio of the
slices
. The default fill value of theslices
is 1 meaning that they are entirely shaded. On the other hand Applying afill
ratio less than one would allow the creation of openings parallel to the edges.- locations
Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis y except start and end.
- locationssrc
Sets the source reference on Chart Studio Cloud for
locations
.- show
Determines whether or not slice planes about the y dimension are drawn.
z
¶The ‘z’ property is an instance of Z that may be specified as:
An instance of
plotly.graph_objects.volume.slices.Z
A dict of string/value properties that will be passed to the Z constructor
Supported dict properties:
- fill
Sets the fill ratio of the
slices
. The default fill value of theslices
is 1 meaning that they are entirely shaded. On the other hand Applying afill
ratio less than one would allow the creation of openings parallel to the edges.- locations
Specifies the location(s) of slices on the axis. When not specified slices would be created for all points of the axis z except start and end.
- locationssrc
Sets the source reference on Chart Studio Cloud for
locations
.- show
Determines whether or not slice planes about the z dimension are drawn.
plotly.graph_objects.volume.
Spaceframe
(arg=None, fill=None, show=None, **kwargs)¶fill
¶Sets the fill ratio of the spaceframe
elements. The default
fill value is 1 meaning that they are entirely shaded. Applying
a fill
ratio less than one would allow the creation of
openings parallel to the edges.
An int or float in the interval [0, 1]
int|float
plotly.graph_objects.volume.
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
plotly.graph_objects.volume.
Surface
(arg=None, count=None, fill=None, pattern=None, show=None, **kwargs)¶count
¶Sets the number of iso-surfaces between minimum and maximum iso-values. By default this value is 2 meaning that only minimum and maximum surfaces would be drawn.
An int (or float that will be cast to an int) in the interval [1, 9223372036854775807]
fill
¶Sets the fill ratio of the iso-surface. The default fill value
of the surface is 1 meaning that they are entirely shaded. On
the other hand Applying a fill
ratio less than one would
allow the creation of openings parallel to the edges.
An int or float in the interval [0, 1]
int|float
pattern
¶Sets the surface pattern of the iso-surface 3-D sections. The
default pattern of the surface is all
meaning that the rest
of surface elements would be shaded. The check options (either
1 or 2) could be used to draw half of the squares on the
surface. Using various combinations of capital A
, B
, C
,
D
and E
may also be used to reduce the number of triangles
on the iso-surfaces and creating other patterns of interest.
The ‘pattern’ property is a flaglist and may be specified as a string containing:
Any combination of [‘A’, ‘B’, ‘C’, ‘D’, ‘E’] joined with ‘+’ characters (e.g. ‘A+B’) OR exactly one of [‘all’, ‘odd’, ‘even’] (e.g. ‘even’)
Any