Georeferencing API
    Preparing search index...

    Interface ReportOptions

    Options for a locally generated PDF report. Map capture is optional and requires a browser DOM.

    interface ReportOptions {
        attribution?: string;
        definitions?: Definitions;
        landscape?: boolean;
        map?: ReportMap;
        margin?: number;
        paper?: "A4" | "A3" | "Letter";
    }
    Index
    attribution? definitions? landscape? map? margin? paper?
    attribution?: string

    Host-provided map attribution override. When omitted with map capture, existing map attribution text is used.

    definitions?: Definitions

    Host projection definitions for report coordinate conversion and unit labels.

    landscape?: boolean

    Swap paper width and height.

    false

    map?: ReportMap

    Optional current loaded OpenLayers canvas map frame. The report does not move the view or wait for all network layers; sources must permit CORS export.

    margin?: number

    Page margin in PDF points (1/72 inch); at least 15 and must leave 200 points of usable width/height.

    40

    paper?: "A4" | "A3" | "Letter"

    PDF paper size.

    "A4"

    Settings
    Member Visibility

    On This Page
    Properties