Class: AppFactory

AppFactory(options)

API class that is used to create a custom dashboard application that is dependent on glass. Glass refers to an internal Cognos Analytics API that controls the user interface. It allows developers to perform actions on the UI, such as opening a view or accessing view configurations or services.

Constructor

new AppFactory(options)

Parameters:
Name Type Description
options Object
Properties
Name Type Description
glassContext String

Contains the glass context of the application.
features.name.excludes Array.<String>

List of feature names to prevent from loading for a feature collection.
apiConsumerConfig Array.<String>

Object used to modify api consumer flags, e.g { metadataBlocksVisualization : false }

Methods

create(options) → {Promise.<DashboardCoreAPI>}

Parameters:
Name Type Description
options Object
Properties
Name Type Description
assetId String

Specifies the dashboard asset ID.
spec String

Specifies the dashboard specification.
features.name.excludes Array.<String>

List of feature names to prevent from loading for a feature collection.
Returns:

Dashboard API object

Type
Promise.<DashboardCoreAPI>

getFeature(featureName) → {Object}

Parameters:
Name Type Description
featureName String

Name of feature that is supported by the AppFactory, for example 'ContentStore'.
Returns:

Feature, for example ContentStore object.

Type
Object