Carpet
Overview
The carpet
trace type is used to create carpet plots, which can be useful for visualizing data across irregular spaces or non-grid-like arrangements. Carpet plots are commonly employed in complex datasets that span two independent variables, such as pressure and temperature or other bivariate datasets.
Carpet traces provide you with control over the X and Y axes, as well as customization of the A and B axes (the independent variables). You can also use a variety of formatting options, including line, color, and axis ticks to enhance the visualization.
Common Uses
- Distortion Analysis: Visualizing data across irregular spaces, such as in physics or engineering.
- Bivariate Data Visualization: Displaying complex relationships between two independent variables.
- Gridless Data Representation: Visualizing data that doesn't fit neatly into grid-like structures.
Check out the Attributes for the full set of configuration options
Examples
Common Configurations
Here's a simple(ish) carpet
plot showing data across two independent variables (A and B):
You can copy this code below to create this chart in your project:
models:
- name: carpet-data-axes
args:
- echo
- |
a,b,x,y
1,5,2,3
2,6,3,4
3,7,4,5
4,8,5,6
5,9,6,7
traces:
- name: Carpet Plot with Custom Axes
model: ref(carpet-data-axes)
props:
type: carpet
a: query(a)
b: query(b)
y: query(y)
aaxis:
title:
text: "Custom A Axis"
tickprefix: "A-"
baxis:
title:
text: "Custom B Axis"
tickprefix: "B-"
charts:
- name: Simple Carpet Chart
traces:
- ref(Carpet Plot with Custom Axes)
layout:
title:
text: Carpet Plot with Custom Axes<br><sub>With Customized A and B Axes</sub>
xaxis:
title:
text: "X Axis"
yaxis:
title:
text: "Y Axis"
margin:
b: 0
r: 70
l: 70
t: 50
Attributes
These attributes apply to traces where trace.props.type
is set to carpet
. You would configure these attributes on the trace with the trace.props
object.
a: 'data array' #(2)!
a0: 'number' #(1)!
aaxis:
arraydtick: 'integer greater than or equal to 1' #(3)!
arraytick0: 'integer greater than or equal to 0' #(4)!
autorange: 'enumerated , one of ( true | false | "reversed" )' #(5)!
autotypenumbers: 'enumerated , one of ( "convert types" | "strict" )' #(6)!
categoryarray: 'data array' #(7)!
categoryorder: 'enumerated , one of ( "trace" | "category ascending" | "category
descending" | "array" )' #(8)!
cheatertype: enumerated , one of ( "index" | "value" )
color: 'color' #(9)!
dtick: 'number greater than or equal to 0' #(10)!
endline: 'boolean' #(11)!
endlinecolor: 'color' #(12)!
endlinewidth: 'number' #(13)!
exponentformat: 'enumerated , one of ( "none" | "e" | "e" | "power" | "si" | "b"
)' #(14)!
fixedrange: 'boolean' #(15)!
gridcolor: 'color' #(16)!
griddash: 'string' #(17)!
gridwidth: 'number greater than or equal to 0' #(18)!
labelpadding: 'integer' #(19)!
labelprefix: 'string' #(20)!
labelsuffix: 'string' #(21)!
linecolor: 'color' #(22)!
linewidth: 'number greater than or equal to 0' #(23)!
minexponent: 'number greater than or equal to 0' #(24)!
minorgridcolor: 'color' #(25)!
minorgridcount: 'integer greater than or equal to 0' #(26)!
minorgriddash: 'string' #(27)!
minorgridwidth: 'number greater than or equal to 0' #(28)!
nticks: 'integer greater than or equal to 0' #(29)!
range: 'array' #(30)!
rangemode: 'enumerated , one of ( "normal" | "tozero" | "nonnegative" )' #(31)!
separatethousands: 'boolean' #(32)!
showexponent: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(33)!
showgrid: 'boolean' #(34)!
showline: 'boolean' #(35)!
showticklabels: 'enumerated , one of ( "start" | "end" | "both" | "none" )' #(36)!
showtickprefix: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(37)!
showticksuffix: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(38)!
smoothing: number between or equal to 0 and 1.3
startline: 'boolean' #(39)!
startlinecolor: 'color' #(40)!
startlinewidth: 'number' #(41)!
tick0: 'number greater than or equal to 0' #(42)!
tickangle: 'angle' #(43)!
tickfont:
color: color
family: 'string' #(44)!
size: number greater than or equal to 1
tickformat: 'string' #(45)!
tickformatstops:
dtickrange: 'array' #(46)!
enabled: 'boolean' #(47)!
name: 'string' #(48)!
templateitemname: 'string' #(49)!
value: 'string' #(50)!
tickmode: enumerated , one of ( "linear" | "array" )
tickprefix: 'string' #(51)!
ticksuffix: 'string' #(52)!
ticktext: 'data array' #(53)!
tickvals: 'data array' #(54)!
title:
font:
color: color
family: 'string' #(55)!
size: number greater than or equal to 1
offset: 'number' #(56)!
text: 'string' #(57)!
type: 'enumerated , one of ( "-" | "linear" | "date" | "category" )' #(58)!
b: 'data array' #(60)!
b0: 'number' #(59)!
baxis:
arraydtick: 'integer greater than or equal to 1' #(61)!
arraytick0: 'integer greater than or equal to 0' #(62)!
autorange: 'enumerated , one of ( true | false | "reversed" )' #(63)!
autotypenumbers: 'enumerated , one of ( "convert types" | "strict" )' #(64)!
categoryarray: 'data array' #(65)!
categoryorder: 'enumerated , one of ( "trace" | "category ascending" | "category
descending" | "array" )' #(66)!
cheatertype: enumerated , one of ( "index" | "value" )
color: 'color' #(67)!
dtick: 'number greater than or equal to 0' #(68)!
endline: 'boolean' #(69)!
endlinecolor: 'color' #(70)!
endlinewidth: 'number' #(71)!
exponentformat: 'enumerated , one of ( "none" | "e" | "e" | "power" | "si" | "b"
)' #(72)!
fixedrange: 'boolean' #(73)!
gridcolor: 'color' #(74)!
griddash: 'string' #(75)!
gridwidth: 'number greater than or equal to 0' #(76)!
labelpadding: 'integer' #(77)!
labelprefix: 'string' #(78)!
labelsuffix: 'string' #(79)!
linecolor: 'color' #(80)!
linewidth: 'number greater than or equal to 0' #(81)!
minexponent: 'number greater than or equal to 0' #(82)!
minorgridcolor: 'color' #(83)!
minorgridcount: 'integer greater than or equal to 0' #(84)!
minorgriddash: 'string' #(85)!
minorgridwidth: 'number greater than or equal to 0' #(86)!
nticks: 'integer greater than or equal to 0' #(87)!
range: 'array' #(88)!
rangemode: 'enumerated , one of ( "normal" | "tozero" | "nonnegative" )' #(89)!
separatethousands: 'boolean' #(90)!
showexponent: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(91)!
showgrid: 'boolean' #(92)!
showline: 'boolean' #(93)!
showticklabels: 'enumerated , one of ( "start" | "end" | "both" | "none" )' #(94)!
showtickprefix: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(95)!
showticksuffix: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(96)!
smoothing: number between or equal to 0 and 1.3
startline: 'boolean' #(97)!
startlinecolor: 'color' #(98)!
startlinewidth: 'number' #(99)!
tick0: 'number greater than or equal to 0' #(100)!
tickangle: 'angle' #(101)!
tickfont:
color: color
family: 'string' #(102)!
size: number greater than or equal to 1
tickformat: 'string' #(103)!
tickformatstops:
dtickrange: 'array' #(104)!
enabled: 'boolean' #(105)!
name: 'string' #(106)!
templateitemname: 'string' #(107)!
value: 'string' #(108)!
tickmode: enumerated , one of ( "linear" | "array" )
tickprefix: 'string' #(109)!
ticksuffix: 'string' #(110)!
ticktext: 'data array' #(111)!
tickvals: 'data array' #(112)!
title:
font:
color: color
family: 'string' #(113)!
size: number greater than or equal to 1
offset: 'number' #(114)!
text: 'string' #(115)!
type: 'enumerated , one of ( "-" | "linear" | "date" | "category" )' #(116)!
carpet: 'string' #(117)!
cheaterslope: 'number' #(118)!
color: 'color' #(119)!
customdata: 'data array' #(120)!
da: 'number' #(121)!
db: 'number' #(122)!
font:
color: color
family: 'string' #(123)!
size: number greater than or equal to 1
ids: 'data array' #(124)!
legendgrouptitle:
font:
color: color
family: 'string' #(125)!
size: number greater than or equal to 1
text: 'string' #(126)!
legendrank: 'number' #(127)!
legendwidth: 'number greater than or equal to 0' #(128)!
meta: 'number or categorical coordinate string' #(129)!
opacity: 'number between or equal to 0 and 1' #(130)!
type: carpet
uirevision: 'number or categorical coordinate string' #(131)!
visible: 'enumerated , one of ( true | false | "legendonly" )' #(132)!
x: 'data array' #(133)!
xaxis: 'subplotid' #(134)!
y: 'data array' #(135)!
yaxis: 'subplotid' #(136)!
- Alternate to
a
. Builds a linear space of a coordinates. Use withda
wherea0
is the starting coordinate andda
the step. - An array containing values of the first parameter value
- The stride between grid lines along the axis
- The starting index of grid lines along the axis
- Determines whether or not the range of this axis is computed in relation to the input data. See
rangemode
for more info. Ifrange
is provided, thenautorange
is set to "false". - Using "strict" a numeric string in trace data is not converted to a number. Using "convert types" a numeric string in trace data may be treated as a number during automatic axis
type
detection. Defaults to layout.autotypenumbers. - Sets the order in which categories on this axis appear. Only has an effect if
categoryorder
is set to "array". Used withcategoryorder
. - Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set
categoryorder
to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Setcategoryorder
to "array" to derive the ordering from the attributecategoryarray
. If a category is not found in thecategoryarray
array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories incategoryarray
. - Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
- The stride between grid lines along the axis
- Determines whether or not a line is drawn at along the final value of this axis. If "true", the end line is drawn on top of the grid lines.
- Sets the line color of the end line.
- Sets the width (in px) of the end line.
- 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.
- Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
- Sets the axis line color.
- Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
- Sets the width (in px) of the axis line.
- Extra padding between label and the axis
- Sets a axis label prefix.
- Sets a axis label suffix.
- Sets the axis line color.
- Sets the width (in px) of the axis line.
- Hide SI prefix for 10^n if |n| is below this number
- Sets the color of the grid lines.
- Sets the number of minor grid ticks per major grid tick
- Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
- Sets the width (in px) of the grid lines.
- 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 range of this axis. If the axis
type
is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axistype
is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axistype
is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. - If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data.
- 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 grid lines are drawn. If "true", the grid lines are drawn at every tick mark.
- Determines whether or not a line bounding this axis is drawn.
- Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.
- 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. - Determines whether or not a line is drawn at along the starting value of this axis. If "true", the start line is drawn on top of the grid lines.
- Sets the line color of the start line.
- Sets the width (in px) of the start line.
- The starting index of grid lines along the axis
- Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangle
of -90 draws the tick labels vertically. - 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"
- Sets a tick label prefix.
- 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
. - 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".
- An additional amount by which to offset the title from the tick labels, given in pixels. Note that this used to be set by the now deprecated
titleoffset
attribute. - Sets the title of this axis. 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 axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
- Alternate to
b
. Builds a linear space of a coordinates. Use withdb
whereb0
is the starting coordinate anddb
the step. - A two dimensional array of y coordinates at each carpet point.
- The stride between grid lines along the axis
- The starting index of grid lines along the axis
- Determines whether or not the range of this axis is computed in relation to the input data. See
rangemode
for more info. Ifrange
is provided, thenautorange
is set to "false". - Using "strict" a numeric string in trace data is not converted to a number. Using "convert types" a numeric string in trace data may be treated as a number during automatic axis
type
detection. Defaults to layout.autotypenumbers. - Sets the order in which categories on this axis appear. Only has an effect if
categoryorder
is set to "array". Used withcategoryorder
. - Specifies the ordering logic for the case of categorical variables. By default, plotly uses "trace", which specifies the order that is present in the data supplied. Set
categoryorder
to "category ascending" or "category descending" if order should be determined by the alphanumerical order of the category names. Setcategoryorder
to "array" to derive the ordering from the attributecategoryarray
. If a category is not found in thecategoryarray
array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories incategoryarray
. - Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
- The stride between grid lines along the axis
- Determines whether or not a line is drawn at along the final value of this axis. If "true", the end line is drawn on top of the grid lines.
- Sets the line color of the end line.
- Sets the width (in px) of the end line.
- 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.
- Determines whether or not this axis is zoom-able. If true, then zoom is disabled.
- Sets the axis line color.
- Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
- Sets the width (in px) of the axis line.
- Extra padding between label and the axis
- Sets a axis label prefix.
- Sets a axis label suffix.
- Sets the axis line color.
- Sets the width (in px) of the axis line.
- Hide SI prefix for 10^n if |n| is below this number
- Sets the color of the grid lines.
- Sets the number of minor grid ticks per major grid tick
- Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
- Sets the width (in px) of the grid lines.
- 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 range of this axis. If the axis
type
is "log", then you must take the log of your desired range (e.g. to set the range from 1 to 100, set the range from 0 to 2). If the axistype
is "date", it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axistype
is "category", it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears. - If "normal", the range is computed in relation to the extrema of the input data. If "tozero"`, the range extends to 0, regardless of the input data If "nonnegative", the range is non-negative, regardless of the input data.
- 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 grid lines are drawn. If "true", the grid lines are drawn at every tick mark.
- Determines whether or not a line bounding this axis is drawn.
- Determines whether axis labels are drawn on the low side, the high side, both, or neither side of the axis.
- 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. - Determines whether or not a line is drawn at along the starting value of this axis. If "true", the start line is drawn on top of the grid lines.
- Sets the line color of the start line.
- Sets the width (in px) of the start line.
- The starting index of grid lines along the axis
- Sets the angle of the tick labels with respect to the horizontal. For example, a
tickangle
of -90 draws the tick labels vertically. - 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"
- Sets a tick label prefix.
- 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
. - 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".
- An additional amount by which to offset the title from the tick labels, given in pixels. Note that this used to be set by the now deprecated
titleoffset
attribute. - Sets the title of this axis. 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 axis type. By default, plotly attempts to determined the axis type by looking into the data of the traces that referenced the axis in question.
- An identifier for this carpet, so that
scattercarpet
andcontourcarpet
traces can specify a carpet plot on which they lie - The shift applied to each successive row of data in creating a cheater plot. Only used if
x
is been omitted. - Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.
- 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
- Sets the a coordinate step. See
a0
for more info. - Sets the b coordinate step. See
b0
for more info. - 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".
- 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.
- 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.
- 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 trace.
- 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. - 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).
- A two dimensional array of x coordinates at each carpet point. If omitted, the plot is a cheater plot and the xaxis is hidden by default.
- Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to
layout.xaxis
. If "x2", the x coordinates refer tolayout.xaxis2
, and so on. - A two dimensional array of y coordinates at each carpet point.
- Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to
layout.yaxis
. If "y2", the y coordinates refer tolayout.yaxis2
, and so on.