getPageDisplaySize

In sn-plugin-lib later than 0.1.65, it is best not to use this API. It is kept for compatibility with older versions. Use PluginFileAPI.getPageSize instead; for the current page, first use getCurrentFilePath and getCurrentPageNum to get the file path and page number.

sn-plugin-lib 0.1.65 and earlier: this API returns the display size of the currently opened page and is intended for current-page element operations such as batchUpdatePageElements, insertPageElements, and modifyPageElements. When these APIs operate on the current page, call getPageDisplaySize to get the current page display size instead of calling PluginFileAPI.getPageSize, otherwise the position data may not match.

static getPageDisplaySize(): Promise<APIResponse<Size>>;

Returns

APIResponse<Size>: result is the display size of the current page. See Size

Example

import { PluginCommAPI } from 'sn-plugin-lib';

/**
 * Example: get the display size of the current page.
 */
export async function exampleGetPageDisplaySize() {
  const res = await PluginCommAPI.getPageDisplaySize();
  if (!res.success) {
    console.log('getPageDisplaySize failed', res.error);
    throw new Error(res.error?.message ?? 'getPageDisplaySize call failed');
  }
  console.log('getPageDisplaySize result', res.result);
  return res.result;
}

​Example

Example