Class ZoomBandChart

Properties

attachedAxis

attachedAxis: Axis

band

band: Band

engine

engine: PublicEngine

Methods

addLegendBox

addLegendBox(builder: UIElementBuilder<UIElementType>, scale: Vec2<Scale>): UIElementType & UIElement

Type parameters
- UIElementType: UIPart
Parameters
- Optional builder: UIElementBuilder<UIElementType>
- Optional scale: Vec2<Scale>
Returns UIElementType & UIElement

LegendBox that fulfills interfaces: UIElementType (typeparam) and UIElement

addUIElement

addUIElement(uiElementBuilder: UIElementBuilder<UIElementType>, scale: Vec2<Scale>): UIElementType & UIElement

Type parameters
- UIElementType: UIPart
Parameters
- Optional uiElementBuilder: UIElementBuilder<UIElementType>
- Optional scale: Vec2<Scale>
Returns UIElementType & UIElement

Object that fulfills interfaces: UIElementType (typeparam) and UIElement

dispose

dispose(): this

Returns this

Object itself for fluent interface

disposeSeries

disposeSeries(series: ZoomBandChartSupportedSeries): this

Parameters
- series: ZoomBandChartSupportedSeries
Returns this

Object itself.

getBackgroundFillStyle

getBackgroundFillStyle(): FillStyle

Returns FillStyle

FillStyle

getBackgroundStrokeStyle

getBackgroundStrokeStyle(): LineStyle

Returns LineStyle

LineStyle

getChartBackgroundFillStyle

getChartBackgroundFillStyle(): FillStyle

Returns FillStyle

FillStyle

getChartBackgroundStroke

getChartBackgroundStroke(): LineStyle

Returns LineStyle

LineStyle

getDefaultAxisX

getDefaultAxisX(): Axis

Returns Axis

Axis

getDefaultAxisY

getDefaultAxisY(): Axis

Returns Axis

Axis

getMinimumSize

getMinimumSize(): Point | undefined

Returns Point | undefined

Point minimum size or undefined if unimplemented

getPadding

getPadding(): Margin

Returns Margin

Padding datastructure

getTitle

getTitle(): string

Returns string

Chart title as a string.

getTitleFillStyle

getTitleFillStyle(): FillStyle

Returns FillStyle

FillStyle object

getTitleFont

getTitleFont(): FontSettings

Returns FontSettings

FontSettings object

getTitleMarginBottom

getTitleMarginBottom(): number

Returns number

Padding after Chart title

getTitleMarginTop

getTitleMarginTop(): number

Returns number

Padding before Chart title

saveToFile

saveToFile(fileName: string, type: undefined | string, encoderOptions: undefined | number): this

Parameters
- fileName: string
- Optional type: undefined | string
- Optional encoderOptions: undefined | number
Returns this

setBackgroundFillStyle

setBackgroundFillStyle(value: FillStyle | ImmutableMutator<FillStyle>): this

Parameters
- value: FillStyle | ImmutableMutator<FillStyle>
Returns this

Object itself

setBackgroundStrokeStyle

setBackgroundStrokeStyle(value: LineStyle | ImmutableMutator<LineStyle>): this

Parameters
- value: LineStyle | ImmutableMutator<LineStyle>
Returns this

Object itself

setChartBackgroundFillStyle

setChartBackgroundFillStyle(fillStyle: FillStyle | ImmutableMutator<FillStyle>): this

Parameters
- fillStyle: FillStyle | ImmutableMutator<FillStyle>
Returns this

Object itself

setChartBackgroundStroke

setChartBackgroundStroke(value: LineStyle | ImmutableMutator<LineStyle>): this

Parameters
- value: LineStyle | ImmutableMutator<LineStyle>
Returns this

Object itself

setPadding

setPadding(padding: Partial<Margin> | number): this

Parameters
- padding: Partial<Margin> | number
Returns this

Object itself for fluent interface

setSeriesStyle

setSeriesStyle(styler: ZoomBandChartSeriesStyler): this

Parameters
- styler: ZoomBandChartSeriesStyler
Returns this

setTitle

setTitle(title: string): this

Parameters
- title: string
Returns this

Object itself for fluent interface.

setTitleFillStyle

setTitleFillStyle(value: FillStyle | ImmutableMutator<FillStyle>): this

Parameters
- value: FillStyle | ImmutableMutator<FillStyle>
Returns this

Chart itself

setTitleFont

setTitleFont(value: FontSettings | ImmutableMutator<FontSettings>): this

Parameters
- value: FontSettings | ImmutableMutator<FontSettings>
Returns this

Chart itself

setTitleMarginBottom

setTitleMarginBottom(marginPixels: pixel): this

Parameters
- marginPixels: pixel
Returns this

Chart itself for fluent interface

setTitleMarginTop

setTitleMarginTop(marginPixels: pixel): this

Parameters
- marginPixels: pixel
Returns this

Chart itself for fluent interface