Class SpiderChart <CursorPointMarkerType, CursorResultTableBackgroundType >

Index

Properties

Methods

Properties

axisScale

axisScale: Scale

engine

engine: PublicEngine

pixelScale

pixelScale: Vec2<Scale>

uiScale

uiScale: Vec2<Scale>

Methods

addAxis

addAxis(tagOrAxis: string): this

Parameters
- tagOrAxis: string
Returns this

Object itself

addLegendBox

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

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

LegendBox that fulfills interfaces: UIElementType (typeparam) and UIElement

addSeries

addSeries(pointShape: PointShape): SpiderSeries

Parameters
- Default value pointShape: PointShape
Returns SpiderSeries

SpiderSeries instance

addUIElement

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

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

Object that fulfills interfaces: UIElementType (typeparam) and UIElement

disableAnimations

disableAnimations(): this

Returns this

Chart itself for fluent interface.

dispose

dispose(): this

Returns this

Object itself for fluent interface

formatValue

formatValue(value: number): string

Parameters
- value: number
Returns string

Value formated to string

getAnimationsEnabled

getAnimationsEnabled(): boolean

Returns boolean

getAutoAxis

getAutoAxis(): boolean

Returns boolean

Automatic axis creation state

getAxisLabelFont

getAxisLabelFont(): FontSettings

Returns FontSettings

FontSettings object

getAxisLabelPadding

getAxisLabelPadding(): pixel

Returns pixel

Padding in pixels

getAxisLabelStyle

getAxisLabelStyle(): FillStyle

Returns FillStyle

FillStyle object

getAxisScrollStrategy

getAxisScrollStrategy(): AxisScrollStrategy | undefined

Returns AxisScrollStrategy | undefined

getAxisStyle

getAxisStyle(): SolidLine

Returns SolidLine

SolidLine object

getBackgroundFillStyle

getBackgroundFillStyle(): FillStyle

Returns FillStyle

FillStyle

getBackgroundStrokeStyle

getBackgroundStrokeStyle(): LineStyle

Returns LineStyle

LineStyle

getChartBackgroundFillStyle

getChartBackgroundFillStyle(): FillStyle

Returns FillStyle

FillStyle

getChartBackgroundStrokeStyle

getChartBackgroundStrokeStyle(): LineStyle

Returns LineStyle

LineStyle

getEdgeValue

getEdgeValue(): number

Returns number

Value at edges of chart

getMinimumSize

getMinimumSize(): Point | undefined

Returns Point | undefined

Vec2 minimum size or undefined if unimplemented

getMouseInteractions

getMouseInteractions(): boolean

Returns boolean

Boolean flag

getNibLength

getNibLength(): number

Returns number

Length of nibs in pixels

getNibStyle

getNibStyle(): SolidLine

Returns SolidLine

SolidLine object

getOriginValue

getOriginValue(): number

Returns number

Value at center of chart

getPadding

getPadding(): Margin

Returns Margin

Padding datastructure

getScaleLabelFont

getScaleLabelFont(): FontSettings

Returns FontSettings

FontSettings

getScaleLabelPadding

getScaleLabelPadding(): pixel

Returns pixel

Padding in pixels

getScaleLabelStyle

getScaleLabelStyle(): FillStyle

Returns FillStyle

FillStyle object

getSeries

getSeries(): SpiderSeries[]

Returns SpiderSeries[]

series

getSeriesCount

getSeriesCount(): number

Returns number

Amount of series inside chart

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

getWebCount

getWebCount(): number

Returns number

Count of web lines

getWebMode

getWebMode(): SpiderWebMode

Returns SpiderWebMode

Enum SpiderWebMode

getWebStyle

getWebStyle(): LineStyle

Returns LineStyle

LineStyle object

hasAxis

hasAxis(tag: string): boolean

Parameters
- tag: string
Returns boolean

True if axis exists, false if not.

offChartBackgroundMouseClick

