plotly.graph_objects.parcats package¶

class plotly.graph_objects.parcats.Dimension(arg=None, categoryarray=None, categoryarraysrc=None, categoryorder=None, displayindex=None, label=None, ticktext=None, ticktextsrc=None, values=None, valuessrc=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property categoryarray¶

Sets the order in which categories in this dimension appear. Only has an effect if categoryorder is set to “array”. Used with categoryorder.

The ‘categoryarray’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property categoryarraysrc¶

Sets the source reference on Chart Studio Cloud for categoryarray.

The ‘categoryarraysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property categoryorder¶

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.

The ‘categoryorder’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘trace’, ‘category ascending’, ‘category descending’, ‘array’]

Returns
Return type: Any

property displayindex¶

The display index of dimension, from left to right, zero indexed, defaults to dimension index.

The ‘displayindex’ property is a integer and may be specified as:

An int (or float that will be cast to an int)

Returns
Return type: int

property label¶

The shown name of the dimension.

The ‘label’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property ticktext¶

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.

The ‘ticktext’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property ticktextsrc¶

Sets the source reference on Chart Studio Cloud for ticktext.

The ‘ticktextsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property values¶

Dimension values. values[n] represents the category value of the n`th point in the dataset, therefore the `values vector for all dimensions must be the same (longer vectors will be truncated).

The ‘values’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns
Return type: numpy.ndarray

property valuessrc¶

Sets the source reference on Chart Studio Cloud for values.

The ‘valuessrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property visible¶

Shows the dimension when set to true (the default). Hides the dimension for false.

The ‘visible’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

class plotly.graph_objects.parcats.Domain(arg=None, column=None, row=None, x=None, y=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property column¶

If there is a layout grid, use the domain for this column in the grid for this parcats trace .

The ‘column’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns
Return type: int

property row¶

If there is a layout grid, use the domain for this row in the grid for this parcats trace .

The ‘row’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns
Return type: int

property x¶

Sets the horizontal domain of this parcats trace (in plot

fraction).

The ‘x’ property is an info array that may be specified as:

a list or tuple of 2 elements where:

The ‘x[0]’ property is a number and may be specified as:
- An int or float in the interval [0, 1]
The ‘x[1]’ property is a number and may be specified as:
- An int or float in the interval [0, 1]
list

property y¶

Sets the vertical domain of this parcats trace (in plot

fraction).

The ‘y’ property is an info array that may be specified as:

a list or tuple of 2 elements where:

The ‘y[0]’ property is a number and may be specified as:
- An int or float in the interval [0, 1]
The ‘y[1]’ property is a number and may be specified as:
- An int or float in the interval [0, 1]
list

class plotly.graph_objects.parcats.Labelfont(arg=None, color=None, family=None, lineposition=None, shadow=None, size=None, style=None, textcase=None, variant=None, weight=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property color¶

The ‘color’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property family¶

HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart- studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.

The ‘family’ property is a string and must be specified as:

A non-empty string

Returns
Return type: str

property lineposition¶

Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.

The ‘lineposition’ property is a flaglist and may be specified as a string containing:

Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns
Return type: Any

property shadow¶

Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow for additional options.

The ‘shadow’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property size¶

The ‘size’ property is a number and may be specified as:

An int or float in the interval [1, inf]

Returns
Return type: int|float

property style¶

Sets whether a font should be styled with a normal or italic face from its family.

The ‘style’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘italic’]

Returns
Return type: Any

property textcase¶

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

The ‘textcase’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]

Returns
Return type: Any

property variant¶

Sets the variant of the font.

The ‘variant’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]

Returns
Return type: Any

property weight¶

Sets the weight (or boldness) of the font.

The ‘weight’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)

Returns
Return type: int

