Interface IDragPoint

Go to JavaScript Charting Documentation

Go to JavaScript Chart Examples

Go to SciChart.js on Github

Composable drag point contract.

Hierarchy

IDragPoint

Implemented by

Index

Properties

id

Methods

Properties

Readonly id

id: string

Stable id of the drag point.

Methods

applyDrag

applyDrag(ctx: IDragPointContext, currentValues: Point, previousValues: Point): void

- Defined in Extensions/scichart-financial-tools/src/annotations/DragPoints.ts
Applies drag from previous to current value-space points.

Parameters
- ctx: IDragPointContext
- currentValues: Point
- previousValues: Point
Returns void

getAdornerSvg

getAdornerSvg(ctx: IDragPointContext): string

- Defined in Extensions/scichart-financial-tools/src/annotations/DragPoints.ts
Returns SVG for this drag-point adorner.

Parameters
- ctx: IDragPointContext
Returns string

Optional getCursor

getCursor(ctx: IDragPointContext, isDragging: boolean): ECursorStyle | undefined

- Defined in Extensions/scichart-financial-tools/src/annotations/DragPoints.ts
Optional cursor while hover/dragging this drag point.

Parameters
- ctx: IDragPointContext
- isDragging: boolean
Returns ECursorStyle | undefined

getScreenPosition

getScreenPosition(ctx: IDragPointContext): Point | undefined

- Defined in Extensions/scichart-financial-tools/src/annotations/DragPoints.ts
Optional screen position, used by generic distance hit-test.

Parameters
- ctx: IDragPointContext
Returns Point | undefined

hitTest

hitTest(ctx: IDragPointContext, mousePoint: Point): boolean

- Defined in Extensions/scichart-financial-tools/src/annotations/DragPoints.ts
Hit-test in canvas coordinates (DPI scaled).

Parameters
- ctx: IDragPointContext
- mousePoint: Point
Returns boolean

Generated using TypeDoc