View
- Web
更新时间
Whiteboard Web SDK 2.16.59 公开 interface。
export declare interface View成员
- canUndoSteps
- canRedoSteps
- camera
- size
- callbacks
- mode
- divElement
- focusScenePath
- focusSceneIndex
- wrappedComponents
- disableCameraTransform
- disableKey
- commandWheelToZoom
- setMemberState
- setCameraBound
- moveCamera
- moveCameraToContain
- insertImage
- completeImageUpload
- lockImage
- lockImages
- getImagesInformation
- insertText
- updateText
- updateSelectedText
- getBoundingRect
- scenePreview
- generateScreenshot
- fillSceneSnapshot
- screenshotToCanvas
- screenshotToCanvasAsync
- undo
- redo
- clearUndoHistory
- copy
- paste
- duplicate
- delete
- cleanCurrentScene
- moveSelectedComponentsToTop
- moveSelectedComponentsToBottom
- refresh
- refreshSize
- convertToPointInWorld
- convertToPointOnScreen
- release
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;Returns
MemberState
setCameraBound
setCameraBound(cameraBound: CameraBound): void;修改 ``cameraBound`` 以调整视角边界Returns
void
moveCamera
moveCamera(camera: Partial<Camera> & Readonly<{ animationMode?: AnimationMode; }>): void;移动视角Returns
void
moveCameraToContain
moveCameraToContain(rectangle: Rectangle & Readonly<{ animationMode?: AnimationMode; }>): void;移动视角以容纳特定的视觉矩形Returns
void
insertImage
insertImage(imageInfo: ImageInformation): void;Returns
void
completeImageUpload
completeImageUpload(uuid: string, src: string): void;Returns
void
lockImage
lockImage(uuid: string, locked: boolean): void;Returns
void
lockImages
lockImages(locked: boolean): void;Returns
void
getImagesInformation
getImagesInformation(scenePath: string): ImageInformation[];Returns
ImageInformation[]
insertText
insertText(x: number, y: number, textContent?: string): Identifier;Returns
Identifier
updateText
updateText(identifier: Identifier, textContent: string): void;Returns
void
updateSelectedText
updateSelectedText(format: TextFormat): void;Returns
void
getBoundingRect
getBoundingRect(scenePath: string): Rectangle;Returns
Rectangle
scenePreview
scenePreview(scenePath: string, div: HTMLElement, width?: number, height?: number, engine?: RenderEngine): void;Returns
void
generateScreenshot
generateScreenshot(scenePath?: string, width?: number, height?: number): Promise<string>;Returns
Promise<string>
fillSceneSnapshot
fillSceneSnapshot(scenePath: string, div: HTMLElement, width?: number, height?: number, engine?: RenderEngine): void;Returns
void
screenshotToCanvas
screenshotToCanvas(context: CanvasRenderingContext2D, scenePath: string, width: number, height: number, camera: Camera, ratio?: number): void;Returns
void
screenshotToCanvasAsync
screenshotToCanvasAsync(context: CanvasRenderingContext2D, scenePath: string, width: number, height: number, camera: Camera, ratio?: number, timeout?: number): Promise<void>;Returns
Promise<void>
undo
undo(): number;Returns
number
redo
redo(): number;Returns
number
clearUndoHistory
clearUndoHistory(includeRedo?: boolean): void;Returns
void
copy
copy(): void;Returns
void
paste
paste(): void;Returns
void
duplicate
duplicate(): void;Returns
void
delete
delete(): void;Returns
void
cleanCurrentScene
cleanCurrentScene(retainPPT?: boolean): void;Returns
void
moveSelectedComponentsToTop
moveSelectedComponentsToTop(): void;Returns
void
moveSelectedComponentsToBottom
moveSelectedComponentsToBottom(): void;Returns
void
refresh
refresh(): void;Returns
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.Returns
void
convertToPointInWorld
convertToPointInWorld(point: Point): Point;Returns
Point
convertToPointOnScreen
convertToPointOnScreen(x: number, y: number): Point;Returns
Point
release
release(): void;Returns
void