CustomProperties Class

Declaration

export class CustomProperties extends SerializableModel

Inherited Members

disposed

Inheritance

SerializableModel

CustomProperties

constructor(json)

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

Declaration

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

Parameters

Name	Type	Description
json	any
serializer	IModelSerializer	An object used for dashboard deserialization. Do not pass this parameter directly.
info	IDashboardSerializationInfoArray	An array of objects that provide serialization info.

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