Skip to content

Parcats

arrangement: 'enumerated , one of ( "perpendicular" | "freeform" | "fixed" )' #(1)!
bundlecolors: 'boolean' #(2)!
counts: 'number or array of numbers greater than or equal to 0' #(3)!
dimensions:
  categoryarray: 'data array' #(4)!
  categoryorder: 'enumerated , one of ( "trace" | "category ascending" | "category
    descending" | "array" )' #(5)!
  displayindex: 'integer' #(6)!
  label: 'string' #(7)!
  ticktext: 'data array' #(8)!
  values: 'data array' #(9)!
  visible: 'boolean' #(10)!
domain:
  column: 'integer greater than or equal to 0' #(11)!
  row: 'integer greater than or equal to 0' #(12)!
  x: 'array' #(13)!
  y: 'array' #(14)!
hoverinfo: 'flaglist string. any combination of "count", "probability" joined with
  a "+" or "all" or "none" or "skip".' #(15)!
hoveron: 'enumerated , one of ( "category" | "color" | "dimension" )' #(16)!
hovertemplate: 'string' #(17)!
labelfont:
  color: color
  family: 'string' #(18)!
  size: number greater than or equal to 1
legendgrouptitle:
  font:
    color: color
    family: 'string' #(19)!
    size: number greater than or equal to 1
  text: 'string' #(20)!
legendwidth: 'number greater than or equal to 0' #(21)!
line:
  autocolorscale: 'boolean' #(22)!
  cauto: 'boolean' #(23)!
  cmax: 'number' #(24)!
  cmid: 'number' #(25)!
  cmin: 'number' #(26)!
  color: 'color or array of colors' #(27)!
  coloraxis: 'subplotid' #(28)!
  colorbar:
    bgcolor: 'color' #(29)!
    bordercolor: 'color' #(30)!
    borderwidth: 'number greater than or equal to 0' #(31)!
    dtick: 'number or categorical coordinate string' #(32)!
    exponentformat: 'enumerated , one of ( "none" | "e" | "e" | "power" | "si" | "b"
      )' #(33)!
    len: 'number greater than or equal to 0' #(34)!
    lenmode: 'enumerated , one of ( "fraction" | "pixels" )' #(35)!
    minexponent: 'number greater than or equal to 0' #(36)!
    nticks: 'integer greater than or equal to 0' #(37)!
    orientation: 'enumerated , one of ( "h" | "v" )' #(38)!
    outlinecolor: 'color' #(39)!
    outlinewidth: 'number greater than or equal to 0' #(40)!
    separatethousands: 'boolean' #(41)!
    showexponent: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(42)!
    showticklabels: 'boolean' #(43)!
    showtickprefix: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(44)!
    showticksuffix: 'enumerated , one of ( "all" | "first" | "last" | "none" )' #(45)!
    thickness: 'number greater than or equal to 0' #(46)!
    thicknessmode: 'enumerated , one of ( "fraction" | "pixels" )' #(47)!
    tick0: 'number or categorical coordinate string' #(48)!
    tickangle: 'angle' #(49)!
    tickcolor: 'color' #(50)!
    tickfont:
      color: color
      family: 'string' #(51)!
      size: number greater than or equal to 1
    tickformat: 'string' #(52)!
    tickformatstops:
      dtickrange: 'array' #(53)!
      enabled: 'boolean' #(54)!
      name: 'string' #(55)!
      templateitemname: 'string' #(56)!
      value: 'string' #(57)!
    ticklabeloverflow: 'enumerated , one of ( "allow" | "hide past div" | "hide past
      domain" )' #(58)!
    ticklabelposition: 'enumerated , one of ( "outside" | "inside" | "outside top"
      | "inside top" | "outside left" | "inside left" | "outside right" | "inside
      right" | "outside bottom" | "inside bottom" )' #(59)!
    ticklabelstep: 'integer greater than or equal to 1' #(60)!
    ticklen: 'number greater than or equal to 0' #(61)!
    tickmode: 'enumerated , one of ( "auto" | "linear" | "array" )' #(62)!
    tickprefix: 'string' #(63)!
    ticks: 'enumerated , one of ( "outside" | "inside" | "" )' #(64)!
    ticksuffix: 'string' #(65)!
    ticktext: 'data array' #(66)!
    tickvals: 'data array' #(67)!
    tickwidth: 'number greater than or equal to 0' #(68)!
    title:
      font:
        color: color
        family: 'string' #(69)!
        size: number greater than or equal to 1
      side: 'enumerated , one of ( "right" | "top" | "bottom" )' #(70)!
      text: 'string' #(71)!
    x: 'number between or equal to -2 and 3' #(72)!
    xanchor: 'enumerated , one of ( "left" | "center" | "right" )' #(73)!
    xpad: 'number greater than or equal to 0' #(74)!
    y: 'number between or equal to -2 and 3' #(75)!
    yanchor: 'enumerated , one of ( "top" | "middle" | "bottom" )' #(76)!
    ypad: 'number greater than or equal to 0' #(77)!
  colorscale: 'colorscale' #(78)!
  hovertemplate: 'string' #(79)!
  reversescale: 'boolean' #(80)!
  shape: 'enumerated , one of ( "linear" | "hspline" )' #(81)!
  showscale: 'boolean' #(82)!
