gws.plugin.qgis.legend¶
QGIS legend.
Source code: gws.plugin.qgis.legend
Module Contents¶
- class gws.plugin.qgis.legend.Config¶
Bases:
gws.base.legend.ConfigLegend for QGIS project layers, rendered by QGIS Server.
- provider: Config.provider | None¶
QGIS project the legend is rendered from.
- sourceLayers: gws.gis.source.LayerFilter | None¶
Source layers to include in the legend.
- class gws.plugin.qgis.legend.Object¶
Bases:
gws.base.legend.ObjectLegend rendered by QGIS Server with GetLegendGraphic.
- params: dict¶
GetLegendGraphic request parameters.
- provider: Object.provider¶
QGIS provider.
- sourceLayers: list[gws.SourceLayer]¶
Source layers in the legend.
- configure()¶
- configure_params()¶
Build the GetLegendGraphic parameters.
Configured
optionsoverride the default legend parameters.
- configure_provider()¶
Set the QGIS provider.
- Returns:
Trueif a provider was set.- Raises:
gws.Error – If no provider is found.
- configure_source_layers()¶
Select the source layers from the provider layers.
- Returns:
Always
True.
- configure_sources()¶
Select the source layers of the legend.
- Raises:
gws.Error – If the provider is not set.
- render(args=None)¶
