Options
All
  • Public
  • Public/Protected
  • All
Menu

A TextAnnotation presents text information over the chart at specific {@link X1}, {@link Y1} coordinates

Hierarchy

Implements

Index

Constructors

constructor

Properties

Optional fontFamily

fontFamily: string = "Arial"

font family provided by the user

Optional fontSize

fontSize: number = 14

font size provided by the user

Optional fontWeight

fontWeight: string = "Normal"

font weight provided by the user

Protected horizontalAnchorPointProperty

horizontalAnchorPointProperty: EHorizontalAnchorPoint = EHorizontalAnchorPoint.Left

invalidateParentCallback

invalidateParentCallback: () => void
description

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

Type declaration

    • (): void
    • Returns void

Protected svg

svg: SVGElement

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

text

text: string = "DEFAULT TEXT"

text provided by the user

textColor

textColor: string = "#ffffff"

text color provided by the user

Readonly type

type: SVG = EAnnotationType.SVG
description

annotation type. See EAnnotationType for a list of values

Protected verticalAnchorPointProperty

verticalAnchorPointProperty: EVerticalAnchorPoint = EVerticalAnchorPoint.Top

Protected xCoordShiftProperty

xCoordShiftProperty: number

Protected yCoordShiftProperty

yCoordShiftProperty: number

Accessors

annotationLayer

horizontalAnchorPoint

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

parentSurface

Protected svgRoot

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

    Returns SVGSVGElement

verticalAnchorPoint

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 create

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 getCoordinate

Protected getValue

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

update

Generated using TypeDoc