Plotly.Candlestick (plotly_ex v0.3.0)

Copy Markdown View Source

Plotly Candlestick 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 candlestick reference for full descriptions.

  • :close — data array
  • :customdata — data array
  • :decreasing — map (nested properties)
  • :high — data array
  • :hoverinfo — flags: "x" | "y" | "z" | "text" | "name" | "all" | "none" | "skip"

  • :hoverlabel — map (nested properties)
  • :hovertemplate — string
  • :hovertemplatefallback — any
  • :hovertext — string
  • :ids — data array
  • :increasing — map (nested properties)
  • :legend — string (subplot id)
  • :legendgroup — string
  • :legendgrouptitle — map (nested properties)
  • :legendrank — number
  • :legendwidth — number, 0
  • :line — map (nested properties)
  • :low — data array
  • :meta — any
  • :name — string
  • :opacity — number, 0–1
  • :open — data array
  • :selectedpoints — any
  • :showlegend — boolean
  • :text — string
  • :uid — string
  • :uirevision — any
  • :visible — one of: true | false | "legendonly"

  • :whiskerwidth — number, 0–1
  • :x — data array
  • :xaxis — string (subplot id)
  • :xcalendar — one of: "chinese" | "coptic" | "discworld" | "ethiopian" | "gregorian" | "hebrew" | "islamic" | "jalali" | "julian" | "mayan" | "nanakshahi" | "nepali" | "persian" | "taiwan" | "thai" | "ummalqura"

  • :xhoverformat — string
  • :xperiod — any
  • :xperiod0 — any
  • :xperiodalignment — one of: "start" | "middle" | "end"

  • :yaxis — string (subplot id)
  • :yhoverformat — string
  • :zorder — integer

Summary

Functions

OHLC financial chart with filled candles. Construct a Candlestick trace. Raises ArgumentError on unknown keys.

Functions

new(opts \\ [])

OHLC financial chart with filled candles. Construct a Candlestick trace. Raises ArgumentError on unknown keys.