Interface: SerializerAPI

SerializerAPI

API class for the Dashboard Serializer feature, which allows the generation of a JS object representing the dashboard.

Example

dashboard.getFeature('Serializer')

Methods

toJSON(optionsopt) → {object}

Calling this method builds and return a JS object representing the current dashboard. If given a list of content IDs, a minimum dashboard spec (containing the specified IDs) will be returned.
Parameters:
Name Type Attributes Description
options Object <optional>
 Options used to generate a dashboard spec.
Properties
Name Type Description
contentIds Array List of content IDs
dashboardFeatures Array List of dashboard features to include in the spec, include all features by default.
Returns:
JS object representing the current dashboard
Type
object