Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

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 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 isEnabled

isEnabled: boolean

Flag to enable/disable dataLabel generation. Default true

Optional 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

Optional numericFormat

numericFormat: ENumericFormat

Gets or sets numeric format to use for formatting values to text. For a list of values, see ENumericFormat

Optional polarLabelMode

polarLabelMode: EPolarLabelMode

Gets or sets polar label mode to use for calculating data label rotation. Default Horizontal For a list of value, see EPolarLabelMode

Optional precision

precision: number

Gets or sets the precision to use when formatting values to text.

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.

Generated using TypeDoc