new layout.dt/js/api/ThemeComponentMap()
stable API
Content map of a theme. It identifies specific element IDs within the theme's template that should have dynamic content inserted by ABCS.
- Version:
- 17.1.5
- Source:
- See:
-
- ThemeProvider.getComponentMap theme provider SPI method to return a theme's component map
Methods
addCopyright(elementId) → {layout.dt/js/api/ThemeComponentMap}
stable API
Adds a copyright message. The copyright element will be replaced by ABCS with the copyright message configured for the application in the property inspector.
Parameters:
| Name | Type | Description |
|---|---|---|
elementId |
String | The element ID within the theme |
- Version:
- 17.1.5
- Source:
Returns:
a reference to this object to allow method chaining
addFavicon(elementId) → {layout.dt/js/api/ThemeComponentMap}
stable API
Adds a favicon. A favicon element will be replaced by ABCS with an image showing the favicon configured for the application in application settings.
Parameters:
| Name | Type | Description |
|---|---|---|
elementId |
String | The element ID within the theme |
- Version:
- 17.1.5
- Source:
Returns:
a reference to this object to allow method chaining
addLanguageSwitcher(elementId) → {layout.dt/js/api/ThemeComponentMap}
stable API
Adds a language switcher area. A language switcher is an element that ABCS will apply knockout bindings to allow the access to the locales for which translations are available.
Parameters:
| Name | Type | Description |
|---|---|---|
elementId |
String | The element ID within the theme |
- Version:
- 17.2.3
- Source:
Returns:
a reference to this object to allow method chaining
addLogo(elementId) → {layout.dt/js/api/ThemeComponentMap}
stable API
Adds a logo. A logo element will be replaced by ABCS with an image showing the logo configured for the application in the property inspector.
Parameters:
| Name | Type | Description |
|---|---|---|
elementId |
String | The element ID within the theme |
- Version:
- 17.1.5
- Source:
Returns:
a reference to this object to allow method chaining
addMenuArea(elementId, optionsopt) → {layout.dt/js/api/ThemeComponentMap}
stable API
Adds a menu area. A menu area is an element that ABCS will apply knockout bindings to to allow the structure of the main application menu to be accessed.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
elementId |
String | The element ID within the theme |
|||||||||||||
options |
Object |
<optional> |
Structure for passing additional options, as follows: Properties
|
- Version:
- 17.1.5
- Source:
Returns:
a reference to this object to allow method chaining
addThemeArea(elementId) → {layout.dt/js/api/ThemeComponentMap}
stable API
Adds a theme area. A theme area is an element that, when clicked by the user, will open the theme property inspector in the ABCS designer.
Parameters:
| Name | Type | Description |
|---|---|---|
elementId |
String | The element ID within the theme template |
- Version:
- 17.1.5
- Source:
Returns:
a reference to this object to allow method chaining
addTitle(elementId) → {layout.dt/js/api/ThemeComponentMap}
stable API
Adds a title. A title element will be replaced by ABCS with an element containing the title configured for the application in the property inspector.
Parameters:
| Name | Type | Description |
|---|---|---|
elementId |
String | The element ID within the theme |
- Version:
- 17.1.5
- Source:
Returns:
a reference to this object to allow method chaining
addUserArea(elementId) → {layout.dt/js/api/ThemeComponentMap}
stable API
Adds a user area. A user area is an element that ABCS will apply knockout bindings to to allow the current user and help link to be accessed.
Parameters:
| Name | Type | Description |
|---|---|---|
elementId |
String | The element ID within the theme |
- Version:
- 17.1.5
- Source:
Returns:
a reference to this object to allow method chaining