Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BoxAndWhiskers

Index

Properties

boundaries

boundaries: Interval<Point>

dimensionStrategy

dimensionStrategy: MultidimensionalStrategy

end

end: number

lowerExtreme

lowerExtreme: number

lowerQuartile

lowerQuartile: number

median

median: number

scale

scale: Vec2<Scale>

start

start: number

upperExtreme

upperExtreme: number

upperQuartile

upperQuartile: number

Methods

dispose

  • dispose(): this
  • Returns this

getBodyFillStyle

getBodyFillStyleHighlight

  • getBodyFillStyleHighlight(): FillStyle | undefined
  • Returns FillStyle | undefined

    FillStyle object or undefined if not assigned

getBodyStrokeStyle

  • getBodyStrokeStyle(): LineStyle
  • Returns LineStyle

    LineStyle object

getBodyStrokeStyleHighlight

  • getBodyStrokeStyleHighlight(): LineStyle | undefined
  • Returns LineStyle | undefined

    LineStyle object or undefined if not assigned

getBodyWidth

  • getBodyWidth(): number
  • Returns number

    Ratio between box body width and the segments interval

getBoundaries

  • getBoundaries(): Interval<Point>
  • Returns Interval<Point>

    Interval

getDominantStyle

getHighlighted

  • getHighlighted(): boolean
  • Returns boolean

    True for highlighted state of object and false for basic

getIsUnderMouse

  • getIsUnderMouse(): boolean
  • Returns boolean

    Boolean for is object under mouse currently

getMedianStrokeStrokeHighlight

  • getMedianStrokeStrokeHighlight(): LineStyle | undefined
  • Returns LineStyle | undefined

    LineStyle object or undefined if not assigned

getMedianStrokeStyle

  • getMedianStrokeStyle(): LineStyle
  • Returns LineStyle

    LineStyle object

getMouseInteractions

  • getMouseInteractions(): boolean
  • Returns boolean

    Mouse interactions state

getStrokeStyle

  • getStrokeStyle(): LineStyle
  • Returns LineStyle

    LineStyle object

getStrokeStyleHighlight

  • getStrokeStyleHighlight(): LineStyle | undefined
  • Returns LineStyle | undefined

    LineStyle object or undefined if not assigned

getTailWidth

  • getTailWidth(): number
  • Returns number

    Ratio between box tail width and the segments interval

isDisposed

  • isDisposed(): boolean
  • Returns boolean

    True if all shapes are disposed, false if not.

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

onMouseClick

  • Parameters

    Returns Token

    Token-object that is a reference ID to the listener created.

onMouseDoubleClick

onMouseDown

onMouseDrag

onMouseDragStart

onMouseDragStop

onMouseEnter

  • Parameters

    Returns Token

    Token-object that is a reference ID to the listener created.

onMouseLeave

  • Parameters

    Returns Token

    Token-object that is a reference ID to the listener created.

onMouseMove

onMouseUp

onMouseWheel

onTouchEnd

onTouchMove

onTouchStart

restore

  • restore(): this
  • Returns this

setBodyFillStyle

setBodyFillStyleHighlight

setBodyStrokeStyle

  • Parameters

    Returns this

    Series itself for fluent interface.

setBodyStrokeStyleHighlight

  • setBodyStrokeStyleHighlight(lineStyle: LineStyle | ImmutableMutator<LineStyle> | undefined): this
  • Parameters

    Returns this

    Chart itself

setBodyWidth

  • setBodyWidth(width: number): this
  • Parameters

    • width: number

    Returns this

    Object itself

setHighlighted

  • setHighlighted(isHighlighted: boolean): this
  • Parameters

    • isHighlighted: boolean

    Returns this

    Object itself for fluent interface

setMedianStrokeStyle

  • Parameters

    Returns this

    Chart itself

setMedianStrokeStyleHighlight

  • setMedianStrokeStyleHighlight(value: LineStyle | ImmutableMutator<LineStyle> | undefined): this
  • Parameters

    Returns this

    Chart itself

setMouseInteractions

  • setMouseInteractions(state: boolean): this
  • Parameters

    • state: boolean

    Returns this

    Object itself for fluent interface

setStrokeStyle

  • Parameters

    Returns this

    Chart itself

setStrokeStyleHighlight

  • setStrokeStyleHighlight(value: LineStyle | ImmutableMutator<LineStyle> | undefined): this
  • Parameters

    Returns this

    Chart itself

setTailWidth

  • setTailWidth(width: number): this
  • Parameters

    • width: number

    Returns this

    Object itself