Module: /ui/elements/layerStyle

/ui/elements/layerStyle

The module exports an object of methods to for the creation of layer style elements.

Source: ui/elements/layerStyle.mjs, line 1

Requires

module:/ui/layers

Methods

(inner) hover(layer) → {HTMLElement}

The hover() style element method will return a checkbox to toggle the display of the current hover.

Parameters:

Name	Type	Description
`layer`	layer	A decorated mapp layer with a style object.

Properties

Name	Type	Description
`layer.style`	layer-style	The layer style configuration.
`style.hover`	Object	The current hover.
`hover.hidden`	Boolean	Whether a checkbox should be returned.
`hover.display`	Boolean	The state of the hover.

Source: ui/elements/layerStyle.mjs, line 74

Returns:

A checkbox element to toggle the current hover.

Type:: HTMLElement

(inner) hovers(layer) → {HTMLElement}

The hovers() style element method will return a dropdown to change the current hover assigned to a layer.

Parameters:

Name	Type	Description
`layer`	layer	A decorated mapp layer with a style object.

Properties

Name	Type	Description
`layer.style`	layer-style	The layer style configuration.
`style.hover`	Object	The current hover.
`style.hovers`	Object	Object where each property represents a hover configuration.

Source: ui/elements/layerStyle.mjs, line 106

Returns:

A dropdown element to switch the current hover.

Type:: HTMLElement

(inner) icon_scaling(layer) → {HTMLElement}

The icon_scaling() style element method will returns a contents array with controls for icon.scaling properties (field, icon, clusterScale, zoomInScale, and zoomOutScale).

Parameters:

Name	Type	Description
`layer`	layer	A decorated mapp layer with a style object.

Properties

Name	Type	Attributes	Description
`layer.style`	layer-style		The layer style configuration.
`style.icon_scaling`	Object		The icon_scaling config.
`icon_scaling.hidden`	Boolean		Do not show icon_scaling controls in panel.
`icon_scaling.field`	String	<optional>	Assign field value as feature property for scaling point feature icons.
`icon_scaling.icon`	Boolean	<optional>	Add control to alter the base icon scale.
`icon_scaling.clusterScale`	Boolean	<optional>	Add control to alter the cluster.clusterScale value.
`icon_scaling.zoomInScale`	Boolean	<optional>	Add control to alter the zoomInScale value.
`icon_scaling.zoomOutScale`	Boolean	<optional>	Add control to alter the zoomOutScale value.

Source: ui/elements/layerStyle.mjs, line 405

Returns:

with contents array of HTMLElements to control icon scaling.

Type:: HTMLElement

(inner) label(layer) → {HTMLElement}

The label() style element method will return a checkbox to toggle the display of the current label.

Parameters:

Name	Type	Description
`layer`	layer	A decorated mapp layer with a style object.

Properties

Name	Type	Description
`layer.style`	layer-style	The layer style configuration.
`style.label`	Object	The current label.
`label.hidden`	Boolean	Whether a checkbox should be returned.
`label.display`	Boolean	The state of the label.

Source: ui/elements/layerStyle.mjs, line 159

Returns:

A checkbox element to toggle the current label.

Type:: HTMLElement

(inner) labels(layer) → {HTMLElement}

The labels() style element method will return a dropdown to change the current label assigned to a layer.

Parameters:

Name	Type	Description
`layer`	layer	A decorated mapp layer with a style object.

Properties

Name	Type	Description
`layer.style`	layer-style	The layer style configuration.
`style.label`	Object	The current label.
`style.labels`	Object	Object where each property represents a label configuration.

Source: ui/elements/layerStyle.mjs, line 217

Returns:

A dropdown element to switch the current label.

Type:: HTMLElement

(inner) panel(layer) → {HTMLElement}

The panel() style element method creates an array of style.elements from all available style property keys if not implicit.

The elements array will be mapped to return a flat array of HTMLElements as content for the layer.style.view node.

The layer.style.view is returned for the style drawer shown in the default mapp view layer.view.

Parameters:

Name	Type	Description
`layer`	layer	A decorated mapp layer with a style object.

Properties

Name	Type	Attributes	Description
`layer.style`	layer-style		The layer style configuration.
`style.elements`	Array	<optional>	Array of method keys to order elements in the layer.style.view.

Source: ui/elements/layerStyle.mjs, line 36

Returns:

The layer.style.view element.

Type:: HTMLElement

(inner) theme(layer) → {HTMLElement}

The theme() style element method will returns a content array with elements for the theme meta text and legend.

Parameters:

Name	Type	Description
`layer`	layer	A decorated mapp layer with a style object.

Properties

Name	Type	Attributes	Description
`layer.style`	layer-style		The layer style configuration.
`style.labels`	Object	<optional>	Available label configurations.
`style.hovers`	Object	<optional>	Availabel hover configurations.
`style.theme`	Object		The current theme.
`theme.title`	string	<optional>	Theme title for legend.
`theme.meta`	string	<optional>	Meta text to display.
`theme.setLabel`	string	<optional>	Key for label from style.labels{} to assign.
`theme.setHover`	string	<optional>	Key for hover from style.hovers{} to assign.

Source: ui/elements/layerStyle.mjs, line 283

Returns:

with contents array for the theme meta and legend.

Type:: HTMLElement

(inner) themes(layer) → {HTMLElement}

The themes() style element method will return a dropdown to change the current theme assigned to a layer.

Parameters:

Name	Type	Description
`layer`	layer	A decorated mapp layer with a style object.

Properties

Name	Type	Attributes	Description
`layer.style`	layer-style		The layer style configuration.
`style.theme`	Object		The current theme.
`style.themes`	Object		Object where each property represents a theme.
`style.label`	Object	<optional>	The current label.
`style.hover`	Object	<optional>	The current hover.

Source: ui/elements/layerStyle.mjs, line 332

Returns:

A dropdown element to switch the current theme.

Type:: HTMLElement