Skip to content

Scattercarpet

Overview

The scattercarpet trace type is used to create scatter plots on a 2D carpet axis, which allows for more complex and non-linear grids. This trace type is useful for visualizing relationships between variables when the x and y axes are not evenly spaced, such as in polar or distortion grids.

You can customize the marker size, color, and line connections, similar to standard scatter plots but on a carpet axis.

Common Uses

  • Non-Linear Grids: Visualizing data points on non-standard grids where the x and y axes are distorted or uneven.
  • Data Visualization with Carpet Axes: Displaying data points in cases where the relationships between variables are non-linear or require a more flexible grid.
  • Heatmap-Like Data: Scatter plots combined with other traces like carpet for advanced visualizations.

Check out the Attributes for the full set of configuration options

Examples

Common Configurations

Here's a simple scattercarpet plot visualizing data points on a carpet axis:

You can copy this code below to create this chart in your project:

models:
  - name: scattercarpet-data
    args:
      - echo
      - |
        a,b,value
        1,10,15
        2,20,25
        3,15,30
        4,25,35
        5,30,40
traces:
  - name: Simple Scattercarpet Plot
    model: ref(scattercarpet-data)
    props:
      type: scattercarpet
      a: query(a)
      b: query(b)
      mode: "markers"
charts:
  - name: Simple Scattercarpet Chart
    traces:
      - ref(Simple Scattercarpet Plot)
    layout:
      title:
        text: Simple Scattercarpet Plot<br><sub>2D Data Points on Carpet Axis</sub>

This example demonstrates a scattercarpet plot with lines connecting the data points on a carpet axis:

Here's the code:

models:
  - name: scattercarpet-data-lines
    args:
      - echo
      - |
        a,b,value
        1,5,7
        2,10,12
        3,8,10
        4,15,18
        5,12,17
traces:
  - name: Scattercarpet Plot with Lines
    model: ref(scattercarpet-data-lines)
    props:
      type: scattercarpet
      a: query(a)
      b: query(b)
      mode: "lines+markers"
charts:
  - name: Scattercarpet Chart with Lines
    traces:
      - ref(Scattercarpet Plot with Lines)
    layout:
      title:
        text: Scattercarpet Plot with Lines<br><sub>Connecting Data Points on Carpet Axis</sub>

Here's a scattercarpet plot with custom marker sizes and colors, giving more visual weight to each data point on a carpet axis:

Here's the code:

models:
  - name: scattercarpet-data-custom
    args:
      - echo
      - |
        a,b,size,color
        1,5,10,#1f77b4
        2,10,15,#ff7f0e
        3,8,20,#2ca02c
        4,15,25,#d62728
        5,12,30,#9467bd
traces:
  - name: Scattercarpet Plot with Custom Markers
    model: ref(scattercarpet-data-custom)
    props:
      type: scattercarpet
      a: query(a)
      b: query(b)
      mode: "markers"
      marker:
        size: query(size)
        color: query(color)
charts:
  - name: Scattercarpet Chart with Custom Markers
    traces:
      - ref(Scattercarpet Plot with Custom Markers)
    layout:
      title:
        text: Scattercarpet Plot with Custom Markers<br><sub>Custom Sizes and Colors for Carpet Axis Data Points</sub>

Attributes

These attributes apply to traces where trace.props.type is set to scattercarpet. You would configure these attributes on the trace with the trace.props object. 

a: 'data array' #(1)!
b: 'data array' #(2)!
carpet: 'string' #(3)!
connectgaps: 'boolean' #(4)!
customdata: 'data array' #(5)!
fill: 'enumerated , one of ( "none" | "toself" | "tonext" )' #(6)!
fillcolor: 'color' #(7)!
hoverinfo: 'flaglist string. any combination of "a", "b", "text", "name" joined with
  a "+" or "all" or "none" or "skip".' #(8)!
