Class SpiderSeries <CursorPointInterface >

Index

Properties

scale

Methods

Properties

scale

scale: Vec2<Scale>

Methods

addPoints

addPoints(points: SpiderPoint[]): this

Parameters
- Rest points: SpiderPoint[]
Returns this

Object itself

attach

attach(entry: LegendBoxEntry, disposeOnClick: boolean): this

Parameters
- entry: LegendBoxEntry
- Default value disposeOnClick: boolean
Returns this

Series itself for fluent interface

dispose

dispose(): this

Returns this

Series itself for fluent interface

getCursorEnabled

getCursorEnabled(): boolean

Returns boolean

Whether Cursor is enabled or not

getFillStyle

getFillStyle(): FillStyle

Returns FillStyle

Current series fill style

getFillStyleHighlight

getFillStyleHighlight(): FillStyle | undefined

Returns FillStyle | undefined

getHighlightOnHover

getHighlightOnHover(): boolean

Returns boolean

Boolean for if object should highlight on mouse hover or not.

getHighlighted

getHighlighted(): boolean

Returns boolean

the state of highlighted flag

getIsUnderMouse

getIsUnderMouse(): boolean

Returns boolean

Boolean for is object under mouse currently

getMouseInteractions

getMouseInteractions(): boolean

Returns boolean

Mouse interactions state

getName

getName(): string

Returns string

The name of the Component.

getPointFillStyle

getPointFillStyle(): FillStyle

Returns FillStyle

Current point fill style

getPointFillStyleHighlight

getPointFillStyleHighlight(): FillStyle | undefined

Returns FillStyle | undefined

Current highlight point fill style

getPointRotation

getPointRotation(): number

Returns number

getPointShape

getPointShape(): PointShape

Returns PointShape

PointShape

getPointSize

getPointSize(): number

Returns number

Size of point in pixels

getResultTableFormatter

getResultTableFormatter(): SpiderSeriesFormatter

Returns SpiderSeriesFormatter

Function which builds ResultTable content for SpiderSeries.

getStrokeStyle

getStrokeStyle(): LineStyle

Returns LineStyle

getStrokeStyleHighlight

getStrokeStyleHighlight(): LineStyle | undefined

Returns LineStyle | undefined

LineStyle or undefined for auto assignment

getValue

getValue(tag: string, animated: boolean): number | undefined

Parameters
- tag: string
- Default value animated: boolean
Returns number | undefined

isDisposed

isDisposed(): boolean

Returns boolean

TODO: True for enabled and false for disabled

offHover

