View

Whiteboard Web SDK 2.16.59 公开 interface。

JavaScript

export declare interface View  

Properties

canUndoSteps

readonly canUndoSteps: number;

canRedoSteps

readonly canRedoSteps: number;

camera

readonly camera: Camera;

size

readonly size: Size;

callbacks

readonly callbacks: Callbacks<ViewCallbacks>;

mode

mode: ViewVisionMode;

divElement

divElement: HTMLDivElement | null;

focusScenePath

focusScenePath: string | undefined;

focusSceneIndex

focusSceneIndex: number | undefined;

wrappedComponents

wrappedComponents: WrappedComponents;

disableCameraTransform

disableCameraTransform: boolean;

是否禁止设备主动操作视角。 禁止后，用户无法使用鼠标滚轮，或在 touch 设备上通过多指手势来改变视角。 该属性不会影响 ``setCameraBound``、``moveCamera``、``moveCameraToContain`` 方法的使用。

disableKey

disableKey: boolean;

是否禁止处理键盘事件。

commandWheelToZoom

commandWheelToZoom: boolean;

在 macOS 上，是否把 ``command`` 滚轮识别为缩放，默认为 ``false``。

Methods

setMemberState

setMemberState(modifyState: Partial<MemberState>): MemberState;

返回值

MemberState

setCameraBound

setCameraBound(cameraBound: CameraBound): void;

修改 cameraBound 以调整视角边界

返回值

void

moveCamera

moveCamera(camera: Partial<Camera> & Readonly<{ animationMode?: AnimationMode; }>): void;

移动视角

返回值

void

moveCameraToContain

moveCameraToContain(rectangle: Rectangle & Readonly<{ animationMode?: AnimationMode; }>): void;

移动视角以容纳特定的视觉矩形

返回值

void

insertImage

insertImage(imageInfo: ImageInformation): void;

返回值

void

completeImageUpload

completeImageUpload(uuid: string, src: string): void;

返回值

void

lockImage

lockImage(uuid: string, locked: boolean): void;

返回值

void

lockImages

lockImages(locked: boolean): void;

返回值

void

getImagesInformation

getImagesInformation(scenePath: string): ImageInformation[];

返回值

ImageInformation[]

insertText

insertText(x: number, y: number, textContent?: string): Identifier;

返回值

Identifier

updateText

updateText(identifier: Identifier, textContent: string): void;

返回值

void

updateSelectedText

updateSelectedText(format: TextFormat): void;

返回值

void

getBoundingRect

getBoundingRect(scenePath: string): Rectangle;

返回值

Rectangle

scenePreview

scenePreview(scenePath: string, div: HTMLElement, width?: number, height?: number, engine?: RenderEngine): void;

返回值

void

generateScreenshot

generateScreenshot(scenePath?: string, width?: number, height?: number): Promise<string>;

返回值

Promise<string>

fillSceneSnapshot

fillSceneSnapshot(scenePath: string, div: HTMLElement, width?: number, height?: number, engine?: RenderEngine): void;

返回值

void

screenshotToCanvas

screenshotToCanvas(context: CanvasRenderingContext2D, scenePath: string, width: number, height: number, camera: Camera, ratio?: number): void;

返回值

void

screenshotToCanvasAsync

screenshotToCanvasAsync(context: CanvasRenderingContext2D, scenePath: string, width: number, height: number, camera: Camera, ratio?: number, timeout?: number): Promise<void>;

返回值

Promise<void>

undo

undo(): number;

返回值

number

redo

redo(): number;

返回值

number

clearUndoHistory

clearUndoHistory(includeRedo?: boolean): void;

返回值

void

copy

copy(): void;

返回值

void

paste

paste(): void;

返回值

void

duplicate

duplicate(): void;

返回值

void

delete

delete(): void;

返回值

void

cleanCurrentScene

cleanCurrentScene(retainPPT?: boolean): void;

返回值

void

moveSelectedComponentsToTop

moveSelectedComponentsToTop(): void;

返回值

void

moveSelectedComponentsToBottom

moveSelectedComponentsToBottom(): void;

返回值

void

refresh

refresh(): void;

返回值

void

refreshSize

refreshSize(width: number, height: number): void;

按已知 CSS 像素尺寸刷新 View；width/height 必须为有限正数。调用期间暂时断开 ResizeObserver，结束后恢复。

Refresh the view with a known container size in CSS pixels.
Temporarily disconnects ResizeObserver while applying the known size.

返回值

void

convertToPointInWorld

convertToPointInWorld(point: Point): Point;

返回值

Point

convertToPointOnScreen

convertToPointOnScreen(x: number, y: number): Point;

返回值

Point

release

release(): void;

返回值

void