Module: /ui/layers/listview

/ui/layers/listview

The module exports the default listview method.

The add method creates a layer.view and adds this to the listview.

Parameters:

Name	Type	Description
`layer`	layer	The layer object to add

Properties

Name	Type	Attributes	Description
`layer.hidden`	boolean	<optional>	Do not create a layer.view and shortcircuit.
`layer.group`	string	<optional>	Create a layer group and or add the layer to an existing listview.group

Fires:

Adds a layer to group [this].

Parameters:

Name	Type	Description
`layer`	layer	Layer to add to the group

Checks if any layers in group are visible and toggles visibility button accordingly

Parameters:

Name	Type	Description
`layer`	layer	The layer to add to a group.

Properties

Name	Type	Attributes	Description
`layer.group`	string		Group key.
`layer.groupClassList`	string	<optional>	CSS classes to apply to group
`layer.groupmeta`	string	<optional>	HTML content for group metadata

Creates a listview for organizing and displaying map layers, optionally grouped.

A HTMLelement target property must be provided for the listview element to be rendered into.

An initial list of decorated mapview layers is optional since layers can be added to the listview object through the add method.

The listview method is a decorator which returns the decorated listview object.

mapp.ui.layers.listview({
  layers: mapview.layers,
  target: document.getElementById('layer-list')
});

Parameters:

Name	Type	Description
`params`	Object	Configuration parameters

Properties

Name	Type	Attributes	Description
`params.target`	HTMLElement		DOM element where the listview will be rendered
`params.layers`	Object	<optional>	Map of layer objects to be added to the listview