IService

Last updated
Save as PDF

pentaho .theme. IService

The IService interface contains methods for managing themes of modules.

Source: doc-js/pentaho/theme/IService.jsdoc, line 17

Methods

Name	Description
classifyDomAsModule(domElement, moduleOrId)	Brands a DOM element so that the styles of CSS theme resources of a module apply to it.
getModuleCssClass(moduleOrId) : `string`	Gets a CSS class that selects all versions of a given module.
getModuleUniqueCssClass(moduleOrId) : `string`	Gets a CSS class that selects a given module.
loadModuleThemeAsync(moduleOrId) : `Promise`	Loads the theme resources of a given module, if any.

Methods Details

classifyDomAsModule(domElement, moduleOrId)

Brands a DOM element so that the styles of CSS theme resources of a module apply to it.

Currently, two CSS classes are added to the element, one which identifies every version of this module and another which identifies exactly the current version.

Source: doc-js/pentaho/theme/IService.jsdoc, line 49

Parameters:
Name	Default Value	Summary
domElement : `HTMLElement`		The DOM element.
moduleOrId : `string \| pentaho.module.IMeta`		The module object or its identifier.

getModuleCssClass(moduleOrId) : string

Gets a CSS class that selects all versions of a given module.

As an example, if the given module had the identifier:

@hitachivantara/pentaho-core@1.2.20/pentaho/visual/models/Bar,

then the class would be:

_hitachivantara-pentaho-core-pentaho-visual-models-Bar.

Source: doc-js/pentaho/theme/IService.jsdoc, line 67

Parameters:
Name	Default Value	Summary
moduleOrId : `string \| pentaho.module.IMeta`		The module object or its identifier.

Returns:
Name	Description
`string`	The CSS class.

getModuleUniqueCssClass(moduleOrId) : string

Gets a CSS class that selects a given module.

This method may return a random CSS class associated with each module.

Source: doc-js/pentaho/theme/IService.jsdoc, line 87

Parameters:
Name	Default Value	Summary
moduleOrId : `string \| pentaho.module.IMeta`		The module object or its identifier.

Returns:
Name	Description
`string`	The CSS class.

loadModuleThemeAsync(moduleOrId) : Promise

Loads the theme resources of a given module, if any.

Determines if the module has an associated ThemeAnnotation, in which case its main and extensions resource modules are loaded.

If module is a type module, any theme resources of ascendant modules are also loaded.

Source: doc-js/pentaho/theme/IService.jsdoc, line 29

Parameters:
Name	Default Value	Summary
moduleOrId : `string \| pentaho.module.IMeta`		The module object or its identifier.

Returns:
Name	Description
`Promise`	A promise which is resolved when the themes are loaded.