Interface PrintingOptions

Options supported when printing the map.

interface PrintingOptions {
    blockUserInteraction?: boolean;
    overlayText?: string;
    viewPadding?: ViewPaddingBehavior;
}

Properties

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.

overlayText?: string

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

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