from plotly.basedatatypes import BaseTraceHierarchyType import copy class Link(BaseTraceHierarchyType): # color # ----- @property def color(self): """ 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. 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, 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 list or array of any of the above Returns ------- str|numpy.ndarray """ return self['color'] @color.setter def color(self, val): self['color'] = val # colorsrc # -------- @property def colorsrc(self): """ Sets the source reference on plot.ly for color . The 'colorsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str """ return self['colorsrc'] @colorsrc.setter def colorsrc(self, val): self['colorsrc'] = val # hoverinfo # --------- @property def hoverinfo(self): """ 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. The 'hoverinfo' property is an enumeration that may be specified as: - One of the following enumeration values: ['all', 'none', 'skip'] Returns ------- Any """ return self['hoverinfo'] @hoverinfo.setter def hoverinfo(self, val): self['hoverinfo'] = val # hoverlabel # ---------- @property def hoverlabel(self): """ The 'hoverlabel' property is an instance of Hoverlabel that may be specified as: - An instance of plotly.graph_objs.sankey.link.Hoverlabel - A dict of string/value properties that will be passed to the Hoverlabel constructor Supported dict properties: bgcolor Sets the background color of the hover labels for this trace bgcolorsrc Sets the source reference on plot.ly for bgcolor . bordercolor Sets the border color of the hover labels for this trace. bordercolorsrc Sets the source reference on plot.ly for bordercolor . font Sets the font used in hover labels. namelength Sets the length (in number of characters) of the trace name in the hover labels for this trace. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis. namelengthsrc Sets the source reference on plot.ly for namelength . Returns ------- plotly.graph_objs.sankey.link.Hoverlabel """ return self['hoverlabel'] @hoverlabel.setter def hoverlabel(self, val): self['hoverlabel'] = val # label # ----- @property def label(self): """ The shown name of the link. The 'label' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray """ return self['label'] @label.setter def label(self, val): self['label'] = val # labelsrc # -------- @property def labelsrc(self): """ Sets the source reference on plot.ly for label . The 'labelsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str """ return self['labelsrc'] @labelsrc.setter def labelsrc(self, val): self['labelsrc'] = val # line # ---- @property def line(self): """ The 'line' property is an instance of Line that may be specified as: - An instance of plotly.graph_objs.sankey.link.Line - A dict of string/value properties that will be passed to the Line constructor Supported dict properties: color Sets the color of the `line` around each `link`. colorsrc Sets the source reference on plot.ly for color . width Sets the width (in px) of the `line` around each `link`. widthsrc Sets the source reference on plot.ly for width . Returns ------- plotly.graph_objs.sankey.link.Line """ return self['line'] @line.setter def line(self, val): self['line'] = val # source # ------ @property def source(self): """ An integer number `[0..nodes.length - 1]` that represents the source node. The 'source' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray """ return self['source'] @source.setter def source(self, val): self['source'] = val # sourcesrc # --------- @property def sourcesrc(self): """ Sets the source reference on plot.ly for source . The 'sourcesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str """ return self['sourcesrc'] @sourcesrc.setter def sourcesrc(self, val): self['sourcesrc'] = val # target # ------ @property def target(self): """ An integer number `[0..nodes.length - 1]` that represents the target node. The 'target' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray """ return self['target'] @target.setter def target(self, val): self['target'] = val # targetsrc # --------- @property def targetsrc(self): """ Sets the source reference on plot.ly for target . The 'targetsrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str """ return self['targetsrc'] @targetsrc.setter def targetsrc(self, val): self['targetsrc'] = val # value # ----- @property def value(self): """ A numeric value representing the flow volume value. The 'value' property is an array that may be specified as a tuple, list, numpy array, or pandas Series Returns ------- numpy.ndarray """ return self['value'] @value.setter def value(self, val): self['value'] = val # valuesrc # -------- @property def valuesrc(self): """ Sets the source reference on plot.ly for value . The 'valuesrc' property must be specified as a string or as a plotly.grid_objs.Column object Returns ------- str """ return self['valuesrc'] @valuesrc.setter def valuesrc(self, val): self['valuesrc'] = val # property parent name # -------------------- @property def _parent_path_str(self): return 'sankey' # Self properties description # --------------------------- @property def _prop_descriptions(self): return """\ 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 . """ 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