ChartIndicator Class
Contains settings for Trend Indicators of the Chart dashboard item.
#Declaration
export class ChartIndicator extends SerializableModel
#Inheritance
#constructor
Initializes a new instance of the ChartIndicator
class with specified settings.
#Declaration
constructor(
model?: any,
serializer?: any,
info?: any
)
#Parameters
Name | Type | Description |
---|---|---|
model | any | A model of chart indicator. Do not pass this parameter directly. |
serializer | any | An object used for dashboard deserialization. Do not pass this parameter directly. |
info | any | An array of objects that contains serialization info. Do not pass this parameter directly. |
#Properties
#color Property
Specifies the trend indicator’s color.
#Declaration
color: ko.Observable<string>
#Property Value
Type | Description |
---|---|
Observable<string> | The indicator color. |
#customTypeName Property
Specifies the name of the custom indicator type.
#Declaration
customTypeName: ko.Observable<string>
#Property Value
Type | Description |
---|---|
Observable<string> | The name of the custom indicator type. |
#dashStyle Property
Specifies the dash style used to paint the line.
#Declaration
dashStyle: ko.Observable<string>
#Property Value
Type | Description |
---|---|
Observable<string> | The dash style used to paint the line. |
#displayName Property
Specifies the display name of the custom indicator type.
#Declaration
displayName: ko.Observable<string>
#Property Value
Type | Description |
---|---|
Observable<string> | The display name of the custom indicator type. |
#itemType Property
#Declaration
itemType: ko.Observable<string>
#Property Value
Type |
---|
Observable<string> |
#legendText Property
Specifies the text that identifies the trend indicator within the legend.
#Declaration
legendText: ko.Observable<string>
#Property Value
Type | Description |
---|---|
Observable<string> | The indicator’s legend text. |
#name Property
Specifies the name of the trend indicator within the indicators collection.
#Declaration
name: ko.Observable<string>
#Property Value
Type | Description |
---|---|
Observable<string> | The indicator name. |
#showInLegend Property
Specifies whether to display the trend indicator in the legend.
#Declaration
showInLegend: ko.Observable<boolean>
#Property Value
Type | Description |
---|---|
Observable<boolean> |
|
#thickness Property
Specifies the thickness of the indicator line.
#Declaration
thickness: ko.Observable<number>
#Property Value
Type | Description |
---|---|
Observable<number> | An integer value which specifies the indicator line’s thickness, in pixels. |
#value Property
Specifies the measure data item that is used to calculate the trend indicator.
#Declaration
value: ko.Observable<string>
#Property Value
Type | Description |
---|---|
Observable<string> | A data item’s ID that specifies the measure used to calculate the trend indicator. |
#valueLevel Property
Gets or sets the value that specifies which series point value should be used to calculate the indicator.
#Declaration
valueLevel: ko.Observable<string>
#Property Value
Type | Description |
---|---|
Observable<string> | The value that specifies which series point value should be used to calculate the indicator. |
#visible Property
Specifies whether to display the trend indicator.
#Declaration
visible: ko.Observable<boolean>
#Property Value
Type | Description |
---|---|
Observable<boolean> |
|
#Methods
#getInfo Method
For internal use.
#Declaration
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray
#Returns
Type | Description |
---|---|
ISerialization |
An array of objects that contains serialization info. |