Skip to main content

Dashboard consumption page APIs

The dossierConsumption object is the manipulator of the MicroStrategy dashboard consumption page. It could be got by embeddingContext.dossierConsumption.

The details of the embeddingContext object could be seen in Embedding context.

The APIs under Library page object are as below.

Dashboard consumption page APIs​

getDossierDefinition()​

Description​

This API is used for getting the dashboard definition. Its result contains the dashboard id, name, project id and TOC information.

Class​

DossierConsumption

Return type​

This API would return a Promise object that resolves to an object that contains the dashboard definition. Its serialized JSON string is as below:

{
  "id": "EC5441154009D3C39D5BD6AD75865EF4",
  "name": "DDA_Dossier_filter_SearchBox_style",
  "projectId": "B19DEDCC11D4E0EFC000EB9495D0F44F",
  "chapters": [
    {
      "key": "K36",
      "name": "Chapter 1",
      "pages": [
        {
          "key": "K53",
          "name": "Page 1"
        },
        {
          "key": "W78",
          "name": "Page 2"
        }
      ]
    }
  ]
}

If the API encounters an error in its executing process, the error would be thrown and could be caught.

Example​

try {
  const dossierDefinition = await embeddingContext.dossierConsumption.getDossierDefinition();
} catch (err) {
  // The error handling logic here
  console.error(err);
}

getCurrentPageInfo()​

Description​

This API could be used to get the currently chapter and page information.

Class​

DossierConsumption

Return type​

This API would return a Promise object that resolves to an object that contains the current chapter and page. Its serialized JSON string is as below:

{
  "chapterKey": "K36",
  "pageKey": "W58"
}

Example​

try {
  const currentPageInfo = await embeddingContext.dossierConsumption.getCurrentPageInfo();
} catch (err) {
  // The other error handling logic here
  console.error(err);
}

selectComponents(componentKeys)​

Description​

This API could be used to select visualizations or groups on a dashboard consumption page.

Class​

DossierConsumption

Input Parameters​

  • componentKeys:

    Data Type

    array

    Required?

    Yes

Return type​

This API would return a Promise object that resolves to void. If it encounters an error in its executing process, the error would be thrown and could be caught.

Example​

try {
  const response = await embeddingContext.dossierConsumption.selectComponents([
    "K53",
    "53ACF03646491B5F5F5A7B83EB1BB0BE",
  ]);
} catch (err) {
  // The other error handling logic here
}

getSelectedComponents()​

Description​

This API could be used to get currently selected visualizations and groups on a dashboard consumption page.

Class​

DossierConsumption

Return type​

This API would return a Promise object that resolves to an object that contains the selected components. Its serialized JSON string is as below:

{
  "projectId": "B19DEDCC11D4E0EFC000EB9495D0F44F",
  "dossierId": "EC5441154009D3C39D5BD6AD75865EF4",
  "selectedComponents": [
    {
      "key": "K52",
      "type": "visualization",
      "chapterKey": "K36",
      "pageKey": "K53"
    },
    {
      "key": "53ACF03646491B5F5F5A7B83EB1BB0BE",
      "type": "group",
      "chapterKey": "K87",
      "pageKey": "K67"
    }
  ]
}

If the API encounters an error in its executing process, the error would be thrown and could be caught.

Example​

try {
  const selectedComponents = await embeddingContext.dossierConsumption.getSelectedComponents();
} catch (err) {
  // The other error handling logic here
  console.error(err);
}

getDossierInstanceId()​

Description​

The API details are identical to Dossier.getDossierInstanceId()

getCurrentPageVisualizationList()​

Description​

The API details are identical to Dossier.getCurrentPageVisualizationList()

changeVisualizationSize(props)​

Description​

The API details are identical to Dossier.changeVisualizationSize(props)

getCurrentPagePanelStacks()​

Description​

The API details are identical to Dossier.getCurrentPagePanelStacks()

switchPanel(panelKey)​

Description​

The API details are identical to Dossier.switchPanel(panelKey)

getAvailableElements(vizKey)​

