Appearance
KBE3D / KBCore / ViewerOptions
接口: ViewerOptions
viewer构造参数
继承
属性
animation?
optionalanimation:boolean
如果设置为 false，则不会创建动画控件。
继承自
baseLayerPicker?
optionalbaseLayerPicker:boolean
如果设置为 false，则不会创建基础图层选择器控件。
继承自
ConstructorOptions.baseLayerPicker
fullscreenButton?
optionalfullscreenButton:boolean
如果设置为 false，则不会创建全屏按钮控件。
继承自
ConstructorOptions.fullscreenButton
vrButton?
optionalvrButton:boolean
如果设置为 true，则会创建虚拟现实按钮控件。
继承自
geocoder?
optionalgeocoder:boolean|IonGeocodeProviderType|GeocoderService[]
如果设置为 false，则不会创建地理编码器控件。
继承自
homeButton?
optionalhomeButton:boolean
如果设置为 false，则不会创建主页按钮控件。
继承自
infoBox?
optionalinfoBox:boolean
如果设置为 false，则不会创建信息框控件。
继承自
sceneModePicker?
optionalsceneModePicker:boolean
如果设置为 false，则不会创建场景模式选择器控件。
继承自
ConstructorOptions.sceneModePicker
selectionIndicator?
optionalselectionIndicator:boolean
如果设置为 false，则不会创建选择指示器控件。
继承自
ConstructorOptions.selectionIndicator
timeline?
optionaltimeline:boolean
如果设置为 false，则不会创建时间线控件。
继承自
navigationHelpButton?
optionalnavigationHelpButton:boolean
如果设置为 false，则不会创建导航帮助按钮。
继承自
ConstructorOptions.navigationHelpButton
navigationInstructionsInitiallyVisible?
optionalnavigationInstructionsInitiallyVisible:boolean
如果为 true，则导航说明应初始时即可见；如果为 false，则直到用户明确点击按钮时才会显示。
继承自
ConstructorOptions.navigationInstructionsInitiallyVisible
scene3DOnly?
optionalscene3DOnly:boolean
当为 <code>true</code> 时，每个几何体实例将仅以 3D 形式渲染，以节省 GPU 内存。
继承自
ConstructorOptions.scene3DOnly
shouldAnimate?
optionalshouldAnimate:boolean
如果为 <code>true</code>，则时钟将尝试默认前进模拟时间；如果为 <code>false</code>，则不前进。此选项优先于设置 Cesium.Viewer#clockViewModel。
继承自
ConstructorOptions.shouldAnimate
clockViewModel?
optionalclockViewModel:ClockViewModel
用于控制当前时间的时钟视图模型。
继承自
ConstructorOptions.clockViewModel
selectedImageryProviderViewModel?
optionalselectedImageryProviderViewModel:ProviderViewModel
当前基础影像图层的视图模型，如果未提供，则使用第一个可用的基础图层。此值仅在 baseLayerPicker 设置为 true 时有效。
继承自
ConstructorOptions.selectedImageryProviderViewModel
imageryProviderViewModels?
optionalimageryProviderViewModels:ProviderViewModel[]
可从基础图层选择器中选择的 ProviderViewModels 数组。此值仅在 baseLayerPicker 设置为 true 时有效。
继承自
ConstructorOptions.imageryProviderViewModels
selectedTerrainProviderViewModel?
optionalselectedTerrainProviderViewModel:ProviderViewModel
当前基础地形图层的视图模型，如果未提供，则使用第一个可用的基础图层。此值仅在 baseLayerPicker 设置为 true 时有效。
继承自
ConstructorOptions.selectedTerrainProviderViewModel
terrainProviderViewModels?
optionalterrainProviderViewModels:ProviderViewModel[]
可从基础图层选择器中选择的 ProviderViewModels 数组（针对地形图层）。此值仅在 baseLayerPicker 设置为 true 时有效。
继承自
ConstructorOptions.terrainProviderViewModels
baseLayer?
optionalbaseLayer:false|ImageryLayer
应用到地球的最底部影像图层。如果设置为 <code>false</code>，则不会添加任何影像图层提供器。此值仅在 baseLayerPicker 设置为 false 时有效。
继承自
ellipsoid?
optionalellipsoid:Ellipsoid
The default ellipsoid.
继承自
terrainProvider?
optionalterrainProvider:TerrainProvider
要使用的地形提供器。
继承自
ConstructorOptions.terrainProvider
terrain?
optionalterrain:Terrain
一个处理异步地形提供器的地形对象。仅当 options.terrainProvider 未定义时可以指定。
继承自
skyBox?
optionalskyBox:false|SkyBox
用于渲染星星的天空盒。当为 <code>undefined</code> 时，将使用默认的星星。如果设置为 <code>false</code>，则不会添加天空盒、太阳或月亮。
继承自
skyAtmosphere?
optionalskyAtmosphere:false|SkyAtmosphere
蓝天以及地球边缘周围的光晕。设置为 <code>false</code> 以关闭它。
继承自
ConstructorOptions.skyAtmosphere
fullscreenElement?
optionalfullscreenElement:string|Element
当按下全屏按钮时，要进入全屏模式的元素或元素ID。
继承自
ConstructorOptions.fullscreenElement
useDefaultRenderLoop?
optionaluseDefaultRenderLoop:boolean
如果此小部件应控制渲染循环，则为 true，否则为 false。
继承自
ConstructorOptions.useDefaultRenderLoop
targetFrameRate?
optionaltargetFrameRate:number
在使用默认渲染循环时的目标帧率。
继承自
ConstructorOptions.targetFrameRate
showRenderLoopErrors?
optionalshowRenderLoopErrors:boolean
如果为 true，则在渲染循环发生错误时，此小部件将自动向用户显示一个包含错误的HTML面板。
继承自
ConstructorOptions.showRenderLoopErrors
useBrowserRecommendedResolution?
optionaluseBrowserRecommendedResolution:boolean
如果为 true，则以浏览器推荐的分辨率渲染，并忽略 <code>window.devicePixelRatio</code>。
继承自
ConstructorOptions.useBrowserRecommendedResolution
automaticallyTrackDataSourceClocks?
optionalautomaticallyTrackDataSourceClocks:boolean
如果为 true，则此小部件将自动跟踪新添加的数据源（DataSource）的时钟设置，并在数据源的时钟更改时进行更新。如果希望独立配置时钟，请将此属性设置为 false。
继承自
ConstructorOptions.automaticallyTrackDataSourceClocks
contextOptions?
optionalcontextOptions:ContextOptions
传递给 Cesium.Scene 的上下文和 WebGL 创建属性。
继承自
ConstructorOptions.contextOptions
sceneMode?
optionalsceneMode:SceneMode
初始场景模式。默认为三维场景模式。
继承自
mapProjection?
optionalmapProjection:MapProjection
在二维和哥伦布视图模式中要使用的地图投影。默认为地理投影。
继承自
ConstructorOptions.mapProjection
globe?
optionalglobe:false|Globe
场景中使用的地球仪。如果设置为 <code>false</code>，则不会添加地球仪，并且默认情况下会隐藏天空大气层。
继承自
orderIndependentTranslucency?
optionalorderIndependentTranslucency:boolean
如果为 true 并且配置支持，则使用顺序无关透明性。这有助于减少透明对象渲染时的排序问题。
继承自
ConstructorOptions.orderIndependentTranslucency
creditContainer?
optionalcreditContainer:string|Element
包含 Cesium.CreditDisplay 的 DOM 元素或元素ID。如果不指定，则版权信息将添加到小部件本身的底部。
继承自
ConstructorOptions.creditContainer
creditViewport?
optionalcreditViewport:string|Element
包含由 Cesium.CreditDisplay 创建的版权弹出窗口的 DOM 元素或元素ID。如果不指定，则弹出窗口将出现在小部件上方。
继承自
ConstructorOptions.creditViewport
dataSources?
optionaldataSources:DataSourceCollection
由小部件可视化的数据源集合。如果提供了此参数，则假定其实例由调用者拥有，并且在销毁查看器时不会销毁该实例。这允许您跨多个查看器共享相同的数据源集合。
继承自
ConstructorOptions.dataSources
shadows?
optionalshadows:boolean
确定光源是否投射阴影。设置为 true 以启用阴影，否则为 false。
继承自
terrainShadows?
optionalterrainShadows:ShadowMode
确定地形是否投射或接收来自光源的阴影。ShadowMode.RECEIVE_ONLY 表示地形仅接收阴影，不投射阴影；其他选项可能包括 ShadowMode.CAST_ONLY（仅投射阴影）和 ShadowMode.CAST_AND_RECEIVE（既投射也接收阴影）。
继承自
ConstructorOptions.terrainShadows
mapMode2D?
optionalmapMode2D:MapMode2D
确定二维地图是否可旋转或是否可以在水平方向上无限滚动。MapMode2D.INFINITE_SCROLL 允许无限滚动，而 MapMode2D.ROTATE 允许旋转但不支持无限滚动。
继承自
projectionPicker?
optionalprojectionPicker:boolean
如果设置为 true，将创建 ProjectionPicker 小部件，允许用户在不同的地图投影之间切换。
继承自
ConstructorOptions.projectionPicker
blurActiveElementOnCanvasFocus?
optionalblurActiveElementOnCanvasFocus:boolean
如果为 true，则在点击查看器的画布时，当前活动的元素将失去焦点。将此设置为 false 在某些情况下很有用，例如，当点击画布仅用于获取位置或实体数据，而不希望将画布设置为活动元素时。
继承自
ConstructorOptions.blurActiveElementOnCanvasFocus
requestRenderMode?
optionalrequestRenderMode:boolean
如果为 true，则仅当场景中的更改确定需要时才会渲染帧。启用此模式可以减少应用程序的 CPU/GPU 使用量，并在移动设备上节省电池电量，但要求使用 Cesium.Scene#requestRender 来显式渲染新帧。在此模式下，在 API 的其他部分对场景进行更改后，在许多情况下都需要这样做。有关更多信息，请参阅 使用显式渲染提高性能。
继承自
ConstructorOptions.requestRenderMode
maximumRenderTimeChange?
optionalmaximumRenderTimeChange:number
当 requestRenderMode 设置为 true 时，此属性定义了在请求渲染之前允许的最大模拟时间变化量。这有助于控制渲染频率，以避免在模拟时间变化较小时频繁渲染，从而提高性能。更多关于如何使用显式渲染来提高性能的信息，请参考 使用显式渲染提高性能。
继承自
ConstructorOptions.maximumRenderTimeChange
depthPlaneEllipsoidOffset?
optionaldepthPlaneEllipsoidOffset:number
此属性用于调整深度平面（DepthPlane），以解决位于椭球体零高程以下的渲染伪影问题。通过调整偏移量，可以改善这些区域的渲染质量。
继承自
ConstructorOptions.depthPlaneEllipsoidOffset
msaaSamples?
optionalmsaaSamples:number
如果提供，此属性控制多重采样抗锯齿（Multisample Antialiasing, MSAA）的采样率。典型的 MSAA 采样率包括每像素 2、4 个样本，有时也使用 8 个样本。更高的 MSAA 采样率可能会以牺牲性能为代价来提高视觉质量。然而，这个值仅适用于支持多重采样渲染目标的 WebGL2 上下文。如果不支持多重采样或未设置此属性，则默认为每像素 1 个样本（即无 MSAA）。