hoverlabel:
  align: 'enumerated or array of enumerateds , one of ( "left" | "right" | "auto"
    )' #(9)!
  bgcolor: 'color or array of colors' #(10)!
  bordercolor: 'color or array of colors' #(11)!
  font:
    color: color or array of colors
    family: 'string or array of strings' #(12)!
    size: number or array of numbers greater than or equal to 1
  namelength: 'integer or array of integers greater than or equal to -1' #(13)!
hoveron: 'flaglist string. any combination of "points", "fills" joined with a "+"
 ' #(14)!
hovertemplate: 'string or array of strings' #(15)!
hovertext: 'string or array of strings' #(16)!
ids: 'data array' #(17)!
legendgroup: 'string' #(18)!
legendgrouptitle:
  font:
    color: color
    family: 'string' #(19)!
    size: number greater than or equal to 1
  text: 'string' #(20)!
legendrank: 'number' #(21)!
legendwidth: 'number greater than or equal to 0' #(22)!
line:
  backoff: 'number or array of numbers greater than or equal to 0' #(23)!
  color: 'color' #(24)!
  dash: 'string' #(25)!
  shape: 'enumerated , one of ( "linear" | "spline" )' #(26)!
  smoothing: 'number between or equal to 0 and 1.3' #(27)!
  width: 'number greater than or equal to 0' #(28)!
