def __init__(self,
arg=None,
color=None,
colorsrc=None,
label=None,
labelsrc=None,
line=None,
source=None,
sourcesrc=None,
target=None,
targetsrc=None,
value=None,
valuesrc=None,
**kwargs):
"""
Construct a new Link object
The links of the Sankey plot.
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of plotly.graph_objs.sankey.Link
color
Sets the `link` color. It can be a single value, or an
array for specifying color for each `link`. If
`link.color` is omitted, then by default, a translucent
grey link will be used.
colorsrc
Sets the source reference on plot.ly for color .
label
The shown name of the link.
labelsrc
Sets the source reference on plot.ly for label .
line
plotly.graph_objs.sankey.link.Line instance or dict
with compatible properties
source
An integer number `[0..nodes.length - 1]` that
represents the source node.
sourcesrc
Sets the source reference on plot.ly for source .
target
An integer number `[0..nodes.length - 1]` that
represents the target node.
targetsrc
Sets the source reference on plot.ly for target .
value
A numeric value representing the flow volume value.
valuesrc
Sets the source reference on plot.ly for value .
Returns
-------
Link
"""
super(Link, self).__init__('link')
# 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.sankey.Link
constructor must be a dict or
an instance of plotly.graph_objs.sankey.Link""")
# Import validators
# -----------------
from plotly.validators.sankey import (link as v_link)
# Initialize validators
# ---------------------
self._validators['color'] = v_link.ColorValidator()
self._validators['colorsrc'] = v_link.ColorsrcValidator()
self._validators['label'] = v_link.LabelValidator()
self._validators['labelsrc'] = v_link.LabelsrcValidator()
self._validators['line'] = v_link.LineValidator()
self._validators['source'] = v_link.SourceValidator()
self._validators['sourcesrc'] = v_link.SourcesrcValidator()
self._validators['target'] = v_link.TargetValidator()
self._validators['targetsrc'] = v_link.TargetsrcValidator()
self._validators['value'] = v_link.ValueValidator()
self._validators['valuesrc'] = v_link.ValuesrcValidator()
# Populate data dict with properties
# ----------------------------------
v = arg.pop('color', None)
self.color = color if color is not None else v
v = arg.pop('colorsrc', None)
self.colorsrc = colorsrc if colorsrc is not None else v
v = arg.pop('label', None)
self.label = label if label is not None else v
v = arg.pop('labelsrc', None)
self.labelsrc = labelsrc if labelsrc is not None else v
v = arg.pop('line', None)
self.line = line if line is not None else v
v = arg.pop('source', None)
self.source = source if source is not None else v
v = arg.pop('sourcesrc', None)
self.sourcesrc = sourcesrc if sourcesrc is not None else v
v = arg.pop('target', None)
self.target = target if target is not None else v
v = arg.pop('targetsrc', None)
self.targetsrc = targetsrc if targetsrc is not None else v
v = arg.pop('value', None)
self.value = value if value is not None else v
v = arg.pop('valuesrc', None)
self.valuesrc = valuesrc if valuesrc is not None else v
# Process unknown kwargs
# ----------------------
self._process_kwargs(**dict(arg, **kwargs))
def __init__(
self,
arg=None,
color=None,
colorsrc=None,
hoverinfo=None,
hoverlabel=None,
label=None,
labelsrc=None,
line=None,
source=None,
sourcesrc=None,
target=None,
targetsrc=None,
value=None,
valuesrc=None,
**kwargs
):
"""
Construct a new Link object
The links of the Sankey plot.
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of plotly.graph_objs.sankey.Link
color
Sets the `link` color. It can be a single value, or an
array for specifying color for each `link`. If
`link.color` is omitted, then by default, a translucent
grey link will be used.
colorsrc
Sets the source reference on plot.ly for color .
hoverinfo
Determines which trace information appear when hovering
links. If `none` or `skip` are set, no information is
displayed upon hovering. But, if `none` is set, click
and hover events are still fired.
hoverlabel
plotly.graph_objs.sankey.link.Hoverlabel instance or
dict with compatible properties
label
The shown name of the link.
labelsrc
Sets the source reference on plot.ly for label .
line
plotly.graph_objs.sankey.link.Line instance or dict
with compatible properties
source
An integer number `[0..nodes.length - 1]` that
represents the source node.
sourcesrc
Sets the source reference on plot.ly for source .
target
An integer number `[0..nodes.length - 1]` that
represents the target node.
targetsrc
Sets the source reference on plot.ly for target .
value
A numeric value representing the flow volume value.
valuesrc
Sets the source reference on plot.ly for value .
Returns
-------
Link
"""
super(Link, self).__init__('link')
# 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.sankey.Link
constructor must be a dict or
an instance of plotly.graph_objs.sankey.Link"""
)
# Handle skip_invalid
# -------------------
self._skip_invalid = kwargs.pop('skip_invalid', False)
# Import validators
# -----------------
from plotly.validators.sankey import (link as v_link)
# Initialize validators
# ---------------------
self._validators['color'] = v_link.ColorValidator()
self._validators['colorsrc'] = v_link.ColorsrcValidator()
self._validators['hoverinfo'] = v_link.HoverinfoValidator()
self._validators['hoverlabel'] = v_link.HoverlabelValidator()
self._validators['label'] = v_link.LabelValidator()
self._validators['labelsrc'] = v_link.LabelsrcValidator()
self._validators['line'] = v_link.LineValidator()
self._validators['source'] = v_link.SourceValidator()
self._validators['sourcesrc'] = v_link.SourcesrcValidator()
self._validators['target'] = v_link.TargetValidator()
self._validators['targetsrc'] = v_link.TargetsrcValidator()
self._validators['value'] = v_link.ValueValidator()
self._validators['valuesrc'] = v_link.ValuesrcValidator()
# Populate data dict with properties
# ----------------------------------
_v = arg.pop('color', None)
self['color'] = color if color is not None else _v
_v = arg.pop('colorsrc', None)
self['colorsrc'] = colorsrc if colorsrc is not None else _v
_v = arg.pop('hoverinfo', None)
self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v
_v = arg.pop('hoverlabel', None)
self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v
_v = arg.pop('label', None)
self['label'] = label if label is not None else _v
_v = arg.pop('labelsrc', None)
self['labelsrc'] = labelsrc if labelsrc is not None else _v
_v = arg.pop('line', None)
self['line'] = line if line is not None else _v
_v = arg.pop('source', None)
self['source'] = source if source is not None else _v
_v = arg.pop('sourcesrc', None)
self['sourcesrc'] = sourcesrc if sourcesrc is not None else _v
_v = arg.pop('target', None)
self['target'] = target if target is not None else _v
_v = arg.pop('targetsrc', None)
self['targetsrc'] = targetsrc if targetsrc is not None else _v
_v = arg.pop('value', None)
self['value'] = value if value is not None else _v
_v = arg.pop('valuesrc', None)
self['valuesrc'] = valuesrc if valuesrc is not None else _v
# Process unknown kwargs
# ----------------------
self._process_kwargs(**dict(arg, **kwargs))
# Reset skip_invalid
# ------------------
self._skip_invalid = False
def __init__(self,
arg=None,
color=None,
colorscales=None,
colorscaledefaults=None,
colorsrc=None,
hoverinfo=None,
hoverlabel=None,
hovertemplate=None,
hovertemplatesrc=None,
label=None,
labelsrc=None,
line=None,
source=None,
sourcesrc=None,
target=None,
targetsrc=None,
value=None,
valuesrc=None,
**kwargs):
"""
Construct a new Link object
The links of the Sankey plot.
Parameters
----------
arg
dict of properties compatible with this constructor or
an instance of plotly.graph_objs.sankey.Link
color
Sets the `link` color. It can be a single value, or an
array for specifying color for each `link`. If
`link.color` is omitted, then by default, a translucent
grey link will be used.
colorscales
plotly.graph_objs.sankey.link.Colorscale instance or
dict with compatible properties
colorscaledefaults
When used in a template (as
layout.template.data.sankey.link.colorscaledefaults),
sets the default property values to use for elements of
sankey.link.colorscales
colorsrc
Sets the source reference on plot.ly for color .
hoverinfo
Determines which trace information appear when hovering
links. If `none` or `skip` are set, no information is
displayed upon hovering. But, if `none` is set, click
and hover events are still fired.
hoverlabel
plotly.graph_objs.sankey.link.Hoverlabel instance or
dict with compatible properties
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}". Numbers are formatted using
d3-format's syntax %{variable:d3-format}, for example
"Price: %{y:$.2f}". See https://github.com/d3/d3-format
/blob/master/README.md#locale_format for details on the
formatting syntax. The variables available in
`hovertemplate` are the ones emitted as event data
described at this link
https://plot.ly/javascript/plotlyjs-events/#event-data.
Additionally, every attributes that can be specified
per-point (the ones that are `arrayOk: true`) are
available. variables `value` and `label`. Anything
contained in tag `<extra>` is displayed in the
secondary box, for example
"<extra>{fullData.name}</extra>".
hovertemplatesrc
Sets the source reference on plot.ly for hovertemplate
.
label
The shown name of the link.
labelsrc
Sets the source reference on plot.ly for label .
line
plotly.graph_objs.sankey.link.Line instance or dict
with compatible properties
source
An integer number `[0..nodes.length - 1]` that
represents the source node.
sourcesrc
Sets the source reference on plot.ly for source .
target
An integer number `[0..nodes.length - 1]` that
represents the target node.
targetsrc
Sets the source reference on plot.ly for target .
value
A numeric value representing the flow volume value.
valuesrc
Sets the source reference on plot.ly for value .
Returns
-------
Link
"""
super(Link, self).__init__('link')
# 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.sankey.Link
constructor must be a dict or
an instance of plotly.graph_objs.sankey.Link""")
# Handle skip_invalid
# -------------------
self._skip_invalid = kwargs.pop('skip_invalid', False)
# Import validators
# -----------------
from plotly.validators.sankey import (link as v_link)
# Initialize validators
# ---------------------
self._validators['color'] = v_link.ColorValidator()
self._validators['colorscales'] = v_link.ColorscalesValidator()
self._validators['colorscaledefaults'] = v_link.ColorscaleValidator()
self._validators['colorsrc'] = v_link.ColorsrcValidator()
self._validators['hoverinfo'] = v_link.HoverinfoValidator()
self._validators['hoverlabel'] = v_link.HoverlabelValidator()
self._validators['hovertemplate'] = v_link.HovertemplateValidator()
self._validators[
'hovertemplatesrc'] = v_link.HovertemplatesrcValidator()
self._validators['label'] = v_link.LabelValidator()
self._validators['labelsrc'] = v_link.LabelsrcValidator()
self._validators['line'] = v_link.LineValidator()
self._validators['source'] = v_link.SourceValidator()
self._validators['sourcesrc'] = v_link.SourcesrcValidator()
self._validators['target'] = v_link.TargetValidator()
self._validators['targetsrc'] = v_link.TargetsrcValidator()
self._validators['value'] = v_link.ValueValidator()
self._validators['valuesrc'] = v_link.ValuesrcValidator()
# Populate data dict with properties
# ----------------------------------
_v = arg.pop('color', None)
self['color'] = color if color is not None else _v
_v = arg.pop('colorscales', None)
self['colorscales'] = colorscales if colorscales is not None else _v
_v = arg.pop('colorscaledefaults', None)
self[
'colorscaledefaults'] = colorscaledefaults if colorscaledefaults is not None else _v
_v = arg.pop('colorsrc', None)
self['colorsrc'] = colorsrc if colorsrc is not None else _v
_v = arg.pop('hoverinfo', None)
self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v
_v = arg.pop('hoverlabel', None)
self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v
_v = arg.pop('hovertemplate', None)
self[
'hovertemplate'] = hovertemplate if hovertemplate is not None else _v
_v = arg.pop('hovertemplatesrc', None)
self[
'hovertemplatesrc'] = hovertemplatesrc if hovertemplatesrc is not None else _v
_v = arg.pop('label', None)
self['label'] = label if label is not None else _v
_v = arg.pop('labelsrc', None)
self['labelsrc'] = labelsrc if labelsrc is not None else _v
_v = arg.pop('line', None)
self['line'] = line if line is not None else _v
_v = arg.pop('source', None)
self['source'] = source if source is not None else _v
_v = arg.pop('sourcesrc', None)
self['sourcesrc'] = sourcesrc if sourcesrc is not None else _v
_v = arg.pop('target', None)
self['target'] = target if target is not None else _v
_v = arg.pop('targetsrc', None)
self['targetsrc'] = targetsrc if targetsrc is not None else _v
_v = arg.pop('value', None)
self['value'] = value if value is not None else _v
_v = arg.pop('valuesrc', None)
self['valuesrc'] = valuesrc if valuesrc is not None else _v
# Process unknown kwargs
# ----------------------
self._process_kwargs(**dict(arg, **kwargs))
# Reset skip_invalid
# ------------------
self._skip_invalid = False