Options
All
  • Public
  • Public/Protected
  • All
Menu

The Base class for an Annotation which draws using an HTML5 SVG canvas

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

Protected constructor

Properties

adornerDraggingPoint

adornerDraggingPoint: EDraggingGripPoint

Protected annotationsGripsFillProperty

annotationsGripsFillProperty: string = SciChartSurfaceBase.DEFAULT_THEME.annotationsGripsBackroundBrush

Protected annotationsGripsRadiusProperty

annotationsGripsRadiusProperty: number = ADORNER_GRIP_RADIUS

Protected annotationsGripsStrokeProperty

annotationsGripsStrokeProperty: string = SciChartSurfaceBase.DEFAULT_THEME.annotationsGripsBorderBrush

clicked

dragDelta

dragEnded

dragEnded: EventHandler<void>

Protected dragPointsProperty

dragPointsProperty: EDraggingGripPoint[] = [EDraggingGripPoint.Body,EDraggingGripPoint.x1y1,EDraggingGripPoint.x2y2,EDraggingGripPoint.x2y1,EDraggingGripPoint.x1y2]

dragStarted

dragStarted: EventHandler<void>

Protected horizontalAnchorPointProperty

horizontalAnchorPointProperty: EHorizontalAnchorPoint = EHorizontalAnchorPoint.Left

Readonly id

id: string

A unique Id for the IAnnotation

invalidateParentCallback

invalidateParentCallback: () => void
description

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

Type declaration

    • (): void
    • Returns void

Protected isHiddenProperty

isHiddenProperty: boolean = false

Readonly isSvgAnnotation

isSvgAnnotation: boolean = true
description

defines if the annotations is SVG annotation or RenderContext annotation

Protected prevIsSelected

prevIsSelected: boolean = true

Protected prevValue

prevValue: { x: number; y: number }

Type declaration

  • x: number
  • y: number

Protected prevX1Coordinate

prevX1Coordinate: number = 0

Protected prevY1Coordinate

prevY1Coordinate: number = 0

selectedChanged

selectedChanged: EventHandler<boolean>

Protected selectionBoxDeltaProperty

selectionBoxDeltaProperty: number = 1.5

Protected selectionBoxStrokeProperty

selectionBoxStrokeProperty: string = SciChartSurfaceBase.DEFAULT_THEME.annotationSelectionStroke

Protected selectionBoxThicknessProperty

selectionBoxThicknessProperty: number = 6

showWarning

showWarning: boolean = true

Protected svgAdorner

svgAdorner: SVGElement

Protected svgDOMRect

svgDOMRect: DOMRect

Readonly Abstract type

description

annotation type. See EAnnotationType for a list of values

Protected typeMap

typeMap: Map<string, string> = new Map<string, string>()

Protected verticalAnchorPointProperty

verticalAnchorPointProperty: EVerticalAnchorPoint = EVerticalAnchorPoint.Top

Protected xCoordShiftProperty

xCoordShiftProperty: number = 0

The {@link SVGElement} which will be added to the chart

Protected yCoordShiftProperty

yCoordShiftProperty: number = 0

Accessors

annotationLayer

annotationsGripsFill

  • get annotationsGripsFill(): string
  • set annotationsGripsFill(color: string): void
  • The fill color for the adorner drag handle

    inheritdoc

    Returns string

  • The fill color for the adorner drag handle

    inheritdoc

    Parameters

    • color: string

    Returns void

annotationsGripsRadius

  • get annotationsGripsRadius(): number
  • set annotationsGripsRadius(radius: number): void
  • The radius of the adorner drag handle

    inheritdoc

    Returns number

  • The radius of the adorner drag handle

    inheritdoc

    Parameters

    • radius: number

    Returns void

annotationsGripsStroke

  • get annotationsGripsStroke(): string
  • set annotationsGripsStroke(color: string): void
  • The stroke color for the adorner drag handle

    inheritdoc

    Returns string

  • The stroke color for the adorner drag handle

    inheritdoc

    Parameters

    • color: string

    Returns void

