TemplateConfiguration Class Reference
Constructors
Instance Methods
- getDayColorScheme() ⇒
TemplateColorScheme - getNightColorScheme() ⇒
TemplateColorScheme - getTemplate() ⇒
String - getTemplateParam() ⇒
String - setDayColorScheme(scheme) ⇒
TemplateConfiguration - setNightColorScheme(scheme) ⇒
TemplateConfiguration - setTemplate(template) ⇒
TemplateConfiguration - setTemplateParam(template) ⇒
TemplateConfiguration
Constructors
new TemplateConfiguration(parameters)
Initializes an instance of TemplateConfiguration.
Instance Methods
templateConfiguration.getDayColorScheme() ⇒ TemplateColorScheme
Get the DayColorScheme
Kind: Instance method of TemplateConfiguration
Returns: TemplateColorScheme - the KEY_DAY_COLOR_SCHEME value
templateConfiguration.getNightColorScheme() ⇒ TemplateColorScheme
Get the NightColorScheme
Kind: Instance method of TemplateConfiguration
Returns: TemplateColorScheme - the KEY_NIGHT_COLOR_SCHEME value
templateConfiguration.getTemplate() ⇒ String
Get the Template
Kind: Instance method of TemplateConfiguration
Returns: String - the KEY_TEMPLATE value
templateConfiguration.getTemplateParam() ⇒ String
Get the TemplateParam
Kind: Instance method of TemplateConfiguration
Returns: String - the KEY_TEMPLATE value
templateConfiguration.setDayColorScheme(scheme) ⇒ TemplateConfiguration
Set the DayColorScheme
Kind: Instance method of TemplateConfiguration
Returns: TemplateConfiguration - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| scheme | TemplateColorScheme |
A color scheme for all display layout templates. - The desired DayColorScheme. |
templateConfiguration.setNightColorScheme(scheme) ⇒ TemplateConfiguration
Set the NightColorScheme
Kind: Instance method of TemplateConfiguration
Returns: TemplateConfiguration - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| scheme | TemplateColorScheme |
A color scheme for all display layout templates. - The desired NightColorScheme. |
templateConfiguration.setTemplate(template) ⇒ TemplateConfiguration
Set the Template
Kind: Instance method of TemplateConfiguration
Returns: TemplateConfiguration - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| template | String |
Predefined or dynamically created window template. Currently only predefined window template layouts are defined. - The desired Template. {'string_min_length': 1, 'string_max_length': 500} |
templateConfiguration.setTemplateParam(template) ⇒ TemplateConfiguration
Set the TemplateParam
Kind: Instance method of TemplateConfiguration
Returns: TemplateConfiguration - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| template | String |
Predefined or dynamically created window template. Currently only predefined window template layouts are defined. - The desired TemplateParam. {'string_min_length': 1, 'string_max_length': 500} |