marker:
  angle: 'angle' #(29)!
  angleref: 'enumerated , one of ( "previous" | "up" )' #(30)!
  autocolorscale: 'boolean' #(31)!
  cauto: 'boolean' #(32)!
  cmax: 'number' #(33)!
  cmid: 'number' #(34)!
  cmin: 'number' #(35)!
  color: 'color or array of colors' #(36)!
  coloraxis: 'subplotid' #(37)!
  colorbar:
    bgcolor: 'color' #(38)!
    bordercolor: 'color' #(39)!
    borderwidth: 'number greater than or equal to 0' #(40)!
    dtick: 'number or categorical coordinate string' #(41)!
    exponentformat: 'enumerated , one of ( "none" | "e" | "e" | "power" | "si" | "b"
      )' #(42)!
    len: 'number greater than or equal to 0' #(43)!
    lenmode: 'enumerated , one of ( "fraction" | "pixels" )' #(44)!
    minexponent: 'number greater than or equal to 0' #(45)!
    nticks: 'integer greater than or equal to 0' #(46)!
    orientation: 'enumerated , one of ( "h" | "v" )' #(47)!
    outlinecolor: 'color' #(48)!
    outlinewidth: 'number greater than or equal to 0' #(49)!
    separatethousands: 'boolean' #(50)!
    showexponent: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(51)!
    showticklabels: 'boolean' #(52)!
    showtickprefix: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(53)!
    showticksuffix: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(54)!
    thickness: 'number greater than or equal to 0' #(55)!
    thicknessmode: 'enumerated , one of ( "fraction" | "pixels" )' #(56)!
    tick0: 'number or categorical coordinate string' #(57)!
    tickangle: 'angle' #(58)!
    tickcolor: 'color' #(59)!
    tickfont:
      color: color
      family: 'string' #(60)!
      size: number greater than or equal to 1
    tickformat: 'string' #(61)!
    tickformatstops:
      dtickrange: 'array' #(62)!
      enabled: 'boolean' #(63)!
      name: 'string' #(64)!
      templateitemname: 'string' #(65)!
      value: 'string' #(66)!
    ticklabeloverflow: 'enumerated , one of ( "allow" | "hide past div" | "hide past
      domain" )' #(67)!
    ticklabelposition: 'enumerated , one of ( "outside" | "inside" | "outside top"
      | "inside top" | "outside left" | "inside left" | "outside right" | "inside
      right" | "outside bottom" | "inside bottom" )' #(68)!
    ticklabelstep: 'integer greater than or equal to 1' #(69)!
    ticklen: 'number greater than or equal to 0' #(70)!
    tickmode: 'enumerated , one of ( "auto" | "linear" | "array" )' #(71)!
    tickprefix: 'string' #(72)!
    ticks: 'enumerated , one of ( "outside" | "inside" | "" )' #(73)!
    ticksuffix: 'string' #(74)!
    ticktext: 'data array' #(75)!
    tickvals: 'data array' #(76)!
    tickwidth: 'number greater than or equal to 0' #(77)!
    title:
      font:
        color: color
        family: 'string' #(78)!
        size: number greater than or equal to 1
      side: 'enumerated , one of ( "right" | "top" | "bottom" )' #(79)!
      text: 'string' #(80)!
    x: 'number between or equal to -2 and 3' #(81)!
    xanchor: 'enumerated , one of ( "left" | "center" | "right" )' #(82)!
    xpad: 'number greater than or equal to 0' #(83)!
    y: 'number between or equal to -2 and 3' #(84)!
    yanchor: 'enumerated , one of ( "top" | "middle" | "bottom" )' #(85)!
    ypad: 'number greater than or equal to 0' #(86)!
  colorscale: 'colorscale' #(87)!
  gradient:
    color: 'color or array of colors' #(88)!
    type: 'enumerated or array of enumerateds , one of ( "radial" | "horizontal" |
      "vertical" | "none" )' #(89)!
  line:
    autocolorscale: 'boolean' #(90)!
    cauto: 'boolean' #(91)!
    cmax: 'number' #(92)!
    cmid: 'number' #(93)!
    cmin: 'number' #(94)!
    color: 'color or array of colors' #(95)!
    coloraxis: 'subplotid' #(96)!
    colorscale: 'colorscale' #(97)!
    reversescale: 'boolean' #(98)!
    width: 'number or array of numbers greater than or equal to 0' #(99)!
  maxdisplayed: 'number greater than or equal to 0' #(100)!
  opacity: 'number or array of numbers between or equal to 0 and 1' #(101)!
  reversescale: 'boolean' #(102)!
  showscale: 'boolean' #(103)!
  size: 'number or array of numbers greater than or equal to 0' #(104)!
  sizemin: 'number greater than or equal to 0' #(105)!
  sizemode: 'enumerated , one of ( "diameter" | "area" )' #(106)!
  sizeref: 'number' #(107)!
  standoff: 'number or array of numbers greater than or equal to 0' #(108)!
  symbol: 'enumerated or array of enumerateds , one of ( "0" | "0" | "circle" | "100"
    | "100" | "circle-open" | "200" | "200" | "circle-dot" | "300" | "300" | "circle-open-dot"
    | "1" | "1" | "square" | "101" | "101" | "square-open" | "201" | "201" | "square-dot"
    | "301" | "301" | "square-open-dot" | "2" | "2" | "diamond" | "102" | "102" |
    "diamond-open" | "202" | "202" | "diamond-dot" | "302" | "302" | "diamond-open-dot"
    | "3" | "3" | "cross" | "103" | "103" | "cross-open" | "203" | "203" | "cross-dot"
    | "303" | "303" | "cross-open-dot" | "4" | "4" | "x" | "104" | "104" | "x-open"
    | "204" | "204" | "x-dot" | "304" | "304" | "x-open-dot" | "5" | "5" | "triangle-up"
    | "105" | "105" | "triangle-up-open" | "205" | "205" | "triangle-up-dot" | "305"
    | "305" | "triangle-up-open-dot" | "6" | "6" | "triangle-down" | "106" | "106"
    | "triangle-down-open" | "206" | "206" | "triangle-down-dot" | "306" | "306" |
    "triangle-down-open-dot" | "7" | "7" | "triangle-left" | "107" | "107" | "triangle-left-open"
    | "207" | "207" | "triangle-left-dot" | "307" | "307" | "triangle-left-open-dot"
    | "8" | "8" | "triangle-right" | "108" | "108" | "triangle-right-open" | "208"
    | "208" | "triangle-right-dot" | "308" | "308" | "triangle-right-open-dot" | "9"
    | "9" | "triangle-ne" | "109" | "109" | "triangle-ne-open" | "209" | "209" | "triangle-ne-dot"
    | "309" | "309" | "triangle-ne-open-dot" | "10" | "10" | "triangle-se" | "110"
    | "110" | "triangle-se-open" | "210" | "210" | "triangle-se-dot" | "310" | "310"
    | "triangle-se-open-dot" | "11" | "11" | "triangle-sw" | "111" | "111" | "triangle-sw-open"
    | "211" | "211" | "triangle-sw-dot" | "311" | "311" | "triangle-sw-open-dot" |
    "12" | "12" | "triangle-nw" | "112" | "112" | "triangle-nw-open" | "212" | "212"
    | "triangle-nw-dot" | "312" | "312" | "triangle-nw-open-dot" | "13" | "13" | "pentagon"
    | "113" | "113" | "pentagon-open" | "213" | "213" | "pentagon-dot" | "313" | "313"
    | "pentagon-open-dot" | "14" | "14" | "hexagon" | "114" | "114" | "hexagon-open"
    | "214" | "214" | "hexagon-dot" | "314" | "314" | "hexagon-open-dot" | "15" |
    "15" | "hexagon2" | "115" | "115" | "hexagon2-open" | "215" | "215" | "hexagon2-dot"
    | "315" | "315" | "hexagon2-open-dot" | "16" | "16" | "octagon" | "116" | "116"
    | "octagon-open" | "216" | "216" | "octagon-dot" | "316" | "316" | "octagon-open-dot"
    | "17" | "17" | "star" | "117" | "117" | "star-open" | "217" | "217" | "star-dot"
    | "317" | "317" | "star-open-dot" | "18" | "18" | "hexagram" | "118" | "118" |
    "hexagram-open" | "218" | "218" | "hexagram-dot" | "318" | "318" | "hexagram-open-dot"
    | "19" | "19" | "star-triangle-up" | "119" | "119" | "star-triangle-up-open" |
    "219" | "219" | "star-triangle-up-dot" | "319" | "319" | "star-triangle-up-open-dot"
    | "20" | "20" | "star-triangle-down" | "120" | "120" | "star-triangle-down-open"
    | "220" | "220" | "star-triangle-down-dot" | "320" | "320" | "star-triangle-down-open-dot"
    | "21" | "21" | "star-square" | "121" | "121" | "star-square-open" | "221" | "221"
    | "star-square-dot" | "321" | "321" | "star-square-open-dot" | "22" | "22" | "star-diamond"
    | "122" | "122" | "star-diamond-open" | "222" | "222" | "star-diamond-dot" | "322"
    | "322" | "star-diamond-open-dot" | "23" | "23" | "diamond-tall" | "123" | "123"
    | "diamond-tall-open" | "223" | "223" | "diamond-tall-dot" | "323" | "323" | "diamond-tall-open-dot"
    | "24" | "24" | "diamond-wide" | "124" | "124" | "diamond-wide-open" | "224" |
    "224" | "diamond-wide-dot" | "324" | "324" | "diamond-wide-open-dot" | "25" |
    "25" | "hourglass" | "125" | "125" | "hourglass-open" | "26" | "26" | "bowtie"
    | "126" | "126" | "bowtie-open" | "27" | "27" | "circle-cross" | "127" | "127"
    | "circle-cross-open" | "28" | "28" | "circle-x" | "128" | "128" | "circle-x-open"
    | "29" | "29" | "square-cross" | "129" | "129" | "square-cross-open" | "30" |
    "30" | "square-x" | "130" | "130" | "square-x-open" | "31" | "31" | "diamond-cross"
    | "131" | "131" | "diamond-cross-open" | "32" | "32" | "diamond-x" | "132" | "132"
    | "diamond-x-open" | "33" | "33" | "cross-thin" | "133" | "133" | "cross-thin-open"
    | "34" | "34" | "x-thin" | "134" | "134" | "x-thin-open" | "35" | "35" | "asterisk"
    | "135" | "135" | "asterisk-open" | "36" | "36" | "hash" | "136" | "136" | "hash-open"
    | "236" | "236" | "hash-dot" | "336" | "336" | "hash-open-dot" | "37" | "37" |
    "y-up" | "137" | "137" | "y-up-open" | "38" | "38" | "y-down" | "138" | "138"
    | "y-down-open" | "39" | "39" | "y-left" | "139" | "139" | "y-left-open" | "40"
    | "40" | "y-right" | "140" | "140" | "y-right-open" | "41" | "41" | "line-ew"
    | "141" | "141" | "line-ew-open" | "42" | "42" | "line-ns" | "142" | "142" | "line-ns-open"
    | "43" | "43" | "line-ne" | "143" | "143" | "line-ne-open" | "44" | "44" | "line-nw"
    | "144" | "144" | "line-nw-open" | "45" | "45" | "arrow-up" | "145" | "145" |
    "arrow-up-open" | "46" | "46" | "arrow-down" | "146" | "146" | "arrow-down-open"
    | "47" | "47" | "arrow-left" | "147" | "147" | "arrow-left-open" | "48" | "48"
    | "arrow-right" | "148" | "148" | "arrow-right-open" | "49" | "49" | "arrow-bar-up"
    | "149" | "149" | "arrow-bar-up-open" | "50" | "50" | "arrow-bar-down" | "150"
    | "150" | "arrow-bar-down-open" | "51" | "51" | "arrow-bar-left" | "151" | "151"
    | "arrow-bar-left-open" | "52" | "52" | "arrow-bar-right" | "152" | "152" | "arrow-bar-right-open"
    | "53" | "53" | "arrow" | "153" | "153" | "arrow-open" | "54" | "54" | "arrow-wide"
    | "154" | "154" | "arrow-wide-open" )' #(109)!