Description​

The API details are identical to Dossier.getAvailableElements(visKey)

selectVisualizationElements(props)​

Description​

The API details are identical to Dossier.selectVizElement(props)

getTableContent()​

Description​

This API is deprecated. You can use getDossierDefinition() to get table content. The API details are identical to Dossier.getTableContent().

getChapterList()​

Description​

This API is deprecated. You can use getDossierDefinition() to get table content. The API details are identical to Dossier.getChapterList().

getCurrentChapter()​

Description​

This API is deprecated. You can use getCurrentPageInfo() to get the current chapter and page information. The API details are identical to Dossier.getCurrentChapter().

getCurrentPage()​

Description​

This API is deprecated. You can use getCurrentPageInfo() to get the current chapter and page information. The API details are identical to Dossier.getCurrentPage().

getPageByNodeKey(nodeKey)​

Description​

This API is deprecated. You can use EmbeddingContext.goToPage(pageInfo) to navigate to a page without such preparations. The API details are identical to Dossier.getPageByNodeKey(nodeKey).

goToPrevPage()​

Description​

The API details are identical to Dossier.goToPrevPage().

goToNextPage()​

Description​

The API details are identical to Dossier.goToNextPage().

Description​

The API details are identical to Dossier.navigateToPage(page).

openFilterSummaryBar()​

Description​

The API details are identical to Dossier.openFilterSummaryBar().

closeFilterSummaryBar()​

Description​

The API details are identical to Dossier.closeFilterSummaryBar().

filterSelectAllAttributes(filterJson)​

Description​

This API is deprecated. You can use filterSelectAllAttributeElements(filterJson) instead.

The API details are identical to Dossier.filterSelectAllAttributes(filterJson).

filterSelectAllAttributeElements(filterJson)​

Description​

The API details are identical to Dossier.filterSelectAllAttributes(filterJson).

filterDeselectAllAttributes(filterJson)​

Description​

This API is deprecated. You can use filterDeselectAllAttributeElements(filterJson)instead.

The API details are identical to Dossier.filterDeselectAllAttributes(filterJson).

filterDeselectAllAttributeElements(filterJson)​

Description​

The API details are identical to Dossier.filterDeselectAllAttributes(filterJson).

filterSelectMultiAttributes(filterJson)​

Description​

The API details are identical to Dossier.filterSelectMultiAttributes(filterJson).

filterSelectSingleAttribute(filterJson)​

Description​

The API details are identical to Dossier.filterSelectSingleAttribute(filterJson).

filterSearchSingleAttribute(filterJson)​

Description​

The API details are identical to Dossier.filterSearchSingleAttribute(filterJson).

filterSearchMultiAttributes(filterJson)​

Description​

The API details are identical to Dossier.filterSearchMultiAttributes(filterJson).

filterSetDateRange(filterJson)​

Description​

The API details are identical to Dossier.filterSetDateRange(filterJson).

filterSetMetricQualByValue(filterJson)​

Description​

The API details are identical to Dossier.filterSetMetricQualByValue(filterJson).

filterSetMetricQualByRank(filterJson)​

Description​

The API details are identical to Dossier.filterSetMetricQualByRank(filterJson).

filterAttributeSingleSlider(filterJson)​

Description​

The API details are identical to Dossier.filterAttributeSingleSlider(filterJson).

filterAttributeMultiSlider(filterJson)​

Description​

The API details are identical to Dossier.filterAttributeMultiSlider(filterJson).

filterApplyAll()​

Description​

The API details are identical to Dossier.filterApplyAll().

filterClearAll()​

Description​

The API details are identical to Dossier.filterClearAll().

filterClear(filterJson)​

Description​

The API details are identical to Dossier.filterClear(filterJson).

filterSetInclude(filterJson)​

Description​

The API details are identical to Dossier.filterSetInclude(filterJson).

filterSetExclude(filterJson)​

Description​

The API details are identical to Dossier.filterSetExclude(filterJson).

getFilterList()​

Description​

The API details are identical to Dossier.getFilterList().