Interface: PropertiesAPI

PropertiesAPI

API class that is used to obtain the list of properties and property layouts, and manage provider registrations.

Example

dashboard.getFeature('Properties')

Methods

deregisterProvider(provider)

Deregisters a provider as a properties provider.

Parameters:
Name Type Description
provider PropertiesProviderAPI

Properties provider to deregister and remove properties

getPropertyLayoutList() → {Array.<Object>}

Returns the list of all property layouts.

Returns:
Type
Array.<Object>

getPropertyList() → {Array.<Object>}

Returns the list of all properties.

Returns:
Type
Array.<Object>

getProviderPropertyNameList()

for debug usage

registerProvider(provider)

Registers a provider as a properties provider.

Parameters:
Name Type Description
provider PropertiesProviderAPI

Properties provider to register and contribute properties