gws.plugin.qgis.flatlayer

The qgisflat layer.

Source code: gws.plugin.qgis.flatlayer

Module Contents

class gws.plugin.qgis.flatlayer.Config

Bases: gws.base.layer.Config

Layer that renders selected QGIS project layers as a single image.

provider: Config.provider | None

QGIS project the layer is rendered from.

sourceLayers: gws.gis.source.LayerFilter | None

Source layers to render.

sqlFilters: dict | None

SQL filters for source layers, passed to QGIS Server.

class gws.plugin.qgis.flatlayer.Object

Bases: gws.base.layer.image.Object

Image layer that renders selected QGIS project layers as one image.

The image is rendered by QGIS Server. The layer also provides search, feature models and a legend for its source layers.

imageLayers: list[gws.SourceLayer]

Source layers to render.

provider: Object.provider

QGIS provider.

searchLayers: list[gws.SourceLayer]

Queryable source layers.

sqlFilters: dict

SQL filters, mapping a source layer name (or * for all layers) to a filter expression.

configure()
configure_extent()
configure_legend()
configure_metadata()
configure_models()
configure_provider()
configure_resolutions()
configure_source_layers()

Select the visible image layers of the project.

Returns:

Always True.

configure_sources()
configure_templates()
configure_zoom_bounds()
create_cache_name(cache)
create_finder(cfg)

Create a qgis finder for the layer’s queryable source layers.

Parameters:

cfg – Finder configuration, or None for the default finder.

Returns:

The finder.

create_grabber(opts)
create_model(cfg)

Create a qgis model for the layer’s queryable source layers.

Parameters:

cfg – Model configuration, or None for the default model.

Returns:

The model.

render_params(lri: gws.LayerRenderInput, parent_sql_filters: dict = None) → dict

Build the GetMap parameters for the layer.

The parameters contain LAYERS and, if any SQL filters apply, FILTER, on top of the extra parameters of the render input.

Parameters:

  • lri – Render input.

  • parent_sql_filters – SQL filters of the parent layer, which override the layer’s own filters.

Returns:

GetMap parameters.