Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Band

Axis Highlighter that highlights an interval on the Axis.

Index

Properties

Readonly axis

axis : Axis

Owning Axis.

Methods

attach

  • attach(entry: LegendBoxEntry, disposeOnClick?: undefined | false | true): this
  • Attach object to an legendBox entry

    Parameters

    • entry: LegendBoxEntry

      Object which has to be attached

    • disposeOnClick: undefined | false | true

      Flag that indicates whether the Attachable should be disposed/restored, when its respective Entry is clicked.

    Returns this

    Object itself for fluent interface

dispose

  • dispose(): this
  • Tell the owning chart to remove this component.

    Returns this

    Object itself.

getFillStyle

  • Get fill style of Band.

    Returns FillStyle

    Normal FillStyle

getFillStyleHighlight

  • Get highlight fill style of Band.

    Returns FillStyle

    FillStyle.

getHighlightOnHover

  • getHighlightOnHover(): boolean
  • Get boolean flag for whether object should highlight on mouse hover

    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
  • Get boolean flag for whether object is currently under mouse or not

    Returns boolean

    Boolean for is object under mouse currently

getMouseInteractions

  • getMouseInteractions(): boolean
  • Get mouse interactions enabled or disabled. Disabled mouse-interactions will naturally prevent mouse-driven highlighting from ever happening.

    Returns boolean

    Mouse interactions state

getName

  • getName(): string
  • Get the name of the Component.

    Returns string

    The name of the Component.

getStrokeStyle

  • Get stroke style of Band.

    Returns LineStyle

    Normal StrokeStyle

getStrokeStyleHighlight

  • Get highlight stroke style of Band.

    Returns LineStyle

    StrokeStyle.

getValueEnd

  • getValueEnd(): number
  • Get end value of Band. This is in values of its owning Axis.

    Returns number

    Value on Axis.

getValueStart

  • getValueStart(): number
  • Get start value of Band. This is in values of its owning Axis.

    Returns number

    Value on Axis.

isDisposed

  • isDisposed(): boolean
  • Returns boolean

    TODO: True for enabled and false for disabled

offHighlight

  • offHighlight(token: Token): boolean
  • Unsubscribe from Highlight object event. This is called whenever an object is highlighted

    Parameters

    • token: Token

      Token that was received when subscribing to the event.

    Returns boolean

    True if the unsubscription was successful.

offMouseClick

  • offMouseClick(token: Token): boolean
  • Remove event listener from Mouse Click Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDoubleClick

  • offMouseDoubleClick(token: Token): boolean
  • Remove event listener from Mouse Double Click Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDown

  • offMouseDown(token: Token): boolean
  • Remove event listener from Mouse Down Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDrag

  • offMouseDrag(token: Token): boolean
  • Remove event listener from Mouse Drag Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDragStart

  • offMouseDragStart(token: Token): boolean
  • Remove event listener from Mouse Drag Start Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseDragStop

  • offMouseDragStop(token: Token): boolean
  • Remove event listener from Mouse Drag Stop Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseEnter

  • offMouseEnter(token: Token): boolean
  • Remove event listener from Mouse Enter Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseLeave

  • offMouseLeave(token: Token): boolean
  • Remove event listener from Mouse Leave Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseMove

  • offMouseMove(token: Token): boolean
  • Remove event listener from Mouse Move Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseUp

  • offMouseUp(token: Token): boolean
  • Remove event listener from Mouse Up Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offMouseWheel

  • offMouseWheel(token: Token): boolean
  • Remove event listener from Mouse Wheel Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offTouchEnd

  • offTouchEnd(token: Token): boolean
  • Remove event listener from Touch End Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offTouchMove

  • offTouchMove(token: Token): boolean
  • Remove event listener from Touch Move Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offTouchStart

  • offTouchStart(token: Token): boolean
  • Remove event listener from Touch Start Event

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

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

offValueChange

  • offValueChange(token: Token): boolean
  • Unsubscribe from value change event.

    This event is called whenever the position of the Band is changed via either Band.setValueStart/End or user interactions.

    Parameters

    • token: Token

      Token that was received when the subscription was created.

    Returns boolean

    True if unsubscription was successful.

onHighlight

  • onHighlight(handler: function): Token
  • Subscribe to highlight object event. This is called whenever an object is highlighted.

    Parameters

    • handler: function

      Function that is called when event is triggered.

        • Parameters

          • isHighlighted: boolean

          Returns void

    Returns Token

    Token that can be used to unsubscribe from the event.

onMouseClick

  • Add event listener to Mouse Click Event

    Parameters

    Returns Token

    Token of the event listener

onMouseDoubleClick

  • Add event listener to Mouse Double Click Event

    Parameters

    Returns Token

    Token of the event listener

onMouseDown

  • Add event listener to Mouse Down Event

    Parameters

    Returns Token

    Token of the event listener

onMouseDrag

onMouseDragStart

onMouseDragStop

onMouseEnter

  • Add event listener to Enter Event

    Parameters

    Returns Token

    Token of the event listener

onMouseLeave

  • Add event listener to Mouse Leave Event

    Parameters

    Returns Token

    Token of the event listener

onMouseMove

  • Add event listener to Mouse Move Event

    Parameters

    Returns Token

    Token of the event listener

onMouseUp

  • Add event listener to Mouse Up Event

    Parameters

    Returns Token

    Token of the event listener

