Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChartCursor

Hierarchy

  • _ChartCursor
    • ChartCursor

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns ChartCursor

Properties

bulletSize

bulletSize: number

Size of bullets, following the cursor.

default

8

bulletsEnabled

bulletsEnabled: boolean

Specifies if bullet for each graph will follow the cursor.

categoryBalloonAlpha

categoryBalloonAlpha: number

Opacity of the category balloon.

default

1

categoryBalloonColor

categoryBalloonColor: string

Color of the category balloon. cursorColor is used if not set.

categoryBalloonDateFormat

categoryBalloonDateFormat: string

Category balloon date format (used only if category axis parses dates). Check this page for instructions on how to format dates. MMM DD, YYYY

categoryBalloonEnabled

categoryBalloonEnabled: boolean

Specifies whether category balloon is enabled.

default

true

color

color: string

Text color. #FFFFFF

cursorAlpha

cursorAlpha: number

Opacity of the cursor line. 1

cursorColor

cursorColor: string

Color of the cursor line. #CC0000

cursorPosition

cursorPosition: string

Specifies where the cursor line should be placed - on the beginning of the period (day, hour, etc) or in the middle (only when parseDates property of categoryAxis is set to true). If you want the cursor to follow mouse and not to glue to the nearest data point, set "mouse" here. Possible values are: "start", "middle", "mouse".

enabled

enabled: boolean

Specifies whether cursor is enabled.

default

true

fullWidth

fullWidth: boolean

If set to true, instead of a cursor line user will see a fill which width will always be equal to the width of one data item. Recommend setting cursorAlpha to 0.1 or some other small number if using this feature.

default

false

oneBalloonOnly

oneBalloonOnly: boolean

If this is set to true, only one balloon at a time will be displayed. Note, this is quite CPU consuming.

pan

pan: boolean

If this is set to true, the user will be able to pan the chart (Serial only) instead of zooming.

selectWithoutZooming

selectWithoutZooming: boolean

Specifies if cursor should only mark selected area but not zoom-in after user releases mouse button.

selectionAlpha

selectionAlpha: number

Opacity of the selection.

valueBalloonsEnabled

valueBalloonsEnabled: boolean

Specifies whether value balloons are enabled. In case they are not, the balloons might be displayed anyway, when the user rolls-over the column or bullet.

default

true

zoomable

zoomable: boolean

Specifies if the user can zoom-in the chart. If pan is set to true, zoomable is switched to false automatically.

default

true

zooming

zooming: boolean

Indicates if currently user is selecting some chart area to zoom-in.

Methods

addListener

  • addListener(type: string, handler: (e: { chart: default; delta2X?: number; delta2Y?: number; deltaX?: number; deltaY?: number; end?: number; finalX?: number; finalY?: number; index?: number; initialX?: number; initialY?: number; mostCloseGraph?: default; start?: number; target?: default; type: string; x?: number; y?: number; zooming?: boolean }) => void): void

  • Adds event listener.

    Parameters

    • type: string

      One of "changed", "draw", "moved", "onHideCursor", "onShowCursor", "panning", "selected", "zoomed", "zoomStarted".

    • handler: (e: { chart: default; delta2X?: number; delta2Y?: number; deltaX?: number; deltaY?: number; end?: number; finalX?: number; finalY?: number; index?: number; initialX?: number; initialY?: number; mostCloseGraph?: default; start?: number; target?: default; type: string; x?: number; y?: number; zooming?: boolean }) => void

      The event handler.

        • (e: { chart: default; delta2X?: number; delta2Y?: number; deltaX?: number; deltaY?: number; end?: number; finalX?: number; finalY?: number; index?: number; initialX?: number; initialY?: number; mostCloseGraph?: default; start?: number; target?: default; type: string; x?: number; y?: number; zooming?: boolean }): void

        • Parameters

          • e: { chart: default; delta2X?: number; delta2Y?: number; deltaX?: number; deltaY?: number; end?: number; finalX?: number; finalY?: number; index?: number; initialX?: number; initialY?: number; mostCloseGraph?: default; start?: number; target?: default; type: string; x?: number; y?: number; zooming?: boolean }
            • chart: default
            • Optional delta2X?: number
            • Optional delta2Y?: number
            • Optional deltaX?: number
            • Optional deltaY?: number
            • Optional end?: number
            • Optional finalX?: number
            • Optional finalY?: number
            • Optional index?: number
            • Optional initialX?: number
            • Optional initialY?: number
            • Optional mostCloseGraph?: default
            • Optional start?: number
            • Optional target?: default
            • type: string
            • Optional x?: number
            • Optional y?: number
            • Optional zooming?: boolean

          Returns void

    Returns void

hideCursor

  • hideCursor(): void

  • Hides cursor.

    Returns void

removeListener

  • removeListener(chart: default, type: string, handler: any): void

  • Removes event listener from chart object.

    Parameters

    • chart: default
    • type: string
    • handler: any

    Returns void

showCursorAt

  • showCursorAt(category: string | Date): void

  • You can force cursor to appear at specified cateogry or date.

    Parameters

    • category: string | Date

    Returns void

Generated using TypeDoc