1337 lines
50 KiB
Python
1337 lines
50 KiB
Python
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
|
|
import copy as _copy
|
|
|
|
|
|
class Parcats(_BaseTraceType):
|
|
|
|
# class properties
|
|
# --------------------
|
|
_parent_path_str = ""
|
|
_path_str = "parcats"
|
|
_valid_props = {
|
|
"arrangement",
|
|
"bundlecolors",
|
|
"counts",
|
|
"countssrc",
|
|
"dimensiondefaults",
|
|
"dimensions",
|
|
"domain",
|
|
"hoverinfo",
|
|
"hoveron",
|
|
"hovertemplate",
|
|
"labelfont",
|
|
"legendgrouptitle",
|
|
"legendwidth",
|
|
"line",
|
|
"meta",
|
|
"metasrc",
|
|
"name",
|
|
"sortpaths",
|
|
"stream",
|
|
"tickfont",
|
|
"type",
|
|
"uid",
|
|
"uirevision",
|
|
"visible",
|
|
}
|
|
|
|
# arrangement
|
|
# -----------
|
|
@property
|
|
def arrangement(self):
|
|
"""
|
|
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.
|
|
|
|
The 'arrangement' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['perpendicular', 'freeform', 'fixed']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["arrangement"]
|
|
|
|
@arrangement.setter
|
|
def arrangement(self, val):
|
|
self["arrangement"] = val
|
|
|
|
# bundlecolors
|
|
# ------------
|
|
@property
|
|
def bundlecolors(self):
|
|
"""
|
|
Sort paths so that like colors are bundled together within each
|
|
category.
|
|
|
|
The 'bundlecolors' property must be specified as a bool
|
|
(either True, or False)
|
|
|
|
Returns
|
|
-------
|
|
bool
|
|
"""
|
|
return self["bundlecolors"]
|
|
|
|
@bundlecolors.setter
|
|
def bundlecolors(self, val):
|
|
self["bundlecolors"] = val
|
|
|
|
# counts
|
|
# ------
|
|
@property
|
|
def counts(self):
|
|
"""
|
|
The number of observations represented by each state. Defaults
|
|
to 1 so that each state represents one observation
|
|
|
|
The 'counts' property is a number and may be specified as:
|
|
- An int or float in the interval [0, inf]
|
|
- A tuple, list, or one-dimensional numpy array of the above
|
|
|
|
Returns
|
|
-------
|
|
int|float|numpy.ndarray
|
|
"""
|
|
return self["counts"]
|
|
|
|
@counts.setter
|
|
def counts(self, val):
|
|
self["counts"] = val
|
|
|
|
# countssrc
|
|
# ---------
|
|
@property
|
|
def countssrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `counts`.
|
|
|
|
The 'countssrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["countssrc"]
|
|
|
|
@countssrc.setter
|
|
def countssrc(self, val):
|
|
self["countssrc"] = val
|
|
|
|
# dimensions
|
|
# ----------
|
|
@property
|
|
def dimensions(self):
|
|
"""
|
|
The dimensions (variables) of the parallel categories diagram.
|
|
|
|
The 'dimensions' property is a tuple of instances of
|
|
Dimension that may be specified as:
|
|
- A list or tuple of instances of plotly.graph_objs.parcats.Dimension
|
|
- A list or tuple of dicts of string/value properties that
|
|
will be passed to the Dimension constructor
|
|
|
|
Supported dict properties:
|
|
|
|
categoryarray
|
|
Sets the order in which categories in this
|
|
dimension appear. Only has an effect if
|
|
`categoryorder` is set to "array". Used with
|
|
`categoryorder`.
|
|
categoryarraysrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `categoryarray`.
|
|
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`.
|
|
displayindex
|
|
The display index of dimension, from left to
|
|
right, zero indexed, defaults to dimension
|
|
index.
|
|
label
|
|
The shown name of the dimension.
|
|
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`.
|
|
ticktextsrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `ticktext`.
|
|
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).
|
|
valuessrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `values`.
|
|
visible
|
|
Shows the dimension when set to `true` (the
|
|
default). Hides the dimension for `false`.
|
|
|
|
Returns
|
|
-------
|
|
tuple[plotly.graph_objs.parcats.Dimension]
|
|
"""
|
|
return self["dimensions"]
|
|
|
|
@dimensions.setter
|
|
def dimensions(self, val):
|
|
self["dimensions"] = val
|
|
|
|
# dimensiondefaults
|
|
# -----------------
|
|
@property
|
|
def dimensiondefaults(self):
|
|
"""
|
|
When used in a template (as
|
|
layout.template.data.parcats.dimensiondefaults), sets the
|
|
default property values to use for elements of
|
|
parcats.dimensions
|
|
|
|
The 'dimensiondefaults' property is an instance of Dimension
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.parcats.Dimension`
|
|
- A dict of string/value properties that will be passed
|
|
to the Dimension constructor
|
|
|
|
Supported dict properties:
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.parcats.Dimension
|
|
"""
|
|
return self["dimensiondefaults"]
|
|
|
|
@dimensiondefaults.setter
|
|
def dimensiondefaults(self, val):
|
|
self["dimensiondefaults"] = val
|
|
|
|
# domain
|
|
# ------
|
|
@property
|
|
def domain(self):
|
|
"""
|
|
The 'domain' property is an instance of Domain
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.parcats.Domain`
|
|
- A dict of string/value properties that will be passed
|
|
to the Domain constructor
|
|
|
|
Supported dict properties:
|
|
|
|
column
|
|
If there is a layout grid, use the domain for
|
|
this column in the grid for this parcats trace
|
|
.
|
|
row
|
|
If there is a layout grid, use the domain for
|
|
this row in the grid for this parcats trace .
|
|
x
|
|
Sets the horizontal domain of this parcats
|
|
trace (in plot fraction).
|
|
y
|
|
Sets the vertical domain of this parcats trace
|
|
(in plot fraction).
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.parcats.Domain
|
|
"""
|
|
return self["domain"]
|
|
|
|
@domain.setter
|
|
def domain(self, val):
|
|
self["domain"] = val
|
|
|
|
# hoverinfo
|
|
# ---------
|
|
@property
|
|
def hoverinfo(self):
|
|
"""
|
|
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.
|
|
|
|
The 'hoverinfo' property is a flaglist and may be specified
|
|
as a string containing:
|
|
- Any combination of ['count', 'probability'] joined with '+' characters
|
|
(e.g. 'count+probability')
|
|
OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["hoverinfo"]
|
|
|
|
@hoverinfo.setter
|
|
def hoverinfo(self, val):
|
|
self["hoverinfo"] = val
|
|
|
|
# hoveron
|
|
# -------
|
|
@property
|
|
def hoveron(self):
|
|
"""
|
|
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.
|
|
|
|
The 'hoveron' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['category', 'color', 'dimension']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["hoveron"]
|
|
|
|
@hoveron.setter
|
|
def hoveron(self, val):
|
|
self["hoveron"] = val
|
|
|
|
# hovertemplate
|
|
# -------------
|
|
@property
|
|
def hovertemplate(self):
|
|
"""
|
|
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 dimensions. Note that
|
|
`*categorycount`, "colorcount" and "bandcolorcount" are only
|
|
available when `hoveron` contains the "color" flagFinally, the
|
|
template string has access to variables `count`, `probability`,
|
|
`category`, `categorycount`, `colorcount` and `bandcolorcount`.
|
|
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
|
|
-------
|
|
str
|
|
"""
|
|
return self["hovertemplate"]
|
|
|
|
@hovertemplate.setter
|
|
def hovertemplate(self, val):
|
|
self["hovertemplate"] = val
|
|
|
|
# labelfont
|
|
# ---------
|
|
@property
|
|
def labelfont(self):
|
|
"""
|
|
Sets the font for the `dimension` labels.
|
|
|
|
The 'labelfont' property is an instance of Labelfont
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.parcats.Labelfont`
|
|
- A dict of string/value properties that will be passed
|
|
to the Labelfont 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".
|
|
size
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.parcats.Labelfont
|
|
"""
|
|
return self["labelfont"]
|
|
|
|
@labelfont.setter
|
|
def labelfont(self, val):
|
|
self["labelfont"] = val
|
|
|
|
# legendgrouptitle
|
|
# ----------------
|
|
@property
|
|
def legendgrouptitle(self):
|
|
"""
|
|
The 'legendgrouptitle' property is an instance of Legendgrouptitle
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.parcats.Legendgrouptitle`
|
|
- A dict of string/value properties that will be passed
|
|
to the Legendgrouptitle constructor
|
|
|
|
Supported dict properties:
|
|
|
|
font
|
|
Sets this legend group's title font.
|
|
text
|
|
Sets the title of the legend group.
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.parcats.Legendgrouptitle
|
|
"""
|
|
return self["legendgrouptitle"]
|
|
|
|
@legendgrouptitle.setter
|
|
def legendgrouptitle(self, val):
|
|
self["legendgrouptitle"] = val
|
|
|
|
# legendwidth
|
|
# -----------
|
|
@property
|
|
def legendwidth(self):
|
|
"""
|
|
Sets the width (in px or fraction) of the legend for this
|
|
trace.
|
|
|
|
The 'legendwidth' property is a number and may be specified as:
|
|
- An int or float in the interval [0, inf]
|
|
|
|
Returns
|
|
-------
|
|
int|float
|
|
"""
|
|
return self["legendwidth"]
|
|
|
|
@legendwidth.setter
|
|
def legendwidth(self, val):
|
|
self["legendwidth"] = val
|
|
|
|
# line
|
|
# ----
|
|
@property
|
|
def line(self):
|
|
"""
|
|
The 'line' property is an instance of Line
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.parcats.Line`
|
|
- A dict of string/value properties that will be passed
|
|
to the Line constructor
|
|
|
|
Supported dict properties:
|
|
|
|
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.
|
|
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.
|
|
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.
|
|
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`.
|
|
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.
|
|
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.
|
|
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.
|
|
colorbar
|
|
:class:`plotly.graph_objects.parcats.line.Color
|
|
Bar` instance or dict with compatible
|
|
properties
|
|
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,Bl
|
|
uered,Blues,Cividis,Earth,Electric,Greens,Greys
|
|
,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viri
|
|
dis,YlGnBu,YlOrRd.
|
|
colorsrc
|
|
Sets the source reference on Chart Studio Cloud
|
|
for `color`.
|
|
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>`.
|
|
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.
|
|
shape
|
|
Sets the shape of the paths. If `linear`, paths
|
|
are composed of straight lines. If `hspline`,
|
|
paths are composed of horizontal curved splines
|
|
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.
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.parcats.Line
|
|
"""
|
|
return self["line"]
|
|
|
|
@line.setter
|
|
def line(self, val):
|
|
self["line"] = val
|
|
|
|
# meta
|
|
# ----
|
|
@property
|
|
def meta(self):
|
|
"""
|
|
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.
|
|
|
|
The 'meta' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any|numpy.ndarray
|
|
"""
|
|
return self["meta"]
|
|
|
|
@meta.setter
|
|
def meta(self, val):
|
|
self["meta"] = val
|
|
|
|
# metasrc
|
|
# -------
|
|
@property
|
|
def metasrc(self):
|
|
"""
|
|
Sets the source reference on Chart Studio Cloud for `meta`.
|
|
|
|
The 'metasrc' property must be specified as a string or
|
|
as a plotly.grid_objs.Column object
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["metasrc"]
|
|
|
|
@metasrc.setter
|
|
def metasrc(self, val):
|
|
self["metasrc"] = val
|
|
|
|
# name
|
|
# ----
|
|
@property
|
|
def name(self):
|
|
"""
|
|
Sets the trace name. The trace name appears as the legend item
|
|
and on hover.
|
|
|
|
The 'name' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["name"]
|
|
|
|
@name.setter
|
|
def name(self, val):
|
|
self["name"] = val
|
|
|
|
# sortpaths
|
|
# ---------
|
|
@property
|
|
def sortpaths(self):
|
|
"""
|
|
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.
|
|
|
|
The 'sortpaths' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
['forward', 'backward']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["sortpaths"]
|
|
|
|
@sortpaths.setter
|
|
def sortpaths(self, val):
|
|
self["sortpaths"] = val
|
|
|
|
# stream
|
|
# ------
|
|
@property
|
|
def stream(self):
|
|
"""
|
|
The 'stream' property is an instance of Stream
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.parcats.Stream`
|
|
- A dict of string/value properties that will be passed
|
|
to the Stream constructor
|
|
|
|
Supported dict properties:
|
|
|
|
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.
|
|
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.
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.parcats.Stream
|
|
"""
|
|
return self["stream"]
|
|
|
|
@stream.setter
|
|
def stream(self, val):
|
|
self["stream"] = val
|
|
|
|
# tickfont
|
|
# --------
|
|
@property
|
|
def tickfont(self):
|
|
"""
|
|
Sets the font for the `category` labels.
|
|
|
|
The 'tickfont' property is an instance of Tickfont
|
|
that may be specified as:
|
|
- An instance of :class:`plotly.graph_objs.parcats.Tickfont`
|
|
- A dict of string/value properties that will be passed
|
|
to the Tickfont 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".
|
|
size
|
|
|
|
Returns
|
|
-------
|
|
plotly.graph_objs.parcats.Tickfont
|
|
"""
|
|
return self["tickfont"]
|
|
|
|
@tickfont.setter
|
|
def tickfont(self, val):
|
|
self["tickfont"] = val
|
|
|
|
# uid
|
|
# ---
|
|
@property
|
|
def uid(self):
|
|
"""
|
|
Assign an id to this trace, Use this to provide object
|
|
constancy between traces during animations and transitions.
|
|
|
|
The 'uid' property is a string and must be specified as:
|
|
- A string
|
|
- A number that will be converted to a string
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
"""
|
|
return self["uid"]
|
|
|
|
@uid.setter
|
|
def uid(self, val):
|
|
self["uid"] = val
|
|
|
|
# uirevision
|
|
# ----------
|
|
@property
|
|
def uirevision(self):
|
|
"""
|
|
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.
|
|
|
|
The 'uirevision' property accepts values of any type
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["uirevision"]
|
|
|
|
@uirevision.setter
|
|
def uirevision(self, val):
|
|
self["uirevision"] = val
|
|
|
|
# visible
|
|
# -------
|
|
@property
|
|
def visible(self):
|
|
"""
|
|
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).
|
|
|
|
The 'visible' property is an enumeration that may be specified as:
|
|
- One of the following enumeration values:
|
|
[True, False, 'legendonly']
|
|
|
|
Returns
|
|
-------
|
|
Any
|
|
"""
|
|
return self["visible"]
|
|
|
|
@visible.setter
|
|
def visible(self, val):
|
|
self["visible"] = val
|
|
|
|
# type
|
|
# ----
|
|
@property
|
|
def type(self):
|
|
return self._props["type"]
|
|
|
|
# Self properties description
|
|
# ---------------------------
|
|
@property
|
|
def _prop_descriptions(self):
|
|
return """\
|
|
arrangement
|
|
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.
|
|
bundlecolors
|
|
Sort paths so that like colors are bundled together
|
|
within each category.
|
|
counts
|
|
The number of observations represented by each state.
|
|
Defaults to 1 so that each state represents one
|
|
observation
|
|
countssrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`counts`.
|
|
dimensions
|
|
The dimensions (variables) of the parallel categories
|
|
diagram.
|
|
dimensiondefaults
|
|
When used in a template (as
|
|
layout.template.data.parcats.dimensiondefaults), sets
|
|
the default property values to use for elements of
|
|
parcats.dimensions
|
|
domain
|
|
:class:`plotly.graph_objects.parcats.Domain` instance
|
|
or dict with compatible properties
|
|
hoverinfo
|
|
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.
|
|
hoveron
|
|
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.
|
|
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 dimensions. Note that `*categorycount`,
|
|
"colorcount" and "bandcolorcount" are only available
|
|
when `hoveron` contains the "color" flagFinally, the
|
|
template string has access to variables `count`,
|
|
`probability`, `category`, `categorycount`,
|
|
`colorcount` and `bandcolorcount`. 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>`.
|
|
labelfont
|
|
Sets the font for the `dimension` labels.
|
|
legendgrouptitle
|
|
:class:`plotly.graph_objects.parcats.Legendgrouptitle`
|
|
instance or dict with compatible properties
|
|
legendwidth
|
|
Sets the width (in px or fraction) of the legend for
|
|
this trace.
|
|
line
|
|
:class:`plotly.graph_objects.parcats.Line` instance or
|
|
dict with compatible properties
|
|
meta
|
|
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.
|
|
metasrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`meta`.
|
|
name
|
|
Sets the trace name. The trace name appears as the
|
|
legend item and on hover.
|
|
sortpaths
|
|
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.
|
|
stream
|
|
:class:`plotly.graph_objects.parcats.Stream` instance
|
|
or dict with compatible properties
|
|
tickfont
|
|
Sets the font for the `category` labels.
|
|
uid
|
|
Assign an id to this trace, Use this to provide object
|
|
constancy between traces during animations and
|
|
transitions.
|
|
uirevision
|
|
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.
|
|
visible
|
|
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).
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
arg=None,
|
|
arrangement=None,
|
|
bundlecolors=None,
|
|
counts=None,
|
|
countssrc=None,
|
|
dimensions=None,
|
|
dimensiondefaults=None,
|
|
domain=None,
|
|
hoverinfo=None,
|
|
hoveron=None,
|
|
hovertemplate=None,
|
|
labelfont=None,
|
|
legendgrouptitle=None,
|
|
legendwidth=None,
|
|
line=None,
|
|
meta=None,
|
|
metasrc=None,
|
|
name=None,
|
|
sortpaths=None,
|
|
stream=None,
|
|
tickfont=None,
|
|
uid=None,
|
|
uirevision=None,
|
|
visible=None,
|
|
**kwargs,
|
|
):
|
|
"""
|
|
Construct a new Parcats object
|
|
|
|
Parallel categories diagram for multidimensional categorical
|
|
data.
|
|
|
|
Parameters
|
|
----------
|
|
arg
|
|
dict of properties compatible with this constructor or
|
|
an instance of :class:`plotly.graph_objs.Parcats`
|
|
arrangement
|
|
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.
|
|
bundlecolors
|
|
Sort paths so that like colors are bundled together
|
|
within each category.
|
|
counts
|
|
The number of observations represented by each state.
|
|
Defaults to 1 so that each state represents one
|
|
observation
|
|
countssrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`counts`.
|
|
dimensions
|
|
The dimensions (variables) of the parallel categories
|
|
diagram.
|
|
dimensiondefaults
|
|
When used in a template (as
|
|
layout.template.data.parcats.dimensiondefaults), sets
|
|
the default property values to use for elements of
|
|
parcats.dimensions
|
|
domain
|
|
:class:`plotly.graph_objects.parcats.Domain` instance
|
|
or dict with compatible properties
|
|
hoverinfo
|
|
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.
|
|
hoveron
|
|
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.
|
|
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 dimensions. Note that `*categorycount`,
|
|
"colorcount" and "bandcolorcount" are only available
|
|
when `hoveron` contains the "color" flagFinally, the
|
|
template string has access to variables `count`,
|
|
`probability`, `category`, `categorycount`,
|
|
`colorcount` and `bandcolorcount`. 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>`.
|
|
labelfont
|
|
Sets the font for the `dimension` labels.
|
|
legendgrouptitle
|
|
:class:`plotly.graph_objects.parcats.Legendgrouptitle`
|
|
instance or dict with compatible properties
|
|
legendwidth
|
|
Sets the width (in px or fraction) of the legend for
|
|
this trace.
|
|
line
|
|
:class:`plotly.graph_objects.parcats.Line` instance or
|
|
dict with compatible properties
|
|
meta
|
|
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.
|
|
metasrc
|
|
Sets the source reference on Chart Studio Cloud for
|
|
`meta`.
|
|
name
|
|
Sets the trace name. The trace name appears as the
|
|
legend item and on hover.
|
|
sortpaths
|
|
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.
|
|
stream
|
|
:class:`plotly.graph_objects.parcats.Stream` instance
|
|
or dict with compatible properties
|
|
tickfont
|
|
Sets the font for the `category` labels.
|
|
uid
|
|
Assign an id to this trace, Use this to provide object
|
|
constancy between traces during animations and
|
|
transitions.
|
|
uirevision
|
|
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.
|
|
visible
|
|
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).
|
|
|
|
Returns
|
|
-------
|
|
Parcats
|
|
"""
|
|
super(Parcats, self).__init__("parcats")
|
|
|
|
if "_parent" in kwargs:
|
|
self._parent = kwargs["_parent"]
|
|
return
|
|
|
|
# Validate arg
|
|
# ------------
|
|
if arg is None:
|
|
arg = {}
|
|
elif isinstance(arg, self.__class__):
|
|
arg = arg.to_plotly_json()
|
|
elif isinstance(arg, dict):
|
|
arg = _copy.copy(arg)
|
|
else:
|
|
raise ValueError(
|
|
"""\
|
|
The first argument to the plotly.graph_objs.Parcats
|
|
constructor must be a dict or
|
|
an instance of :class:`plotly.graph_objs.Parcats`"""
|
|
)
|
|
|
|
# Handle skip_invalid
|
|
# -------------------
|
|
self._skip_invalid = kwargs.pop("skip_invalid", False)
|
|
self._validate = kwargs.pop("_validate", True)
|
|
|
|
# Populate data dict with properties
|
|
# ----------------------------------
|
|
_v = arg.pop("arrangement", None)
|
|
_v = arrangement if arrangement is not None else _v
|
|
if _v is not None:
|
|
self["arrangement"] = _v
|
|
_v = arg.pop("bundlecolors", None)
|
|
_v = bundlecolors if bundlecolors is not None else _v
|
|
if _v is not None:
|
|
self["bundlecolors"] = _v
|
|
_v = arg.pop("counts", None)
|
|
_v = counts if counts is not None else _v
|
|
if _v is not None:
|
|
self["counts"] = _v
|
|
_v = arg.pop("countssrc", None)
|
|
_v = countssrc if countssrc is not None else _v
|
|
if _v is not None:
|
|
self["countssrc"] = _v
|
|
_v = arg.pop("dimensions", None)
|
|
_v = dimensions if dimensions is not None else _v
|
|
if _v is not None:
|
|
self["dimensions"] = _v
|
|
_v = arg.pop("dimensiondefaults", None)
|
|
_v = dimensiondefaults if dimensiondefaults is not None else _v
|
|
if _v is not None:
|
|
self["dimensiondefaults"] = _v
|
|
_v = arg.pop("domain", None)
|
|
_v = domain if domain is not None else _v
|
|
if _v is not None:
|
|
self["domain"] = _v
|
|
_v = arg.pop("hoverinfo", None)
|
|
_v = hoverinfo if hoverinfo is not None else _v
|
|
if _v is not None:
|
|
self["hoverinfo"] = _v
|
|
_v = arg.pop("hoveron", None)
|
|
_v = hoveron if hoveron is not None else _v
|
|
if _v is not None:
|
|
self["hoveron"] = _v
|
|
_v = arg.pop("hovertemplate", None)
|
|
_v = hovertemplate if hovertemplate is not None else _v
|
|
if _v is not None:
|
|
self["hovertemplate"] = _v
|
|
_v = arg.pop("labelfont", None)
|
|
_v = labelfont if labelfont is not None else _v
|
|
if _v is not None:
|
|
self["labelfont"] = _v
|
|
_v = arg.pop("legendgrouptitle", None)
|
|
_v = legendgrouptitle if legendgrouptitle is not None else _v
|
|
if _v is not None:
|
|
self["legendgrouptitle"] = _v
|
|
_v = arg.pop("legendwidth", None)
|
|
_v = legendwidth if legendwidth is not None else _v
|
|
if _v is not None:
|
|
self["legendwidth"] = _v
|
|
_v = arg.pop("line", None)
|
|
_v = line if line is not None else _v
|
|
if _v is not None:
|
|
self["line"] = _v
|
|
_v = arg.pop("meta", None)
|
|
_v = meta if meta is not None else _v
|
|
if _v is not None:
|
|
self["meta"] = _v
|
|
_v = arg.pop("metasrc", None)
|
|
_v = metasrc if metasrc is not None else _v
|
|
if _v is not None:
|
|
self["metasrc"] = _v
|
|
_v = arg.pop("name", None)
|
|
_v = name if name is not None else _v
|
|
if _v is not None:
|
|
self["name"] = _v
|
|
_v = arg.pop("sortpaths", None)
|
|
_v = sortpaths if sortpaths is not None else _v
|
|
if _v is not None:
|
|
self["sortpaths"] = _v
|
|
_v = arg.pop("stream", None)
|
|
_v = stream if stream is not None else _v
|
|
if _v is not None:
|
|
self["stream"] = _v
|
|
_v = arg.pop("tickfont", None)
|
|
_v = tickfont if tickfont is not None else _v
|
|
if _v is not None:
|
|
self["tickfont"] = _v
|
|
_v = arg.pop("uid", None)
|
|
_v = uid if uid is not None else _v
|
|
if _v is not None:
|
|
self["uid"] = _v
|
|
_v = arg.pop("uirevision", None)
|
|
_v = uirevision if uirevision is not None else _v
|
|
if _v is not None:
|
|
self["uirevision"] = _v
|
|
_v = arg.pop("visible", None)
|
|
_v = visible if visible is not None else _v
|
|
if _v is not None:
|
|
self["visible"] = _v
|
|
|
|
# Read-only literals
|
|
# ------------------
|
|
|
|
self._props["type"] = "parcats"
|
|
arg.pop("type", None)
|
|
|
|
# Process unknown kwargs
|
|
# ----------------------
|
|
self._process_kwargs(**dict(arg, **kwargs))
|
|
|
|
# Reset skip_invalid
|
|
# ------------------
|
|
self._skip_invalid = False
|