gws.base.layer.tree

Child layer configurations built from a hierarchy of source layers.

Source code: gws.base.layer.tree

Module Contents

class gws.base.layer.tree.Config(*args, **kwargs)

Bases: gws.Config

Configuration for the layer tree.

autoLayers: list[gws.base.layer.core.AutoLayersConfig] | None

Extra configuration for generated layers that match a filter.

excludeLayers: gws.gis.source.LayerFilter | None

Source layers to exclude.

flattenLayers: FlattenConfig | None

Collapse source groups below a level into single layers.

rootLayers: gws.gis.source.LayerFilter | None

Source layers to use as roots.

gws.base.layer.tree.configure_group_layers_for(layer: gws.base.layer.core.Object, source_layers: list[gws.SourceLayer], create_leaf_layer_config: collections.abc.Callable) → bool

Create child layers of a layer from a list of source layers.

The layer’s rootLayers, excludeLayers, flattenLayers and autoLayers options control which source layers are used and how. Source groups become group layers, other source layers are passed to create_leaf_layer_config.

Parameters:

  • layer – The layer to create children for.

  • source_layers – Source layer hierarchy.

  • create_leaf_layer_config – Function that takes a list of source layers and returns a config for a leaf layer that shows them.

Returns:

True.

Raises:
gws.base.layer.tree.create_group_layers(layer: gws.base.layer.core.Object, layer_configs: list)

Create child layers of a layer from their configs.

Each config gets the parent’s WGS extent, resolutions and map CRS. The created layers replace layer.layers.

Parameters:

  • layer – The layer to create children for.

  • layer_configs – Child layer configs.

Raises:

gws.Error – If no child layers could be created.

class gws.base.layer.tree.FlattenConfig(*args, **kwargs)

Bases: gws.Config

Turns source groups below a level into single layers.

level: int

Source hierarchy level from which groups become single layers.

useGroups: bool = False

Request a flattened group by its own name instead of its image layers.