Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

Protected colorProperty

colorProperty: string

dataLabels

dataLabels: TDataLabel[] = []

The text to draw, along with the sizes and positions. Usually generated, but can be set or updated before final drawing

Protected engineeringPrefixProperty

engineeringPrefixProperty: IEngineeringPrefix

Protected horizontalTextPositionProperty

horizontalTextPositionProperty: EHorizontalTextPosition = EHorizontalTextPosition.Right

Protected isEnabledProperty

isEnabledProperty: boolean = true

metaDataSelector

metaDataSelector: (metadata: IPointMetadata) => string

If this is set it will be used to get text values from metaData, rather than formatting y values. The selector will be called even if the metaData for an index is undefined.

Type declaration

Protected numericFormatProperty

numericFormatProperty: ENumericFormat = ENumericFormat.Decimal

Protected parentSeries

parentSeries: IRenderableSeries

The Parent RenderableSeries

Protected pointCountThresholdProperty

pointCountThresholdProperty: number = Infinity

Protected pointGapThresholdProperty

pointGapThresholdProperty: number = 0

Protected precisionProperty

precisionProperty: number = 1

Protected skipModeProperty

skipModeProperty: EDataLabelSkipMode = EDataLabelSkipMode.SkipIfOverlapPrevious

Protected skipNumberProperty

skipNumberProperty: number = 0

Protected state

Protected state1

Protected styleProperty

styleProperty: TDataLabelStyle

Readonly type

type: EDataLabelProviderType = EDataLabelProviderType.Band

updateTextInAnimation

updateTextInAnimation: boolean = false

Whether the label text should update when the label position is animating. Default false.

Protected verticalTextPositionProperty

verticalTextPositionProperty: EVerticalTextPosition = EVerticalTextPosition.Above

Protected webAssemblyContext

webAssemblyContext: TSciChart

The SciChart 2D WebAssembly Context containing native methods and access to our WebGL2 Engine and WebAssembly numerical methods

ySelector

ySelector: (ps: IPointSeries) => SCRTDoubleVector

A function to pick which y values to use from the pointSeries passed in on the renderPassData

Type declaration

Accessors

aboveBelow

  • get aboveBelow(): boolean
  • set aboveBelow(value: boolean): void
  • Gets or Sets whether text should be positioned above the line if it is going down, and below the line if it going up. Default true. When true this overrides horizontalAnchorPoint and verticalAnchorPoint to be left, bottom.

    Returns boolean

  • Gets or Sets whether text should be positioned above the line if it is going down, and below the line if it going up. Default true. When true this overrides horizontalAnchorPoint and verticalAnchorPoint to be left, bottom.

    Parameters

    • value: boolean

    Returns void

color

  • get color(): string
  • set color(value: string): void
  • Gets or sets the color for data labels. Defaults to axis label color

    Returns string

  • Gets or sets the color for data labels. Defaults to axis label color

    Parameters

    • value: string

    Returns void

engineeringPrefix

horizontalTextPosition

isEnabled

  • get isEnabled(): boolean
  • set isEnabled(value: boolean): void
  • Flag to enable/disable dataLabel generation. Default true

    Returns boolean

  • Flag to enable/disable dataLabel generation. Default true

    Parameters

    • value: boolean

    Returns void

numericFormat

  • Gets or sets numeric format to use when formatting values to text. For a list of values, see ENumericFormat For more control, override getText

    Returns ENumericFormat

  • Gets or sets numeric format to use when formatting values to text. For a list of values, see ENumericFormat For more control, override getText

    Parameters

    Returns void

pointCountThreshold

  • get pointCountThreshold(): number
  • set pointCountThreshold(value: number): void
  • Gets or sets the number of points below which drawing will start. Default Infinity This can be used instead of pointGapThreshold when data is unevenly spaced or has large y variation

    Returns number

  • Gets or sets the number of points below which drawing will start. Default Infinity This can be used instead of pointGapThreshold when data is unevenly spaced or has large y variation

    Parameters

    • value: number

    Returns void

pointGapThreshold

  • get pointGapThreshold(): number
  • set pointGapThreshold(value: number): void
  • Gets or sets the zoom threshold above which label drawing will start. Default 0. This is expressed as the gap between the first points divided by the size of the first text If data is unevenly spaced, consider pointCountThreshold or override shouldDrawText

    Returns number

  • Gets or sets the zoom threshold above which label drawing will start. Default 0. This is expressed as the gap between the first points divided by the size of the first text If data is unevenly spaced, consider pointCountThreshold or override shouldDrawText

    Parameters

    • value: number

    Returns void

precision

  • get precision(): number
  • set precision(value: number): void
  • Gets or sets the precision to use when formatting values to text For more control, override getText

    Returns number

  • Gets or sets the precision to use when formatting values to text For more control, override getText

    Parameters

    • value: number

    Returns void

singleLabel

  • get singleLabel(): boolean
  • set singleLabel(value: boolean): void
  • Gets or Sets whether to render a single label with both y and y1 values, in the center of the band, or separate labels for each line. Default false.

    Returns boolean

  • Gets or Sets whether to render a single label with both y and y1 values, in the center of the band, or separate labels for each line. Default false.

    Parameters

    • value: boolean

    Returns void

skipMode

skipNumber

  • get skipNumber(): number
  • set skipNumber(value: number): void
  • The number of points to skip while generating labels. Default 0 = no skip. 1 = skip every other. When creating text with many data points, it will help performance to skip points rather than creating and checking overlap for every data point.

    Returns number

  • The number of points to skip while generating labels. Default 0 = no skip. 1 = skip every other. When creating text with many data points, it will help performance to skip points rather than creating and checking overlap for every data point.

    Parameters

    • value: number

    Returns void

style

  • Gets or sets the text style used for data labels. The style must be set, with fontFamily and fontSize set, in order for text to be drawn.

    Returns TDataLabelStyle

  • Gets or sets the text style used for data labels. The style must be set, with fontFamily and fontSize set, in order for text to be drawn.

    Parameters

    Returns void

verticalTextPosition

Methods

delete

  • delete(): void
  • Returns void

draw

generateDataLabels

getColor

getPosition

getSingleLabelText

  • getSingleLabelText(xVal: number, yVal: number, y1Val: number): string
  • Parameters

    • xVal: number
    • yVal: number
    • y1Val: number

    Returns string

getText

getY1Provider

  • When doing separate labels for each line (ie singleLabel = false) this is used to create a provider to generate the labels for the y1 series. By default this creates a LineSeriesDataLabelProvider using the same options as on the current provider.

    Parameters

    Returns LineSeriesDataLabelProvider

Protected invalidateParent

  • invalidateParent(): void

onAttach

onDetach

  • onDetach(): void
  • Returns void

resolveAutoColors

  • resolveAutoColors(index: number, maxSeries: number, theme: IThemeProvider): void

shouldGenerate

shouldSkipLabel

toJSON

updateStyle

  • Update the style. Only the properties passed will be updated

    Parameters

    Returns void

Generated using TypeDoc