meta: 'number or categorical coordinate string' #(83)!
sortpaths: 'enumerated , one of ( "forward" | "backward" )' #(84)!
tickfont:
  color: color
  family: 'string' #(85)!
  size: number greater than or equal to 1
type: parcats
uirevision: 'number or categorical coordinate string' #(86)!
visible: 'enumerated , one of ( true | false | "legendonly" )' #(87)!
  1. Sets the drag interaction mode for categories and dimensions. If perpendicular, the categories can only move along a line perpendicular to the paths. If freeform, the categories can freely move on the plane. If fixed, the categories and dimensions are stationary.
  2. Sort paths so that like colors are bundled together within each category.
  3. The number of observations represented by each state. Defaults to 1 so that each state represents one observation
  4. Sets the order in which categories in this dimension appear. Only has an effect if categoryorder is set to "array". Used with categoryorder.
  5. Specifies the ordering logic for the categories in the dimension. 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. Set categoryorder to "array" to derive the ordering from the attribute categoryarray. If a category is not found in the categoryarray array, the sorting behavior for that attribute will be identical to the "trace" mode. The unspecified categories will follow the categories in categoryarray.
  6. The display index of dimension, from left to right, zero indexed, defaults to dimension index.
  7. The shown name of the dimension.
  8. Sets alternative tick labels for the categories in this dimension. Only has an effect if categoryorder is set to "array". Should be an array the same length as categoryarray Used with categoryorder.
  9. Dimension values. values[n] represents the category value of the nth point in the dataset, therefore the values vector for all dimensions must be the same (longer vectors will be truncated).
  10. Shows the dimension when set to true (the default). Hides the dimension for false.
  11. If there is a layout grid, use the domain for this column in the grid for this parcats trace .
  12. If there is a layout grid, use the domain for this row in the grid for this parcats trace .
  13. Sets the horizontal domain of this parcats trace (in plot fraction).
  14. Sets the vertical domain of this parcats trace (in plot fraction).
  15. 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.
  16. Sets the hover interaction mode for the parcats diagram. If category, hover interaction take place per category. If color, hover interactions take place per color per category. If dimension, hover interactions take place across all categories per dimension.
  17. 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. variables count, probability, category, categorycount, colorcount and bandcolorcount. 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>.
  18. 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".
  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 width (in px or fraction) of the legend for this trace.
  22. Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by line.colorscale. Has an effect only if in 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.
  23. Determines whether or not the color domain is computed with respect to the input data (here in line.color) or the bounds set in line.cmin and line.cmax Has an effect only if in line.color is set to a numerical array. Defaults to false when line.cmin and line.cmax are set by the user.
  24. Sets the upper bound of the color domain. Has an effect only if in line.color is set to a numerical array. Value should have the same units as in line.color and if set, line.cmin must be set as well.
  25. Sets the mid-point of the color domain by scaling line.cmin and/or line.cmax to be equidistant to this point. Has an effect only if in line.color is set to a numerical array. Value should have the same units as in line.color. Has no effect when line.cauto is false.
  26. Sets the lower bound of the color domain. Has an effect only if in line.color is set to a numerical array. Value should have the same units as in line.color and if set, line.cmax must be set as well.
  27. Sets the 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 line.cmin and line.cmax if set.
  28. 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.
  29. Sets the color of padded area.
  30. Sets the axis line color.
  31. Sets the width (in px) or the border enclosing this color bar.
  32. 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"
  33. 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.
  34. 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.
  35. 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.
  36. Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is "SI" or "B".
  37. 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".
  38. Sets the orientation of the colorbar.
  39. Sets the axis line color.
  40. Sets the width (in px) of the axis line.
  41. If "true", even 4-digit integers are separated
  42. 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.
  43. Determines whether or not the tick labels are drawn.
  44. 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.
  45. Same as showtickprefix but for tick suffixes.
  46. Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.
  47. 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.
  48. 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.
  49. Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.
  50. Sets the tick color.
  51. 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".
  52. 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"
  53. 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"
  54. Determines whether or not this stop is used. If false, this stop is ignored even within its dtickrange.
  55. 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.
  56. 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.
  57. string - dtickformat for described zoom level, the same as "tickformat"
  58. 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".
  59. 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".
  60. 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".
  61. Sets the tick length (in px).
  62. 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).
  63. Sets a tick label prefix.
  64. 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.
  65. Sets a tick label suffix.
  66. Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to "array". Used with tickvals.
  67. Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to "array". Used with ticktext.
  68. Sets the tick width (in px).
  69. 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".
  70. 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.
  71. 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.
  72. 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".
  73. 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".
  74. Sets the amount of padding (in px) along the x direction.
  75. 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".
  76. 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".
  77. Sets the amount of padding (in px) along the y direction.
  78. Sets the colorscale. Has an effect only if in 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 line.cmin and 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.
  79. 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. variables count and probability. 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>.
  80. Reverses the color mapping if true. Has an effect only if in line.color is set to a numerical array. If true, line.cmin will correspond to the last color in the array and line.cmax will correspond to the first color.
  81. Sets the shape of the paths. If linear, paths are composed of straight lines. If hspline, paths are composed of horizontal curved splines
  82. Determines whether or not a colorbar is displayed for this trace. Has an effect only if in line.color is set to a numerical array.
  83. 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.
  84. Sets the path sorting algorithm. If forward, sort paths based on dimension categories from left to right. If backward, sort paths based on dimensions categories from right to left.
  85. 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".
  86. 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.
  87. 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).