Plotly.Sankey (plotly_ex v0.3.0)

Copy Markdown View Source

Plotly Sankey trace struct. All top-level trace properties are struct fields. Unknown keys raise ArgumentError at construction time.

Nested properties (marker, line, etc.) accept plain maps or keyword lists — keyword lists are automatically normalised to maps before JSON encoding.

Fields

See the Plotly sankey reference for full descriptions.

  • :arrangement — one of: "snap" | "perpendicular" | "freeform" | "fixed"

  • :customdata — data array
  • :direction — one of: "forward" | "reversed"

  • :domain — map (nested properties)
  • :hoverinfo — flags: "all" | "none" | "skip"

  • :hoverlabel — map (nested properties)
  • :ids — data array
  • :legend — string (subplot id)
  • :legendgrouptitle — map (nested properties)
  • :legendrank — number
  • :legendwidth — number, 0
  • :link — map (nested properties)
  • :meta — any
  • :name — string
  • :node — map (nested properties)
  • :orientation — one of: "v" | "h"

  • :selectedpoints — any
  • :textfont — map (nested properties)
  • :uid — string
  • :uirevision — any
  • :valueformat — string
  • :valuesuffix — string
  • :visible — one of: true | false | "legendonly"

Summary

Functions

Flow diagram: quantities between source/target nodes. Construct a Sankey trace. Raises ArgumentError on unknown keys.

Functions

new(opts \\ [])

Flow diagram: quantities between source/target nodes. Construct a Sankey trace. Raises ArgumentError on unknown keys.