import OrientedImageryViewer from "@arcgis/core/widgets/OrientedImageryViewer.js";const OrientedImageryViewer = await $arcgis.import("@arcgis/core/widgets/OrientedImageryViewer.js");- Since
- ArcGIS Maps SDK for JavaScript 4.28
The oriented imagery viewer widget allows the user to explore and use their oriented images. Click on a map to view the best image in your collection that depicts a clicked location. To see an image better, the user can view assets from multiple directions, and enhance contrast, brightness and sharpening. As the user pans and zooms in an image, the widget will update the camera's field of view on the map (and show how it relates to any vector data in the map). The oriented imagery viewer supports JPG, JPEG, TIF and MRF image formats.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Example
// typical usageorientedImageryViewer = new OrientedImageryViewer({ view, container: "oi-container"});Properties
| Property | Type | Class |
|---|---|---|
container inherited | HTMLElement | null | undefined | |
| | ||
| | ||
declaredClass readonly inherited | ||
destroyed readonly inherited | ||
| | ||
| | ||
Icon["icon"] | | |
id inherited | ||
| | ||
imageGalleryEnabled readonly | | |
| | ||
| | ||
| | ||
label inherited | ||
| | ||
| | ||
| | ||
| | ||
referencePoint readonly | | |
| | ||
viewModel readonly | | |
visible inherited |
container
- Type
- HTMLElement | null | undefined
The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use case when working with widgets.
Examples
// Create the HTML div element programmatically at runtime and set to the widget's containerconst basemapGallery = new BasemapGallery({ view: view, container: document.createElement("div")});
// Add the widget to the top-right corner of the viewview.ui.add(basemapGallery, { position: "top-right"});// Specify an already-defined HTML div element in the widget's container
const basemapGallery = new BasemapGallery({ view: view, container: basemapGalleryDiv});
// Add the widget to the top-right corner of the viewview.ui.add(basemapGallery, { position: "top-right"});
// HTML markup<body> <div id="viewDiv"></div> <div id="basemapGalleryDiv"></div></body>// Specify the widget while adding to the view's UIconst basemapGallery = new BasemapGallery({ view: view});
// Add the widget to the top-right corner of the viewview.ui.add(basemapGallery, { position: "top-right"}); 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
dataCaptureEnabled
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.32
Indicates whether the data capture tools are enabled in the oriented imagery viewer for digitization.
When set to true , the data capture (edit) option will be visible on the digitizable overlayed feature layers available in the image overlays tab.
On clicking the data capture option, the digitization tools will appear at the bottom of the viewer once the overlay tab is closed.
- Default value
- false
disabled
- Type
- boolean
When false, the view click interaction is enabled for the oriented imagery viewer widget. This allows users to pick a location on the map and display the best image to the viewer.
When true the view click interaction will be defaulted to map navigation.
- Default value
- false
galleryOpened
- Type
- boolean
Indicates if the image gallery functionality is available in the widget. To visualize additional images of the same location, select the image gallery from the oriented imagery viewer. The galley is a carousel of low-resolution thumbnails of all images that depict the selected map location. Click a thumbnail to view the full-resolution image in the oriented imagery viewer.
- Default value
- false
icon
- Type
- Icon["icon"]
Icon displayed in the widget's button.
- Default value
- "oriented-imagery-widget"
imageEnhancementToolActive
- Type
- boolean
Indicates if the image enhancement tool is active. When true the widget displays the functionalities to adjust the brightness, contrast, and sharpness of the
image in the oriented imagery viewer using interactive sliders.
Settings will be preserved for subsequent images loaded in the oriented imagery viewer.
- 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.
imageOverlaysOpened
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.32
Indicates whether the image overlays tab in the oriented imagery viewer is open.
When set to true , the overlays tab appears at the bottom of the viewer. It includes two toggle options: overlay camera locations and overlay map features.
These options enable users to visualize and overlay map features that intersect with the image’s footprint within the 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) show the camera locations for additional images that depict the location the user selects.
- Default value
- false
layer
- Type
- OrientedImageryLayer | null | undefined
Specifies the current OrientedImageryLayer to use. The layer is one the widget connects to and utilizes to populate the image. The layer contains the 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 is available in the widget.
When true, the user can select a point on the map and the corresponding location in pixel space will be displayed in the image, and vice versa.
- Default value
- false
navigationToolActive
- Type
- boolean
When true, the navigation tool is available in the widget.
The navigation tool can be used to explore the images that contain the selected location on the map using a compass.
To view a different image of the selected map location, click the camera locations (blue dots), or click a segment to view
the best image from that segment (segments with images are shown in white; segments without images are gray).
- 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
view
- Type
- MapViewOrSceneView | null | undefined
viewModel
The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the OrientedImageryViewerViewModel class to access all properties and methods on the widget.
visible
- Type
- boolean
Indicates whether the widget is visible.
If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is
the first of three widgets associated to the upper right hand corner of the DefaultUI, then the other widgets will reposition when this widget is made invisible.
For more information, refer to the css display value of "none".
- Default value
- true
Example
// Hides the widget in the viewwidget.visible = false;Methods
| Method | Signature | Class |
|---|---|---|
classes inherited | classes(...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): string | |
destroy inherited | destroy(): void | |
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 | |
postInitialize inherited | postInitialize(): void | |
render inherited | render(): any | null | |
renderNow inherited | renderNow(): void | |
reset(): void | | |
scheduleRender inherited | scheduleRender(): void | |
when inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
classes
- Signature
-
classes (...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): string
A utility method used for building the value for a widget's class property.
This aids in simplifying css class setup.
Parameters
- Returns
- string
The computed class name.
Example
// .tsx syntax showing how to set css classes while rendering the widget
render() { const dynamicClasses = { [css.flip]: this.flip, [css.primary]: this.primary };
return ( <div class={classes(css.root, css.mixin, dynamicClasses)} /> );} 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);}); reset
- Signature
-
reset (): void
- Since
- ArcGIS Maps SDK for JavaScript 4.34
Resets the viewer to its initial state. This method clears the currently displayed image or video from the viewer and removes all associated graphics from the map.
- Returns
- void
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});