A base widget for building applications. It composites all of the standard Cesium widgets into one reusable package. The widget can always be extended by using mixins, which add functionality useful for a variety of applications.
Viewer是一个用于构建应用程序的基本小部件。它将所有标准Cesium小部件组合到一个可重用的程序包中。我们可以通过使用mixin扩展窗口小部件,这些文件添加了对各种应用程序有用的功能。
【函数名称】
new Cesium.Viewer(container, options)
【入参】
container,类型:Element/String,包含小部件的DOM元素或DOM元素的ID。
options(可选),类型:Viewer.ConstructorOptions对象,描述初始化选项的对象。
Viewer.ConstructorOptions详解:
【抛出异常】
DeveloperError:开发异常,ID为’容器’的元素在文档中不存在。
DeveloperError:开发异常,options.selectedImageryProviderViewModel在不使用BaseLayerPicker小部件时不可用,请指定options.imageryProvider。
DeveloperError:开发异常,options.selectedTerrainProviderViewModel在不使用BaseLayerPicker小部件时不可用,请指定options.terrainProvider。
【类型】
Boolean
【官方解释】
Gets or sets whether or not data sources can temporarily pause animation in order to avoid showing an incomplete picture to the user. For example, if asynchronous primitives are being processed in the background, the clock will not advance until the geometry is ready.
【中文翻译】
获取或设置数据源是否可以暂时暂停动画,以避免向用户显示不完整的图片。例如,如果异步原始类型(asynchronous primitives)在后台处理,时钟将不会前进,直到几何图形准备好。
【类型】
Animation
【官方解释】
Gets the Animation widget.
【中文翻译】
获取动画(Animation)小部件。
【类型】
BaseLayerPicker
【官方解释】
Gets the BaseLayerPicker.
【中文翻译】
获取底图选择器(baseLayerPicker)小部件。
【类型】
Element
【官方解释】
Gets the DOM element for the area at the bottom of the window containing the CreditDisplay and potentially other things.
【中文翻译】
获取包含 CreditDisplay 和其他内容的窗口底部区域的DOM元素。
【类型】
Camera
【官方解释】
Gets the camera.
【中文翻译】
获取相机(camera)对象。
【类型】
HTMLCanvasElement
【官方解释】
Gets the canvas.
【中文翻译】
获取canvas画布 DOM元素。
【类型】
CesiumWidget
【官方解释】
Gets the CesiumWidget.
【中文翻译】
获取CesiumWidget小部件。
【类型】
Clock
【官方解释】
Gets the clock.
【中文翻译】
获取时钟(clock)对象。
【类型】
DataSource
【官方解释】
Gets or sets the data source to track with the viewer’s clock.
【中文翻译】
获取或设置要使用查看器(Viewer)的时钟跟踪的数据源。
【类型】
DataSource
【官方解释】
Gets the clock view model.
【中文翻译】
获取时钟视图模型。
【类型】
Element
【官方解释】
Gets the parent container.
【中文翻译】
获取父容器。
【类型】
DataSourceDisplay
【官方解释】
Gets the display used for DataSource visualization.
【中文翻译】
获取用于 DataSource 可视化的显示。
【类型】
DataSourceCollection
【官方解释】
Gets the set of DataSource instances to be visualized.
【中文翻译】
获取要可视化的 DataSource 实例集。
【类型】
EntityCollection
【官方解释】
Gets the collection of entities not tied to a particular data source. This is a shortcut to dataSourceDisplay.defaultDataSource.entities.
【中文翻译】
获取未绑定到特定数据源的实体的集合。这是 dataSourceDisplay.defaultDataSource.entities 的快捷方式。
【类型】
FullscreenButton
【官方解释】
Gets the FullscreenButton.
【中文翻译】
获取全屏按钮(FullscreenButton)小部件。
【类型】
Geocoder
【官方解释】
Gets the Geocoder.
【中文翻译】
获取地理编码器(geocoder)小部件。
【类型】
HomeButton
【官方解释】
Gets the HomeButton.
【中文翻译】
获取主页按钮(HomeButton)小部件。
【类型】
ImageryLayerCollection
【官方解释】
Gets the collection of image layers that will be rendered on the globe.
【中文翻译】
获取将在地球上(globe)渲染的图像图层的集合。
【类型】
InfoBox
【官方解释】
Gets the info box.
【中文翻译】
获取信息框(info box)小部件。
【类型】
NavigationHelpButton
【官方解释】
Gets the NavigationHelpButton.
【中文翻译】
获取导航帮助按钮(NavigationHelpButton)小部件。
【类型】
PostProcessStageCollection
【官方解释】
Gets the post-process stages.
【中文翻译】
获取后期处理效果集合。
【类型】
ProjectionPicker
【官方解释】
Gets the ProjectionPicker.
【中文翻译】
获取投影选择器(ProjectionPicker)小部件。
【类型】
Number
【默认值】
1.0
【官方解释】
Gets or sets a scaling factor for rendering resolution. Values less than 1.0 can improve performance on less powerful devices while values greater than 1.0 will render at a higher resolution and then scale down, resulting in improved visual fidelity. For example, if the widget is laid out at a size of 640x480, setting this value to 0.5 will cause the scene to be rendered at 320x240 and then scaled up while setting it to 2.0 will cause the scene to be rendered at 1280x960 and then scaled down.
【中文翻译】
获取或设置渲染分辨率的比例因子。小于1.0的值可以在功能不太强大的设备上提高性能,而大于1.0的值将以更高的分辨率渲染,然后缩小,从而提高视觉保真度。例如,如果小部件的布局尺寸为640x480,将此值设置为0.5将导致场景以320x240渲染,然后缩放,而将其设置为2.0将导致场景以1280x960渲染,然后缩小。
【类型】
Scene
【官方解释】
Gets the scene.
【中文翻译】
获取场景(scene)对象。
【类型】
SceneModePicker
【官方解释】
Gets the SceneModePicker.
【中文翻译】
获取场景模式选择器(SceneModePicker)小部件。
【类型】
ScreenSpaceEventHandler
【官方解释】
Gets the screen space event handler.
【中文翻译】
获取屏幕空间事件处理程序。参考我另一篇博文:Cesium 事件详解。
【类型】
Entity|undefined
【官方解释】
Gets or sets the object instance for which to display a selection indicator. If a user interactively picks a Cesium3DTilesFeature instance, then this property will contain a transient Entity instance with a property named “feature” that is the instance that was picked.
【中文翻译】
获取或设置要为其显示选择指示器的对象实例。如果用户交互式地选择了一个Cesium3DTilesFeature实例,那么这个属性将包含一个瞬时实体实例,其属性名为“feature”,即被选择的实例。
【类型】
Event
【官方解释】
Gets the event that is raised when the selected entity changes.
【中文翻译】
获取当选择的实体(entity)发生变化时触发的事件。
【类型】
SelectionIndicator
【官方解释】
Gets the selection indicator.
【中文翻译】
获取选择指示符(selectionIndicator)小部件。
【类型】
ShadowMap
【官方解释】
Get the scene’s shadow map.
【中文翻译】
获取场景阴影贴图。
【类型】
Boolean
【官方解释】
Determines if shadows are cast by light sources.
【中文翻译】
确定是否由光源投射阴影。
【类型】
Number
【官方解释】
Gets or sets the target frame rate of the widget when useDefaultRenderLoop is true. If undefined, the browser’s requestAnimationFrame implementation determines the frame rate. If defined, this value must be greater than 0. A value higher than the underlying requestAnimationFrame implementation will have no effect.
【中文翻译】
获取或设置当 useDefaultRenderLoop 为 true 时小部件的目标帧速率。如果未定义,浏览器的 requestAnimationFrame 实现决定帧速率。如果定义了,这个值必须大于0。高于底层 requestAnimationFrame 实现的值不起作用。
【类型】
TerrainProvider
【官方解释】
The terrain provider providing surface geometry for the globe.
【中文翻译】
地形提供程序为地球(globe)提供表面几何形状。
【类型】
ShadowMode
【官方解释】
Determines if the terrain casts or shadows from light sources.
【中文翻译】
确定地形是否投射或接收光源的阴影。
【类型】
Timeline
【官方解释】
Gets the Timeline widget.
【中文翻译】
获取时间线(Timeline)小部件。
【类型】
Entity|undefined
【官方解释】
Gets or sets the Entity instance currently being tracked by the camera.
【中文翻译】
获取或设置当前被摄像机跟踪的实体实例(Entity instance)。
【类型】
Event
【官方解释】
Gets the event that is raised when the tracked entity changes.
【中文翻译】
获取当追踪的实体(entity)发生变化时触发的事件。
【类型】
Boolean
【默认值】
true
【官方解释】
Boolean flag indicating if the browser’s recommended resolution is used. If true, the browser’s device pixel ratio is ignored and 1.0 is used instead, effectively rendering based on CSS pixels instead of device pixels. This can improve performance on less powerful devices that have high pixel density. When false, rendering will be in device pixels. Viewer#resolutionScale will still take effect whether this flag is true or false.
【中文翻译】
是否使用浏览器推荐的分辨率,布尔类型(Boolean)。如果设置为true,则会忽略浏览器的设备像素比率,取而代之的是1.0,这样根据CSS像素而不是设备像素有效地渲染。这样可以改善在像素密度较高的功能较弱的设备上的性能。如果设置为false,则渲染将以设备像素为单位。 无论设置为true还是false,Viewer#resolutionScale 都有效。
【类型】
Boolean
【默认值】
true
【官方解释】
Gets or sets whether or not this widget should control the render loop. If set to true the widget will use requestAnimationFrame to perform rendering and resizing of the widget, as well as drive the simulation clock. If set to false, you must manually call the resize, render methods as part of a custom render loop. If an error occurs during rendering, Scene’s renderError event will be raised and this property will be set to false. It must be set back to true to continue rendering after the error.
【中文翻译】
获取或设置此小部件是否应控制渲染循环。如果设置为true,小部件将使用 requestAnimationFrame 来执行小部件的渲染(rendering)和调整大小(resizing),以及驱动模拟时钟。如果设置为false,您必须手动调用resize, render方法作为自定义渲染循环的一部分。如果在渲染过程中发生错误,场景(Scene)的renderError事件将触发,并且此属性将被设置为false。必须将其设置回true才能在错误之后继续渲染。
【类型】
VRButton
【官方解释】
Gets the VRButton.
【中文翻译】
获取VR按钮(VRButton)小部件。
【官方解释】
Destroys the widget. Should be called if permanently removing the widget from layout.
【中文翻译】
销毁小部件。如果小部件从布局中永久删除,应该调用此方法释放内存。
【官方解释】
Extends the base viewer functionality with the provided mixin. A mixin may add additional properties, functions, or other behavior to the provided viewer instance.
【中文翻译】
使用所提供的mixin扩展基本查看器(viewer)的功能。mixin可以向所提供的查看器实例添加额外的属性、函数或其他行为。
【入参】
mixin,类型:Viewer.ViewerMixin,要添加到实例上的查看器混入(mixin)。
options(可选),类型:Object,要传给mixin函数的选项对象。
【官方解释】
Flies the camera to the provided entity, entities, or data source. If the data source is still in the process of loading or the visualization is otherwise still loading, this method waits for the data to be ready before performing the flight.
The offset is heading/pitch/range in the local east-north-up reference frame centered at the center of the bounding sphere. The heading and the pitch angles are defined in the local east-north-up reference frame. The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch angles are above the plane. Negative pitch angles are below the plane. The range is the distance from the center. If the range is zero, a range will be computed such that the whole bounding sphere is visible.
In 2D, there must be a top down view. The camera will be placed above the target looking down. The height above the target will be the range. The heading will be determined from the offset. If the heading cannot be determined from the offset, the heading will be north.
【中文翻译】
将摄像机飞向所提供的单个实体、多个实体或数据源。如果数据源仍在加载过程中,或者可视化仍在加载过程中,则该方法等待数据准备就绪后再执行飞行。
偏移量(offset)是在以边界球中心为中心的站心坐标系(ENU坐标系)中的航向(heading)/俯仰(pitch)/范围。航向和俯仰是在站心坐标系中定义的。航向是从y轴向x轴增加的角度。俯仰是从xy平面开始的旋转J角度,往平面上方旋转为正,往平面下方旋转为负。范围就是到中心的距离,如果范围为零,将自动计算一个能使整个边界球可见范围。
在2D中,必须是自上而下的视图,需要把摄像机放置在目标的上方向下看,目标上方的高度就是范围。航向将由偏移量确定。如果不能从偏移量确定航向,则航向将是向北的。
【入参】
target,类型:Entity | Array.< Entity > | EntityCollection | DataSource | ImageryLayer | Cesium3DTileset | TimeDynamicPointCloud | Promise.< (Entity|Array.< Entity >|EntityCollection|DataSource|ImageryLayer|Cesium3DTileset|TimeDynamicPointCloud) >,要查看的实体、实体数组、实体集合、数据源、Cesium3DTileset、点云、或成像层,还可以传递一个Promise对象,解析成前面提到的类型之一。
options(可选),类型:Object,此对象具有以下属性:
【出参】
类型:Promise.< Boolean >,一个Promise对象,如果飞行成功,则解析为true;如果目标当前未在场景中显示或飞行已经取消,则解析为false。
【官方解释】
This forces the widget to re-think its layout, including widget sizes and credit placement.
【中文翻译】
强制小部件重新考虑其布局,包括小部件的尺寸和credit信息的位置。
【出参】
对象如果已经销毁,则返回true,否则返回false。
【官方解释】
Renders the scene. This function is called automatically unless useDefaultRenderLoop is set to false;
【中文翻译】
渲染场景。这个函数一般会自动调用,除非 useDefaultRenderLoop 设置为false。
【官方解释】
Resizes the widget to match the container size. This function is called automatically as needed unless useDefaultRenderLoop is set to false.
【中文翻译】
调整小部件以匹配容器大小。这个函数一般会自动调用,除非 useDefaultRenderLoop 设置为false。
【官方解释】
Asynchronously sets the camera to view the provided entity, entities, or data source. If the data source is still in the process of loading or the visualization is otherwise still loading, this method waits for the data to be ready before performing the zoom.
The offset is heading/pitch/range in the local east-north-up reference frame centered at the center of the bounding sphere. The heading and the pitch angles are defined in the local east-north-up reference frame. The heading is the angle from y axis and increasing towards the x axis. Pitch is the rotation from the xy-plane. Positive pitch angles are above the plane. Negative pitch angles are below the plane. The range is the distance from the center. If the range is zero, a range will be computed such that the whole bounding sphere is visible.
In 2D, there must be a top down view. The camera will be placed above the target looking down. The height above the target will be the range. The heading will be determined from the offset. If the heading cannot be determined from the offset, the heading will be north.
【中文翻译】
异步设置相机以查看所提供的单个实体、多个实体或数据源。如果数据源仍在加载过程中,或者可视化仍在加载过程中,则该方法等待数据准备就绪后再执行缩放(zoom)操作。
偏移量(offset)是在以边界球中心为中心的站心坐标系(ENU坐标系)中的航向(heading)/俯仰(pitch)/范围。航向和俯仰是在站心坐标系中定义的。航向是从y轴向x轴增加的角度。俯仰是从xy平面开始的旋转J角度,往平面上方旋转为正,往平面下方旋转为负。范围就是到中心的距离,如果范围为零,将自动计算一个能使整个边界球可见范围。
在2D中,必须是自上而下的视图,需要把摄像机放置在目标的上方向下看,目标上方的高度就是范围。航向将由偏移量确定。如果不能从偏移量确定航向,则航向将是向北的。
【入参】
target,类型:Entity | Array.< Entity > | EntityCollection | DataSource | ImageryLayer | Cesium3DTileset | TimeDynamicPointCloud | Promise.< (Entity|Array.< Entity >|EntityCollection|DataSource|ImageryLayer|Cesium3DTileset|TimeDynamicPointCloud) >,要查看的实体、实体数组、实体集合、数据源、Cesium3DTileset、点云、或成像层,还可以传递一个Promise对象,解析成前面提到的类型之一。
offset(可选),类型:HeadingPitchRange,在以目标为中心的站心坐标系(ENU坐标系)中,距目标的偏移量。
【出参】
类型:Promise.< Boolean >,一个Promise对象,如果缩放成功,则解析为true;如果目标当前未在场景中显示或缩放已经取消,则解析为false。