Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PolarSector

Highlighter component that lives under PolarChart.

Can be used to highlight sectors in the polar coordinate system, specified by four values:

  • start angle
  • end angle
  • start amplitude
  • end amplitude

Created with PolarChart.addSector.

Index

Methods

attach

  • Attach object to an legendBox entry

    Parameters

    • entry: LegendBoxEntry

      Object which has to be attached

    • disposeOnClick: boolean

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

    Returns this

    Series itself for fluent interface

dispose

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

    Returns this

    Object itself.

getAmplitudeEnd

  • getAmplitudeEnd(): number | undefined
  • Get Sectors end amplitude.

    Returns number | undefined

    End amplitude. Setting to undefined results in tracking the PolarAxes end value. This doesn't have to be greater than amplitude start value.

getAmplitudeStart

  • getAmplitudeStart(): number | undefined
  • Get Sectors start amplitude.

    Returns number | undefined

    Start amplitude. Setting to undefined results in tracking the PolarAxes start value. This doesn't have to be less than amplitude end value.

getAngleEnd

  • getAngleEnd(): number
  • Get Sectors end angle in degrees.

    Returns number

    End angle in degrees, restricted to [0, 360]. This doesn't have to be greater than angle start value.

getAngleStart

  • getAngleStart(): number
  • Get Sectors start angle in degrees.

    Returns number

    Start angle in degrees, restricted to [0, 360]. This doesn't have to be less than angle end value.

getFillStyle

  • Get Fill Style of Sector.

    Returns FillStyle

    FillStyle

getFillStyleHighlighted

  • getFillStyleHighlighted(): FillStyle | undefined
  • Get Fill Style of Sector when highlighted.

    Returns FillStyle | undefined

    FillStyle or undefined (automatic assignment)

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 PolarSector.

    Returns LineStyle

    Normal StrokeStyle

getStrokeStyleHighlight

  • Get highlight stroke style of PolarSector.

    Returns LineStyle

    StrokeStyle.

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

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

restore

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

    Returns this

    Object itself.

setAmplitudeEnd

  • setAmplitudeEnd(amplitudeEnd: number | undefined): this
  • Set Sectors end amplitude.

    Parameters

    • amplitudeEnd: number | undefined

      End amplitude. Setting to undefined results in tracking the PolarAxes end value. This doesn't have to be greater than amplitude start value.

    Returns this

    Object itself for fluent interface.

setAmplitudeStart

  • setAmplitudeStart(amplitudeStart: number): this
  • Set Sectors start amplitude.

    Parameters

    • amplitudeStart: number

      Start amplitude. Setting to undefined results in tracking the PolarAxes start value. This doesn't have to be less than amplitude end value.

    Returns this

    Object itself for fluent interface.

setAngleEnd

  • setAngleEnd(angleEnd: number): this
  • Set Sectors end angle in degrees.

    Parameters

    • angleEnd: number

      End angle in degrees, restricted to [0, 360]. This doesn't have to be greater than angle start value.

    Returns this

    Object itself for fluent interface.

setAngleStart

  • setAngleStart(angleStart: number): this
  • Set Sectors start angle in degrees.

    Parameters

    • angleStart: number

      Start angle in degrees, restricted to [0, 360]. This doesn't have to be less than angle end value.

    Returns this

    Object itself for fluent interface.

setFillStyle

  • Set Fill Style of Sector.

    Example use:

    // Create a new style
    PolarSector.setFillStyle(new SolidFill({ color: ColorHEX('#F00') }))
    // Change transparency
    PolarSector.setFillStyle((solidFill) => solidFill.setA(80))
    // Set hidden
    PolarSector.setFillStyle(emptyFill)
    
    @param   value   FillStyle object or function which mutates existing value.
    @return          Object itself for fluent interface.
    

    Parameters

    Returns this

setFillStyleHighlighted

  • Set Fill Style of Sector when highlighted.

    Example use:

    // Create a new style
    PolarSector.setFillStyleHighlight(new SolidFill({ color: ColorHEX('#F00') }))
    // Change transparency
    PolarSector.setFillStyleHighlight((solidFill) => solidFill.setA(80))
    // Set hidden
    PolarSector.setFillStyleHighlight(emptyFill)
    // Automatic
    PolarSector.setFillStyleHighlight(undefined)
    

    Parameters

    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 PolarSector.

    Example usage:

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

    Parameters

    Returns this

    Chart itself

setStrokeStyleHighlight

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

    Example usage:

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

    Parameters

    • value: LineStyle | ImmutableMutator<LineStyle> | undefined

      Either a LineStyle 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