IOrganizationStylingService
This service provides access to organization styling settings such as theme.
export interface IOrganizationStylingService
Methods
Method | Description |
|---|---|
Clear active color palette setting from organization. | |
Clear active theme setting from organization. | |
Create new color palette on organization level. | |
Create new theme on organization level. | |
Delete color palette on organization level. | |
Delete theme on organization level. | |
Request active color palette setting from organization. | |
Request active theme setting from organization. | |
Request all color palettes defined on organization level. | |
Asynchronously returns the active theme for the organization. | |
Request all themes defined on organization level. | |
Set active color palette setting in organization. | |
Set active theme setting in organization. | |
Update existing color palette on organization level. | |
Update existing theme on organization level. |
Method details
IOrganizationStylingService.clearActiveColorPalette()method
Clear active color palette setting from organization.
clearActiveColorPalette(): Promise<void>;
Returns
Promise<void>
promise
IOrganizationStylingService.clearActiveTheme()method
Clear active theme setting from organization.
clearActiveTheme(): Promise<void>;
Returns
Promise<void>
promise
IOrganizationStylingService.createColorPalette()method
Create new color palette on organization level.
createColorPalette(colorPalette: IColorPaletteDefinition): Promise<IColorPaletteMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
colorPalette |
Returns
Promise<IColorPaletteMetadataObject>
promise
IOrganizationStylingService.createTheme()method
Create new theme on organization level.
createTheme(theme: IThemeDefinition): Promise<IThemeMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
theme |
Returns
Promise<IThemeMetadataObject>
promise
IOrganizationStylingService.deleteColorPalette()method
Delete color palette on organization level.
deleteColorPalette(colorPaletteRef: ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
colorPaletteRef |
Returns
Promise<void>
promise
IOrganizationStylingService.deleteTheme()method
Delete theme on organization level.
deleteTheme(themeRef: ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
themeRef |
Returns
Promise<void>
promise
IOrganizationStylingService.getActiveColorPalette()method
Request active color palette setting from organization.
getActiveColorPalette(): Promise<ObjRef | undefined>;
Returns
Promise<ObjRef | undefined>
promise of color palette object reference
IOrganizationStylingService.getActiveTheme()method
Request active theme setting from organization.
getActiveTheme(): Promise<ObjRef | undefined>;
Returns
Promise<ObjRef | undefined>
promise of theme object reference
IOrganizationStylingService.getColorPalettes()method
Request all color palettes defined on organization level.
getColorPalettes(): Promise<IColorPaletteMetadataObject[]>;
Returns
Promise<IColorPaletteMetadataObject[]>
promise of array of color palette metadata objects
IOrganizationStylingService.getTheme()method
Asynchronously returns the active theme for the organization.
getTheme(): Promise<ITheme>;
Returns
Promise<ITheme>
promise of theme
Remarks
Resolves the active theme setting and fetches the corresponding theme content. Returns an empty theme when no active theme is configured or the fetch fails.
IOrganizationStylingService.getThemes()method
Request all themes defined on organization level.
getThemes(): Promise<IThemeMetadataObject[]>;
Returns
Promise<IThemeMetadataObject[]>
promise of array of theme metadata objects
IOrganizationStylingService.setActiveColorPalette()method
Set active color palette setting in organization.
setActiveColorPalette(colorPaletteRef: ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
colorPaletteRef | active color palette reference |
Returns
Promise<void>
promise
IOrganizationStylingService.setActiveTheme()method
Set active theme setting in organization.
setActiveTheme(themeRef: ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
themeRef | active theme reference |
Returns
Promise<void>
promise
IOrganizationStylingService.updateColorPalette()method
Update existing color palette on organization level.
updateColorPalette(colorPalette: IColorPaletteDefinition): Promise<IColorPaletteMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
colorPalette |
Returns
Promise<IColorPaletteMetadataObject>
promise
IOrganizationStylingService.updateTheme()method
Update existing theme on organization level.
updateTheme(theme: IThemeDefinition): Promise<IThemeMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
theme |
Returns
Promise<IThemeMetadataObject>
promise