IWorkspaceStylingService

Home > @gooddata/sdk-backend-spi > IWorkspaceStylingService

IWorkspaceStylingService interface

This service provides access to workspace styling settings such as color palette.

Signature:

export interface IWorkspaceStylingService 

Remarks

The contract here is that styling settings ARE applied in Analytical Designer and Dashboard applications and so any SDK code that embeds entities created by those applications MUST also use the same styling settings in order to maintain consistent user experience.

Methods

Method	Description
clearActiveColorPalette()	Clear active color palette setting from workspace.
clearActiveTheme()	Clear active theme setting from workspace.
createColorPalette(colorPalette)	Create a new color palette on the workspace level.
createTheme(theme)	Create a new theme on the workspace level.
deleteColorPalette(colorPaletteRef)	Delete a color palette on the workspace level.
deleteTheme(themeRef)	Delete a theme on the workspace level.
getActiveColorPalette()	Request active color palette setting from workspace.
getActiveTheme()	Request active theme setting from workspace.
getColorPalette()	Asynchronously returns items in the color palette.
getColorPalettes()	Request all color palettes defined on the workspace level.
getTheme()	Asynchronously returns theme.
getThemes()	Request all themes defined on the workspace level.
setActiveColorPalette(colorPaletteRef)	Set active color palette setting in workspace.
setActiveTheme(themeRef)	Set active theme setting in workspace.
updateColorPalette(colorPalette)	Update an existing color palette on the workspace level.
updateTheme(theme)	Update an existing theme on the workspace level.