Enumeration: EventName

Enum representing the SDK events to listen for on embedded components. Events triggered by component functions to handle with addEventListener().

  • COMPONENT_LOADED: Event received when a component loads completely, including all metadata, filters, and layouts.

  • UPDATED_FILTERS: Event received when the filters for a component are updated.

  • UPDATED_TIME_RANGE: Event received when the time range for an AnalyticsMetric component is updated.

  • UPDATED_SELECTIONS: Event received when the selections for an AnalyticsVisualization component are updated.

  • RECEIVED_DATASOURCES: Event received when the datasources for an AnalyticsDashboard is loaded.

  • RECEIVED_FIELDS: Event received when fields associated with a component are loaded.

  • RECEIVED_FILTERS: Event received when the list of applied filters for a component is loaded.

  • RECEIVED_FILTER_FIELD_VALUES: Event received when filter field values associated with a component field are loaded.

  • RECEIVED_INTERACTION_DETAILS: Event received when the interaction Details associated with component are loaded.

  • RECEIVED_LAYOUT: Event received when the layout for an AnalyticsMetric component is loaded.

  • RECEIVED_METADATA: Event received when metadata for an AnalyticsDashboard or AnalyticsVisualization component is loaded.

  • RECEIVED_PAGES: Event received when a list of page labels for an AnalyticsDashboard component is loaded.

  • RECEIVED_SELECTIONS: Event received when the list of applied selections for an AnalyticsVisualization is loaded.

  • DEFAULT: Event received when an enumerated event name isn't specified.

  • ERROR: Event received for global SDK and component errors.

COMPONENT_LOADED: "ComponentLoaded"

enums/sdk.enums.ts:182


DEFAULT: "DEFAULT"

enums/sdk.enums.ts:199


ERROR: "Error"

enums/sdk.enums.ts:200


RECEIVED_DATASOURCES: "ReceivedDatasources"

enums/sdk.enums.ts:195


RECEIVED_FIELDS: "ReceivedFields"

enums/sdk.enums.ts:193


RECEIVED_FILTERS: "ReceivedFilters"

enums/sdk.enums.ts:187


RECEIVED_FILTER_FIELD_VALUES: "ReceivedFilterFieldValues"

enums/sdk.enums.ts:194


RECEIVED_INTERACTION_DETAILS: "ReceivedInteractionDetails"

enums/sdk.enums.ts:196


RECEIVED_LAYOUT: "ReceivedLayout"

enums/sdk.enums.ts:191


RECEIVED_METADATA: "ReceivedMetadata"

enums/sdk.enums.ts:192


RECEIVED_PAGES: "ReceivedPages"

enums/sdk.enums.ts:189


RECEIVED_PARAMETERS: "ReceivedParameters"

enums/sdk.enums.ts:197


RECEIVED_SELECTIONS: "ReceivedSelections"

enums/sdk.enums.ts:190


RECEIVED_TIME_RANGE: "ReceivedTimeRange"

enums/sdk.enums.ts:188


UPDATED_FILTERS: "UpdatedFilters"

enums/sdk.enums.ts:183


UPDATED_PARAMETERS: "UpdatedParameters"

enums/sdk.enums.ts:186


UPDATED_SELECTIONS: "UpdatedSelections"

enums/sdk.enums.ts:185


UPDATED_TIME_RANGE: "UpdatedTimeRange"

enums/sdk.enums.ts:184