Class: Viewer

// Initialize the viewer widget
var viewer = new SuperMap3D.Viewer('Container', {
    // Use STK World Terrain
    terrainProvider : new SuperMap3D.SuperMapTerrainProvider({
        url : 'https://assets.agi.com/stk-terrain/world'
    }),
    // Use OpenStreetMaps
    imageryProvider : SuperMap3D.createOpenStreetMapImageryProvider({
        url : 'https://a.tile.openstreetmap.org/'
    }),
});

// Add basic drag-and-drop functionality
viewer.extend(SuperMap3D.viewerDragDropMixin);

// Handle errors when deleting files and show a pop-up warning.
viewer.dropError.addEventListener(function(dropHandler, name, error) {
    console.log(error);
    window.alert(error);
});

Members

_connectWithViewerContextType

Use version when setting or getting initialization, default to WebGL2

Example

如设置使用版本为WebGL2
var viewer = new SuperMap3D.Viewer('Container', {
            contextOptions:{
                contextType:SuperMap3D.ContextType.WebGL1
            }

        });

allowDataSourcesToSuspendAnimationBoolean

Can the data source temporarily pause the animation to avoid displaying incomplete images to the user. For example, if the backend is processing asynchronous functions, the clock will not move forward until the geometry is ready.

readonly animationAnimation

Obtain animation components.

readonly baseLayerPickerBaseLayerPicker

Get the BaseLayerPicker object.

readonly bottomContainerElement

Retrieve DOM elements at the bottom of the window that contain CreditDisplay and other potential information.

readonly cameraCamera

Retrieve the camera object.

readonly canvasCanvas

Retrieve the canvas object.

readonly cesiumLogoElement

Obtain the logo elements of Cesium.

readonly clockClock

Retrieve the clock object.

clockTrackedDataSourceDataSource

Get or set the data source for tracking the viewer clock.

readonly clockViewModelClockViewModel

Obtain the clock view model.

readonly containerElement

Retrieve the parent container.

readonly dataSourceDisplayDataSourceDisplay

Get the display for the Data Source.

readonly dataSourcesDataSourceCollection

Get or set the collection of DataSource instances that will be visualized.

readonly entitiesEntityCollection

Retrieve a collection of entities that are independent of a specific data source. This is a shortcut to access dataSourceDisplay. defaultDataSource.Entities.

readonly fullscreenButtonFullscreenButton

Retrieve the FullscreenButton object.

readonly geocoderGeocoder

Retrieve the Geoencoder object.

readonly homeButtonHomeButton

Retrieve the HomeButton object.

readonly imageryLayersImageryLayerCollection

Get the collection of image layers to be rendered on Earth.

readonly navigationHelpButtonNavigationHelpButton

Retrieve the NavigationHelpButton object.

readonly postProcessStagesPostProcessStageCollection

Obtain post-processing stage.

readonly projectionPickerProjectionPicker

Obtain the projection picker.

resolutionScaleNumber

Get or set the scaling factor for rendering resolution. When the value is less than 1.0, it can improve performance on less powerful devices; On the contrary, when the value is greater than 1.0, it will be rendered at a higher resolution and then scaled down proportionally to improve visual fidelity. For example, if the widget is set to a size of 640x480 and this attribute is set to 0.5, it will cause the scene to be rendered at a resolution of 320x240 and scaled up proportionally, while setting it to 2.0 will cause the scene to be rendered at 1280x960 and scaled down proportionally.

Default Value:

1.0

Methods

destroy()

Release the resources occupied by the object.

extend(mixin, options)

Use the provided mixin to extend the basic viewer functionality. Mixins can add additional properties, functionalities, or other behaviors to the provided viewer instance.

Name	Type	Description
mixin	Viewer~ViewerMixin	Specify the Viewer mixin object to be added to the instance.
options	Object	optional Specify the options object passed to the mixin function.

See:

• viewerDragDropMixin

flyTo(target){Promise.<Boolean>}

