marker.js 3 Documentation
    Preparing search index...

    Interface AnnotationEditorSettings

    interface AnnotationEditorSettings {
        rendererSettings: {
            height?: number;
            imageQuality?: number;
            imageType?: string;
            markersOnly?: boolean;
            naturalSize?: boolean;
            width?: number;
        };
        renderOnSave?: boolean;
    }
    Index

    Properties

    rendererSettings renderOnSave?

    Properties

    rendererSettings: {
        height?: number;
        imageQuality?: number;
        imageType?: string;
        markersOnly?: boolean;
        naturalSize?: boolean;
        width?: number;
    }

    Configuration for the image renderer. This is used to configure the image rendering settings.

    Type declaration

    • Optionalheight?: number

      When set and naturalSize is false sets the height of the rendered image.

      Both width and height have to be set for this to take effect.

    • OptionalimageQuality?: number

      For formats that support it, specifies rendering quality.

      In the case of image/jpeg you can specify a value between 0 and 1 (lowest to highest quality).

    • OptionalimageType?: string

      Rendered image type (image/png, image/jpeg, etc.).

    • OptionalmarkersOnly?: boolean

      When set to true, only the marker layer without the original image will be rendered.

    • OptionalnaturalSize?: boolean

      Whether the image should be rendered at the original (natural) target image size.

    • Optionalwidth?: number

      When set and naturalSize is false sets the width of the rendered image.

      Both width and height have to be set for this to take effect.

    renderOnSave?: boolean

    Whether the rasterized image should be rendered on save. If set to false the editorsave event will not contain the dataUrl property.

    Settings

    Member Visibility

    On This Page

    Properties