horizontalAnchorPoint

  • Gets or sets horizontal anchor point

    Returns EHorizontalAnchorPoint

  • Gets or sets horizontal anchor point

    Parameters

    Returns void

isDraggingStarted

  • get isDraggingStarted(): 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

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

resizeDirections

selectionBoxDelta

  • get selectionBoxDelta(): number
  • set selectionBoxDelta(delta: number): void
  • How much bigger the selection box is than the bounding box of the annotation, in pixels

    inheritdoc

    Returns number

  • How much bigger the selection box is than the bounding box of the annotation, in pixels

    inheritdoc

    Parameters

    • delta: number

    Returns void

selectionBoxStroke

  • get selectionBoxStroke(): string
  • set selectionBoxStroke(color: string): void
  • The stroke color for the adorner selection box

    inheritdoc

    Returns string

  • The stroke color for the adorner selection box

    inheritdoc

    Parameters

    • color: string

    Returns void

selectionBoxThickness

  • get selectionBoxThickness(): number
  • set selectionBoxThickness(delta: number): void
  • The thickness of the selection box line

    inheritdoc

    Returns number

  • The thickness of the selection box line

    inheritdoc

    Parameters

    • delta: number

    Returns void

svg

  • get svg(): SVGElement
  • Returns SVGElement

Protected svgAdornerRoot

  • get svgAdornerRoot(): SVGSVGElement

Protected svgRoot

  • get svgRoot(): SVGSVGElement
  • Gets the {@link SVGSVGElement | SVG Element} at the root of this annotation

    Returns SVGSVGElement

verticalAnchorPoint

  • Gets or sets vertical anchor point

    Returns EVerticalAnchorPoint

  • Gets or sets vertical anchor point

    Parameters

    Returns void

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

xCoordShift

  • get xCoordShift(): number
  • set xCoordShift(value: number): void
  • Gets or sets an offset to shift X-coordinates

    Returns number

  • Gets or sets an offset to shift X-coordinates

    Parameters

    • value: number

    Returns void

xCoordinateMode

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

yCoordShift

  • get yCoordShift(): number
  • set yCoordShift(value: number): void
  • Gets or sets an offset to shift Y-coordinates

    Returns number

  • Gets or sets an offset to shift Y-coordinates

    Parameters

    • value: number

    Returns void

yCoordinateMode

Methods

Protected calcAndSetAnnotationBorders

calcDragDistance

  • calcDragDistance(xyValues: Point): void

canDragPoint

  • Override this to disable drag behaviour for certain dragging points

    Parameters

    Returns boolean

checkIsClickedOnAnnotation

  • checkIsClickedOnAnnotation(x: number, y: number): boolean

Protected checkIsClickedOnAnnotationInternal

  • checkIsClickedOnAnnotationInternal(x: number, y: number): boolean

click

  • Called internally. Send a click to the annotation if the point is in bounds, raising the clicked event and optionally selecting the annotation.

    Parameters

    Returns boolean

clickToSelect

Protected convertFromCoordinate

Protected Abstract create

  • Called to create the SVG Dom Element right before it is added to the parent chart

    Parameters

    Returns void

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

Protected getAbsoluteCoordinates

Protected getAbsoluteHorizontalCoordinate

  • getAbsoluteHorizontalCoordinate(value: number): number

Protected getAbsoluteVerticalCoordinate

  • getAbsoluteVerticalCoordinate(value: number): number

getAdornerAnnotationBorders

  • getAdornerAnnotationBorders(ordered?: boolean, applyDelta?: boolean): { x1: number; x2: number; y1: number; y2: number }
  • Returns annotation borders for the AdornerLayer which has the size of the whole canvas

    Parameters

    • Default value ordered: boolean = false

      flag to return x and y values in ascending order

    • Default value applyDelta: boolean = false

    Returns { x1: number; x2: number; y1: number; y2: number }

    • x1: number
    • x2: number
    • y1: number
    • y2: number

