Types and Interfaces

API reference for the MicroStrategy types and interfaces provided by the embed-dossier-mstr-react package.

Types and Interfaces

The embed-dossier-mstr-react package provides a comprehensive set of TypeScript types and interfaces that help you work with the MicroStrategy Embedding SDK. These types provide strong typing for all aspects of embedding MicroStrategy content in your React applications.

Core Types

These are the primary types that you'll work with when embedding MicroStrategy content:

TypeDescription
MicroStrategySDKThe main interface for the MicroStrategy SDK object available on the global window object
MicroStrategyDossierInterface for the dossier (dashboard) object returned when creating an embedded dossier
MicroStrategyDossierConfigConfiguration options for embedding a dossier
EmbedLibraryPageInterface for the library page object returned when embedding a library page
EmbedLibraryPageConfigConfiguration options for embedding a library page
EmbedDossierConsumptionPageInterface for the dossier consumption page object
EmbedDossierConsumptionPageConfigConfiguration options for embedding a dossier consumption page
EmbedBotConsumptionPageInterface for the bot consumption page object
EmbedBotConsumptionPageConfigConfiguration options for embedding a bot consumption page
EmbedReportPageInterface for the report page object
EmbedReportPageConfigConfiguration options for embedding a report page

These types help you work with the structure and navigation elements of MicroStrategy content:

TypeDescription
TableOfContentsInterface for the table of contents structure of a dossier
DossierChapterInterface representing a chapter within a dossier
DossierPageInterface representing a page within a dossier
PageInfoInformation about a page for navigation purposes

UI and Configuration Types

These types help you customize the appearance and behavior of embedded content:

TypeDescription
CustomUiOptions for customizing the UI of embedded content
NavigationBarOptions for configuring the navigation bar
OptionsFeatureOptions for configuring various features
ShareFeatureOptions for configuring sharing capabilities
SettingsSettings for configuring various aspects of embedded content

Event Handling Types

These types help you work with events in the MicroStrategy SDK:

TypeDescription
EventTypesTypes of events that can be listened for
EventHandlerInterface for an event handler function

Filter Types

These types help you work with filters in MicroStrategy content:

TypeDescription
FilterJsonJSON structure for filter definitions
FilterCreationOptions for creating filters
FilterListTypeStructure for lists of filters

Global Declarations

The package extends the global Window interface to include MicroStrategy SDK access:

declare global {
  interface Window {
    microstrategy: MicroStrategySDK
  }
}

This allows you to access the MicroStrategy SDK via window.microstrategy after it's loaded.

Type Import Example

When working with the package, you can import the types you need:

import {
  EmbedBotConsumptionPageConfig,
  EmbedLibraryPage,
  MicroStrategyDossier,
  MicroStrategyDossierConfig,
} from "embed-dossier-mstr-react"

// Then use these types in your code
const config: MicroStrategyDossierConfig = {
  placeholder: document.getElementById("dossier-container"),
  url: "https://your-mstr-server/MicroStrategyLibrary/app/[PROJECT_ID]/[DOSSIER_ID]",
}

For more detailed information about each type, follow the links to their individual reference pages.