onMouseWheel

  • Subscribe to Mouse Wheel event

    Parameters

    Returns Token

    Token of subscription

onTouchEnd

  • Subscribe to Touch End event

    Parameters

    Returns Token

    Token of subscription

onTouchMove

  • Subscribe to Touch Move event

    Parameters

    Returns Token

    Token of subscription

onTouchStart

  • Subscribe to Touch Start event

    Parameters

    Returns Token

    Token of subscription

onValueChange

  • onValueChange(handler: function): Token
  • Subscribe to value change event.

    This event is called whenever the position of the Band is changed via either Band.setValueStart/End or user interactions.

    Parameters

    • handler: function

      Function that is called when event is triggered.

        • Parameters

          • band: this
          • start: number
          • end: number

          Returns void

    Returns Token

    Token that can be used to unsubscribe from the event.

restore

  • restore(): this
  • Tell the owning chart to restore this component.

    Returns this

    Object itself.

setFillStyle

  • Set fill style of Band.

    Example Usage:

    // Specified FillStyle
    Band.setFillStyle(new SolidFill({ color: ColorHEX('#F00') }))
    // Changed transparency
    Band.setFillStyle((solidFill) => solidFill.setA(80))
    // Hidden (emptyFill is not supported)
    Band.setFillStyle(transparentFill)
    

    Parameters

    Returns this

    Object itself for fluent interface.

setFillStyleHighlight

  • Set fill style of Band when it is highlighted. Highlighting is activated by placing mouse on top / touching Band (if mouse-interactions are not disabled), or by using setHighlighted() method.

    // Specified FillStyle
    Band.setFillStyleHighlight(new SolidFill({ color: ColorHEX('#F00') }))
    // Changed transparency
    Band.setFillStyleHighlight((solidFill) => solidFill.setA(80))
    // Hidden (emptyFill is not supported)
    Band.setFillStyleHighlight(transparentFill)
    // Automatic
    Band.setFillStyleHighlight(undefined)
    

    Parameters

    • value: FillStyle | ImmutableMutator<FillStyle> | undefined

      Either a FillStyle object or a function, which will be used to create a new FillStyle based on current value or undefined for automatic value based on normal style.

    Returns this

    Object itself for fluent interface.

setHighlightOnHover

  • setHighlightOnHover(state: boolean): this
  • Set highlight on mouse hover enabled or disabled.

    Mouse interactions have to be enabled on the component for this to function as expected. See setMouseInteractions for more information.

    Parameters

    • state: boolean

      True if highlighting on mouse hover, false if no highlight on mouse hover

    Returns this

    Object itself for fluent interface.

setHighlighted

  • setHighlighted(highLight: boolean): this
  • Enable or disable forced highlighting of component

    Parameters

    • highLight: boolean

      True for enabled and false for disabled

    Returns this

    component itself for fluent interface

setMouseInteractions

  • setMouseInteractions(state: boolean): this
  • Set component mouse interactions enabled or disabled.

    Disabling mouse interactions means that the objects below this component can be interacted through it.

    Possible side-effects from disabling mouse interactions:

    • Mouse events are not triggered. For example, onMouseMove.
    • Mouse driven highlighting will not work.

    Parameters

    • state: boolean

      Specifies state of mouse interactions

    Returns this

    Object itself for fluent interface

setName

  • setName(name: string): this
  • Sets the name of the Component updating attached LegendBox entries

    Parameters

    • name: string

      Name of the Component

    Returns this

    Object itself

setStrokeStyle

  • Set stroke style of Band.

    Example usage:

    // Specified SolidLine
    Band.setStrokeStyle(new SolidLine({ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
    // Changed thickness
    Band.setStrokeStyle((solidLine) => solidLine.setThickness(5))
    // Hidden (emptyLine is not supported)
    Band.setStrokeStyle(transparentLine)
    

    Parameters

    Returns this

    Chart itself

setStrokeStyleHighlight

  • Set stroke style of Band when it is highlighted. Highlighting is activated by placing mouse on top / touching Band (if mouse-interactions are not disabled), or by using setHighlighted() method.

    Example usage:

    // Specified SolidLine
    Band.setStrokeStyleHighlight(new SolidLine({ thickness: 2, fillStyle: new SolidFill({ color: ColorHEX('#F00') }) }))
    // Changed thickness
    Band.setStrokeStyleHighlight((solidLine) => solidLine.setThickness(5))
    // Hidden (emptyLine is not supported)
    Band.setStrokeStyleHighlight(transparentLine)
    // Automatic
    Band.setStrokeStyleHighlight(undefined)
    

    Parameters

    • value: SolidLine | ImmutableMutator<SolidLine> | undefined

      Either a SolidLine object or a function, which will be used to modify current value or undefined for automatic value based on normal style.

    Returns this

    Chart itself

setValueEnd

  • setValueEnd(valueEnd: number): this
  • Set end value of Band. This is in values of its owning Axis.

    Parameters

    • valueEnd: number

      Value on Axis.

    Returns this

    Object itself for fluent interface.

setValueStart

  • setValueStart(valueStart: number): this
  • Set start value of Band. This is in values of its owning Axis.

    Parameters

    • valueStart: number

      Value on Axis.

    Returns this

    Object itself for fluent interface.