The camera flies towards the designated entity, entity set, or data source. If the data source is still loading or the visualization is still in progress, this method needs to wait for the data to be ready before executing the flight.

The offset variable is represented by the "azimuth/elevation/range" in the local "northeast up" reference frame (with the center point being the center of the enclosing sphere). The angles of azimuth and elevation are defined in the local "East North Up" reference frame. The azimuth heading is the angle value that starts from the y-axis and increases towards the x-axis. Pitch is the rotational angle starting from the xy plane, where a positive pitch indicates being above the plane and a negative pitch indicates being below the plane. The distance range represents the distance from the center point. If the range is 0, a range will be calculated to make the entire enclosing sphere visible.

There must be a top-down view in two dimensions. The camera is located above the overhead target. Range is the height above the target; The heading is determined by the offset, and if the azimuth cannot be determined based on the offset, the heading is in the north direction.

Name	Type	Default	Description
target	Entity | Array.<Entity> | EntityCollection | DataSource | ImageryLayer | Promise.<(Entity|Array.<Entity>|EntityCollection|DataSource|ImageryLayer)>		Specify the entity, entity set, data source, or image layer to view. You can also specify a promise to resolve one of the aforementioned types.
options.duration	Number	3.0	optional Flight duration (in seconds).
options.maximumHeight	Number		optional The maximum altitude during flight.
options.offset	HeadingPitchRange		optional The offset from the target in the local "East North Up" reference frame centered on the target.

Returns:

Type	Description
Promise.<Boolean>	When the flight is successful, the promise is parsed as true; If the entity is not visualized in the scene or the flight is cancelled, the promise is parsed as false.

forceResize()

Forcefully readjust, causing the components to reconsider layout including component size, credit placement, etc.

isDestroyed(){Boolean}

Return whether to release the resources occupied by the object.

Returns:

Type	Description
Boolean	True indicates that the occupied resources have been released, otherwise return false.

render()

Rendering the scene. Unless useDefaultRenderLoop is set to false, this function will be automatically called.

resize()

Adjust the size of the components to match the container. This function will be automatically called as needed, unless useDefaultRenderLoop is set to false.

zoomTo(target, offset){Promise.<Boolean>}

Asynchronous camera setup to view specified entities, entity sets, or data sources. If the data source is still loading or visualization is still in progress, this method needs to wait for the data to be ready before performing scaling.

The offset variable is represented by the "azimuth/elevation/range" in the local "northeast up" reference frame (with the center point being the center of the enclosing sphere). The angles of azimuth and elevation are defined in the local "East North Up" reference frame. The azimuth heading is the angle value that starts from the y-axis and increases towards the x-axis. Pitch is the rotational angle starting from the xy plane, where a positive pitch indicates being above the plane and a negative pitch indicates being below the plane. The distance range represents the distance from the center point. If the range is 0, a range will be calculated to make the entire enclosing sphere visible.

There must be a top-down view in two dimensions. The camera is located above the overhead target. Range is the height above the target; The heading is determined by the offset, otherwise the azimuth cannot be determined based on the offset. The heading is in the north direction.

Name	Type	Description
target	Entity | Array.<Entity> | EntityCollection | DataSource | ImageryLayer | Promise.<(Entity|Array.<Entity>|EntityCollection|DataSource|ImageryLayer)>	Specify the entity, entity set, data source, or image layer to view. You can also specify a promise to resolve one of the aforementioned types.
offset	HeadingPitchRange	optional Specify the offset from the center of the local "East North Up" reference frame.

Returns:

Type	Description
Promise.<Boolean>	When scaling is successful, the promise is parsed as true; If the entity is not visualized or scaled in the scene, the promise is parsed as false.

Type Definitions

ViewerMixin(viewer, options)

Add functions for Viewer instances with additional features.

Name	Type	Description
viewer	Viewer	Viewer instance object.
options	Object	The options object passed to the mixin function.

See:

• Viewer#extend