All docs
V20.1
20.1
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
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.

CustomProperties Class

Declaration

export class CustomProperties extends SerializableModel

constructor(json)

Initializes a new instance of the CustomProperties class with specified settings.

Declaration

constructor(json: any, serializer?: DevExpress.Analytics.Utils.IModelSerializer, info?: IDashboardSerializationInfoArray)

Parameters

Name Type
json any
serializer IModelSerializer
info IDashboardSerializationInfoArray

Properties

getInfo Property

Declaration

getInfo: () => DevExpress.Analytics.Utils.ISerializationInfoArray

Property Value

Type
() => ISerializationInfoArray

Methods

getValue(propertyName) Method

Gets the custom property's value.

Declaration

getValue(propertyName: string): CustomPropertyValueType

Parameters

Name Type Description
propertyName string

A string that is a property name.

Returns

Type Description
CustomPropertyValueType

A CustomPropertyValueType value that defines a custom property's type.

Remarks

The custom property string value you get from the server is a string that can be set by a user. To avoid XSS attacks, do not pass this value to HTML markup as is.

setValue(propertyName, propertyValue) Method

Declaration

setValue(propertyName: string, propertyValue: CustomPropertyValueType): void

Parameters

Name Type
propertyName string
propertyValue CustomPropertyValueType