The requested page is not available for the requested platform. You are viewing the content for Default platform.
All docs
V18.2
19.1 (preview)
18.2
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

PointLabelOptions Class

Contains options related to series point labels.

Declaration

export class PointLabelOptions extends PointLabelOptionsBase

Remarks

Use the ChartSeries.pointLabelOptions property to get access to options related to series point labels.

Inheritance

PointLabelOptionsBase
PointLabelOptions

constructor

Initializes a new instance of the PointLabelOptions class.

Declaration

constructor(JSON?: any, serializer?: DxDesigner.Analytics.Utils.ModelSerializer)

Optional Parameters

Type Name Default Description
any JSON null
DxDesigner.Analytics.Utils.ModelSerializer serializer null

An object used for a dashboard deserialization. Do not pass this parameter directly.

Properties

contentType Property

Specifies the type of content displayed within series point labels.

Declaration

contentType: KnockoutObservable<PointLabelContentType>

Property Value

Type Description
KnockoutObservable<PointLabelContentType>

A value that specifies the type of content displayed within series point labels.

position Property

Specifies point labels' position relative to bars.

Declaration

position: KnockoutObservable<PointLabelPosition>

Property Value

Type Description
KnockoutObservable<PointLabelPosition>

A PointLabelPosition object that specifies the point label position.

Remarks

Point labels can be displayed inside or outside bars. When you select the inside position and there is no enough space inside the bars, point labels are not displayed. Switch the position to outside to display labels.

showForZeroValues Property

Specifies whether to show point labels for zero values.

Declaration

showForZeroValues: KnockoutObservable<boolean>

Property Value

Type Description
KnockoutObservable<boolean>

true, to show point labels for zero values; otherwise, false.

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationsInfo

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationsInfo

 

grabFrom(options) Method

Declaration

grabFrom(options: PointLabelOptions): void

Parameters

Name Type Description
options PointLabelOptions