qgserde - v0.3.1
    Preparing search index...

    Interface QgsLayoutItem

    Layout item. type is the QGIS item type number, such as 65638 (page), 65639 (map), 65640 (picture), 65641 (label), 65642 (legend), 65643 (shape), 65645 (polyline), 65646 (scale bar), or 65647 (frame of a multi-frame). QGIS reads only the parts its type uses.

    interface QgsLayoutItem {
        atlasClipping?: QgsLayoutClippingAttributes;
        atlasClippingLayers?: string[];
        atlasMap?: QgsLayoutAtlasMapAttributes;
        attributes?: QgsLayoutItemAttributes;
        backgroundColor?: QgsLayoutColorAttributes;
        cameraPose?: QgsCameraPoseAttributes;
        crs?: QgsCrs;
        curve?: string;
        divisionLineSymbol?: QgsSymbol;
        extent?: QgsRectangle;
        fillColor?: QgsLayoutColorAttributes;
        fillColor2?: QgsLayoutColorAttributes;
        fillSymbol1?: QgsSymbol;
        fillSymbol2?: QgsSymbol;
        filterByMaps?: string[];
        format?: QgsTextFormat;
        frameColor?: QgsLayoutColorAttributes;
        grids?: QgsLayoutMapGrid[];
        groupItems?: string[];
        itemClipping?: QgsLayoutClippingAttributes;
        labelBlockingItems?: string[];
        layers?: (QgsLayoutMapLayerAttributes & { id?: string })[];
        layerStyleOverrides?: QgsLayoutLayerStyleAttributes[];
        layoutObject?: QgsLayoutObject;
        legendStyles?: QgsLayoutLegendStyle[];
        legendTree?: Omit<QgsLegendNode, "kind" | "extensions">;
        lineSymbol?: QgsSymbol;
        nodes?: QgsLayoutNodeAttributes[];
        numericFormat?: QgsNumericFormat;
        overviews?: QgsLayoutMapOverview[];
        plot?: QgsLayoutPlot;
        profileLayers?: QgsLayerRefAttributes[];
        profileSources?: QgsProfileSource[];
        scene3D?: QgsScene3D;
        series?: QgsChartSeriesAttributes[];
        strokeColor?: QgsLayoutColorAttributes;
        subdivisionLineSymbol?: QgsSymbol;
        subsectionsSymbol?: QgsSymbol;
        symbol?: QgsSymbol;
        temporalSettings3D?: QgsLayout3DTemporalAttributes;
        type: string;
    }
    Index

    Map atlas clipping settings.

    atlasClippingLayers?: string[]

    Layers clipped to the atlas feature.

    Map atlas settings (atlasDriven, scalingMode, margin).

    Item settings, such as id, uuid, position, size, labelText, or file.

    backgroundColor?: QgsLayoutColorAttributes

    Background color (red, green, blue, alpha).

    Camera of a 3D map item.

    crs?: QgsCrs

    Map CRS.

    curve?: string

    Elevation profile curve as WKT.

    divisionLineSymbol?: QgsSymbol

    Scale bar division line symbol.

    extent?: QgsRectangle

    Map extent.

    Scale bar first fill color.

    Scale bar second fill color.

    fillSymbol1?: QgsSymbol

    Scale bar first fill symbol.

    fillSymbol2?: QgsSymbol

    Scale bar second fill symbol.

    filterByMaps?: string[]

    UUIDs of maps a legend is filtered by.

    format?: QgsTextFormat

    Label or scale bar text format.

    Frame color (red, green, blue, alpha).

    Map grids.

    groupItems?: string[]

    UUIDs of a group's member items.

    Map item clipping settings.

    labelBlockingItems?: string[]

    UUIDs of items whose area map labels avoid.

    layers?: (QgsLayoutMapLayerAttributes & { id?: string })[]

    Locked map layers, each with source, provider, name, and the layer id.

    Type Declaration

    • Optionalid?: string

      Layer ID, stored as the element text.

    layerStyleOverrides?: QgsLayoutLayerStyleAttributes[]

    Map layer style overrides (<LayerStyles>), each naming the layer by layerid, name, source, and provider. The style document itself is kept with each override.

    layoutObject?: QgsLayoutObject

    Data-defined and custom properties.

    legendStyles?: QgsLayoutLegendStyle[]

    Legend text styles.

    legendTree?: Omit<QgsLegendNode, "kind" | "extensions">

    Customized legend tree; QGIS uses the project tree when absent.

    lineSymbol?: QgsSymbol

    Scale bar line symbol.

    Polyline or polygon nodes, each with x and y.

    numericFormat?: QgsNumericFormat

    Scale bar number format.

    overviews?: QgsLayoutMapOverview[]

    Map overviews.

    Plot of an elevation profile or chart.

    profileLayers?: QgsLayerRefAttributes[]

    Layers of an elevation profile.

    profileSources?: QgsProfileSource[]

    Elevation profile sources in drawing order (QGIS 3.44+).

    scene3D?: QgsScene3D

    Scene settings of a 3D map item.

    Chart data series (QGIS 4.2+).

    Scale bar stroke color.

    subdivisionLineSymbol?: QgsSymbol

    Scale bar subdivision line symbol.

    subsectionsSymbol?: QgsSymbol

    Symbol of elevation profile subsection lines.

    symbol?: QgsSymbol

    Shape, polyline, polygon, or page symbol.

    temporalSettings3D?: QgsLayout3DTemporalAttributes

    Time range of a 3D map item.

    type: string

    QGIS item type number.