class plotly.graph_objects.parcats.Legendgrouptitle(arg=None, font=None, text=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property font¶

Sets this legend group’s title font.

The ‘font’ property is an instance of Font that may be specified as:

An instance of plotly.graph_objects.parcats.legendgrouptitle.Font

A dict of string/value properties that will be passed to the Font constructor

Supported dict properties:

color

family
HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren’t available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include “Arial”, “Balto”, “Courier New”, “Droid Sans”, “Droid Serif”, “Droid Sans Mono”, “Gravitas One”, “Old Standard TT”, “Open Sans”, “Overpass”, “PT Sans Narrow”, “Raleway”, “Times New Roman”.

lineposition
Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.

shadow
Sets the shape and color of the shadow behind text. “auto” places minimal shadow and applies contrast text font color. See https://developer.mozilla.org/en- US/docs/Web/CSS/text-shadow for additional options.

size

style
Sets whether a font should be styled with a normal or italic face from its family.

textcase
Sets capitalization of text. It can be used to make text appear in all-uppercase or all- lowercase, or with each word capitalized.

variant
Sets the variant of the font.

weight
Sets the weight (or boldness) of the font.

Returns
Return type: plotly.graph_objects.parcats.legendgrouptitle.Font

property text¶

Sets the title of the legend group.

The ‘text’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

class plotly.graph_objects.parcats.Line(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, colorsrc=None, hovertemplate=None, reversescale=None, shape=None, showscale=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property autocolorscale¶

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.

The ‘autocolorscale’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property cauto¶

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.

The ‘cauto’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property cmax¶

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.

The ‘cmax’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property cmid¶

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.

The ‘cmid’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property cmin¶

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.

The ‘cmin’ property is a number and may be specified as:

An int or float

Returns
Return type: int|float

property color¶

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.

The ‘color’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
A number that will be interpreted as a color according to parcats.line.colorscale
A list or array of any of the above

Returns
Return type: str|numpy.ndarray

property coloraxis¶

Sets a reference to a shared color axis. References to these shared color axes are “coloraxis”, “coloraxis2”, “coloraxis3”, etc. Settings for these shared color axes are set in the layout, under layout.coloraxis, layout.coloraxis2, etc. Note that multiple color scales can be linked to the same color axis.

The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)

Returns
Return type: str

property colorbar¶

The ‘colorbar’ property is an instance of ColorBar that may be specified as:

An instance of plotly.graph_objects.parcats.line.ColorBar

A dict of string/value properties that will be passed to the ColorBar constructor

Supported dict properties:

bgcolor
Sets the color of padded area.

bordercolor
Sets the axis line color.

borderwidth
Sets the width (in px) or the border enclosing this color bar.

dtick
Sets the step in-between ticks on this axis. Use with tick0. Must be a positive number, or special strings available to “log” and “date” axes. If the axis type is “log”, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, … set dtick to 1. To set tick marks at 1, 100, 10000, … set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to log_10(5), or 0.69897000433. “log” has several special values; “L<f>”, where f is a positive number, gives ticks linearly spaced in value (but not position). For example tick0 = 0.1, dtick = “L0.5” will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use “D1” (all digits) or “D2” (only 2 and 5). tick0 is ignored for “D1” and “D2”. If the axis type is “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick to 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months. n must be a positive integer. To set ticks on the 15th of every third month, set tick0 to “2000-01-15” and dtick to “M3”. To set ticks every 4 years, set dtick to “M48”

exponentformat
Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If “none”, it appears as 1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If “power”, 1x10^9 (with 9 in a super script). If “SI”, 1G. If “B”, 1B.

labelalias
Replacement text for specific tick or hover labels. For example using {US: ‘USA’, CA: ‘Canada’} changes US to USA and CA to Canada. The labels we would have shown must match the keys exactly, after adding any tickprefix or ticksuffix. For negative numbers the minus sign symbol used (U+2212) is wider than the regular ascii dash. That means you need to use −1 instead of -1. labelalias can be used with any axis type, and both keys (if needed) and values (if desired) can include html-like tags or MathJax.

len
Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

lenmode
Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use len to set the value.

minexponent
Hide SI prefix for 10^n if |n| is below this number. This only has an effect when tickformat is “SI” or “B”.

nticks
Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to nticks. Has an effect only if tickmode is set to “auto”.

orientation
Sets the orientation of the colorbar.

outlinecolor
Sets the axis line color.

outlinewidth
Sets the width (in px) of the axis line.

separatethousands
If “true”, even 4-digit integers are separated

showexponent
If “all”, all exponents are shown besides their significands. If “first”, only the exponent of the first tick is shown. If “last”, only the exponent of the last tick is shown. If “none”, no exponents appear.

showticklabels
Determines whether or not the tick labels are drawn.

showtickprefix
If “all”, all tick labels are displayed with a prefix. If “first”, only the first tick is displayed with a prefix. If “last”, only the last tick is displayed with a suffix. If “none”, tick prefixes are hidden.

showticksuffix
Same as showtickprefix but for tick suffixes.

thickness
Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

thicknessmode
Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use thickness to set the value.

tick0
Sets the placement of the first tick on this axis. Use with dtick. If the axis type is “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the tick0 to 2) except when dtick`=*L<f>* (see `dtick for more info). If the axis type is “date”, it should be a date string, like date data. If the axis type is “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

