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.

Inherited Members

disposed

orientation

overlappingMode

showPointLabels

Inheritance

SerializableModel

PointLabelOptionsBase

PointLabelOptions

constructor

Initializes a new instance of the PointLabelOptions class.

Declaration

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

Parameters

Name	Type	Description
JSON	any	A JSON object used for dashboard deserialization. Do not pass this parameter directly.
serializer	ModelSerializer	An object used for dashboard deserialization. Do not pass this parameter directly.

Properties

contentType Property

Specifies the type of content displayed within series point labels.

Declaration

contentType: ko.Observable<DevExpress.Dashboard.Model.PointLabelContentType>

Property Value

Type	Description
Observable<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: ko.Observable<DevExpress.Dashboard.Model.PointLabelPosition>

Property Value

Type	Description
Observable<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: ko.Observable<boolean>

Property Value

Type	Description
Observable<boolean>	true, to show point labels for zero values; otherwise, false.

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

Returns

Type	Description
ISerializationInfoArray	An array of objects that provide serialization info.

grabFrom(options) Method

Declaration

grabFrom(
    options: PointLabelOptions
): void

Parameters

Name	Type
options	PointLabelOptions