Plotly.Funnel (plotly_ex v0.3.0)

Copy Markdown View Source

Plotly Funnel 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 funnel reference for full descriptions.

  • :alignmentgroup — string
  • :cliponaxis — boolean
  • :connector — map (nested properties)
  • :constraintext — one of: "inside" | "outside" | "both" | "none"

  • :customdata — data array
  • :dx — number
  • :dy — number
  • :hoverinfo — flags: "name" | "x" | "y" | "text" | "percent initial" | "percent previous" | "percent total" | "all" | "none" | "skip"

  • :hoverlabel — map (nested properties)
  • :hovertemplate — string
  • :hovertemplatefallback — any
  • :hovertext — string
  • :ids — data array
  • :insidetextanchor — one of: "end" | "middle" | "start"

  • :insidetextfont — map (nested properties)
  • :legend — string (subplot id)
  • :legendgroup — string
  • :legendgrouptitle — map (nested properties)
  • :legendrank — number
  • :legendwidth — number, 0
  • :marker — map (nested properties)
  • :meta — any
  • :name — string
  • :offset — number
  • :offsetgroup — string
  • :opacity — number, 0–1
  • :orientation — one of: "v" | "h"

  • :outsidetextfont — map (nested properties)
  • :selectedpoints — any
  • :showlegend — boolean
  • :text — string
  • :textangle — number (angle in degrees)
  • :textfont — map (nested properties)
  • :textinfo — flags: "label" | "text" | "percent initial" | "percent previous" | "percent total" | "value" | "none"

  • :textposition — one of: "inside" | "outside" | "auto" | "none"

  • :texttemplate — string
  • :texttemplatefallback — any
  • :uid — string
  • :uirevision — any
  • :visible — one of: true | false | "legendonly"

  • :width — number, 0
  • :x — data array
  • :x0 — any
  • :xaxis — string (subplot id)
  • :xhoverformat — string
  • :xperiod — any
  • :xperiod0 — any
  • :xperiodalignment — one of: "start" | "middle" | "end"

  • :y — data array
  • :y0 — any
  • :yaxis — string (subplot id)
  • :yhoverformat — string
  • :yperiod — any
  • :yperiod0 — any
  • :yperiodalignment — one of: "start" | "middle" | "end"

  • :zorder — integer

Summary

Functions

Funnel chart for sequential stage values. Construct a Funnel trace. Raises ArgumentError on unknown keys.

Functions

new(opts \\ [])

Funnel chart for sequential stage values. Construct a Funnel trace. Raises ArgumentError on unknown keys.