tickangle
Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

tickcolor
Sets the tick color.

tickfont
Sets the color bar’s tick label font

tickformat
Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: h ttps://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”

tickformatstops
A tuple of plotly.graph_objects.parcats .line.colorbar.Tickformatstop instances or dicts with compatible properties

tickformatstopdefaults
When used in a template (as layout.template.dat a.parcats.line.colorbar.tickformatstopdefaults) , sets the default property values to use for elements of parcats.line.colorbar.tickformatstops

ticklabeloverflow
Determines how we handle tick labels that would overflow either the graph div or the domain of the axis. The default value for inside tick labels is hide past domain. In other cases the default is hide past div.

ticklabelposition
Determines where tick labels are drawn relative to the ticks. Left and right options are used when orientation is “h”, top and bottom when orientation is “v”.

ticklabelstep
Sets the spacing between tick labels as compared to the spacing between ticks. A value of 1 (default) means each tick gets a label. A value of 2 means shows every 2nd label. A larger value n means only every nth tick is labeled. tick0 determines which labels are shown. Not implemented for axes with type “log” or “multicategory”, or when tickmode is “array”.

ticklen
Sets the tick length (in px).

tickmode
Sets the tick mode for this axis. If “auto”, the number of ticks is set via nticks. If “linear”, the placement of the ticks is determined by a starting position tick0 and a tick step dtick (“linear” is the default value if tick0 and dtick are provided). If “array”, the placement of the ticks is set via tickvals and the tick text is ticktext. (“array” is the default value if tickvals is provided).

tickprefix
Sets a tick label prefix.

ticks
Determines whether ticks are drawn or not. If “”, this axis’ ticks are not drawn. If “outside” (“inside”), this axis’ are drawn outside (inside) the axis lines.

ticksuffix
Sets a tick label suffix.

ticktext
Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to “array”. Used with tickvals.

ticktextsrc
Sets the source reference on Chart Studio Cloud for ticktext.

tickvals
Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to “array”. Used with ticktext.

tickvalssrc
Sets the source reference on Chart Studio Cloud for tickvals.

tickwidth
Sets the tick width (in px).

title
plotly.graph_objects.parcats.line.color bar.Title instance or dict with compatible properties

x
Sets the x position with respect to xref of the color bar (in plot fraction). When xref is “paper”, defaults to 1.02 when orientation is “v” and 0.5 when orientation is “h”. When xref is “container”, defaults to 1 when orientation is “v” and 0.5 when orientation is “h”. Must be between 0 and 1 if xref is “container” and between “-2” and 3 if xref is “paper”.

xanchor
Sets this color bar’s horizontal position anchor. This anchor binds the x position to the “left”, “center” or “right” of the color bar. Defaults to “left” when orientation is “v” and “center” when orientation is “h”.

xpad
Sets the amount of padding (in px) along the x direction.

xref
Sets the container x refers to. “container” spans the entire width of the plot. “paper” refers to the width of the plotting area only.

y
Sets the y position with respect to yref of the color bar (in plot fraction). When yref is “paper”, defaults to 0.5 when orientation is “v” and 1.02 when orientation is “h”. When yref is “container”, defaults to 0.5 when orientation is “v” and 1 when orientation is “h”. Must be between 0 and 1 if yref is “container” and between “-2” and 3 if yref is “paper”.

yanchor
Sets this color bar’s vertical position anchor This anchor binds the y position to the “top”, “middle” or “bottom” of the color bar. Defaults to “middle” when orientation is “v” and “bottom” when orientation is “h”.

