import OrientedImageryViewerViewModel from "@arcgis/core/widgets/OrientedImageryViewer/OrientedImageryViewerViewModel.js";const OrientedImageryViewerViewModel = await $arcgis.import("@arcgis/core/widgets/OrientedImageryViewer/OrientedImageryViewerViewModel.js");- Inheritance:
- OrientedImageryViewerViewModel→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.28
Provides the logic for the OrientedImageryViewer widget and component.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| | ||
| | ||
| | ||
declaredClass readonly inherited | ||
| | ||
imageGalleryEnabled readonly | | |
imageLoaded readonly | | |
| | ||
| | ||
| | ||
| | ||
| | ||
| |
brightness
- Type
- number
Changes the image brightness loaded in the viewer. Brightness is adjusted in the oriented imagery viewer using interactive sliders. Settings will be preserved for subsequent images loaded in the oriented imagery viewer. The value must be between -10 and 10.
- Default value
- 0
contrast
- Type
- number
Changes the image contrast loaded in the viewer. Contrast is adjusted in the oriented imagery viewer using interactive sliders. Settings will be preserved for subsequent images loaded in the oriented imagery viewer. The value must be between -10 and 10.
- Default value
- 0
currentCoverageVisible
- Type
- boolean
Toggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer. Current footprint coverage allows you to better understand how the images in the oriented imagery layer relate to the map. The footprint of the image is symbolized with red fill on the map. If you zoom or pan in the oriented imagery viewer, the footprint coverage graphic will update on the map to highlight the area on the map that is visible in the image.
- Default value
- true
disabled
- Type
- boolean
When false, the view click interaction enabled for the oriented imagery viewer widget. This allows users to pick a location on the map and display the best image will the viewer.
When true the view click interaction will be defaulted to map navigation.
- Default value
- false
imageGalleryEnabled
- Type
- boolean
When true, the image gallery functionality is available in the widget.
Image gallery currently only supports MRF and Tif image formats.
- Default value
- true
imageLoaded
- Type
- boolean
Indicates if the image has been loaded onto the oriented imagery viewer.
- Default value
- false
isAdditionalCoverageVisible
- Type
- boolean
Indicates if the additional footprint polygons are visible for the selected image loaded in the viewer. The footprint graphics (appearing in blue) show the coverage footprints of all the additional images in the layer that depict the location selected by the user.
- Default value
- false
isAdditionalPointSourcesVisible
- Type
- boolean
Indicates if the additional camera locations are visible for the selected image loaded in the viewer. The point location graphics (appearing in blue) shows the camera locations for additional images that depict the location selected by the user.
- Default value
- false
layer
- Type
- OrientedImageryLayer | null | undefined
OrientedImageryLayer associated with the widget. The layer contains feature data and oriented imagery properties required by the viewer to load the image and generate the associated graphics.
mapImageConversionToolState
- Type
- boolean
Indicates if the map-image location tool available in the widget. When activated, the user can select a point on the map and corresponding a location in pixel space will be displayed in the image, and vice versa.
- Default value
- false
preloadMedia
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
When true, loading an image via directional or sequential navigation caches all neighboring images associated with that image. Navigating to adjacent images then uses the cached assets, reducing load times and improving viewer performance.
- Default value
- false
sharpness
- Type
- number
Changes the image sharpness loaded in the viewer. Sharpness is adjusted in the oriented imagery viewer using interactive sliders. Settings will be preserved for subsequent images loaded in the oriented imagery viewer." The value must be between 0 and 1.
- Default value
- 0
Methods
| Method | Signature | Class |
|---|---|---|
emit inherited | emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean | |
hasEventListener inherited | hasEventListener<Type extends EventNames<this>>(type: Type): boolean | |
isFulfilled inherited | isFulfilled(): boolean | |
isRejected inherited | isRejected(): boolean | |
isResolved inherited | isResolved(): boolean | |
on inherited | on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle | |
when inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
emit
- Signature
-
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
- Type parameters
- <Type extends EventNames<this>>
Emits an event on the instance. This method should only be used when creating subclasses of this class.
hasEventListener
- Signature
-
hasEventListener <Type extends EventNames<this>>(type: Type): boolean
- Type parameters
- <Type extends EventNames<this>>
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | The name of the event. | |
- Returns
- boolean
Returns true if the class supports the input event.
isFulfilled
- Signature
-
isFulfilled (): boolean
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
If it is fulfilled, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected
- Signature
-
isRejected (): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.
If it is rejected, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been rejected.
isResolved
- Signature
-
isResolved (): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.
If it is resolved, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been resolved.
on
- Signature
-
on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
- Type parameters
- <Type extends EventNames<this>>
Registers an event handler on the instance. Call this method to hook an event with a listener.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | An event or an array of events to listen for. | |
| listener | EventedCallback<this["@eventTypes"][Type]> | The function to call when the event fires. | |
- Returns
- ResourceHandle
Returns an event handler with a
remove()method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint);}); when
- Signature
-
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function.
The onFulfilled executes when the instance of the class loads. The
onRejected executes if the instance of the class fails to load.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| onFulfilled | OnFulfilledCallback<this, TResult1> | null | undefined | The function to call when the promise resolves. | |
| onRejected | The function to execute when the promise fails. | |
- Returns
- Promise<TResult1 | TResult2>
Returns a new promise for the result of
onFulfilledthat may be used to chain additional functions.
Example
// Although this example uses MapView, any class instance that is a promise may use when() in the same waylet view = new MapView();view.when(function(){ // This function will execute once the promise is resolved}, function(error){ // This function will execute if the promise is rejected due to an error});