Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: ObliqueViewer
[ AMD Module Require | Legacy Module Require ]
require(["esri/dijit/ObliqueViewer"], function(ObliqueViewer) { /* code goes here */ });
Description
(Added at v3.14)
(Currently in beta)
The oblique viewer widget, displays images in their native coordinate system using an Image Coordinate System (ICS). See ImageSpatialReference. Oblique images are displayed in their native ICS, to avoid distortion caused by projecting them to a geographic or projected coordinate system. The widget allows the user to pan around in oblique mode, in a single viewing angle, or switch angles to view an area of interest from different angles.
This widget requires an image service published on a 10.3 or higher to ArcGIS Server. The service data source must be mosaic datasets authored using the frame camera raster type. The map used to construct the viewer must have this type of image service.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new ObliqueViewer(params) | Creates an instance of the ObliqueViewer widget. |
CSS
esri/dijit/ObliqueViewer | Download source
Properties
| Name | Type | Summary |
|---|---|---|
| azimuthAngle | Number | Indicates the current azimuth angle of the viewer. |
| azimuthField | String | Image service field that denotes the sensor azimuth value for a record. |
| azimuthTolerance | Number | Indicates the tolerance value applied when selecting images for a given azimuth angle value. |
| elevationField | String | Image service field that denotes the sensor elevation value for a record. |
| elevationThreshold | Number | Elevation value between 0 and 90 that differentiates an image as oblique or nadir. |
| filteredRecords | Object[] | Subset of records, filtered based on current azimuth angle. |
| imageServiceLayer | ArcGISImageServiceLayer | Image service layer to be used as source for oblique images. |
| isNadir | Boolean | Indicates whether current view is nadir. |
| map | Map | Map object associated with the widget. |
| noQueryOnExtentChange | Boolean | When true, the widget doesn't refresh itself with new oblique records when the map's extent changes. |
| rasterInfoFields | Object[] | Raster info fields to be queried and displayed in the raster list. |
| rasterListRefresh | Boolean | When true, the list is populated on data refresh. |
| records | Object[] | Oblique image data that is currently being used by the viewer. |
| selectedRaster | Object | Object containing additional information about the raster. |
| selectedRasterId | Number | Id of the raster currently being displayed. |
| showThumbnail | Boolean | When true, thumbnail images for records are displayed in the list. |
Methods
| Name | Return type | Summary |
|---|---|---|
| locate(geometry) | None | Queries and displays the best image in a specific direction. |
| projectGeometry(geometry, outSpatialReference) | Deferred | Projects the input geometry to the specified spatial reference. |
| search(geometry) | Deferred | Performs a query on the image service for oblique images covering the input geometry. |
| setData(records, extent) | None | Sets the records and extent on the viewer. |
| setExtent(extent) | Deferred | Projects the given extent to the map's spatial reference and sets the extent. |
| setImage(id, extent) | None | Sets the input image (based on the image ID) to the given extent. |
| zoomToSelectedImage() | None | Sets the map extent to the currently selected image. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| azimuth-change | {
azimuth: < | Fires when the azimuth is changed. |
| raster-select | {
selectedRasterId: < | Fires when the selected raster is changed. |
| records-refresh | {
filteredRecords: < | Fires when the viewer records are refreshed. |
Constructor Details
Creates an instance of the ObliqueViewer widget.
Parameters:
< |
Required | Constructor options. See object specification table below for more details about each property. |
params properties: < |
Optional | Azimuth angle value for which to display oblique images. If not provided, the widget is initialized in nadir mode, displaying ortho images. |
< |
Optional | Image service field that denotes the sensor azimuth value for a record. Default value is SensorAzimuth. |
< |
Optional | Tolerance value applied when filtering azimuth images. Default is 10. |
< |
Optional | Image service field that denotes the sensor elevation value for a record. Default value is SensorElevation. |
< |
Optional | Elevation value between 0 and 90 that differentiates an image as oblique or nadir. Default value is 70. |
< |
Required | Image service layer to be used as source for oblique images. |
< |
Required | Map object associated with the widget. |
< |
Optional | When true, the widget doesn't refresh itself with new oblique records when the map's extent changes. Default value is false. |
< |
Optional | Raster info fields to be queried and displayed in the raster list. For object specification, see the table in the rasterInfoFields property. |
< |
Optional | DOM Node or id, where the list element is to be placed. |
< |
Optional | When true, list is populated on data refresh. |
< |
Optional | DOM Node or id, where the oblique rotation gauge element is to be placed. |
< |
Optional | When true, thumbnail images for records are displayed in the list. Default value is true. |
< |
Optional | Sorting function that takes query results and sorts them. The first one from the list is displayed by default when the map's extent changes. Users can define their own sorters. The sorting function takes one parameter for the input query records. |
Property Details
<Number
NumberIndicates the current azimuth angle of the viewer.
<String
StringImage service field that denotes the sensor azimuth value for a record.
Default value:
SensorAzimuth<Number
NumberIndicates the tolerance value applied when selecting images for a given azimuth angle value.
Default value:
10<String
StringImage service field that denotes the sensor elevation value for a record.
Default value:
SensorElevation<Number
NumberElevation value between 0 and 90 that differentiates an image as oblique or nadir.
Known values:
0 - 90Default value:
70<Object[]
Object[]Subset of records, filtered based on current azimuth angle.
<ArcGISImageServiceLayer
ArcGISImageServiceLayerImage service layer to be used as source for oblique images.
<Boolean
BooleanIndicates whether current view is nadir.
<Map
MapMap object associated with the widget.
<Boolean
BooleanWhen
true, the widget doesn't refresh itself with new oblique records when the map's extent changes.Known values:
true | falseDefault value:
false<Object[]
Object[]Raster info fields to be queried and displayed in the raster list. See object specification table below for more details.
<Boolean
BooleanWhen
true, the list is populated on data refresh.<Object[]
Object[]Oblique image data that is currently being used by the viewer. The image data is a JSON object of the query response format from the image service. See object specification table below and Query Image Service for additional details.
<Object
ObjectObject containing additional information about the raster. Contains an "attributes" property and a "geometry" property.
<Number
NumberId of the raster currently being displayed.
<Boolean
BooleanWhen
true, thumbnail images for records are displayed in the list.Known values:
true | falseDefault value:
trueMethod Details
Queries and displays the best image in a specific direction. The area of interest is defined by the input geometry, the direction is defined by the current
azimuth and the best image for that AOI is selected based on the sorting algorithm (see sorter in the constructor options). (Added at v3.16)Parameters:
< |
Required | The specified input geometry needed for querying for the best image in a given azimuth direction. |
Projects the input geometry to the specified spatial reference.
Return type:
DeferredParameters:
< |
Required | The geometry to project. |
< |
Required | The spatial reference to project the geometry to. |
Performs a query on the image service for oblique images covering the input geometry.
Return type:
DeferredParameters:
< |
Required | The input geometry to use for the search. |
Sets the records and extent on the viewer. The records are an array of raster data objects, which is a JSON object in the query response format from image service. For the specification of this object see the object specification table in the records property.
Projects the given extent to the map's spatial reference and sets the extent.
Return type:
DeferredParameters:
< |
Required | The extent to project the map's spatial reference to. |
Sets the input image (based on the image ID) to the given extent.
Event Details
[ On Style Events | Connect Style Event ]
Fires when the azimuth is changed.
Event Object Properties:
< |
The azimuth of the viewer. |
Fires when the selected raster is changed.
Event Object Properties:
< |
The ID of the newly selected raster. |
Fires when the viewer records are refreshed.
Event Object Properties:
< |
An array of raster data objects representing the filtered records. For the specification of this object see the object specification table in the records property. |
< |
An array of raster data objects representing the records prior to filtering. For the specification of this object see the object specification table in the records property. |