esri.dijit.ObliqueViewer
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
CSS
esri/dijit/ObliqueViewer | Download source
Properties
Methods
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.
Constructor Details
Creates an instance of the ObliqueViewer widget.
Parameters:
<Object > params |
Required |
Constructor options. See object specification table below for more details about each property. |
params
properties:
<Number > azimuthAngle |
Optional |
Azimuth angle value for which to display oblique images. If not provided, the widget is initialized in nadir mode, displaying ortho images. |
<String > azimuthField |
Optional |
Image service field that denotes the sensor azimuth value for a record. Default value is SensorAzimuth . |
<Number > azimuthTolerance |
Optional |
Tolerance value applied when filtering azimuth images. Default is 10 . |
<String > elevationField |
Optional |
Image service field that denotes the sensor elevation value for a record. Default value is SensorElevation . |
<Number > elevationThreshold |
Optional |
Elevation value between 0 and 90 that differentiates an image as oblique or nadir. Default value is 70 . |
<ArcGISImageServiceLayer > imageServiceLayer |
Required |
Image service layer to be used as source for oblique images. |
<Map > map |
Required |
Map object associated with the widget. |
<Boolean > noQueryOnExtentChange |
Optional |
When true , the widget doesn't refresh itself with new oblique records when the map's extent changes. Default value is false . |
<Object[] > rasterInfoFields |
Optional |
Raster info fields to be queried and displayed in the raster list. For object specification, see the table in the rasterInfoFields property. |
<String | Node > rasterListDiv |
Optional |
DOM Node or id, where the list element is to be placed. |
<Boolean > rasterListRefresh |
Optional |
When true , list is populated on data refresh. |
<String | Node > rotationDiv |
Optional |
DOM Node or id, where the oblique rotation gauge element is to be placed. |
<Boolean > showThumbnail |
Optional |
When true , thumbnail images for records are displayed in the list. Default value is true . |
<Function > sorter |
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
Indicates the current azimuth angle of the viewer.
Image service field that denotes the sensor azimuth value for a record.
Default value: SensorAzimuth
Indicates the tolerance value applied when selecting images for a given azimuth angle value.
Default value: 10
Image service field that denotes the sensor elevation value for a record.
Default value: SensorElevation
Elevation value between 0 and 90 that differentiates an image as oblique or nadir.
Known values: 0 - 90
Default value: 70
Subset of records, filtered based on current azimuth angle.
Image service layer to be used as source for oblique images.
Indicates whether current view is nadir.
Map object associated with the widget.
When true
, the widget doesn't refresh itself with new oblique records when the map's extent changes.
Known values: true | false
Default value: false
Raster info fields to be queried and displayed in the raster list. See object specification table below for more details.
Object Specifications: <infoFields
>
<String > alias |
Required |
The field alias. |
<Boolean > display |
Required |
Indicates whether to display of the field. |
<String > name |
Required |
The name of the field |
When true
, the list is populated on data refresh.
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 Specifications: <rasterDataObject
>
<Object > attributes |
Required |
The attributes of the feature in the query response. |
<Geometry > geometry |
Required |
The geometry from the query response. |
Object containing additional information about the raster. Contains an "attributes" property and a "geometry" property.
Id of the raster currently being displayed.
When true
, thumbnail images for records are displayed in the list.
Known values: true | false
Default value: true
Method 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:
<Geometry > geometry |
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.
Parameters:
<Geometry > geometry |
Required |
The geometry to project. |
<SpatialReference > outSpatialReference |
Required |
The spatial reference to project the geometry to. |
Performs a query on the image service for oblique images covering the input geometry.
Parameters:
<Geometry > geometry |
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.
Parameters:
<Object[] > records |
Required |
An array of raster data objects. For the specification of this object see the object specification table in the records property. |
<Extent > extent |
Required |
The extent to set the viewer to. |
Projects the given extent to the map's spatial reference and sets the extent.
Parameters:
<Extent > extent |
Required |
The extent to project the map's spatial reference to. |
Sets the input image (based on the image ID) to the given extent.
Parameters:
<Number > id |
Required |
The ID of the raster image. |
<Extent > extent |
Required |
The extent to set the raster image to. |
Sets the map extent to the currently selected image.
Event Details
[ On Style Events | Connect Style Event ]
Fires when the azimuth is changed.
Event Object Properties:
<Number > azimuth |
The azimuth of the viewer. |
Fires when the selected raster is changed.
Event Object Properties:
<Number > selectedRasterId |
The ID of the newly selected raster. |
Fires when the viewer records are refreshed.
Event Object Properties:
<Object[] > filteredRecords |
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. |
<Object[] > records |
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. |
Fires when the azimuth is changed.
Event Object Properties:
<Number > azimuth |
The azimuth of the viewer. |
Fires when the selected raster is changed.
Event Object Properties:
<Number > selectedRasterId |
The ID of the newly selected raster. |
Fires when the viewer records are refreshed.
Event Object Properties:
<Object[] > filteredRecords |
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. |
<Object[] > records |
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. |