offChartBackgroundMouseClick(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseDoubleClick

offChartBackgroundMouseDoubleClick(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseDown

offChartBackgroundMouseDown(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseDrag

offChartBackgroundMouseDrag(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseDragStart

offChartBackgroundMouseDragStart(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseDragStop

offChartBackgroundMouseDragStop(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseEnter

offChartBackgroundMouseEnter(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseLeave

offChartBackgroundMouseLeave(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseMove

offChartBackgroundMouseMove(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseUp

offChartBackgroundMouseUp(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundMouseWheel

offChartBackgroundMouseWheel(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundTouchEnd

offChartBackgroundTouchEnd(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundTouchMove

offChartBackgroundTouchMove(token: Token): boolean

Parameters
- token: Token
Returns boolean

offChartBackgroundTouchStart

offChartBackgroundTouchStart(token: Token): boolean

Parameters
- token: Token
Returns boolean

offResize

offResize(token: Token): boolean

Parameters
- token: Token
Returns boolean

True if the listener is successfully removed and false if it is not found

onChartBackgroundMouseClick

onChartBackgroundMouseClick(handler: MouseEventHandler<this>): Token

Parameters
- handler: MouseEventHandler<this>
Returns Token

onChartBackgroundMouseDoubleClick

onChartBackgroundMouseDoubleClick(handler: MouseEventHandler<this>): Token

Parameters
- handler: MouseEventHandler<this>
Returns Token

onChartBackgroundMouseDown

onChartBackgroundMouseDown(handler: MouseEventHandler<this>): Token

Parameters
- handler: MouseEventHandler<this>
Returns Token

onChartBackgroundMouseDrag

onChartBackgroundMouseDrag(handler: MouseDragEventHandler<this>): Token

Parameters
- handler: MouseDragEventHandler<this>
Returns Token

onChartBackgroundMouseDragStart

onChartBackgroundMouseDragStart(handler: MouseDragStartEventHandler<this>): Token

Parameters
- handler: MouseDragStartEventHandler<this>
Returns Token

onChartBackgroundMouseDragStop

onChartBackgroundMouseDragStop(handler: MouseDragStopEventHandler<this>): Token

Parameters
- handler: MouseDragStopEventHandler<this>
Returns Token

onChartBackgroundMouseEnter

onChartBackgroundMouseEnter(handler: MouseEventHandler<this>): Token

Parameters
- handler: MouseEventHandler<this>
Returns Token

onChartBackgroundMouseLeave

onChartBackgroundMouseLeave(handler: MouseEventHandler<this>): Token

Parameters
- handler: MouseEventHandler<this>
Returns Token

onChartBackgroundMouseMove

onChartBackgroundMouseMove(handler: MouseEventHandler<this>): Token

Parameters
- handler: MouseEventHandler<this>
Returns Token

onChartBackgroundMouseUp

onChartBackgroundMouseUp(handler: MouseEventHandler<this>): Token

Parameters
- handler: MouseEventHandler<this>
Returns Token

onChartBackgroundMouseWheel

onChartBackgroundMouseWheel(handler: MouseWheelEventHandler<this>): Token

Parameters
- handler: MouseWheelEventHandler<this>
Returns Token

onChartBackgroundTouchEnd

onChartBackgroundTouchEnd(handler: TouchEventHandler<this>): Token

Parameters
- handler: TouchEventHandler<this>
Returns Token

onChartBackgroundTouchMove

onChartBackgroundTouchMove(handler: TouchEventHandler<this>): Token

Parameters
- handler: TouchEventHandler<this>
Returns Token

onChartBackgroundTouchStart

onChartBackgroundTouchStart(handler: TouchEventHandler<this>): Token

Parameters
- handler: TouchEventHandler<this>
Returns Token

onResize

onResize(handler: function): Token

Parameters
- handler: function
  - - Parameters
      - obj: this
      - width: pixel
      - height: pixel
      - engineWidth: pixel
      - engineHeight: pixel
      Returns void
Returns Token

Token of subscription

removeAxis

removeAxis(tagOrAxis: string | SpiderAxis): this

Parameters
- tagOrAxis: string | SpiderAxis
Returns this

Object itself for fluent interface

restoreAxis

restoreAxis(axis: SpiderAxis): this

Parameters
- axis: SpiderAxis
Returns this

This.

saveToFile

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

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

setAnimationsEnabled

setAnimationsEnabled(animationsEnabled: boolean): this

Parameters
- animationsEnabled: boolean
Returns this

setAutoAxis

setAutoAxis(createAxesAutomatically: boolean): this

Parameters
- createAxesAutomatically: boolean
Returns this

Object itself for fluent interface

setAxisInterval

setAxisInterval(edge: number, center: number): this

Parameters
- edge: number
- Default value center: number
Returns this

Object itself

setAxisLabelFont

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

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

Object itself

setAxisLabelPadding

setAxisLabelPadding(padding: pixel): this

Parameters
- padding: pixel
Returns this

Object itself

setAxisLabelStrategy

setAxisLabelStrategy(axisLabelStrategy: SpiderAxisLabelStrategy): this

Parameters
- Optional axisLabelStrategy: SpiderAxisLabelStrategy
Returns this

Object itself

setAxisLabelStyle

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

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

Object itself

setAxisScrollStrategy

setAxisScrollStrategy(scrollStrategy: AxisScrollStrategy): this

Parameters
- Optional scrollStrategy: AxisScrollStrategy
Returns this

Object itself

setAxisStyle

setAxisStyle(value: SolidLine | ImmutableMutator<SolidLine>): this

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

Object itself

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

setChartBackgroundStrokeStyle

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

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

Object itself

setMouseInteractions

setMouseInteractions(enabled: boolean): this

Parameters
- enabled: boolean
Returns this

Object itself

setNibLength

setNibLength(length: number): this

Parameters
- length: number
Returns this

setNibStyle

setNibStyle(value: SolidLine | ImmutableMutator<SolidLine>): this

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

Object itself

setPadding

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

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

Object itself

setScaleLabelFont

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

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

Object itself

setScaleLabelPadding

setScaleLabelPadding(padding: pixel): this

Parameters
- padding: pixel
Returns this

Object itself

setScaleLabelStrategy

setScaleLabelStrategy(scaleLabelStrategy: SpiderScaleLabelStrategy): this

Parameters
- Optional scaleLabelStrategy: SpiderScaleLabelStrategy
Returns this

Object itself

setScaleLabelStyle

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

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

setSeriesHighlightOnHover

setSeriesHighlightOnHover(state: boolean): this

Parameters
- state: boolean
Returns this

Object itself for fluent interface.

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

setWebCount

setWebCount(webCount: number): this

Parameters
- webCount: number
Returns this

Object itself

setWebMode

setWebMode(webMode: SpiderWebMode): this

Parameters
- webMode: SpiderWebMode
Returns this

Object itself

setWebStyle

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

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

Object itself

solveNearest

solveNearest(location: Point | undefined): undefined | CursorPoint

Parameters
- Default value location: Point | undefined
Returns undefined | CursorPoint

Undefined or data-structure for positioning of markers (and cursors)