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?: IModelSerializer,
    info?: IDashboardSerializationInfoArray
)

Parameters

Name	Type
json	any
serializer	IModelSerializer
info	IDashboardSerializationInfoArray

Properties

getInfo Property

Declaration

getInfo: () => 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