Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines the base class to an Annotation - a type of marker, text label, line or custom UI overlay on a 2D Cartesian SciChartSurface

Hierarchy

Implements

Index

Constructors

Protected constructor

Properties

adornerDraggingPoint

adornerDraggingPoint: EDraggingGripPoint

dragDelta

dragEnded

dragEnded: EventHandler<void>

dragStarted

dragStarted: EventHandler<void>

invalidateParentCallback

invalidateParentCallback: () => void
description

callback which notifies the parent SciChartSurface it's time to draw

Type declaration

    • (): void
    • Returns void

Protected prevIsSelected

prevIsSelected: boolean = true

Protected prevValue

prevValue: { x: number; y: number }

Type declaration

  • x: number
  • y: number

Protected svgAdorner

svgAdorner: SVGElement

Readonly Abstract type

description

annotation type. See EAnnotationType for a list of values

Accessors

annotationLayer

  • inheritdoc

    Returns EAnnotationLayer

  • inheritdoc

    Parameters

    Returns void

isDraggingStarted

  • get isDraggingStarted(): boolean
  • Returns boolean

isEditable

  • get isEditable(): boolean
  • set isEditable(isEditable: boolean): void
  • inheritdoc

    Returns boolean

  • inheritdoc

    Parameters

    • isEditable: boolean

    Returns void

isHidden

  • get isHidden(): boolean
  • set isHidden(isHidden: boolean): void
  • inheritdoc

    Returns boolean

  • inheritdoc

    Parameters

    • isHidden: boolean

    Returns void

isSelected

  • get isSelected(): boolean
  • set isSelected(value: boolean): void
  • inheritdoc

    Returns boolean

  • inheritdoc

    Parameters

    • value: boolean

    Returns void

isVerticalChart

  • get isVerticalChart(): boolean
  • inheritdoc

    Returns boolean

opacity

  • get opacity(): number
  • set opacity(opacity: number): void
  • Sets an opacity override for the entire annotation, from 0..1

    inheritdoc

    Returns number

  • Sets an opacity override for the entire annotation, from 0..1

    inheritdoc

    Parameters

    • opacity: number

    Returns void

parentSurface

  • inheritdoc

    Returns SciChartSurface

  • inheritdoc

    Parameters

    Returns void

resizeDirections

  • inheritdoc

    Returns EXyDirection

  • inheritdoc

    Parameters

    Returns void

Protected svgAdornerRoot

  • get svgAdornerRoot(): SVGSVGElement
  • Returns SVGSVGElement

x1

  • get x1(): number
  • set x1(x1: number): void
  • inheritdoc

    Returns number

  • inheritdoc

    Parameters

    • x1: number

    Returns void

x2

  • get x2(): number
  • set x2(x2: number): void
  • inheritdoc

    Returns number

  • inheritdoc

    Parameters

    • x2: number

    Returns void

xAxisId

  • get xAxisId(): string
  • set xAxisId(xAxisId: string): void
  • inheritdoc

    Returns string

  • inheritdoc

    Parameters

    • xAxisId: string

    Returns void

xCoordinateMode

  • The X-Coordinate mode. See ECoordinateMode for a list of values

    inheritdoc

    Returns ECoordinateMode

  • The X-Coordinate mode. See ECoordinateMode for a list of values

    inheritdoc

    Parameters

    Returns void

y1

  • get y1(): number
  • set y1(y1: number): void
  • inheritdoc

    Returns number

  • inheritdoc

    Parameters

    • y1: number

    Returns void

y2

  • get y2(): number
  • set y2(y2: number): void
  • inheritdoc

    Returns number

  • inheritdoc

    Parameters

    • y2: number

    Returns void

yAxisId

  • get yAxisId(): string
  • set yAxisId(yAxisId: string): void
  • inheritdoc

    Returns string

  • inheritdoc

    Parameters

    • yAxisId: string

    Returns void

yCoordinateMode

  • The Y-Coordinate mode. See ECoordinateMode for a list of values

    inheritdoc

    Returns ECoordinateMode

  • The Y-Coordinate mode. See ECoordinateMode for a list of values

    inheritdoc

    Parameters

    Returns void

Methods

checkIsClickedOnAnnotation

  • checkIsClickedOnAnnotation(xyPoint: Point, x1: number, x2: number, y1: number, y2: number): boolean
  • Parameters

    • xyPoint: Point
    • x1: number
    • x2: number
    • y1: number
    • y2: number

    Returns boolean

Abstract delete

  • delete(): void
  • Deletes native (WebAssembly) memory used by this type, after which it cannot be used.

    remarks

    Call .delete() before finishing with the object to ensure that WebAssmembly memory leaks do not occur.

    All elements within SciChart's High Performance Realtime JavaScript Charts which implement IDeletable must be deleted manually to free native (WebAssembly) memory

    Returns void

Protected deleteAdorner

  • deleteAdorner(): void
  • Returns void

Protected getCoordinate

Protected getValue

Protected getX1Coordinate

Protected getX2Coordinate

Protected getXYCoordinatesFromValues

  • getXYCoordinatesFromValues(xyDataPoint: Point): Point
  • Parameters

    Returns Point

Protected getXYValuesFromCoordinates

  • getXYValuesFromCoordinates(point: Point, translateToSeriesViewRect: boolean): Point
  • Parameters

    • point: Point
    • translateToSeriesViewRect: boolean

    Returns Point

Protected getY1Coordinate

Protected getY2Coordinate

isPointWithinBounds

Protected notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void
  • summary

    Notifies subscribers of {@link AnnotationBase.propertyChanged} that a property has changed and the chart requires redrawing

    description

    SciChart provides fully reactive components, changing any property or changing data will cause the AnnotationBase to redraw where necessary. This method notifies subscribers of the {@link AnnotationBase.propertyChanged} EventHandler that a property has changed.

    Parameters

    • propertyName: string

      The name of the property which has changed

    Returns void

onAttach

  • description

    Called when the annotation is attached to a parent SciChartSurface.

    Parameters

    Returns void

onDetach

  • onDetach(): void
  • description

    Called when the annotation is detached from a parent SciChartSurface.

    Returns void

onDragAdorner

onDragEnded

  • onDragEnded(): void

onDragStarted

updateAdorner

  • updateAdorner(): void

сalcDragDistance

  • сalcDragDistance(xyPoint: Point): void
  • Parameters

    Returns void

Object literals

Protected annontationBorders

annontationBorders: object

x1

x1: number = 0

x2

x2: number = 0

y1

y1: number = 0

y2

y2: number = 0

Generated using TypeDoc