Interface PageEditorType

interface PageEditorType {
    editActivatePageEditor: (filter: number) => Promise<void>;
    editCreateImage: (
        diBitmap: DIBitmapType,
        point: Point,
        pix: number,
        piy: number,
    ) => Promise<boolean>;
    editGetSelectedGraphObjectUtils: () => Promise<
        null
        | GraphicObjectUtilsType,
    >;
    isInObjectEditMode: () => Promise<boolean>;
    options?: Options;
}

Implemented by

Properties

editActivatePageEditor editCreateImage editGetSelectedGraphObjectUtils isInObjectEditMode options?

Properties

editActivatePageEditor

editActivatePageEditor: (filter: number) => Promise<void>

Starts the graphic object utilities for a given page and document view.

Type declaration

    • (filter: number): Promise<void>

    • Parameters

      • filter: number

        The filter to apply to the graphic object utilities.

      Returns Promise<void>

      A promise that resolves when the operation is complete.

editCreateImage

editCreateImage: (
    diBitmap: DIBitmapType,
    point: Point,
    pix: number,
    piy: number,
) => Promise<boolean>

Creates a new image object on the page.

Type declaration

    • (
          diBitmap: DIBitmapType,
          point: Point,
          pix: number,
          piy: number,
      ): Promise<boolean>

    • Parameters

      • diBitmap: DIBitmapType

        The DIBitmap object representing the image to be created.

      • point: Point

        The position where the image will be placed.

      • pix: number

        The horizontal DPI of the image.

      • piy: number

        The vertical DPI of the image.

      Returns Promise<boolean>

      A promise that resolves with a boolean indicating whether the image was successfully created.

editGetSelectedGraphObjectUtils

editGetSelectedGraphObjectUtils: () => Promise<null | GraphicObjectUtilsType>

Gets the currently selected graphic object utilities.

Type declaration

isInObjectEditMode

isInObjectEditMode: () => Promise<boolean>

Checks if the page editor is in object edit mode.

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

      A promise that resolves to true if in object edit mode, false otherwise.

Optionaloptions

options?: Options

Settings

Member Visibility

On This Page

Properties