Box and whiskers StatisticFigure implementation.

Hierarchy

Properties

boundaries: Interval<Point>

Boundaries of BoxFigure. Constant and computed in constructor.

dimensionStrategy: MultidimensionalStrategy
end: number
lowerExtreme: number
lowerQuartile: number
median: number
scale: LinearScaleXY
start: number
upperExtreme: number
upperQuartile: number

Methods

  • Permanently destroy the component.

    To fully allow Garbage-Collection to free the resources used by the component, make sure to remove any references to the component and its children in application code.

    let chart = ...ChartXY()
    let axisX = chart.getDefaultAxisX()
    // Dispose Chart, and remove all references so that they can be garbage-collected.
    chart.dispose()
    chart = undefined
    axisX = undefined

    Returns

    Object itself for fluent interface

    Returns BoxAndWhiskers

  • Get fill style of box body when not highlighted.

    Returns

    FillStyle object

    Returns FillStyle

  • Get style of box body when not highlighted.

    Returns

    LineStyle object

    Returns LineStyle

  • Get width of box body as a % of the width of its interval width.

    Returns

    Ratio between box body width and the segments interval

    Returns number

  • Get state of component highlighting.

    Returns

    Number between 0 and 1, where 1 is fully highlighted.

    Returns number

  • Get boolean flag for whether object is currently under mouse or not

    Returns

    Boolean for is object under mouse currently

    Returns boolean

  • Get stroke style of box median line when not highlighted.

    Returns

    LineStyle object

    Returns LineStyle

  • Get stroke style of box whiskers and tails when not highlighted.

    Returns

    LineStyle object

    Returns LineStyle

  • Get width of box tails as a % of the width of its interval width.

    Returns

    Ratio between box tail width and the segments interval

    Returns number

  • Get element visibility.

    Returns

    true when element is set to be visible and false otherwise.

    Returns boolean

  • Remove event listener from dispose event.

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Unsubscribe from Highlight object event. This is called whenever an object is highlighted

    Returns

    True if the unsubscription was successful.

    Parameters

    • token: Token

      Token that was received when subscribing to the event.

    Returns boolean

  • Remove event listener from Mouse Click Event

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Remove event listener from Mouse Double Click Event

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Remove event listener from Mouse Down Event

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Remove event listener from Mouse Drag Event

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Remove event listener from Mouse Drag Start Event

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Remove event listener from Mouse Drag Stop Event

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Remove event listener from Mouse Enter Event

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Remove event listener from Mouse Leave Event

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Remove event listener from Mouse Move Event

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Remove event listener from Mouse Up Event

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Remove event listener from Mouse Wheel Event

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Remove event listener from Touch End Event

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Remove event listener from Touch Move Event

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Remove event listener from Touch Start Event

    Returns

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

    Parameters

    • token: Token

      Token of event listener which has to be removed

    Returns boolean

  • Remove event listener from visibleStateChanged

    Parameters

    • token: Token

    Returns boolean

  • Subscribe onDispose event. This event is triggered whenever the object is disposed.

     // Example usage

    Figure.onDispose(() => {
    console.log('Figure was disposed')
    })

    Figure.dispose()

    Returns

    Token of subscription

    Parameters

    Returns Token

  • Subscribe to highlight object event. This is called whenever an object is highlighted.

    Returns

    Token that can be used to unsubscribe from the event.

    Parameters

    • handler: ((isHighlighted: boolean) => void)

      Function that is called when event is triggered.

        • (isHighlighted: boolean): void
        • Parameters

          • isHighlighted: boolean

          Returns void

    Returns Token

  • Register new event listener to visibleStateChanged event.

    Parameters

    • listener: VisibleStateChangedHandler<BoxAndWhiskers>

      Event listener for visibleStateChanged

    Returns Token

  • Set fill style of Series.

    Example Usage:

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

    Returns

    Series itself for fluent interface.

    Parameters

    Returns BoxAndWhiskers

  • Set border style of Series.

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

    Returns

    Series itself for fluent interface.

    Parameters

    Returns BoxAndWhiskers

  • Set width of box body as a % of the width of its interval width.

    Returns

    Object itself

    Parameters

    • width: number

      Ratio between box body width and the segments interval

    Returns BoxAndWhiskers

  • Set state of component highlighting.

     // Example usage

    component.setHighlight(true)

    component.setHighlight(0.5)

    If highlight animations are enabled (which is true by default), the transition will be animated. As long as the component is highlighted, the active highlight intensity will be animated continuously between 0 and the configured value. Highlight animations can be disabled with setAnimationHighlight

    Returns

    Object itself

    Parameters

    • highlight: number | boolean

      Boolean or number between 0 and 1, where 1 is fully highlighted.

    Returns BoxAndWhiskers

  • Set stroke style of Series median line.

    Example usage:

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

    Returns

    Chart itself

    Parameters

    Returns BoxAndWhiskers

  • Set stroke style of Series whiskers and tails.

    Example usage:

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

    Returns

    Chart itself

    Parameters

    Returns BoxAndWhiskers

  • Set width of box tails as a % of the width of its interval width.

    Returns

    Object itself

    Parameters

    • width: number

      Ratio between box tail width and the segments interval

    Returns BoxAndWhiskers

  • Set element visibility.

    Returns

    Object itself.

    Parameters

    • state: boolean

      true when element should be visible and false when element should be hidden.

    Returns BoxAndWhiskers