Struct Sankey

pub struct Sankey<'a> { /* private fields */ }

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.

Implementations

impl<'a> Sankey<'a>

pub fn visible(&mut self, visible: Visible) -> &mut 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).

default: true

pub fn name(&mut self, name: &'a str) -> &mut Self

Sets the trace name. The trace name appear as the legend item and on hover.

pub fn uid(&mut self, uid: &'a str) -> &mut Self

Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

pub fn ids(&mut self, ids: &'a [&'a str]) -> &mut 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.

pub fn meta(&mut self, meta: Any) -> &mut 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.

pub fn selectedpoints(&mut self, selectedpoints: Any) -> &mut 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.

pub fn stream(&mut self) -> &mut Stream<'a>

pub fn uirevision(&mut self, uirevision: Any) -> &mut 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.

pub fn hoverinfo(&mut self) -> &mut 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.

default: all

pub fn hoverlabel(&mut self) -> &mut Hoverlabel<'a>

pub fn domain(&mut self) -> &mut Domain<'a>

pub fn orientation(&mut self, orientation: Orientation) -> &mut Self

Sets the orientation of the Sankey diagram.

default: h

pub fn valueformat(&mut self, valueformat: &'a str) -> &mut Self

Sets the value formatting rule using d3 formatting mini-language which is similar to those of Python. See https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

default: .3s

pub fn valuesuffix(&mut self, valuesuffix: &'a str) -> &mut Self

Adds a unit to follow the value in the hover tooltip. Add a space if a separation is necessary from the value.

default: ``

pub fn arrangement(&mut self, arrangement: Arrangement) -> &mut 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.

default: snap

pub fn textfont(&mut self) -> &mut Textfont<'a>

Sets the font for node labels

pub fn node(&mut self) -> &mut Node<'a>

The nodes of the Sankey plot.

pub fn link(&mut self) -> &mut Link<'a>

The links of the Sankey plot.

pub fn idssrc(&mut self, idssrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for ids .

pub fn customdatasrc(&mut self, customdatasrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for customdata .

pub fn metasrc(&mut self, metasrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for meta .

Trait Implementations

impl<'a> Default for Sankey<'a>

fn default() -> Sankey<'a>

Returns the “default value” for a type.

impl<'a> Serialize for Sankey<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.