Options
All
  • Public
  • Public/Protected
  • All
Menu
summary

The BoxAnnotation provides an Annotation which draws a rectangle or box over the SciChartSurface

description

To add a BoxAnnotation to a SciChartSurface, use the following code:

const sciChartSurface: SciChartSurface;
const boxAnnotation = new BoxAnnotation( { x1: 1, x2: 2, y1: 3, y2: 4, fill: "#FF000077", stroke: "#FF0000"});
sciChartSurface.annotations.add(boxAnnotation);
remarks

Uses the fast WebGL/WebAssembly {@link WebGL2RenderingContext} for rendering

Hierarchy

Implements

Index

Constructors

constructor

Properties

adornerDraggingPoint

adornerDraggingPoint: EDraggingGripPoint

dragDelta

dragEnded

dragEnded: EventHandler<void>

dragStarted

dragStarted: EventHandler<void>

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 = false
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

showWarning

showWarning: boolean = true

Protected svgAdorner

svgAdorner: SVGElement

Readonly type

type: RenderContextBoxAnnotation = EAnnotationType.RenderContextBoxAnnotation
description

annotation type. See EAnnotationType for a list of values

Protected typeMap

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

Accessors

annotationLayer

fill

  • get fill(): string
  • set fill(htmlColorCode: string): void
  • Gets the fill for the BoxAnnotation

    remarks

    Acceptable values include RGB format e.g. #FF0000, RGBA format e.g. #FF000077`` and RGBA format e.g.rgba(255,0,0,0.5)```

    Returns string

  • Sets the fill for the BoxAnnotation

    remarks

    Acceptable values include RGB format e.g. #FF0000, RGBA format e.g. #FF000077`` and RGBA format e.g.rgba(255,0,0,0.5)```

    Parameters

    • htmlColorCode: string

    Returns void

isDraggingStarted

  • get isDraggingStarted(): boolean

isEditable

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

isHidden

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

isSelected

  • get isSelected(): boolean
  • set isSelected(value: boolean): 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

stroke

  • get stroke(): string
  • set stroke(htmlColorCode: string): void
  • Gets stroke for the outline of the BoxAnnotation

    remarks

    Acceptable values include RGB format e.g. #FF0000, RGBA format e.g. #FF000077`` and RGBA format e.g.rgba(255,0,0,0.5)```

    Returns string

  • Sets the stroke for the outline of the BoxAnnotation

    remarks

    Acceptable values include RGB format e.g. #FF0000, RGBA format e.g. #FF000077`` and RGBA format e.g.rgba(255,0,0,0.5)```

    Parameters

    • htmlColorCode: string

    Returns void

strokeThickness

  • get strokeThickness(): number
  • set strokeThickness(value: number): void
  • Gets the strokeThickness for the outline of the BoxAnnotation

    Returns number

  • Sets the strokeThickness for the outline of the BoxAnnotation

    Parameters

    • value: number

    Returns void

Protected svgAdornerRoot

  • get svgAdornerRoot(): SVGSVGElement

x1

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

x2

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

xAxisId

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

xCoordinateMode

y1

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

y2

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

yAxisId

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

yCoordinateMode

Methods

calcDragDistance

  • calcDragDistance(xyValues: Point): void

checkIsClickedOnAnnotation

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

Protected checkIsClickedOnAnnotationInternal

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

clickToSelect

Protected convertFromCoordinate

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

drawWithContext

Protected getAbsoluteCoordinates

Protected getAbsoluteHorizontalCoordinate

  • getAbsoluteHorizontalCoordinate(value: number): number

Protected getAbsoluteVerticalCoordinate

  • getAbsoluteVerticalCoordinate(value: number): number

getAdornerAnnotationBorders

  • getAdornerAnnotationBorders(ordered?: 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

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

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

getAnnotationBorders

  • getAnnotationBorders(ordered?: 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

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

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

Protected getCoordinate

Protected getValue

Protected getValuesFromCoordinates

  • getValuesFromCoordinates(point: Point, translateToSeriesViewRect: boolean): Point

Protected getX1Coordinate

Protected getX2Coordinate

Protected getXYCoordinatesFromValues

  • getXYCoordinatesFromValues(xyDataPoint: Point): Point

Protected getY1Coordinate

Protected getY2Coordinate

Protected notifyPropertyChanged

  • notifyPropertyChanged(propertyName: string): void

onAttach

onDetach

  • onDetach(): void

onDpiChanged

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

suspendInvalidate

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

    Returns void

toJSON

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