Class SegmentSeries

Index

Properties

Properties

axisX

axisX: Axis

axisY

axisY: Axis

chart

chart: ChartXY

scale

scale: Vec2<Scale>

Methods

add

add(dimensions: SegmentDimensions): SegmentFigure

Parameters
- dimensions: SegmentDimensions
Returns SegmentFigure

Created figure

addMarker

addMarker(cursorBuilder: StaticCursorXYBuilder<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>): SeriesMarkerXY<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>

Type parameters
- PointMarkerType: PointMarker
- ResultTableBackgroundType: UIBackground
- TickMarkerBackgroundTypeX: PointableBackground
- TickMarkerBackgroundTypeY: PointableBackground
Parameters
- Default value cursorBuilder: StaticCursorXYBuilder<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>
Returns SeriesMarkerXY<PointMarkerType, ResultTableBackgroundType, TickMarkerBackgroundTypeX, TickMarkerBackgroundTypeY>

SeriesMarkerXY

attach

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

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

Series itself for fluent interface

clear

clear(): this

Returns this

Series itself for fluent interface

dispose

dispose(): this

Returns this

Object itself for fluent interface

getBoundaries

getBoundaries(): Interval<Point>

Returns Interval<Point>

getCursorEnabled

getCursorEnabled(): boolean

Returns boolean

Whether Cursor is enabled or not

getHighlightMode

getHighlightMode(): HighlightModes

Returns HighlightModes

HighlightMode

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.

getResultTableFormatter

getResultTableFormatter(): FigureSeriesFormatter<SegmentFigure, SegmentSeries>

Returns FigureSeriesFormatter<SegmentFigure, SegmentSeries>

Function which builds ResultTable content for the Series.

getXMax

getXMax(): number

Returns number

Max X value of the series

getXMin

getXMin(): number

Returns number

Min X value of the series

getYMax

getYMax(): number

Returns number

Max Y value of the series

getYMin

getYMin(): number

Returns number

Min Y value of the series

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: SimpleFigureSeriesCursorPoint<SegmentFigure> | 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

Object itself.

setCursorEnabled

setCursorEnabled(state: boolean): this

Parameters
- state: boolean
Returns this

setDefaultStyle

setDefaultStyle(styler: FigureStyler<SegmentFigure>): this

Parameters
- styler: FigureStyler<SegmentFigure>
Returns this

Object itself

setHighlightMode

setHighlightMode(highlightMode: HighlightModes): this

Parameters
- highlightMode: HighlightModes
Returns this

Object itself

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

component 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

setResultTableFormatter

setResultTableFormatter(formatter: FigureSeriesFormatter<SegmentFigure, SegmentSeries>): this

Parameters
- formatter: FigureSeriesFormatter<SegmentFigure, SegmentSeries>
Returns this

Object itself

solveNearestFromScreen

solveNearestFromScreen(location: Point): undefined | SimpleFigureSeriesCursorPoint<SegmentFigure>

Parameters
- location: Point
Returns undefined | SimpleFigureSeriesCursorPoint<SegmentFigure>

Undefined or data-structure for positioning of cursors

solveNearestFromSegment

solveNearestFromSegment(location: Point, segment: SegmentFigure): undefined | SimpleFigureSeriesCursorPoint<SegmentFigure>

Parameters
- location: Point
- segment: SegmentFigure
Returns undefined | SimpleFigureSeriesCursorPoint<SegmentFigure>

Undefined or data-structure for positioning of cursors