Class AreaPlot

Area plot

Hierarchy (view full)

Plot<AreaPlotOptions>
- AreaPlot

Index

Constructors

Properties

data id options range scale

Accessors

Methods

plot setData setOption setOptions setRange updateDynamicScale

Constructors

constructor

new AreaPlot(id, options?): AreaPlot
Parameters
- id: string | number
- options: AreaPlotOptions = ...
Returns AreaPlot
Inherited from Plot.constructor
- Defined in plots/plot.ts:16

Properties

data

data: any

id

id: string | number

options

options: AreaPlotOptions

range

range: Range

scale

scale: Scale

Accessors

offset

get offset(): number
Returns number
Inherited from Plot.offset
- Defined in plots/plot.ts:29

Methods

plot

plot(ctx, scale): void
Renders area plot to canvas context
Parameters
- ctx: CanvasRenderingContext2D
  canvas context instance
- scale: Scale
  y-scale
Returns void
Overrides Plot.plot
- Defined in plots/area-plot.ts:15

setData

setData(data, scale?, plotOptions?): Plot<PlotOptions>
Sets the plot data
Parameters
- data: any
  Data for all plots on track
- Optional scale: Scale
- Optional plotOptions: Map<string | number, AreaPlotOptions>
Returns Plot<PlotOptions>
Inherited from Plot.setData
- Defined in plots/plot.ts:48

setOption

setOption(key, value): Plot<PlotOptions>
Set option
Parameters
- key: string
- value: any
Returns Plot<PlotOptions>
Inherited from Plot.setOption
- Defined in plots/plot.ts:64

setOptions

setOptions(options): Plot<PlotOptions>
Set multiple options
Parameters
- options: any
  object containing options to set
Returns Plot<PlotOptions>
Inherited from Plot.setOptions
- Defined in plots/plot.ts:84

setRange

setRange(range): Plot<PlotOptions>
Set range of plot scale
Parameters
- range: Range
Returns Plot<PlotOptions>
Inherited from Plot.setRange
- Defined in plots/plot.ts:36

updateDynamicScale

updateDynamicScale(data, graphOptions): void
Parameters
- data: any
- graphOptions: any
Returns void
Inherited from Plot.updateDynamicScale
- Defined in plots/plot.ts:91

Generated using TypeDoc