offHover(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseClick

offMouseClick(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseDoubleClick

offMouseDoubleClick(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseDown

offMouseDown(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseDrag

offMouseDrag(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseDragStart

offMouseDragStart(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseDragStop

offMouseDragStop(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseEnter

offMouseEnter(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseLeave

offMouseLeave(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseMove

offMouseMove(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseUp

offMouseUp(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offMouseWheel

offMouseWheel(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offTouchEnd

offTouchEnd(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offTouchMove

offTouchMove(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

offTouchStart

offTouchStart(token: Token): boolean

Parameters
- token: Token
Returns boolean

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

onHover

onHover(clbk: function): Token

Parameters
- clbk: function
  - - Parameters
      - series: this
      - cursorPoint: CursorPointInterface | undefined
      Returns void
Returns Token

Token of the event listener

onMouseClick

onMouseClick(clbk: MouseEventHandler<this>): Token

Parameters
- clbk: MouseEventHandler<this>
Returns Token

Token of the event listener

onMouseDoubleClick

onMouseDoubleClick(clbk: MouseEventHandler<this>): Token

Parameters
- clbk: MouseEventHandler<this>
Returns Token

Token of the event listener

onMouseDown

onMouseDown(clbk: MouseEventHandler<this>): Token

Parameters
- clbk: MouseEventHandler<this>
Returns Token

Token of the event listener

onMouseDrag

onMouseDrag(clbk: MouseDragEventHandler<this>): Token

Parameters
- clbk: MouseDragEventHandler<this>
Returns Token

onMouseDragStart

onMouseDragStart(clbk: MouseDragStartEventHandler<this>): Token

Parameters
- clbk: MouseDragStartEventHandler<this>
Returns Token

onMouseDragStop

onMouseDragStop(clbk: MouseDragStopEventHandler<this>): Token

Parameters
- clbk: MouseDragStopEventHandler<this>
Returns Token

onMouseEnter

onMouseEnter(clbk: MouseEventHandler<this>): Token

Parameters
- clbk: MouseEventHandler<this>
Returns Token

Token of the event listener

onMouseLeave

onMouseLeave(clbk: AbruptMouseEventHandler<this>): Token

Parameters
- clbk: AbruptMouseEventHandler<this>
Returns Token

Token of the event listener

onMouseMove

onMouseMove(clbk: MouseEventHandler<this>): Token

Parameters
- clbk: MouseEventHandler<this>
Returns Token

Token of the event listener

onMouseUp

onMouseUp(clbk: MouseEventHandler<this>): Token

Parameters
- clbk: MouseEventHandler<this>
Returns Token

Token of the event listener

onMouseWheel

onMouseWheel(clbk: MouseWheelEventHandler<this>): Token

Parameters
- clbk: MouseWheelEventHandler<this>
Returns Token

Token of subscription

onTouchEnd

onTouchEnd(clbk: TouchEventHandler<this>): Token

Parameters
- clbk: TouchEventHandler<this>
Returns Token

Token of subscription

onTouchMove

onTouchMove(clbk: TouchEventHandler<this>): Token

Parameters
- clbk: TouchEventHandler<this>
Returns Token

Token of subscription

onTouchStart

onTouchStart(clbk: TouchEventHandler<this>): Token

Parameters
- clbk: TouchEventHandler<this>
Returns Token

Token of subscription

restore

restore(): this

Returns this

Series itself for fluent interface

setAnimationAddPoints

setAnimationAddPoints(easing: AnimationEasing, duration: undefined | number): this

Parameters
- Optional easing: AnimationEasing
- Optional duration: undefined | number
Returns this

Object itself

setCursorEnabled

setCursorEnabled(state: boolean): this

Parameters
- state: boolean
Returns this

setDisposeAnimation

setDisposeAnimation(easing: AnimationEasing, duration: undefined | number): this

Parameters
- Optional easing: AnimationEasing
- Optional duration: undefined | number
Returns this

Object itself

setFillStyle

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

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

Series itself for fluent interface.

setFillStyleHighlight

setFillStyleHighlight(value: FillStyle | ImmutableMutator<FillStyle> | undefined): this

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

Series itself for fluent interface.

setHighlightOnHover

setHighlightOnHover(state: boolean): this

Parameters
- state: boolean
Returns this

Object itself for fluent interface.

setHighlighted

setHighlighted(highLight: boolean): this

Parameters
- highLight: boolean
Returns this

Series itself for fluent interface

setMouseInteractions

setMouseInteractions(state: boolean): this

Parameters
- state: boolean
Returns this

Object itself for fluent interface

setName

setName(name: string): this

Parameters
- name: string
Returns this

Object itself

setPointFillStyle

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

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

Series itself for fluent interface.

setPointFillStyleHighlight

setPointFillStyleHighlight(fillStyle: FillStyle | ImmutableMutator<FillStyle> | undefined): this

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

Series itself for fluent interface.

setPointRotation

setPointRotation(angle: number): this

Parameters
- angle: number
Returns this

setPointSize

setPointSize(size: number): this

Parameters
- size: number
Returns this

Object itself for fluent interface

setResultTableFormatter

setResultTableFormatter(formatter: SpiderSeriesFormatter): this

Parameters
- formatter: SpiderSeriesFormatter
Returns this

Object itself

setStrokeStyle

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

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

Chart itself

setStrokeStyleHighlight

setStrokeStyleHighlight(value: LineStyle | ImmutableMutator<LineStyle> | undefined): this

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

Chart itself

solveNearestFromScreen

solveNearestFromScreen(location: Point): undefined | CursorPoint

Parameters
- location: Point
Returns undefined | CursorPoint

Undefined or data-structure for positioning of cursors

solveNearestFromSegment

solveNearestFromSegment(location: Point, segment: SpiderChartVisual): undefined | CursorPoint

Parameters
- location: Point
- segment: SpiderChartVisual
Returns undefined | CursorPoint

Undefined or data-structure for positioning of cursors