meta: 'number or categorical coordinate string' #(110)!
mode: 'flaglist string. any combination of "lines", "markers", "text" joined with
  a "+" or "none".' #(111)!
opacity: 'number between or equal to 0 and 1' #(112)!
selected:
  marker:
    color: 'color' #(113)!
    opacity: 'number between or equal to 0 and 1' #(114)!
    size: 'number greater than or equal to 0' #(115)!
  textfont:
    color: 'color' #(116)!
selectedpoints: 'number or categorical coordinate string' #(117)!
showlegend: 'boolean' #(118)!
text: 'string or array of strings' #(119)!
textfont:
  color: color or array of colors
  family: 'string or array of strings' #(120)!
  size: number or array of numbers greater than or equal to 1
textposition: 'enumerated or array of enumerateds , one of ( "top left" | "top center"
  | "top right" | "middle left" | "middle center" | "middle right" | "bottom left"
  | "bottom center" | "bottom right" )' #(121)!
texttemplate: 'string or array of strings' #(122)!
type: scattercarpet
uirevision: 'number or categorical coordinate string' #(123)!
unselected:
  marker:
    color: 'color' #(124)!
    opacity: 'number between or equal to 0 and 1' #(125)!
    size: 'number greater than or equal to 0' #(126)!
  textfont:
    color: 'color' #(127)!
