Plotly.Image (plotly_ex v0.3.0)

Copy Markdown View Source

Plotly Image 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 image reference for full descriptions.

  • :colormodel — one of: "rgb" | "rgba" | "rgba256" | "hsl" | "hsla"

  • :customdata — data array
  • :dx — number
  • :dy — number
  • :hoverinfo — flags: "x" | "y" | "z" | "color" | "name" | "text" | "all" | "none" | "skip"

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

  • :x0 — any
  • :xaxis — string (subplot id)
  • :y0 — any
  • :yaxis — string (subplot id)
  • :z — data array
  • :zmax — any
  • :zmin — any
  • :zorder — integer
  • :zsmooth — one of: "fast" | false

Summary

Functions

Construct a Image trace. Raises ArgumentError on unknown keys.

Functions

new(opts \\ [])

Construct a Image trace. Raises ArgumentError on unknown keys.