WindowParams class 参考

适用版本：@shengwang/whiteboard 0.2.11。

多窗口入房配置；支持属性和链式 setter。

可从 @shengwang/whiteboard 直接导入 WindowParams。

类型结构（源码声明）

下方源码文件的 export 声明不等同于 SDK 包入口导出；业务导入方式以上方说明为准。

export class WindowParams

containerSizeRatio	`containerSizeRatio?: number`
chessboard	`chessboard?: boolean`
collectorStyles	`collectorStyles?: Record<string, string>`
overwriteStyles	`overwriteStyles?: string`
debug	`debug?: boolean`
prefersColorScheme	`prefersColorScheme?: WindowPrefersColorScheme`
fullscreen	`fullscreen?: boolean`
polling	`polling?: boolean`
useBoxesStatus	`useBoxesStatus?: boolean`
forceMaximized	`forceMaximized?: boolean`
lazySetupInMaximizedMode	`lazySetupInMaximizedMode?: boolean`
maxCachedAppsInMaximizedMode	`maxCachedAppsInMaximizedMode?: number`
builtinAppOptions	`builtinAppOptions?: BuiltinAppOptions`
originSize	`originSize?: WindowOriginSize`
pageScaleRange	`pageScaleRange?: PageScaleRange`
setContainerSizeRatio	`setContainerSizeRatio(containerSizeRatio: number) : WindowParams`
setChessboard	`setChessboard(chessboard: boolean) : WindowParams`
setDebug	`setDebug(debug: boolean) : WindowParams`
setCollectorStyles	`setCollectorStyles(collectorStyles: Record<string, string>) : WindowParams`
setOverwriteStyles	`setOverwriteStyles(overwriteStyles: string) : WindowParams`
setPrefersColorScheme	`setPrefersColorScheme(prefersColorScheme: WindowPrefersColorScheme) : WindowParams`
setFullscreen	`setFullscreen(fullscreen: boolean) : WindowParams`
setPolling	`setPolling(polling: boolean) : WindowParams`
setUseBoxesStatus	`setUseBoxesStatus(useBoxesStatus: boolean) : WindowParams`
setForceMaximized	`setForceMaximized(forceMaximized: boolean) : WindowParams`
setLazySetupInMaximizedMode	`setLazySetupInMaximizedMode(lazySetupInMaximizedMode: boolean) : WindowParams`
setMaxCachedAppsInMaximizedMode	`setMaxCachedAppsInMaximizedMode(maxCachedAppsInMaximizedMode: number) : WindowParams`
setBuiltinAppOptions	`setBuiltinAppOptions(builtinAppOptions: BuiltinAppOptions) : WindowParams`
setOriginSize	`setOriginSize(originSize: WindowOriginSize) : WindowParams`
setPageScaleRange	`setPageScaleRange(pageScaleRange: PageScaleRange) : WindowParams`

变量说明

containerSizeRatio

containerSizeRatio?: number

各个端本地显示多窗口内容时，高与宽比例，默认为 9:16

chessboard

chessboard?: boolean

多窗口区域（主窗口）以外的空间显示 PS 棋盘背景，默认 true

collectorStyles

collectorStyles?: Record<string, string>

驼峰形式的 CSS，透传给多窗口时，最小化 div 的 css

overwriteStyles

overwriteStyles?: string

窗口样式覆盖

debug

debug?: boolean

是否在网页控制台打印日志

prefersColorScheme

prefersColorScheme?: WindowPrefersColorScheme

窗口配色模式

fullscreen

fullscreen?: boolean

是否全屏

polling

polling?: boolean

是否轮询

useBoxesStatus

useBoxesStatus?: boolean

每个窗口独立同步最大化/最小化状态；在入房前配置，同房间客户端保持一致。与 forceMaximized 策略不兼容。

forceMaximized

forceMaximized?: boolean

房间级强制最大化；可写端开启后同步到房间。两者不能同时生效；继承房间强制最大化或有效 lazy 模式时忽略本地 useBoxesStatus，否则同时请求两者时独立窗口状态优先。

lazySetupInMaximizedMode

lazySetupInMaximizedMode?: boolean

本地按焦点初始化 App；仅在房间已强制最大化且处于 maximized/minimized 时生效，否则使用 eager 初始化。默认关闭。

maxCachedAppsInMaximizedMode

maxCachedAppsInMaximizedMode?: number

lazy 模式本地 App runtime 缓存容量；内嵌 Window Manager 默认 4，按 LRU 管理。不是房间 App 数量上限，Slide 保留 runtime 的行为由播放器活动状态管理。

builtinAppOptions

builtinAppOptions?: BuiltinAppOptions

本地内置 App 配置，不同步到房间；其中 Presentation 配置用于恢复存量 App 前注册。

originSize

originSize?: WindowOriginSize

正数 width/height 组成的归一化参考尺寸。WindowParams 用于 MainView；WindowAppParam 用于 Slide/Presentation 并写入 attributes.originSize。

pageScaleRange

pageScaleRange?: PageScaleRange

相对适配尺寸的 minScale/maxScale 范围；未配置边界不增加业务限制。

函数说明

setContainerSizeRatio

setContainerSizeRatio(containerSizeRatio: number) : WindowParams

setContainerSizeRatio：WindowParams 的公开成员。参数和返回类型见下方签名。

setChessboard

setChessboard(chessboard: boolean) : WindowParams

setChessboard：WindowParams 的公开成员。参数和返回类型见下方签名。

setDebug

setDebug(debug: boolean) : WindowParams

setDebug：WindowParams 的公开成员。参数和返回类型见下方签名。

setCollectorStyles

setCollectorStyles(collectorStyles: Record<string, string>) : WindowParams

setCollectorStyles：WindowParams 的公开成员。参数和返回类型见下方签名。

setOverwriteStyles

setOverwriteStyles(overwriteStyles: string) : WindowParams

setOverwriteStyles：WindowParams 的公开成员。参数和返回类型见下方签名。

setPrefersColorScheme

setPrefersColorScheme(prefersColorScheme: WindowPrefersColorScheme) : WindowParams

setPrefersColorScheme：WindowParams 的公开成员。参数和返回类型见下方签名。

setFullscreen

setFullscreen(fullscreen: boolean) : WindowParams

setFullscreen：WindowParams 的公开成员。参数和返回类型见下方签名。

setPolling

setPolling(polling: boolean) : WindowParams

setPolling：WindowParams 的公开成员。参数和返回类型见下方签名。

setUseBoxesStatus

setUseBoxesStatus(useBoxesStatus: boolean) : WindowParams