plotly.graph_objects.parcoords package¶

class plotly.graph_objects.parcoords.Dimension(arg=None, constraintrange=None, label=None, multiselect=None, name=None, range=None, templateitemname=None, tickformat=None, ticktext=None, ticktextsrc=None, tickvals=None, tickvalssrc=None, values=None, valuessrc=None, visible=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property constraintrange¶

The domain range to which the filter on the dimension is

constrained. Must be an array of [fromValue, toValue] with fromValue <= toValue, or if multiselect is not disabled, you may give an array of arrays, where each inner array is [fromValue, toValue].

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

a list or tuple of 2 elements where:

The ‘constraintrange[0]’ property accepts values of any type
The ‘constraintrange[1]’ property accepts values of any type
- a 2D list where:

The ‘constraintrange[i][0]’ property accepts values of any type
The ‘constraintrange[i][1]’ property accepts values of any type

list

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 multiselect¶

Do we allow multiple selection ranges or just a single range?

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

Returns
Return type: bool

property name¶

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.

The ‘name’ 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 range¶

The domain range that represents the full, shown axis extent.

Defaults to the values extent. Must be an array of [fromValue, toValue] with finite numbers as elements.

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

a list or tuple of 2 elements where:

The ‘range[0]’ property is a number and may be specified as:
- An int or float
The ‘range[1]’ property is a number and may be specified as:
- An int or float
list

property templateitemname¶

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.

The ‘templateitemname’ 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 tickformat¶

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”

The ‘tickformat’ 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 the text displayed at the ticks position via tickvals.

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 tickvals¶

Sets the values at which ticks on this axis appear.

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

Returns
Return type: numpy.ndarray

property tickvalssrc¶

Sets the source reference on Chart Studio Cloud for tickvals.

The ‘tickvalssrc’ 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 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). Each value must be a finite number.

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.parcoords.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 parcoords 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 parcoords 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 parcoords 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 parcoords 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.parcoords.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: see https://plotly.com/python/css-colors/ for a list

Returns
Return type: str

property family¶

HTML font family - the typeface that will be applied by the web browser. The web browser can only apply a font if it is available on the system where it runs. Provide multiple font families, separated by commas, to indicate the order in which to apply fonts if they aren’t available.

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.parcoords.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.parcoords.legendgrouptitle.Font

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

Returns
Return type: plotly.graph_objects.parcoords.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.parcoords.Line(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, colorsrc=None, reversescale=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: see https://plotly.com/python/css-colors/ for a list
A number that will be interpreted as a color according to parcoords.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.parcoords.line.ColorBar

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

Returns
Return type: plotly.graph_objects.parcoords.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 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 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.parcoords.Rangefont(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: see https://plotly.com/python/css-colors/ for a list

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

class plotly.graph_objects.parcoords.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.parcoords.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: see https://plotly.com/python/css-colors/ for a list

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

class plotly.graph_objects.parcoords.Unselected(arg=None, line=None, **kwargs)¶

Bases: plotly.basedatatypes.BaseTraceHierarchyType

property line¶

The ‘line’ property is an instance of Line that may be specified as:

An instance of plotly.graph_objects.parcoords.unselected.Line

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

Returns
Return type: plotly.graph_objects.parcoords.unselected.Line

plotly.graph_objects.parcoords package¶

Subpackages¶