Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional calculateTextBounds

calculateTextBounds: boolean

If you want to be able to look at the position and size of labels before they are drawn, set this true otherwise it is faster to leave it false.

Optional color

color: string

Sets the color for data labels. Defaults to axis label color

Optional drawImmediate

drawImmediate: boolean

Draws immediately, set this True when using sub-surfaces for proper data label layering

Optional engineeringPrefix

engineeringPrefix: IEngineeringPrefix

Engineering prefixes used with ENumericFormat.Engineering

Optional formatValue

formatValue: TFormatLabelFn

A function converting a data value to text, overriding labelFormat/labelPrecision/engineeringPrefix. Must depend only on the value (results are cached per value).

Optional getClipRect

getClipRect: (renderPassData: RenderPassData) => Rect

When set, this provider's labels are drawn immediately after generation (during the series draw), clipped to the returned rect (surface coordinates), instead of in the deferred global text pass. Consequences: clipped labels draw at the series-layer z-order and are excluded from {@link DataLabelLayoutManager} global text layout. Return undefined to skip drawing clipped for a pass. Use getYRangeClipRect to clip to the series' y-axis range (e.g. one grid column).

Type declaration

Optional horizontalTextPosition

horizontalTextPosition: EHorizontalTextPosition

Sets the horizontal text position for the label

Optional isEnabled

isEnabled: boolean

Flag to enable/disable dataLabel generation. Default true

Optional labelFormat

labelFormat: ENumericFormat

Numeric format used to convert values to text (includes date formats). Default ENumericFormat.Decimal

Optional labelPostfix

labelPostfix: string

A postfix added to each formatted label

Optional labelPrecision

labelPrecision: number

Number of decimal places (or significant figures, format-dependent) used to convert values to text. Default 1

Optional labelPrefix

labelPrefix: string

A prefix added to each formatted label

Optional style

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.

Optional textField

textField: string | number

The name or index of a value array on the dataSeries whose values are formatted as the label text. When unset: an XyTextDataSeries' textValues are used if present, otherwise the series' selected y values ({@link IRenderableSeries.yArrayFilter}-aware) are formatted.

Optional verticalTextPosition

verticalTextPosition: EVerticalTextPosition

Sets the vertical text position for the label

Generated using TypeDoc