Class PageEditor

constructor

• new PageEditor(options?: Options): PageEditor

  No longer use 'new' to create, but use create instead.

  Parameters

  • Optionaloptions: Options

  Returns PageEditor

  Example

  const pageEditor = await PageEditor.create();
  Copy

Optionaloptions

editActivatePageEditor

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

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

  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.

  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.

  Returns Promise<null | GraphicObjectUtilsType>

  A promise that resolves with the currently selected graphic object utilities.

isInObjectEditMode

• isInObjectEditMode(): Promise<boolean>

  Checks if the page editor is in object edit mode.

  Returns Promise<boolean>

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

Staticcreate

• create(options?: Options): Promise<PageEditorType>

  No longer use 'new' to create, but use create instead.

  Parameters

  • Optionaloptions: Options

  Returns Promise<PageEditorType>

  Create a PageEditor instance

  Example

  const pageEditor = await PageEditor.create();
  Copy