Skip to content
Request a demo
On this page
interface Alpha Guide: AnalyticalDesigner component Guide: Customize Analytical Designer Source: analyticalDesignerTypes.ts ↗

IAnalyticalDesignerConfig

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Configuration of Analytical Designer.

export interface IAnalyticalDesignerConfig

Remarks

Analytical Designer reads the values that set up the runtime (locale, settings, organization, theme, telemetry and read-only mode) when it mounts. Changes to the route values (sourceDashboard, sourceInsight, the actions, the tags, the separators, asOfDate, isEmbedded and allowDashboardLinks) navigate Analytical Designer.

Properties

Property

Modifiers

Type

Description

agGridToken?

string

(ALPHA) (Optional) AG Grid token for the pivot table. The default comes from the settings.

allowDashboardLinks?

boolean

(ALPHA) (Optional) Whether the drill-to-dashboard configuration can link dashboards.

asOfDate?

string

(ALPHA) (Optional) Date that relative date filters are computed from, in the YYYY-MM-DD format.

colorPalette?

IColorPalette

(ALPHA) (Optional) Color palette of the charts. Analytical Designer loads the palette of the workspace when it is not provided.

displayedActions?

Array<“cancel”>

(ALPHA) (Optional) Header actions to show that are hidden by default.

excludeObjectsWithTags?

string[]

(ALPHA) (Optional) The catalog items with one of these tags are hidden.

formatLocale?

string

(ALPHA) (Optional) Locale that formats numbers and dates. The default comes from the settings.

hiddenActions?

AnalyticalDesignerHiddenAction[]

(ALPHA) (Optional) Header actions to hide.

includeObjectsWithTags?

string[]

(ALPHA) (Optional) Only the catalog items with one of these tags are shown.

isEmbedded?

boolean

(ALPHA) (Optional) Marks Analytical Designer as opened from a dashboard.

isReadOnly?

boolean

(ALPHA) (Optional) Hides the actions that change the insight: save, save as and create new.

locale?

ILocale

(ALPHA) (Optional) Locale of the user interface. The default is en-US.

mapboxToken?

string

(ALPHA) (Optional) Mapbox token for the geo charts. The default comes from the settings.

organization?

{ id?: string; title?: string; isAdmin?: boolean; expiredDate?: string; entitlements?: IEntitlementDescriptor[]; }

(ALPHA) (Optional) The organization. Analytical Designer loads its id and title when id is not provided. The other values are stored in the bootstrap data for hosts that pass them; Analytical Designer itself reads none of them today (the trial dialog that did was removed).

separators?

ISeparators

(ALPHA) (Optional) Separators of thousands and decimals. The default comes from the settings.

settings?

IUserWorkspaceSettings | IUserSettings

(ALPHA) (Optional) Settings and feature flags. Analytical Designer loads them from the backend when they are not provided.

sourceDashboard?

string | ObjRef

(ALPHA) (Optional) Dashboard the edited insight comes from. Its presence, not its value, starts the edit-from-dashboard flow: the header offers going back to the dashboard. An empty string means the dashboard is not saved yet.

sourceInsight?

string | ObjRef

(ALPHA) (Optional) Insight to open as an unsaved copy (the explore flow). Saving creates a new insight.

telemetryCallbacks?

IAnalyticalDesignerTelemetryCallbacks

(ALPHA) (Optional) Forwards the Analytical Designer telemetry into the host’s pipeline. The default tracks nothing.

user?

IUser

(ALPHA) (Optional) The current user. Analytical Designer loads it when it is not provided.

whiteLabeling?

{ logoUrl?: string; isBranded?: boolean; }

(ALPHA) (Optional) White labeling of the Analytical Designer user interface.

Property details

IAnalyticalDesignerConfig.agGridTokenpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

AG Grid token for the pivot table. The default comes from the settings.

agGridToken?: string;

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Whether the drill-to-dashboard configuration can link dashboards.

allowDashboardLinks?: boolean;

IAnalyticalDesignerConfig.asOfDatepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Date that relative date filters are computed from, in the YYYY-MM-DD format.

asOfDate?: string;

IAnalyticalDesignerConfig.colorPalettepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Color palette of the charts. Analytical Designer loads the palette of the workspace when it is not provided.

colorPalette?: IColorPalette;

IAnalyticalDesignerConfig.displayedActionspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Header actions to show that are hidden by default.

displayedActions?: Array<"cancel">;

IAnalyticalDesignerConfig.excludeObjectsWithTagspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

The catalog items with one of these tags are hidden.

excludeObjectsWithTags?: string[];

IAnalyticalDesignerConfig.formatLocalepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Locale that formats numbers and dates. The default comes from the settings.

formatLocale?: string;

IAnalyticalDesignerConfig.hiddenActionspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Header actions to hide.

hiddenActions?: AnalyticalDesignerHiddenAction[];

IAnalyticalDesignerConfig.includeObjectsWithTagspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Only the catalog items with one of these tags are shown.

includeObjectsWithTags?: string[];

IAnalyticalDesignerConfig.isEmbeddedpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Marks Analytical Designer as opened from a dashboard.

isEmbedded?: boolean;

IAnalyticalDesignerConfig.isReadOnlypropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Hides the actions that change the insight: save, save as and create new.

isReadOnly?: boolean;

IAnalyticalDesignerConfig.localepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Locale of the user interface. The default is en-US.

locale?: ILocale;

IAnalyticalDesignerConfig.mapboxTokenpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Mapbox token for the geo charts. The default comes from the settings.

mapboxToken?: string;

IAnalyticalDesignerConfig.organizationpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

The organization. Analytical Designer loads its id and title when id is not provided. The other values are stored in the bootstrap data for hosts that pass them; Analytical Designer itself reads none of them today (the trial dialog that did was removed).

organization?: {
        id?: string;
        title?: string;
        isAdmin?: boolean;
        expiredDate?: string;
        entitlements?: IEntitlementDescriptor[];
    };

IAnalyticalDesignerConfig.separatorspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Separators of thousands and decimals. The default comes from the settings.

separators?: ISeparators;

IAnalyticalDesignerConfig.settingspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Settings and feature flags. Analytical Designer loads them from the backend when they are not provided.

settings?: IUserWorkspaceSettings | IUserSettings;

IAnalyticalDesignerConfig.sourceDashboardpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Dashboard the edited insight comes from. Its presence, not its value, starts the edit-from-dashboard flow: the header offers going back to the dashboard. An empty string means the dashboard is not saved yet.

sourceDashboard?: string | ObjRef;

IAnalyticalDesignerConfig.sourceInsightpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Insight to open as an unsaved copy (the explore flow). Saving creates a new insight.

sourceInsight?: string | ObjRef;

IAnalyticalDesignerConfig.telemetryCallbackspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Forwards the Analytical Designer telemetry into the host’s pipeline. The default tracks nothing.

telemetryCallbacks?: IAnalyticalDesignerTelemetryCallbacks;

IAnalyticalDesignerConfig.userpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

The current user. Analytical Designer loads it when it is not provided.

user?: IUser;

IAnalyticalDesignerConfig.whiteLabelingpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

White labeling of the Analytical Designer user interface.

whiteLabeling?: {
        logoUrl?: string;
        isBranded?: boolean;
    };

Related

IAnalyticalDesignerProps
→
AnalyticalDesignerHiddenAction
→
IAnalyticalDesignerTelemetryCallbacks
→
IColorPalette
→
IEntitlementDescriptor
→