Volume
Overview
The volume
trace type is used to create 3D volume plots, which visualize 3D volumetric data. Volume plots are useful for representing datasets where the values at each (x, y, z) point in a grid represent a density or scalar field, such as medical imaging, fluid dynamics, and other scientific data.
You can customize the opacity, surface levels, and colors to effectively visualize the internal structure of the volume.
Common Uses
- Medical Imaging: Visualizing 3D scans such as MRI or CT data.
- Fluid Dynamics: Representing 3D fields of density or pressure.
- Scientific Visualization: Displaying any 3D scalar field or volumetric data.
Check out the Attributes for the full set of configuration options
Examples
Common Configurations
Here's a simple volume
plot visualizing a 3D scalar field:
You can copy this code below to create this chart in your project:
models:
- name: isosurface-data-simple
args:
- echo
- |
idx,x,y,z,value
0,0,0,1,1
1,0,1,1,2
2,0,0,0,3
3,0,1,0,4
4,1,0,1,5
5,1,1,1,6
6,1,0,0,7
7,1,1,0,8
traces:
- name: Simple Isosurface Plot Trace
model: ref(isosurface-data-simple)
props:
type: isosurface
x: query(x)
y: query(y)
z: query(z)
value: query(value)
isomin: 2
isomax: 6
colorscale: "Reds"
order_by:
- query( idx asc )
charts:
- name: Simple Isosurface Chart
traces:
- ref(Simple Isosurface Plot Trace)
layout:
title:
text: Simple Isosurface Plot<br><sub>3D Volume Visualization</sub>
Attributes
These attributes apply to traces where trace.props.type
is set to volume
. You would configure these attributes on the trace with the trace.props
object.
autocolorscale: 'boolean' #(1)!
caps:
x:
fill: 'number between or equal to 0 and 1' #(2)!
show: 'boolean' #(3)!
y:
fill: 'number between or equal to 0 and 1' #(4)!
show: 'boolean' #(5)!
z:
fill: 'number between or equal to 0 and 1' #(6)!
show: 'boolean' #(7)!
cauto: 'boolean' #(8)!
cmax: 'number' #(9)!
cmid: 'number' #(10)!
cmin: 'number' #(11)!
coloraxis: 'subplotid' #(12)!
colorbar:
bgcolor: 'color' #(13)!
bordercolor: 'color' #(14)!
borderwidth: 'number greater than or equal to 0' #(15)!
dtick: 'number or categorical coordinate string' #(16)!
exponentformat: 'enumerated , one of ( "none" | "e" | "e" | "power" | "si" | "b"
)' #(17)!
len: 'number greater than or equal to 0' #(18)!
lenmode: 'enumerated , one of ( "fraction" | "pixels" )' #(19)!
minexponent: 'number greater than or equal to 0' #(20)!
nticks: 'integer greater than or equal to 0' #(21)!
orientation: 'enumerated , one of ( "h" | "v" )' #(22)!
outlinecolor: 'color' #(23)!
outlinewidth: 'number greater than or equal to 0' #(24)!
separatethousands: 'boolean' #(25)!
showexponent: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(26)!
showticklabels: 'boolean' #(27)!
showtickprefix: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(28)!
showticksuffix: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(29)!
thickness: 'number greater than or equal to 0' #(30)!
thicknessmode: 'enumerated , one of ( "fraction" | "pixels" )' #(31)!
tick0: 'number or categorical coordinate string' #(32)!
tickangle: 'angle' #(33)!
tickcolor: 'color' #(34)!
tickfont:
color: color
family: 'string' #(35)!
size: number greater than or equal to 1
tickformat: 'string' #(36)!
tickformatstops:
dtickrange: 'array' #(37)!
enabled: 'boolean' #(38)!
name: 'string' #(39)!
templateitemname: 'string' #(40)!
value: 'string' #(41)!
ticklabeloverflow: 'enumerated , one of ( "allow" | "hide past div" | "hide past
domain" )' #(42)!
ticklabelposition: 'enumerated , one of ( "outside" | "inside" | "outside top" |
"inside top" | "outside left" | "inside left" | "outside right" | "inside right"
| "outside bottom" | "inside bottom" )' #(43)!
ticklabelstep: 'integer greater than or equal to 1' #(44)!
ticklen: 'number greater than or equal to 0' #(45)!
tickmode: 'enumerated , one of ( "auto" | "linear" | "array" )' #(46)!
tickprefix: 'string' #(47)!
ticks: 'enumerated , one of ( "outside" | "inside" | "" )' #(48)!
ticksuffix: 'string' #(49)!
ticktext: 'data array' #(50)!
tickvals: 'data array' #(51)!
tickwidth: 'number greater than or equal to 0' #(52)!
title:
font:
color: color
family: 'string' #(53)!
size: number greater than or equal to 1
side: 'enumerated , one of ( "right" | "top" | "bottom" )' #(54)!
text: 'string' #(55)!
x: 'number between or equal to -2 and 3' #(56)!
xanchor: 'enumerated , one of ( "left" | "center" | "right" )' #(57)!
xpad: 'number greater than or equal to 0' #(58)!
y: 'number between or equal to -2 and 3' #(59)!
yanchor: 'enumerated , one of ( "top" | "middle" | "bottom" )' #(60)!
ypad: 'number greater than or equal to 0' #(61)!
colorscale: 'colorscale' #(62)!
contour:
color: 'color' #(63)!
show: 'boolean' #(64)!
width: 'number between or equal to 1 and 16' #(65)!
customdata: 'data array' #(66)!
flatshading: 'boolean' #(67)!
hoverinfo: 'flaglist string. any combination of "x", "y", "z", "text", "name" joined
with a "+" or "all" or "none" or "skip".' #(68)!
hoverlabel:
align: 'enumerated or array of enumerateds , one of ( "left" | "right" | "auto"
)' #(69)!
bgcolor: 'color or array of colors' #(70)!
bordercolor: 'color or array of colors' #(71)!
font:
color: color or array of colors
family: 'string or array of strings' #(72)!
size: number or array of numbers greater than or equal to 1
namelength: 'integer or array of integers greater than or equal to -1' #(73)!
hovertemplate: 'string or array of strings' #(74)!
hovertext: 'string or array of strings' #(75)!
ids: 'data array' #(76)!
isomax: 'number' #(77)!
isomin: 'number' #(78)!
legendgroup: 'string' #(79)!
legendgrouptitle:
font:
color: color
family: 'string' #(80)!
size: number greater than or equal to 1
text: 'string' #(81)!
legendrank: 'number' #(82)!
legendwidth: 'number greater than or equal to 0' #(83)!
lighting:
ambient: 'number between or equal to 0 and 1' #(84)!
diffuse: 'number between or equal to 0 and 1' #(85)!
facenormalsepsilon: 'number between or equal to 0 and 1' #(86)!
fresnel: 'number between or equal to 0 and 5' #(87)!
roughness: 'number between or equal to 0 and 1' #(88)!
specular: 'number between or equal to 0 and 2' #(89)!
vertexnormalsepsilon: 'number between or equal to 0 and 1' #(90)!
lightposition:
x: 'number between or equal to -100000 and 100000' #(91)!
y: 'number between or equal to -100000 and 100000' #(92)!
z: 'number between or equal to -100000 and 100000' #(93)!
meta: 'number or categorical coordinate string' #(94)!
opacity: 'number between or equal to 0 and 1' #(95)!
opacityscale: 'number or categorical coordinate string' #(96)!
reversescale: 'boolean' #(97)!
scene: 'subplotid' #(98)!
showlegend: 'boolean' #(99)!
showscale: 'boolean' #(100)!
slices:
x:
fill: 'number between or equal to 0 and 1' #(101)!
locations: 'data array' #(102)!
show: 'boolean' #(103)!
y:
fill: 'number between or equal to 0 and 1' #(104)!
locations: 'data array' #(105)!
show: 'boolean' #(106)!
z:
fill: 'number between or equal to 0 and 1' #(107)!
locations: 'data array' #(108)!
show: 'boolean' #(109)!
spaceframe:
fill: 'number between or equal to 0 and 1' #(110)!
show: 'boolean' #(111)!
surface:
count: 'integer greater than or equal to 1' #(112)!
fill: 'number between or equal to 0 and 1' #(113)!
pattern: 'flaglist string. any combination of "a", "b", "c", "d", "e" joined with
a "+" or "all" or "odd" or "even".' #(114)!
show: 'boolean' #(115)!
text: 'string or array of strings' #(116)!
type: volume
uirevision: 'number or categorical coordinate string' #(117)!
value: 'data array' #(118)!
valuehoverformat: 'string' #(119)!
visible: 'enumerated , one of ( true | false | "legendonly" )' #(120)!
x: 'data array' #(121)!
xhoverformat: 'string' #(122)!
y: 'data array' #(123)!
yhoverformat: 'string' #(124)!
z: 'data array' #(125)!
zhoverformat: 'string' #(126)!
- Determines whether the colorscale is a default palette (
autocolorscale: true
) or the palette determined bycolorscale
. In casecolorscale
is unspecified orautocolorscale
is true, the default palette will be chosen according to whether numbers in thecolor
array are all positive, all negative or mixed. - 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. - 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. - 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. - 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. - 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. - 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. - Determines whether or not the color domain is computed with respect to the input data (here
value
) or the bounds set incmin
andcmax
Defaults tofalse
whencmin
andcmax
are set by the user. - 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. - Sets the mid-point of the color domain by scaling
cmin
and/orcmax
to be equidistant to this point. Value should have the same units asvalue
. Has no effect whencauto
isfalse
. - 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. - 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. - Sets the color of padded area.
- Sets the axis line color.
- Sets the width (in px) or the border enclosing this color bar.
- 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 axistype
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", where f
is a positive number, gives ticks linearly spaced in value (but not position). For exampletick0
= 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 axistype
is "date", then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, setdtick
to 86400000.0. "date" also has special values "M" gives ticks spaced by a number of months. n
must be a positive integer. To set ticks on the 15th of every third month, settick0
to "2000-01-15" anddtick
to "M3". To set ticks every 4 years, setdtick
to "M48" - 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.
- 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.
- 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. - Hide SI prefix for 10^n if |n| is below this number. This only has an effect when
tickformat
is "SI" or "B". - 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 iftickmode
is set to "auto". - Sets the orientation of the colorbar.
- Sets the axis line color.
- Sets the width (in px) of the axis line.
- If "true", even 4-digit integers are separated
- 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.
- Determines whether or not the tick labels are drawn.
- 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.
- Same as
showtickprefix
but for tick suffixes. - Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
- 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. - Sets the placement of the first tick on this axis. Use with
dtick
. If the axistype
is "log", then you must take the log of your starting tick (e.g. to set the starting tick to 100, set thetick0
to 2) except whendtick
="L" (see dtick
for more info). If the axistype
is "date", it should be a date string, like date data. If the axistype
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. - Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangle
of -90 draws the tick labels vertically. - Sets the tick color.
- 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".
- 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"
- 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"
- Determines whether or not this stop is used. If
false
, this stop is ignored even within itsdtickrange
. - 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. - 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
. - string - dtickformat for described zoom level, the same as "tickformat"
- 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".
- Determines where tick labels are drawn relative to the ticks. Left and right options are used when
orientation
is "h", top and bottom whenorientation
is "v". - 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 withtype
"log" or "multicategory", or whentickmode
is "array". - Sets the tick length (in px).
- 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 positiontick0
and a tick stepdtick
("linear" is the default value iftick0
anddtick
are provided). If "array", the placement of the ticks is set viatickvals
and the tick text isticktext
. ("array" is the default value iftickvals
is provided). - Sets a tick label prefix.
- 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.
- Sets a tick label suffix.
- Sets the text displayed at the ticks position via
tickvals
. Only has an effect iftickmode
is set to "array". Used withtickvals
. - Sets the values at which ticks on this axis appear. Only has an effect if
tickmode
is set to "array". Used withticktext
. - Sets the tick width (in px).
- 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".
- 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". Note that the title's location used to be set by the now deprecatedtitleside
attribute. - Sets the title of the color bar. Note that before the existence of
title.text
, the title's contents used to be defined as thetitle
attribute itself. This behavior has been deprecated. - Sets the x position of the color bar (in plot fraction). Defaults to 1.02 when
orientation
is "v" and 0.5 whenorientation
is "h". - 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" whenorientation
is "v" and "center" whenorientation
is "h". - Sets the amount of padding (in px) along the x direction.
- Sets the y position of the color bar (in plot fraction). Defaults to 0.5 when
orientation
is "v" and 1.02 whenorientation
is "h". - 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" whenorientation
is "v" and "bottom" whenorientation
is "h". - Sets the amount of padding (in px) along the y direction.
- 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, usecmin
andcmax
. Alternatively,colorscale
may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. - Sets the color of the contour lines.
- Sets whether or not dynamic contours are shown on hover
- Sets the width of the contour lines.
- 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
- Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low-poly look via flat reflections.
- Determines which trace information appear on hover. If
none
orskip
are set, no information is displayed upon hovering. But, ifnone
is set, click and hover events are still fired. - 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
- Sets the background color of the hover labels for this trace
- Sets the border color of the hover labels for this trace.
- 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".
- 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. - 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 inhovertemplate
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 arearrayOk: true
) are available. Anything contained in tag<extra>
is displayed in the secondary box, for example "{fullData.name} ". To hide the secondary box completely, use an empty tag<extra></extra>
. - Same as
text
. - 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.
- Sets the maximum boundary for iso-surface plot.
- Sets the minimum boundary for iso-surface plot.
- Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
- 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".
- Sets the title of the legend group.
- 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. - Sets the width (in px or fraction) of the legend for this trace.
- Ambient light increases overall color visibility but can wash out the image.
- Represents the extent that incident rays are reflected in a range of angles.
- Epsilon for face normals calculation avoids math issues arising from degenerate geometry.
- 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.
- Alters specular reflection; the rougher the surface, the wider and less contrasty the shine.
- Represents the level that incident rays are reflected in a single direction, causing shine.
- Epsilon for vertex normals calculation avoids math issues arising from degenerate geometry.
- Numeric vector, representing the X coordinate for each vertex.
- Numeric vector, representing the Y coordinate for each vertex.
- Numeric vector, representing the Z coordinate for each vertex.
- Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace
name
, graph, axis and colorbartitle.text
, annotationtext
rangeselector
,updatemenues
andsliders
label
text all supportmeta
. To access the tracemeta
values in an attribute in the same trace, simply use%{meta[i]}
wherei
is the index or key of themeta
item in question. To access tracemeta
in layout attributes, use%{data[n[.meta[i]}
wherei
is the index or key of themeta
andn
is the trace index. - 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. - 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'. - Reverses the color mapping if true. If true,
cmin
will correspond to the last color in the array andcmax
will correspond to the first color. - 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 tolayout.scene2
, and so on. - Determines whether or not an item corresponding to this trace is shown in the legend.
- Determines whether or not a colorbar is displayed for this trace.
- 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. - 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.
- Determines whether or not slice planes about the x dimension are drawn.
- 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. - 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.
- Determines whether or not slice planes about the y dimension are drawn.
- 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. - 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.
- Determines whether or not slice planes about the z dimension are drawn.
- Sets the fill ratio of the
spaceframe
elements. The default fill value is 1 meaning that they are entirely shaded. Applying afill
ratio less than one would allow the creation of openings parallel to the edges. - Displays/hides tetrahedron shapes between minimum and maximum iso-values. Often useful when either caps or surfaces are disabled or filled with values less than 1.
- 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.
- 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. - 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 capitalA
,B
,C
,D
andE
may also be used to reduce the number of triangles on the iso-surfaces and creating other patterns of interest. - Hides/displays surfaces between minimum and maximum iso-values.
- 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. - Controls persistence of some user-driven changes to the trace:
constraintrange
inparcoords
traces, as well as someeditable: true
modifications such asname
andcolorbar.title
. Defaults tolayout.uirevision
. Note that other user-driven trace attribute changes are controlled bylayout
attributes:trace.visible
is controlled bylayout.legend.uirevision
,selectedpoints
is controlled bylayout.selectionrevision
, andcolorbar.(x|y)
(accessible withconfig: {editable: true}
) is controlled bylayout.editrevision
. Trace changes are tracked byuid
, which only falls back on trace index if nouid
is provided. So if your app can add/remove traces before the end of thedata
array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace auid
that stays with it as it moves. - Sets the 4th dimension (value) of the vertices.
- 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/d3/d3-format/tree/v1.4.5#d3-format.By default the values are formatted using generic number format. - 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).
- Sets the X coordinates of the vertices on X axis.
- 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 usingxaxis.hoverformat
. - Sets the Y coordinates of the vertices on Y axis.
- 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 usingyaxis.hoverformat
. - Sets the Z coordinates of the vertices on Z axis.
- 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 usingzaxis.hoverformat
.