qgserde - v0.3.1
    Preparing search index...

    Interface QgsMapLayerBase

    Settings shared by all layer types. Edits do not modify the data source itself.

    interface QgsMapLayerBase {
        attributes?: QgsMapLayerAttributes;
        blendMode?: number;
        crs?: QgsCrs;
        customProperties?: QgsVariantMap;
        elevation?: QgsElevationProperties;
        extent?: QgsRectangle;
        flags?: QgsLayerFlagsAttributes;
        id: string;
        legend?: QgsLayerLegendAttributes;
        legendTextOnSymbol?: QgsLegendTextOnSymbol;
        mapTip?: string;
        mapTipEnabled?: boolean;
        maxScale?: number;
        metadata?: QgsLayerMetadata;
        minScale?: number;
        name: string;
        notes?: string;
        opacity?: number;
        provider: string;
        providerEncoding?: string;
        renderer3d?: QgsRenderer3d;
        scaleBasedVisibility?: boolean;
        server?: QgsLayerServerProperties;
        source: string;
        styles?: QgsLayerStyles<
            Partial<
                Omit<
                    QgsMapLayerBase,
                    | "type"
                    | "name"
                    | "crs"
                    | "extent"
                    | "provider"
                    | "id"
                    | "source"
                    | "extensions"
                    | "xmlType"
                    | "geometry"
                    | "wkbType"
                    | "styles"
                    | "providerEncoding"
                    | "unmodeled",
                >,
            >,
        >;
        temporal?: QgsTemporalProperties;
        timestamp?: string;
        unmodeled?: QgsUnmodeled;
        wgs84Extent?: QgsRectangle;
    }

    Hierarchy (View Summary)

    Index

    Other <maplayer> attributes, such as autoRefreshMode, styleCategories, or simplifyDrawingTol.

    blendMode?: number

    QPainter composition mode used to draw the layer, as a QGIS blend mode number.

    crs?: QgsCrs

    Layer CRS. Assigning it does not transform geographic data.

    customProperties?: QgsVariantMap

    Plugin and application properties stored with the layer.

    Elevation and profile settings (<elevation>).

    extent?: QgsRectangle

    Layer extent in its CRS coordinate units.

    Layer flags (<flags>): Identifiable, Removable, Searchable, and Private, as 1 or 0.

    id: string

    Unique ID with at least 11 UTF-16 code units, fixed for the layer's life: tree, drawing-order, and other references use it. A layer with another ID is another layer. Shorter IDs are rejected on serialization, including when read from XML.

    Legend settings (<legend>), such as type and showLabelLegend.

    legendTextOnSymbol?: QgsLegendTextOnSymbol

    Text drawn on legend symbols (<legend><text-on-symbol>), vector layers only.

    mapTip?: string

    Map tip HTML template.

    mapTipEnabled?: boolean

    Whether the map tip is enabled.

    maxScale?: number

    QGIS maxScale denominator. Applied when scaleBasedVisibility is enabled.

    metadata?: QgsLayerMetadata

    Descriptive layer metadata.

    minScale?: number

    QGIS minScale denominator. Applied when scaleBasedVisibility is enabled.

    name: string

    Layer name, also written to its tree references.

    notes?: string

    User notes (<userNotes value>), often HTML.

    opacity?: number

    Layer opacity: 0 is transparent and 1 is opaque in QGIS.

    provider: string

    QGIS provider identifier, such as ogr, gdal, memory, or wms.

    providerEncoding?: string

    Provider character encoding.

    renderer3d?: QgsRenderer3d

    3D renderer type and settings; nested 3D symbols stay in extension data.

    scaleBasedVisibility?: boolean

    Whether scale-based visibility limits are enabled.

    Publishing settings used by QGIS Server and legends.

    source: string

    Provider connection string or URI. Source availability is not checked and paths are not rewritten.

    styles?: QgsLayerStyles<
        Partial<
            Omit<
                QgsMapLayerBase,
                | "type"
                | "name"
                | "crs"
                | "extent"
                | "provider"
                | "id"
                | "source"
                | "extensions"
                | "xmlType"
                | "geometry"
                | "wkbType"
                | "styles"
                | "providerEncoding"
                | "unmodeled",
            >,
        >,
    >

    Named style variants.

    Time settings (<temporal>).

    timestamp?: string

    Data timestamp (<timestamp>) in ISO 8601, written by some providers.

    unmodeled?: QgsUnmodeled

    XML of this <maplayer> that the model does not cover; see QgsUnmodeled.

    wgs84Extent?: QgsRectangle

    Layer extent in WGS 84, as stored by QGIS.