visible: 'enumerated , one of ( true | false | "legendonly" )' #(128)!
xaxis: 'subplotid' #(129)!
yaxis: 'subplotid' #(130)!
  1. Sets the a-axis coordinates.
  2. Sets the b-axis coordinates.
  3. An identifier for this carpet, so that scattercarpet and contourcarpet traces can specify a carpet plot on which they lie
  4. Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.
  5. 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
  6. Sets the area to fill with a solid color. Use with fillcolor if not "none". scatterternary has a subset of the options available to scatter. "toself" connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. "tonext" fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like "toself" if there is no trace before it. "tonext" should not be used if one trace does not enclose the other.
  7. Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.
  8. 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.
  9. 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
  10. Sets the background color of the hover labels for this trace
  11. Sets the border color of the hover labels for this trace.
  12. 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".
  13. 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.
  14. Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or text, then the default is "fills", otherwise it is "points".
  15. 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 "{fullData.name}". To hide the secondary box completely, use an empty tag <extra></extra>.
  16. Sets hover text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). To be seen, trace hoverinfo must contain a "text" flag.
  17. 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.
  18. Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
  19. 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".
  20. Sets the title of the legend group.
  21. 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.
  22. Sets the width (in px or fraction) of the legend for this trace.
  23. Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With "auto" the lines would trim before markers if marker.angleref is set to "previous".
  24. Sets the line color.
  25. 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").
  26. Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
  27. Has an effect only if shape is set to "spline" Sets the amount of smoothing. "0" corresponds to no smoothing (equivalent to a "linear" shape).
  28. Sets the line width (in px).
  29. Sets the marker angle in respect to angleref.
  30. Sets the reference for marker angle. With "previous", angle 0 points along the line from the previous point to this one. With "up", angle 0 points toward the top of the screen.
  31. Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.colorscale. Has an effect only if in marker.color is set to a numerical array. 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.
  32. Determines whether or not the color domain is computed with respect to the input data (here in marker.color) or the bounds set in marker.cmin and marker.cmax Has an effect only if in marker.color is set to a numerical array. Defaults to false when marker.cmin and marker.cmax are set by the user.
  33. Sets the upper bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmin must be set as well.
  34. Sets the mid-point of the color domain by scaling marker.cmin and/or marker.cmax to be equidistant to this point. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color. Has no effect when marker.cauto is false.
  35. Sets the lower bound of the color domain. Has an effect only if in marker.color is set to a numerical array. Value should have the same units as in marker.color and if set, marker.cmax must be set as well.
  36. Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.cmin and marker.cmax if set.
  37. 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.
  38. Sets the color of padded area.
  39. Sets the axis line color.
  40. Sets the width (in px) or the border enclosing this color bar.
  41. 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", 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" 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"
  42. 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.
  43. 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.
  44. 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.
  45. Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is "SI" or "B".
  46. 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".
  47. Sets the orientation of the colorbar.
  48. Sets the axis line color.
  49. Sets the width (in px) of the axis line.
  50. If "true", even 4-digit integers are separated
  51. 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.
  52. Determines whether or not the tick labels are drawn.
  53. 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.
  54. Same as showtickprefix but for tick suffixes.
  55. Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
  56. 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.
  57. 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" (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.
  58. Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.
  59. Sets the tick color.
  60. 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".
  61. 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"
  62. 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"
  63. Determines whether or not this stop is used. If false, this stop is ignored even within its dtickrange.
  64. 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 this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.
  65. 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 its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.
  66. string - dtickformat for described zoom level, the same as "tickformat"
  67. 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".
  68. 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".
  69. 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".
  70. Sets the tick length (in px).
  71. 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).
  72. Sets a tick label prefix.
  73. 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.
  74. Sets a tick label suffix.
  75. Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to "array". Used with tickvals.
  76. Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to "array". Used with ticktext.
  77. Sets the tick width (in px).
  78. 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".
  79. 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" when orientation if "h". Note that the title's location used to be set by the now deprecated titleside attribute.
  80. Sets the title of the color bar. Note that before the existence of title.text, the title's contents used to be defined as the title attribute itself. This behavior has been deprecated.
  81. Sets the x position of the color bar (in plot fraction). Defaults to 1.02 when orientation is "v" and 0.5 when orientation is "h".
  82. 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".
  83. Sets the amount of padding (in px) along the x direction.
  84. Sets the y position of the color bar (in plot fraction). Defaults to 0.5 when orientation is "v" and 1.02 when orientation is "h".
  85. 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".
  86. Sets the amount of padding (in px) along the y direction.
  87. Sets the colorscale. Has an effect only if in marker.color is set to a numerical array. 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 marker.cmin and marker.cmax. 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.
  88. Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.
  89. Sets the type of gradient used to fill the markers
  90. Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.line.color is set to a numerical array. 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.
  91. Determines whether or not the color domain is computed with respect to the input data (here in marker.line.color) or the bounds set in marker.line.cmin and marker.line.cmax Has an effect only if in marker.line.color is set to a numerical array. Defaults to false when marker.line.cmin and marker.line.cmax are set by the user.
  92. Sets the upper bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmin must be set as well.
  93. Sets the mid-point of the color domain by scaling marker.line.cmin and/or marker.line.cmax to be equidistant to this point. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color. Has no effect when marker.line.cauto is false.
  94. Sets the lower bound of the color domain. Has an effect only if in marker.line.color is set to a numerical array. Value should have the same units as in marker.line.color and if set, marker.line.cmax must be set as well.
  95. Sets the marker.line color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to marker.line.cmin and marker.line.cmax if set.
  96. 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.
  97. Sets the colorscale. Has an effect only if in marker.line.color is set to a numerical array. 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 marker.line.cmin and marker.line.cmax. 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.
  98. Reverses the color mapping if true. Has an effect only if in marker.line.color is set to a numerical array. If true, marker.line.cmin will correspond to the last color in the array and marker.line.cmax will correspond to the first color.
  99. Sets the width (in px) of the lines bounding the marker points.
  100. Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.
  101. Sets the marker opacity.
  102. Reverses the color mapping if true. Has an effect only if in marker.color is set to a numerical array. If true, marker.cmin will correspond to the last color in the array and marker.cmax will correspond to the first color.
  103. Determines whether or not a colorbar is displayed for this trace. Has an effect only if in marker.color is set to a numerical array.
  104. Sets the marker size (in px).
  105. Has an effect only if marker.size is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
  106. Has an effect only if marker.size is set to a numerical array. Sets the rule for which the data in size is converted to pixels.
  107. Has an effect only if marker.size is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with sizemin and sizemode.
  108. Moves the marker away from the data point in the direction of angle (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.
  109. Sets the marker symbol type. Adding 100 is equivalent to appending "-open" to a symbol name. Adding 200 is equivalent to appending "-dot" to a symbol name. Adding 300 is equivalent to appending "-open-dot" or "dot-open" to a symbol name.
  110. 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.
  111. Determines the drawing mode for this scatter trace. If the provided mode includes "text" then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is "lines+markers". Otherwise, "lines".
  112. Sets the opacity of the trace.
  113. Sets the marker color of selected points.
  114. Sets the marker opacity of selected points.
  115. Sets the marker size of selected points.
  116. Sets the text font color of selected points.
  117. Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.
  118. Determines whether or not an item corresponding to this trace is shown in the legend.
  119. Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). If trace hoverinfo contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
  120. 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".
  121. Sets the positions of the text elements with respects to the (x,y) coordinates.
  122. Template string used for rendering the information text that appear on points. Note that this will override textinfo. Variables are inserted using %{variable}, for example "y: %{y}". 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. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. variables a, b and text.
  123. 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.
  124. Sets the marker color of unselected points, applied only when a selection exists.
  125. Sets the marker opacity of unselected points, applied only when a selection exists.
  126. Sets the marker size of unselected points, applied only when a selection exists.
  127. Sets the text font color of unselected points, applied only when a selection exists.
  128. 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).
  129. Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If "x" (the default value), the x coordinates refer to layout.xaxis. If "x2", the x coordinates refer to layout.xaxis2, and so on.
  130. Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If "y" (the default value), the y coordinates refer to layout.yaxis. If "y2", the y coordinates refer to layout.yaxis2, and so on.