ITheme
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Theme used to customize selected parts of the UI
export interface ITheme
Remarks
Only the primary color main value is mandatory
Optional properties are replaced with the default values
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(BETA) (Optional) Analytical designer specific properties | |||
(ALPHA) (Optional) Image assets offered to documents | |||
(BETA) (Optional) Button customizable UI properties | |||
(BETA) (Optional) Chart customizable UI properties | |||
(BETA) (Optional) KPI dashboards specific properties | |||
(ALPHA) (Optional) How documents with content version 2 look. Version 1 documents read | |||
(ALPHA) (Optional) Application header (top bar) specific properties | |||
(BETA) (Optional) Images Customizable images used in the UI | |||
(BETA) (Optional) Global Kpi/Headline customizable UI properties | |||
(BETA) (Optional) Non-toast message specific properties | |||
(BETA) (Optional) Modal customizable UI properties | |||
(BETA) (Optional) Customizable palette of major colors Inspired by Material UI palette: https://material-ui.com/customization/palette/ | |||
(ALPHA) (Optional) Publisher-specific properties | |||
(BETA) (Optional) Table customizable UI properties | |||
(BETA) (Optional) Toast message specific properties | |||
(ALPHA) (Optional) Toolbar customizable UI properties | |||
(BETA) (Optional) Tooltip customizable UI properties | |||
(BETA) (Optional) Typography Definition of both normal and bold font URIs | |||
“2” | (BETA) (Optional) Shape version of the theme content. Absent means version 1: a theme created before the |
Property details
ITheme.analyticalDesignerpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Analytical designer specific properties
analyticalDesigner?: IThemeAnalyticalDesigner;
ITheme.assetspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Image assets offered to documents
assets?: IThemeAssets;
ITheme.buttonpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Button customizable UI properties
button?: IThemeButton;
ITheme.chartpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Chart customizable UI properties
chart?: IThemeChart;
ITheme.dashboardspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
KPI dashboards specific properties
dashboards?: IThemeDashboard;
ITheme.documentspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
How documents with content version 2 look. Version 1 documents read reports until the switch to version 2.
documents?: IThemeDocuments;
ITheme.headerpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Application header (top bar) specific properties
header?: IThemeHeader;
ITheme.imagespropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Images
Customizable images used in the UI
images?: IThemeImages;
ITheme.kpipropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Global Kpi/Headline customizable UI properties
kpi?: IThemeKpi;
ITheme.messagepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Non-toast message specific properties
message?: IThemeMessage;
ITheme.modalpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Modal customizable UI properties
modal?: IThemeModal;
ITheme.palettepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Customizable palette of major colors
Inspired by Material UI palette: https://material-ui.com/customization/palette/
palette?: IThemePalette;
ITheme.reportspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Publisher-specific properties
reports?: IThemePublisher;
ITheme.tablepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Table customizable UI properties
table?: IThemeTable;
ITheme.toastMessagepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Toast message specific properties
toastMessage?: IThemeToastMessage;
ITheme.toolbarpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Toolbar customizable UI properties
toolbar?: IThemeToolbar;
ITheme.tooltippropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Tooltip customizable UI properties
tooltip?: IThemeTooltip;
ITheme.typographypropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Typography
Definition of both normal and bold font URIs
typography?: IThemeTypography;
ITheme.versionpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Shape version of the theme content. Absent means version 1: a theme created before the reports and assets sections existed.
version?: "2";