done

lib/python3.11/site-packages/plotly/graph_objs/_sankey.py

@@ -0,0 +1,966 @@
+#                   --- THIS FILE IS AUTO-GENERATED ---
+# Modifications will be overwitten the next time code generation run.
+
+from plotly.basedatatypes import BaseTraceType as _BaseTraceType
+import copy as _copy
+
+
+class Sankey(_BaseTraceType):
+    _parent_path_str = ""
+    _path_str = "sankey"
+    _valid_props = {
+        "arrangement",
+        "customdata",
+        "customdatasrc",
+        "domain",
+        "hoverinfo",
+        "hoverlabel",
+        "ids",
+        "idssrc",
+        "legend",
+        "legendgrouptitle",
+        "legendrank",
+        "legendwidth",
+        "link",
+        "meta",
+        "metasrc",
+        "name",
+        "node",
+        "orientation",
+        "selectedpoints",
+        "stream",
+        "textfont",
+        "type",
+        "uid",
+        "uirevision",
+        "valueformat",
+        "valuesuffix",
+        "visible",
+    }
+
+    @property
+    def arrangement(self):
+        """
+        If value is `snap` (the default), the node arrangement is
+        assisted by automatic snapping of elements to preserve space
+        between nodes specified via `nodepad`. If value is
+        `perpendicular`, the nodes can only move along a line
+        perpendicular to the flow. If value is `freeform`, the nodes
+        can freely move on the plane. If value is `fixed`, the nodes
+        are stationary.
+
+        The 'arrangement' property is an enumeration that may be specified as:
+          - One of the following enumeration values:
+                ['snap', 'perpendicular', 'freeform', 'fixed']
+
+        Returns
+        -------
+        Any
+        """
+        return self["arrangement"]
+
+    @arrangement.setter
+    def arrangement(self, val):
+        self["arrangement"] = val
+
+    @property
+    def customdata(self):
+        """
+        Assigns extra data each datum. This may be useful when
+        listening to hover, click and selection events. Note that,
+        "scatter" traces also appends customdata items in the markers
+        DOM elements
+
+        The 'customdata' property is an array that may be specified as a tuple,
+        list, numpy array, or pandas Series
+
+        Returns
+        -------
+        numpy.ndarray
+        """
+        return self["customdata"]
+
+    @customdata.setter
+    def customdata(self, val):
+        self["customdata"] = val
+
+    @property
+    def customdatasrc(self):
+        """
+        Sets the source reference on Chart Studio Cloud for
+        `customdata`.
+
+        The 'customdatasrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
+
+        Returns
+        -------
+        str
+        """
+        return self["customdatasrc"]
+
+    @customdatasrc.setter
+    def customdatasrc(self, val):
+        self["customdatasrc"] = val
+
+    @property
+    def domain(self):
+        """
+        The 'domain' property is an instance of Domain
+        that may be specified as:
+          - An instance of :class:`plotly.graph_objs.sankey.Domain`
+          - A dict of string/value properties that will be passed
+            to the Domain constructor
+
+        Returns
+        -------
+        plotly.graph_objs.sankey.Domain
+        """
+        return self["domain"]
+
+    @domain.setter
+    def domain(self, val):
+        self["domain"] = val
+
+    @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.
+        Note that this attribute is superseded by `node.hoverinfo` and
+        `node.hoverinfo` for nodes and links respectively.
+
+        The 'hoverinfo' property is a flaglist and may be specified
+        as a string containing:
+          - Any combination of [] joined with '+' characters
+            (e.g. '')
+            OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
+
+        Returns
+        -------
+        Any
+        """
+        return self["hoverinfo"]
+
+    @hoverinfo.setter
+    def hoverinfo(self, val):
+        self["hoverinfo"] = val
+
+    @property
+    def hoverlabel(self):
+        """
+        The 'hoverlabel' property is an instance of Hoverlabel
+        that may be specified as:
+          - An instance of :class:`plotly.graph_objs.sankey.Hoverlabel`
+          - A dict of string/value properties that will be passed
+            to the Hoverlabel constructor
+
+        Returns
+        -------
+        plotly.graph_objs.sankey.Hoverlabel
+        """
+        return self["hoverlabel"]
+
+    @hoverlabel.setter
+    def hoverlabel(self, val):
+        self["hoverlabel"] = val
+
+    @property
+    def ids(self):
+        """
+        Assigns id labels to each datum. These ids for object constancy
+        of data points during animation. Should be an array of strings,
+        not numbers or any other type.
+
+        The 'ids' property is an array that may be specified as a tuple,
+        list, numpy array, or pandas Series
+
+        Returns
+        -------
+        numpy.ndarray
+        """
+        return self["ids"]
+
+    @ids.setter
+    def ids(self, val):
+        self["ids"] = val
+
+    @property
+    def idssrc(self):
+        """
+        Sets the source reference on Chart Studio Cloud for `ids`.
+
+        The 'idssrc' property must be specified as a string or
+        as a plotly.grid_objs.Column object
+
+        Returns
+        -------
+        str
+        """
+        return self["idssrc"]
+
+    @idssrc.setter
+    def idssrc(self, val):
+        self["idssrc"] = val
+
+    @property
+    def legend(self):
+        """
+        Sets the reference to a legend to show this trace in.
+        References to these legends are "legend", "legend2", "legend3",
+        etc. Settings for these legends are set in the layout, under
+        `layout.legend`, `layout.legend2`, etc.
+
+        The 'legend' property is an identifier of a particular
+        subplot, of type 'legend', that may be specified as the string 'legend'
+        optionally followed by an integer >= 1
+        (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.)
+
+        Returns
+        -------
+        str
+        """
+        return self["legend"]
+
+    @legend.setter
+    def legend(self, val):
+        self["legend"] = val
+
+    @property
+    def legendgrouptitle(self):
+        """
+        The 'legendgrouptitle' property is an instance of Legendgrouptitle
+        that may be specified as:
+          - An instance of :class:`plotly.graph_objs.sankey.Legendgrouptitle`
+          - A dict of string/value properties that will be passed
+            to the Legendgrouptitle constructor
+
+        Returns
+        -------
+        plotly.graph_objs.sankey.Legendgrouptitle
+        """
+        return self["legendgrouptitle"]
+
+    @legendgrouptitle.setter
+    def legendgrouptitle(self, val):
+        self["legendgrouptitle"] = val
+
+    @property
+    def legendrank(self):
+        """
+        Sets the legend rank for this trace. Items and groups with
+        smaller ranks are presented on top/left side while with
+        "reversed" `legend.traceorder` they are on bottom/right side.
+        The default legendrank is 1000, so that you can use ranks less
+        than 1000 to place certain items before all unranked items, and
+        ranks greater than 1000 to go after all unranked items. When
+        having unranked or equal rank items shapes would be displayed
+        after traces i.e. according to their order in data and layout.
+
+        The 'legendrank' property is a number and may be specified as:
+          - An int or float
+
+        Returns
+        -------
+        int|float
+        """
+        return self["legendrank"]
+
+    @legendrank.setter
+    def legendrank(self, val):
+        self["legendrank"] = val
+
+    @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
+
+    @property
+    def link(self):
+        """
+        The links of the Sankey plot.
+
+        The 'link' property is an instance of Link
+        that may be specified as:
+          - An instance of :class:`plotly.graph_objs.sankey.Link`
+          - A dict of string/value properties that will be passed
+            to the Link constructor
+
+        Returns
+        -------
+        plotly.graph_objs.sankey.Link
+        """
+        return self["link"]
+
+    @link.setter
+    def link(self, val):
+        self["link"] = val
+
+    @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
+
+    @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
+
+    @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
+
+    @property
+    def node(self):
+        """
+        The nodes of the Sankey plot.
+
+        The 'node' property is an instance of Node
+        that may be specified as:
+          - An instance of :class:`plotly.graph_objs.sankey.Node`
+          - A dict of string/value properties that will be passed
+            to the Node constructor
+
+        Returns
+        -------
+        plotly.graph_objs.sankey.Node
+        """
+        return self["node"]
+
+    @node.setter
+    def node(self, val):
+        self["node"] = val
+
+    @property
+    def orientation(self):
+        """
+        Sets the orientation of the Sankey diagram.
+
+        The 'orientation' property is an enumeration that may be specified as:
+          - One of the following enumeration values:
+                ['v', 'h']
+
+        Returns
+        -------
+        Any
+        """
+        return self["orientation"]
+
+    @orientation.setter
+    def orientation(self, val):
+        self["orientation"] = val
+
+    @property
+    def selectedpoints(self):
+        """
+        Array containing integer indices of selected points. Has an
+        effect only for traces that support selections. Note that an
+        empty array means an empty selection where the `unselected` are
+        turned on for all points, whereas, any other non-array values
+        means no selection all where the `selected` and `unselected`
+        styles have no effect.
+
+        The 'selectedpoints' property accepts values of any type
+
+        Returns
+        -------
+        Any
+        """
+        return self["selectedpoints"]
+
+    @selectedpoints.setter
+    def selectedpoints(self, val):
+        self["selectedpoints"] = val
+
+    @property
+    def stream(self):
+        """
+        The 'stream' property is an instance of Stream
+        that may be specified as:
+          - An instance of :class:`plotly.graph_objs.sankey.Stream`
+          - A dict of string/value properties that will be passed
+            to the Stream constructor
+
+        Returns
+        -------
+        plotly.graph_objs.sankey.Stream
+        """
+        return self["stream"]
+
+    @stream.setter
+    def stream(self, val):
+        self["stream"] = val
+
+    @property
+    def textfont(self):
+        """
+        Sets the font for node labels
+
+        The 'textfont' property is an instance of Textfont
+        that may be specified as:
+          - An instance of :class:`plotly.graph_objs.sankey.Textfont`
+          - A dict of string/value properties that will be passed
+            to the Textfont constructor
+
+        Returns
+        -------
+        plotly.graph_objs.sankey.Textfont
+        """
+        return self["textfont"]
+
+    @textfont.setter
+    def textfont(self, val):
+        self["textfont"] = val
+
+    @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
+
+    @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
+
+    @property
+    def valueformat(self):
+        """
+        Sets the value 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.
+
+        The 'valueformat' property is a string and must be specified as:
+          - A string
+          - A number that will be converted to a string
+
+        Returns
+        -------
+        str
+        """
+        return self["valueformat"]
+
+    @valueformat.setter
+    def valueformat(self, val):
+        self["valueformat"] = val
+
+    @property
+    def valuesuffix(self):
+        """
+        Adds a unit to follow the value in the hover tooltip. Add a
+        space if a separation is necessary from the value.
+
+        The 'valuesuffix' property is a string and must be specified as:
+          - A string
+          - A number that will be converted to a string
+
+        Returns
+        -------
+        str
+        """
+        return self["valuesuffix"]
+
+    @valuesuffix.setter
+    def valuesuffix(self, val):
+        self["valuesuffix"] = val
+
+    @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
+
+    @property
+    def type(self):
+        return self._props["type"]
+
+    @property
+    def _prop_descriptions(self):
+        return """\
+        arrangement
+            If value is `snap` (the default), the node arrangement
+            is assisted by automatic snapping of elements to
+            preserve space between nodes specified via `nodepad`.
+            If value is `perpendicular`, the nodes can only move
+            along a line perpendicular to the flow. If value is
+            `freeform`, the nodes can freely move on the plane. If
+            value is `fixed`, the nodes are stationary.
+        customdata
+            Assigns extra data each datum. This may be useful when
+            listening to hover, click and selection events. Note
+            that, "scatter" traces also appends customdata items in
+            the markers DOM elements
+        customdatasrc
+            Sets the source reference on Chart Studio Cloud for
+            `customdata`.
+        domain
+            :class:`plotly.graph_objects.sankey.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. Note that this attribute is
+            superseded by `node.hoverinfo` and `node.hoverinfo` for
+            nodes and links respectively.
+        hoverlabel
+            :class:`plotly.graph_objects.sankey.Hoverlabel`
+            instance or dict with compatible properties
+        ids
+            Assigns id labels to each datum. These ids for object
+            constancy of data points during animation. Should be an
+            array of strings, not numbers or any other type.
+        idssrc
+            Sets the source reference on Chart Studio Cloud for
+            `ids`.
+        legend
+            Sets the reference to a legend to show this trace in.
+            References to these legends are "legend", "legend2",
+            "legend3", etc. Settings for these legends are set in
+            the layout, under `layout.legend`, `layout.legend2`,
+            etc.
+        legendgrouptitle
+            :class:`plotly.graph_objects.sankey.Legendgrouptitle`
+            instance or dict with compatible properties
+        legendrank
+            Sets the legend rank for this trace. Items and groups
+            with smaller ranks are presented on top/left side while
+            with "reversed" `legend.traceorder` they are on
+            bottom/right side. The default legendrank is 1000, so
+            that you can use ranks less than 1000 to place certain
+            items before all unranked items, and ranks greater than
+            1000 to go after all unranked items. When having
+            unranked or equal rank items shapes would be displayed
+            after traces i.e. according to their order in data and
+            layout.
+        legendwidth
+            Sets the width (in px or fraction) of the legend for
+            this trace.
+        link
+            The links of the Sankey plot.
+        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.
+        node
+            The nodes of the Sankey plot.
+        orientation
+            Sets the orientation of the Sankey diagram.
+        selectedpoints
+            Array containing integer indices of selected points.
+            Has an effect only for traces that support selections.
+            Note that an empty array means an empty selection where
+            the `unselected` are turned on for all points, whereas,
+            any other non-array values means no selection all where
+            the `selected` and `unselected` styles have no effect.
+        stream
+            :class:`plotly.graph_objects.sankey.Stream` instance or
+            dict with compatible properties
+        textfont
+            Sets the font for node 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.
+        valueformat
+            Sets the value 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.
+        valuesuffix
+            Adds a unit to follow the value in the hover tooltip.
+            Add a space if a separation is necessary from the
+            value.
+        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,
+        customdata=None,
+        customdatasrc=None,
+        domain=None,
+        hoverinfo=None,
+        hoverlabel=None,
+        ids=None,
+        idssrc=None,
+        legend=None,
+        legendgrouptitle=None,
+        legendrank=None,
+        legendwidth=None,
+        link=None,
+        meta=None,
+        metasrc=None,
+        name=None,
+        node=None,
+        orientation=None,
+        selectedpoints=None,
+        stream=None,
+        textfont=None,
+        uid=None,
+        uirevision=None,
+        valueformat=None,
+        valuesuffix=None,
+        visible=None,
+        **kwargs,
+    ):
+        """
+        Construct a new Sankey object
+
+        Sankey plots for network flow data analysis. The nodes are
+        specified in `nodes` and the links between sources and targets
+        in `links`. The colors are set in `nodes[i].color` and
+        `links[i].color`, otherwise defaults are used.
+
+        Parameters
+        ----------
+        arg
+            dict of properties compatible with this constructor or
+            an instance of :class:`plotly.graph_objs.Sankey`
+        arrangement
+            If value is `snap` (the default), the node arrangement
+            is assisted by automatic snapping of elements to
+            preserve space between nodes specified via `nodepad`.
+            If value is `perpendicular`, the nodes can only move
+            along a line perpendicular to the flow. If value is
+            `freeform`, the nodes can freely move on the plane. If
+            value is `fixed`, the nodes are stationary.
+        customdata
+            Assigns extra data each datum. This may be useful when
+            listening to hover, click and selection events. Note
+            that, "scatter" traces also appends customdata items in
+            the markers DOM elements
+        customdatasrc
+            Sets the source reference on Chart Studio Cloud for
+            `customdata`.
+        domain
+            :class:`plotly.graph_objects.sankey.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. Note that this attribute is
+            superseded by `node.hoverinfo` and `node.hoverinfo` for
+            nodes and links respectively.
+        hoverlabel
+            :class:`plotly.graph_objects.sankey.Hoverlabel`
+            instance or dict with compatible properties
+        ids
+            Assigns id labels to each datum. These ids for object
+            constancy of data points during animation. Should be an
+            array of strings, not numbers or any other type.
+        idssrc
+            Sets the source reference on Chart Studio Cloud for
+            `ids`.
+        legend
+            Sets the reference to a legend to show this trace in.
+            References to these legends are "legend", "legend2",
+            "legend3", etc. Settings for these legends are set in
+            the layout, under `layout.legend`, `layout.legend2`,
+            etc.
+        legendgrouptitle
+            :class:`plotly.graph_objects.sankey.Legendgrouptitle`
+            instance or dict with compatible properties
+        legendrank
+            Sets the legend rank for this trace. Items and groups
+            with smaller ranks are presented on top/left side while
+            with "reversed" `legend.traceorder` they are on
+            bottom/right side. The default legendrank is 1000, so
+            that you can use ranks less than 1000 to place certain
+            items before all unranked items, and ranks greater than
+            1000 to go after all unranked items. When having
+            unranked or equal rank items shapes would be displayed
+            after traces i.e. according to their order in data and
+            layout.
+        legendwidth
+            Sets the width (in px or fraction) of the legend for
+            this trace.
+        link
+            The links of the Sankey plot.
+        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.
+        node
+            The nodes of the Sankey plot.
+        orientation
+            Sets the orientation of the Sankey diagram.
+        selectedpoints
+            Array containing integer indices of selected points.
+            Has an effect only for traces that support selections.
+            Note that an empty array means an empty selection where
+            the `unselected` are turned on for all points, whereas,
+            any other non-array values means no selection all where
+            the `selected` and `unselected` styles have no effect.
+        stream
+            :class:`plotly.graph_objects.sankey.Stream` instance or
+            dict with compatible properties
+        textfont
+            Sets the font for node 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.
+        valueformat
+            Sets the value 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.
+        valuesuffix
+            Adds a unit to follow the value in the hover tooltip.
+            Add a space if a separation is necessary from the
+            value.
+        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
+        -------
+        Sankey
+        """
+        super().__init__("sankey")
+        if "_parent" in kwargs:
+            self._parent = kwargs["_parent"]
+            return
+
+        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
+constructor must be a dict or
+an instance of :class:`plotly.graph_objs.Sankey`""")
+
+        self._skip_invalid = kwargs.pop("skip_invalid", False)
+        self._validate = kwargs.pop("_validate", True)
+
+        self._set_property("arrangement", arg, arrangement)
+        self._set_property("customdata", arg, customdata)
+        self._set_property("customdatasrc", arg, customdatasrc)
+        self._set_property("domain", arg, domain)
+        self._set_property("hoverinfo", arg, hoverinfo)
+        self._set_property("hoverlabel", arg, hoverlabel)
+        self._set_property("ids", arg, ids)
+        self._set_property("idssrc", arg, idssrc)
+        self._set_property("legend", arg, legend)
+        self._set_property("legendgrouptitle", arg, legendgrouptitle)
+        self._set_property("legendrank", arg, legendrank)
+        self._set_property("legendwidth", arg, legendwidth)
+        self._set_property("link", arg, link)
+        self._set_property("meta", arg, meta)
+        self._set_property("metasrc", arg, metasrc)
+        self._set_property("name", arg, name)
+        self._set_property("node", arg, node)
+        self._set_property("orientation", arg, orientation)
+        self._set_property("selectedpoints", arg, selectedpoints)
+        self._set_property("stream", arg, stream)
+        self._set_property("textfont", arg, textfont)
+        self._set_property("uid", arg, uid)
+        self._set_property("uirevision", arg, uirevision)
+        self._set_property("valueformat", arg, valueformat)
+        self._set_property("valuesuffix", arg, valuesuffix)
+        self._set_property("visible", arg, visible)
+
+        self._props["type"] = "sankey"
+        arg.pop("type", None)
+        self._process_kwargs(**dict(arg, **kwargs))
+        self._skip_invalid = False