Class Band

Properties

axis

axis: Axis

Methods

attach

attach(entry: LegendBoxEntry, disposeOnClick: undefined | false | true): this

Parameters
- entry: LegendBoxEntry
- Optional disposeOnClick: undefined | false | true
Returns this

Object itself for fluent interface

dispose

dispose(): this

Returns this

Object itself.

getFillStyle

getFillStyle(): FillStyle

Returns FillStyle

Normal FillStyle

getFillStyleHighlight

getFillStyleHighlight(): FillStyle

Returns FillStyle

FillStyle.

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.

getStrokeStyle

getStrokeStyle(): LineStyle

Returns LineStyle

Normal StrokeStyle

getStrokeStyleHighlight

getStrokeStyleHighlight(): LineStyle

Returns LineStyle

StrokeStyle.

getValueEnd

getValueEnd(): number

Returns number

Value on Axis.

getValueStart

getValueStart(): number

Returns number

Value on Axis.

isDisposed

isDisposed(): boolean

Returns boolean

TODO: True for enabled and false for disabled

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

offValueChange

offValueChange(token: Token): boolean

Parameters
- token: Token
Returns boolean

True if unsubscription was successful.

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

onValueChange

onValueChange(handler: function): Token

Parameters
- handler: function
  - - Parameters
      - band: this
      - start: number
      - end: number
      Returns void
Returns Token

Token that can be used to unsubscribe from the event.

restore

restore(): this

Returns this

Object itself.

setFillStyle

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

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

Object itself for fluent interface.

setFillStyleHighlight

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

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

Object 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

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

setStrokeStyle

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

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

Chart itself

setStrokeStyleHighlight

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

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

Chart itself

setValueEnd

setValueEnd(valueEnd: number): this

Parameters
- valueEnd: number
Returns this

Object itself for fluent interface.

setValueStart

setValueStart(valueStart: number): this

Parameters
- valueStart: number
Returns this

Object itself for fluent interface.