ypad
Sets the amount of padding (in px) along the y direction.

yref
Sets the container y refers to. “container” spans the entire height of the plot. “paper” refers to the height of the plotting area only.

Returns
Return type: plotly.graph_objects.parcats.line.ColorBar

property colorscale¶

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,Portla nd,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

The ‘colorscale’ property is a colorscale and may be specified as:

A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

One of the following named colorscales:

[‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,
‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

Appending ‘_r’ to a named colorscale reverses it.

Returns
Return type: str

property colorsrc¶

Sets the source reference on Chart Studio Cloud for color.

The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns
Return type: str

property hovertemplate¶

Template string used for rendering the information that appear on hover box. Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}” as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, “xother” will be added to those with different x positions from the first point. An underscore before or after “(x|y)other” will add a space on that side, only when this field is shown. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. This value here applies when hovering over lines.Finally, the template string has access to variables count and probability. Anything contained in tag <extra> is displayed in the secondary box, for example “<extra>{fullData.name}</extra>”. To hide the secondary box completely, use an empty tag <extra></extra>.

The ‘hovertemplate’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property reversescale¶

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.

The ‘reversescale’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

property shape¶

Sets the shape of the paths. If linear, paths are composed of straight lines. If hspline, paths are composed of horizontal curved splines

The ‘shape’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘linear’, ‘hspline’]

Returns
Return type: Any

property showscale¶

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.

The ‘showscale’ property must be specified as a bool (either True, or False)

Returns
Return type: bool

class plotly.graph_objects.parcats.Stream(arg=None, maxpoints=None, token=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property maxpoints¶

Sets the maximum number of points to keep on the plots from an incoming stream. If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

The ‘maxpoints’ property is a number and may be specified as:

An int or float in the interval [0, 10000]

Returns
Return type: int|float

property token¶

The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

The ‘token’ property is a string and must be specified as:

A non-empty string

Returns
Return type: str

class plotly.graph_objects.parcats.Tickfont(arg=None, color=None, family=None, lineposition=None, shadow=None, size=None, style=None, textcase=None, variant=None, weight=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property color¶

The ‘color’ property is a color and may be specified as:

A hex string (e.g. ‘#ff0000’)
An rgb/rgba string (e.g. ‘rgb(255,0,0)’)
An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)
An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)
A named CSS color:
aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns
Return type: str

property family¶

The ‘family’ property is a string and must be specified as:

A non-empty string

Returns
Return type: str

property lineposition¶

Sets the kind of decoration line(s) with text, such as an “under”, “over” or “through” as well as combinations e.g. “under+over”, etc.

The ‘lineposition’ property is a flaglist and may be specified as a string containing:

Any combination of [‘under’, ‘over’, ‘through’] joined with ‘+’ characters (e.g. ‘under+over’) OR exactly one of [‘none’] (e.g. ‘none’)

Returns
Return type: Any

property shadow¶

The ‘shadow’ property is a string and must be specified as:

A string
A number that will be converted to a string

Returns
Return type: str

property size¶

The ‘size’ property is a number and may be specified as:

An int or float in the interval [1, inf]

Returns
Return type: int|float

property style¶

Sets whether a font should be styled with a normal or italic face from its family.

The ‘style’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘italic’]

Returns
Return type: Any

property textcase¶

Sets capitalization of text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized.

The ‘textcase’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘word caps’, ‘upper’, ‘lower’]

Returns
Return type: Any

property variant¶

Sets the variant of the font.

The ‘variant’ property is an enumeration that may be specified as:

One of the following enumeration values:
[‘normal’, ‘small-caps’, ‘all-small-caps’, ‘all-petite-caps’, ‘petite-caps’, ‘unicase’]

Returns
Return type: Any

property weight¶

Sets the weight (or boldness) of the font.

The ‘weight’ property is a integer and may be specified as:

An int (or float that will be cast to an int) in the interval [1, 1000] OR exactly one of [‘normal’, ‘bold’] (e.g. ‘bold’)

Returns
Return type: int

plotly.graph_objects.parcats package¶

Subpackages¶