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

MethodDescription
clearActiveColorPalette()Clear active color palette setting from workspace.
clearActiveTheme()Clear active theme setting from workspace.
getActiveColorPalette()Request active color palette setting from workspace.
getActiveTheme()Request active theme setting from workspace.
getColorPalette()Asynchronously returns items in the color palette.
getTheme()Asynchronously returns theme.
setActiveColorPalette(colorPaletteRef)Set active color palette setting in workspace.
setActiveTheme(themeRef)Set active theme setting in workspace.
← IWorkspacesQueryResultIWorkspaceUserGroupsQuery →