Plotly.Treemap (plotly_ex v0.3.0)

Copy Markdown View Source

Plotly Treemap 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 treemap reference for full descriptions.

  • :branchvalues — one of: "remainder" | "total"

  • :count — flags: "branches" | "leaves"

  • :customdata — data array
  • :domain — map (nested properties)
  • :hoverinfo — flags: "label" | "text" | "value" | "name" | "current path" | "percent root" | "percent entry" | "percent parent" | "all" | "none" | "skip"

  • :hoverlabel — map (nested properties)
  • :hovertemplate — string
  • :hovertemplatefallback — any
  • :hovertext — string
  • :ids — data array
  • :insidetextfont — map (nested properties)
  • :labels — data array
  • :legend — string (subplot id)
  • :legendgrouptitle — map (nested properties)
  • :legendrank — number
  • :legendwidth — number, 0
  • :level — any
  • :marker — map (nested properties)
  • :maxdepth — integer
  • :meta — any
  • :name — string
  • :opacity — number, 0–1
  • :outsidetextfont — map (nested properties)
  • :parents — data array
  • :pathbar — map (nested properties)
  • :root — map (nested properties)
  • :sort — boolean
  • :text — data array
  • :textfont — map (nested properties)
  • :textinfo — flags: "label" | "text" | "value" | "current path" | "percent root" | "percent entry" | "percent parent" | "none"

  • :textposition — one of: "top left" | "top center" | "top right" | "middle left" | "middle center" | "middle right" | "bottom left" | "bottom center" | "bottom right"

  • :texttemplate — string
  • :texttemplatefallback — any
  • :tiling — map (nested properties)
  • :uid — string
  • :uirevision — any
  • :values — data array
  • :visible — one of: true | false | "legendonly"

Summary

Functions

Rectangular hierarchy chart (nested rectangles). Construct a Treemap trace. Raises ArgumentError on unknown keys.

Functions

new(opts \\ [])

Rectangular hierarchy chart (nested rectangles). Construct a Treemap trace. Raises ArgumentError on unknown keys.