Skip to content

legend

legend

input

QslJobInfoLegend dataclass

Bases: QslJobInfoParameter

Source code in src/qgis_server_light/interface/job/legend/input.py 
29
30
31
@dataclass
class QslJobInfoLegend(QslJobInfoParameter):
    job: QslJobParameterLegend = field(metadata={"type": "Element", "required": True})
job: QslJobParameterLegend = field(metadata={'type': 'Element', 'required': True}) class-attribute instance-attribute
__init__(id: str, type: str, job: QslJobParameterLegend) -> None

QslJobParameterLegend dataclass

Bases: QslJobParameter

Render legend graphics for one or more layers.

Source code in src/qgis_server_light/interface/job/legend/input.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
@dataclass(kw_only=True)
class QslJobParameterLegend(QslJobParameter):
    """Render legend graphics for one or more layers."""

    layers: list[QslJobLayer] = field(metadata={"type": "Element"})
    format: str = field(default="image/png", metadata={"type": "Element"})
    width: int | None = field(default=None, metadata={"type": "Element"})
    height: int | None = field(default=None, metadata={"type": "Element"})
    dpi: int = field(default=91, metadata={"type": "Element"})
    scale: float | None = field(default=None, metadata={"type": "Element"})
    layer_title: bool = field(default=False, metadata={"type": "Element"})

    def get_layer_by_name(self, name: str) -> QslJobLayer:
        for layer in self.layers:
            if layer.name == name:
                return layer
        raise LookupError(f'No layer with name "{name}" was found.')
dpi: int = field(default=91, metadata={'type': 'Element'}) class-attribute instance-attribute
format: str = field(default='image/png', metadata={'type': 'Element'}) class-attribute instance-attribute
height: int | None = field(default=None, metadata={'type': 'Element'}) class-attribute instance-attribute
layer_title: bool = field(default=False, metadata={'type': 'Element'}) class-attribute instance-attribute
layers: list[QslJobLayer] = field(metadata={'type': 'Element'}) class-attribute instance-attribute
scale: float | None = field(default=None, metadata={'type': 'Element'}) class-attribute instance-attribute
width: int | None = field(default=None, metadata={'type': 'Element'}) class-attribute instance-attribute
__init__(*, layers: list[QslJobLayer], format: str = 'image/png', width: int | None = None, height: int | None = None, dpi: int = 91, scale: float | None = None, layer_title: bool = False) -> None
get_layer_by_name(name: str) -> QslJobLayer
Source code in src/qgis_server_light/interface/job/legend/input.py 
22
23
24
25
26
def get_layer_by_name(self, name: str) -> QslJobLayer:
    for layer in self.layers:
        if layer.name == name:
            return layer
    raise LookupError(f'No layer with name "{name}" was found.')

output