getAnnotationBorders

  • getAnnotationBorders(ordered?: boolean, applyDelta?: boolean): { x1: number; x2: number; y1: number; y2: number }
  • Returns annotationBorders

    Parameters

    • Default value ordered: boolean = false

      flag to return x and y values in ascending order, where x1 <= x2 and y1 <= y2

    • Default value applyDelta: boolean = false

    Returns { x1: number; x2: number; y1: number; y2: number }

    • x1: number
    • x2: number
    • y1: number
    • y2: number

getAnnotationGripSvg

  • getAnnotationGripSvg(x: number, y: number): string
  • Get svg for the adorner grip handles for standard annotations

    Parameters

    • x: number
    • y: number

    Returns string

Protected getCoordinate

getDragPoints

Protected getValue

Protected getValuesFromCoordinates

  • getValuesFromCoordinates(point: Point, translateToSeriesViewRect: boolean): Point
  • Transforms an absolute coordinates point to the corresponding value point. The value point has x and y converted accordingly to the the coordinate modes xCoordinateMode and yCoordinateMode

    Parameters

    • point: Point
    • translateToSeriesViewRect: boolean

      defines if the coordinates should be projected from the Canvas to SeriesViewRect

    Returns Point

    a point with coordinates ECoordinateMode

Protected getX1Coordinate

Protected getX2Coordinate

Protected getXYCoordinatesFromValues

  • getXYCoordinatesFromValues(xyDataPoint: Point): Point

Protected getY1Coordinate

Protected getY2Coordinate

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

onDetach

  • onDetach(): void
  • description

    Called when the annotation is detached from a parent SciChartSurface.

    Returns void

onDpiChanged

  • Called when the Dpi changes in the browser. This could be due to user zooming the browser, or changing DPI settings in Windows, or moving the browser containing SciChart to another monitor

    Parameters

    Returns void

onDragAdorner

onDragEnded

  • onDragEnded(): void

onDragStarted

resumeInvalidate

  • resumeInvalidate(): void
  • Internal use. If isHidden,x1,y1 have change since suspendInvalidate was called, call invalidateParent

    Returns void

Protected setAnnotationBorders

  • setAnnotationBorders(x1: number, x2: number, y1: number, y2: number): void
  • Sets annotationBorders For renderContext annotations it is scaled and for SVG annotations it is not For example if we have a macbook with retina display and canvas.width = 1600px, canvas.height = 1200px, canvas.style.width = 800px, canvas.style.height = 600px If we have BoxAnnotation (renderContext) which takes 50% width and height, located in the left-top corner it should have annotationBorders as follows x1 = 0, x2 = 800, y1 = 0, y2 = 600 But if we have CustomAnnotation (SVG) which takes 50% width and height, located in the left-top corner it should have annotationBorders as follows x1 = 0, x2 = 400, y1 = 0, y2 = 300

    Parameters

    • x1: number
    • x2: number
    • y1: number
    • y2: number

    Returns void

setDragPoints

  • Set the dragging points that should be enabled for this annotation

    Parameters

    Returns void

Protected setSvg

  • setSvg(svg: SVGElement): void
  • Parameters

    • svg: SVGElement

    Returns void

Protected setSvgAttribute

  • setSvgAttribute(attributeName: string, value: number): void
  • Parameters

    • attributeName: string
    • value: number

    Returns void

suspendInvalidate

  • suspendInvalidate(): void
  • Internal use. Captures the state of isHidden,x1,y1 and prevents invalidateParent being called on change to these properties

    Returns void

Protected svgStringAdornerTemplate

  • svgStringAdornerTemplate(x1: number, y1: number, x2: number, y2: number): string

toJSON

update

  • Updates the annotation position, with the Coordinate Calculators passed in

    Parameters

    Returns void

Protected updateAdornerInner

  • updateAdornerInner(): void

Object literals

Protected annotationBorders

annotationBorders: object

the annotation absolute coordinates

x1

x1: number = 0

x2

x2: number = 0

y1

y1: number = 0

y2

y2: number = 0

Generated using TypeDoc