WindowParams class 参考

详细描述Copy Anchor Link

适用版本：@shengwang/whiteboard 0.2.11。

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

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

类型结构（源码声明）Copy Anchor Link

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

export class WindowParams

变量说明Copy Anchor Link

containerSizeRatioCopy Anchor Link

containerSizeRatio?: number

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

chessboardCopy Anchor Link

chessboard?: boolean

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

collectorStylesCopy Anchor Link

collectorStyles?: Record<string, string>

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

overwriteStylesCopy Anchor Link

overwriteStyles?: string

窗口样式覆盖

debugCopy Anchor Link

debug?: boolean

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

prefersColorSchemeCopy Anchor Link

prefersColorScheme?: WindowPrefersColorScheme

窗口配色模式

fullscreenCopy Anchor Link

fullscreen?: boolean

是否全屏

pollingCopy Anchor Link

polling?: boolean

是否轮询

useBoxesStatusCopy Anchor Link

useBoxesStatus?: boolean

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

forceMaximizedCopy Anchor Link

forceMaximized?: boolean

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

lazySetupInMaximizedModeCopy Anchor Link

lazySetupInMaximizedMode?: boolean

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

maxCachedAppsInMaximizedModeCopy Anchor Link

maxCachedAppsInMaximizedMode?: number

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

builtinAppOptionsCopy Anchor Link

builtinAppOptions?: BuiltinAppOptions

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

originSizeCopy Anchor Link

originSize?: WindowOriginSize

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

pageScaleRangeCopy Anchor Link

pageScaleRange?: PageScaleRange

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

函数说明Copy Anchor Link

setContainerSizeRatioCopy Anchor Link

setContainerSizeRatio(containerSizeRatio: number) : WindowParams

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

setChessboardCopy Anchor Link

setChessboard(chessboard: boolean) : WindowParams

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

setDebugCopy Anchor Link

setDebug(debug: boolean) : WindowParams

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

setCollectorStylesCopy Anchor Link

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

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

setOverwriteStylesCopy Anchor Link

setOverwriteStyles(overwriteStyles: string) : WindowParams

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

setPrefersColorSchemeCopy Anchor Link

setPrefersColorScheme(prefersColorScheme: WindowPrefersColorScheme) : WindowParams

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

setFullscreenCopy Anchor Link

setFullscreen(fullscreen: boolean) : WindowParams

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

setPollingCopy Anchor Link

setPolling(polling: boolean) : WindowParams

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

setUseBoxesStatusCopy Anchor Link

setUseBoxesStatus(useBoxesStatus: boolean) : WindowParams

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

setForceMaximizedCopy Anchor Link

setForceMaximized(forceMaximized: boolean) : WindowParams

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

setLazySetupInMaximizedModeCopy Anchor Link

setLazySetupInMaximizedMode(lazySetupInMaximizedMode: boolean) : WindowParams

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

setMaxCachedAppsInMaximizedModeCopy Anchor Link

setMaxCachedAppsInMaximizedMode(maxCachedAppsInMaximizedMode: number) : WindowParams

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

setBuiltinAppOptionsCopy Anchor Link

setBuiltinAppOptions(builtinAppOptions: BuiltinAppOptions) : WindowParams

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

setOriginSizeCopy Anchor Link

setOriginSize(originSize: WindowOriginSize) : WindowParams

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

setPageScaleRangeCopy Anchor Link

setPageScaleRange(pageScaleRange: PageScaleRange) : WindowParams

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