Open Pioneer Trails Packages
    Preparing search index...

    Interface PrintingProps

    Properties supported by the Printing component.

    interface PrintingProps {
        dpis?: number[];
        fileFormats?: FileFormatType[];
        map?: MapModel;
        mode?: PrintingMode;
        pageFormats?: PageFormatType[];
        pageOrientations?: PageOrientationType[];
        scales?: number[];
        viewPadding?: ViewPaddingBehavior;
        [key: `data-${string}`]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: `data-${string}`]: unknown

      Arbitrary data attributes.

      NOTE: The component may use data properties for its own behavior. Make sure not to overwrite required attributes.

    Index
    dpis?: number[]

    The set of print resolutions in DPI that can be selected by the user (default: selection of pre-configured values).

    Cannot be used when mode is "screenshot".

    fileFormats?: FileFormatType[]

    The set of file formats that can be selected by the user (default: selection of pre-configured values).

    map?: MapModel

    The map model to use.

    The mode of the component (default: page).

    Use "screenshot" to print the entire map as it is currently displayed. In that mode, the user can only choose the title and the file format, and no print area is shown on the map.

    See also PrintingMode.

    pageFormats?: PageFormatType[]

    The set of page formats that can be selected by the user (default: selection of pre-configured values).

    Cannot be used when mode is "screenshot".

    pageOrientations?: PageOrientationType[]

    The set of page orientations that can be selected by the user (default: selection of pre-configured values).

    Cannot be used when mode is "screenshot".

    scales?: number[]

    The set of scales that can be selected by the user (default: selection of pre-configured values).

    Cannot be used when mode is "screenshot".

    viewPadding?: ViewPaddingBehavior

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

    See also ViewPaddingBehavior.