Open Pioneer Trails Packages
    Preparing search index...

    Interface PrintingOptions

    Options supported when printing the map.

    interface PrintingOptions {
        blockUserInteraction?: boolean;
        dpi?: number;
        height?: number;
        overlayText?: string;
        scale?: number;
        viewPadding?: ViewPaddingBehavior;
        width?: number;
    }
    Index
    blockUserInteraction?: boolean

    When this is true (the default), an overlay will be added above the map to block user interactions.

    It is recommended to block user interaction (in some way) while the map is printing to avoid inconsistencies.

    dpi?: number

    The print resolution to be generated in dots per inch (default: current display resolution).

    height?: number

    The height of the generated map in millimeters (default: current map size).

    Only takes effect together with width and scale.

    overlayText?: string

    This option can be used to customize the text content of the overlay (if enabled).

    scale?: number

    The scale denominator of the generated map, for example 25000 for 1:25000 (default: current map scale).

    viewPadding?: ViewPaddingBehavior

    Whether to respect the map view's padding when printing (default: "auto").

    width?: number

    The width of the generated map in millimeters (default: current map size).

    Only takes effect together with height and scale.