Nutrient Web SDK
    Preparing search index...

    Interface EllipseAnnotationJSON

    interface EllipseAnnotationJSON {
        action?:
            | null
            | | { subactions?: (CoreActionJSON)[]; type: "uri"; uri: string }
            | { pageIndex: number; subactions?: (CoreActionJSON)[]; type: "goTo" }
            | {
                newWindow: boolean;
                relativePath: string;
                subactions?: (CoreActionJSON)[];
                targetType: "parent" | "child";
                type: "goToEmbedded";
            }
            | {
                namedDestination: string;
                relativePath: string;
                subactions?: (CoreActionJSON)[];
                type: "goToRemote";
            }
            | {
                annotationReferences: AnnotationReference[];
                hide: boolean;
                subactions?: (CoreActionJSON)[];
                type: "hide";
            }
            | {
                fields: null
                | AnnotationReference[];
                flags: null | string;
                subactions?: (CoreActionJSON)[];
                type: "resetForm";
            }
            | {
                fields: null
                | string[];
                flags: null | ActionFlags[];
                subactions?: (CoreActionJSON)[];
                type: "submitForm";
                uri: string;
            }
            | { filePath: string; subactions?: (CoreActionJSON)[]; type: "launch" }
            | {
                action: Omit<string, "custom">;
                subactions?: (CoreActionJSON)[];
                type: "named";
            }
            | {
                action: "custom";
                customAction: NamedCustomAction;
                subactions?: (CoreActionJSON)[];
                type: "named";
            }
            | { script: string; subactions?: (CoreActionJSON)[]; type: "javaScript" };
        APStreamCache?: { cache: string } | { attach: string };
        bbox: [left: number, top: number, width: number, height: number];
        blendMode?:
            | null
            | | "normal"
            | "multiply"
            | "screen"
            | "overlay"
            | "darken"
            | "lighten"
            | "colorDodge"
            | "colorBurn"
            | "hardLight"
            | "softLight"
            | "difference"
            | "exclusion";
        cloudyBorderInset: | null
        | [left: number, top: number, right: number, bottom: number];
        cloudyBorderIntensity: null | number;
        createdAt?: string | Date;
        creatorName?: null | string;
        customData?: null | Record<string, unknown>;
        fillColor: null | string;
        flags?:
            | null
            | (
                | "noView"
                | "noPrint"
                | "locked"
                | "lockedContents"
                | "readOnly"
                | "hidden"
                | "noZoom"
                | "noRotate"
            )[];
        group?: IGroup;
        id: string;
        isAnonymous?: boolean;
        isCommentThreadRoot?: boolean;
        lineWidth?: null
        | number;
        measurementBBox:
            | null
            | [left: number, top: number, width: number, height: number];
        measurementPrecision?:
            | null
            | | "whole"
            | "oneDp"
            | "twoDp"
            | "threeDp"
            | "fourDp"
            | "1/2"
            | "1/4"
            | "1/8"
            | "1/16";
        measurementScale?: | null
        | {
            from: number;
            to: number;
            unitFrom: "in"
            | "mm"
            | "cm"
            | "pt";
            unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
        };
        name?: null
        | string;
        note?: null | string;
        opacity?: number;
        pageIndex: number;
        pdfObjectId?: null | number;
        permissions?: {
            delete: boolean;
            edit: boolean;
            fill?: boolean;
            reply?: boolean;
            setGroup: boolean;
        };
        strokeColor: null
        | string;
        strokeDashArray?: null | [number, number];
        strokeWidth: number;
        subject?: null | string;
        type: "pspdfkit/shape/ellipse";
        updatedAt?: string | Date;
        v: number;
    }

    Hierarchy

    Index

    Properties

    action?:
        | null
        | | { subactions?: (CoreActionJSON)[]; type: "uri"; uri: string }
        | { pageIndex: number; subactions?: (CoreActionJSON)[]; type: "goTo" }
        | {
            newWindow: boolean;
            relativePath: string;
            subactions?: (CoreActionJSON)[];
            targetType: "parent" | "child";
            type: "goToEmbedded";
        }
        | {
            namedDestination: string;
            relativePath: string;
            subactions?: (CoreActionJSON)[];
            type: "goToRemote";
        }
        | {
            annotationReferences: AnnotationReference[];
            hide: boolean;
            subactions?: (CoreActionJSON)[];
            type: "hide";
        }
        | {
            fields: null
            | AnnotationReference[];
            flags: null | string;
            subactions?: (CoreActionJSON)[];
            type: "resetForm";
        }
        | {
            fields: null
            | string[];
            flags: null | ActionFlags[];
            subactions?: (CoreActionJSON)[];
            type: "submitForm";
            uri: string;
        }
        | { filePath: string; subactions?: (CoreActionJSON)[]; type: "launch" }
        | {
            action: Omit<string, "custom">;
            subactions?: (CoreActionJSON)[];
            type: "named";
        }
        | {
            action: "custom";
            customAction: NamedCustomAction;
            subactions?: (CoreActionJSON)[];
            type: "named";
        }
        | { script: string; subactions?: (CoreActionJSON)[]; type: "javaScript" }
    APStreamCache?: { cache: string } | { attach: string }
    bbox: [left: number, top: number, width: number, height: number]
    blendMode?:
        | null
        | | "normal"
        | "multiply"
        | "screen"
        | "overlay"
        | "darken"
        | "lighten"
        | "colorDodge"
        | "colorBurn"
        | "hardLight"
        | "softLight"
        | "difference"
        | "exclusion"
    cloudyBorderInset:
        | null
        | [left: number, top: number, right: number, bottom: number]
    cloudyBorderIntensity: null | number
    createdAt?: string | Date
    creatorName?: null | string
    customData?: null | Record<string, unknown>
    fillColor: null | string
    flags?:
        | null
        | (
            | "noView"
            | "noPrint"
            | "locked"
            | "lockedContents"
            | "readOnly"
            | "hidden"
            | "noZoom"
            | "noRotate"
        )[]
    group?: IGroup
    id: string
    isAnonymous?: boolean
    isCommentThreadRoot?: boolean
    lineWidth?: null | number
    measurementBBox:
        | null
        | [left: number, top: number, width: number, height: number]
    measurementPrecision?:
        | null
        | | "whole"
        | "oneDp"
        | "twoDp"
        | "threeDp"
        | "fourDp"
        | "1/2"
        | "1/4"
        | "1/8"
        | "1/16"
    measurementScale?:
        | null
        | {
            from: number;
            to: number;
            unitFrom: "in"
            | "mm"
            | "cm"
            | "pt";
            unitTo: "in" | "mm" | "cm" | "pt" | "ft" | "m" | "yd" | "km" | "mi";
        }
    name?: null | string
    note?: null | string
    opacity?: number
    pageIndex: number
    pdfObjectId?: null | number
    permissions?: {
        delete: boolean;
        edit: boolean;
        fill?: boolean;
        reply?: boolean;
        setGroup: boolean;
    }
    strokeColor: null | string
    strokeDashArray?: null | [number, number]
    strokeWidth: number
    subject?: null | string
    type: "pspdfkit/shape/ellipse"
    updatedAt?: string | Date
    v: number