require(["esri/widgets/OrientedImageryViewer"], (OrientedImageryViewer) => { /* code goes here */ });
import OrientedImageryViewer from "@arcgis/core/widgets/OrientedImageryViewer.js";
esri/widgets/OrientedImageryViewer
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.
- See also
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Example// typical usage orientedImageryViewer = new OrientedImageryViewer({ view, container: "oi-container" });
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The ID or node representing the DOM element containing the widget. | Widget | ||
Toggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer. | OrientedImageryViewer | ||
The name of the class. | Accessor | ||
When | OrientedImageryViewer | ||
Indicates if the image gallery functionality is available in the widget. | OrientedImageryViewer | ||
Icon displayed in the widget's button. | OrientedImageryViewer | ||
The unique ID assigned to the widget when the widget is created. | Widget | ||
Indicates if the image enhancement tool is active. | OrientedImageryViewer | ||
When | OrientedImageryViewer | ||
Indicates if the additional footprint polygons are visible for the selected image loaded in the viewer. | OrientedImageryViewer | ||
Indicates if the additional camera locations are visible for the selected image loaded in the viewer. | OrientedImageryViewer | ||
The widget's label. | Widget | ||
Specifies the current OrientedImageryLayer to use. | OrientedImageryViewer | ||
Indicates if the map-image location tool is available in the widget. | OrientedImageryViewer | ||
When | OrientedImageryViewer | ||
This property provides the location of an image pixel in Map coordinates when using map-image conversion tool. | OrientedImageryViewer | ||
OrientedImageryViewer | |||
The view model for this widget. | OrientedImageryViewer | ||
Indicates whether the widget is visible. | Widget |
Property Details
-
container
InheritedPropertycontainer String |HTMLElement
Inherited from Widget -
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 container const basemapGallery = new BasemapGallery({ view: view, container: document.createElement("div") }); // Add the widget to the top-right corner of the view view.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 view view.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 UI const basemapGallery = new BasemapGallery({ view: view }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
-
currentCoverageVisible
currentCoverageVisible 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.
-
disabled
disabled 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. Whentrue
the view click interaction will be defaulted to map navigation.- Default Value:false
-
galleryOpened
galleryOpened 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
icon String
-
Icon displayed in the widget's button.
- Default Value:"oriented-imagery-widget"
- See also
-
imageEnhancementToolActive
imageEnhancementToolActive 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
imageGalleryEnabled Booleanreadonly
-
When
true
, the image gallery functionality is available in the widget. Image gallery currently only supports MRF and Tif image formats.
-
isAdditionalCoverageVisible
isAdditionalCoverageVisible 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.
-
isAdditionalPointSourcesVisible
isAdditionalPointSourcesVisible 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.
-
layer
layer OrientedImageryLayer
-
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
mapImageConversionToolState 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.
-
navigationToolActive
navigationToolActive 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).
-
referencePoint
referencePoint Pointreadonly
Since: ArcGIS Maps SDK for JavaScript 4.29OrientedImageryViewer since 4.28, referencePoint added at 4.29. -
This property provides the location of an image pixel in Map coordinates when using map-image conversion tool.
-
Since: ArcGIS Maps SDK for JavaScript 4.30OrientedImageryViewer since 4.28, view added at 4.30. -
-
viewModel
viewModel OrientedImageryViewerViewModelautocast
-
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
InheritedPropertyvisible Boolean
Inherited from Widget -
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 view UI, 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 view widget.visible = false;
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
A utility method used for building the value for a widget's | Widget | ||
Destroys the widget instance. | Widget | ||
Emits an event on the instance. | Widget | ||
Indicates whether there is an event listener on the instance that matches the provided event name. | Widget | ||
Returns true if a named group of handles exist. | Accessor | ||
| Widget | ||
| Widget | ||
| Widget | ||
Registers an event handler on the instance. | Widget | ||
Adds one or more handles which are to be tied to the lifecycle of the widget. | Widget | ||
Executes after widget is ready for rendering. | Widget | ||
Removes a group of handles owned by the object. | Accessor | ||
This method is implemented by subclasses for rendering. | Widget | ||
Renders widget to the DOM immediately. | Widget | ||
Schedules widget rendering. | Widget | ||
| Widget |
Method Details
-
Inherited from Accessor
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
classes
InheritedMethodclasses(classNames){String}
Inherited from Widget -
A utility method used for building the value for a widget's
class
property. This aids in simplifying css class setup.ReturnsType Description 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)} /> ); }
-
Inherited from Widget
-
Destroys the widget instance.
-
hasEventListener
InheritedMethodhasEventListener(type){Boolean}
Inherited from Widget -
Indicates whether there is an event listener on the instance that matches the provided event name.
Parametertype StringThe name of the event.
ReturnsType Description Boolean Returns true if the class supports the input event.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
isFulfilled
InheritedMethodisFulfilled(){Boolean}
Inherited from Widget -
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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
isRejected
InheritedMethodisRejected(){Boolean}
Inherited from Widget -
isRejected()
may be used to verify if creating an instance of the class is rejected. If it is rejected,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
isResolved
InheritedMethodisResolved(){Boolean}
Inherited from Widget -
isResolved()
may be used to verify if creating an instance of the class is resolved. If it is resolved,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
on
InheritedMethodon(type, listener){Object}
Inherited from Widget -
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersReturnsType Description Object 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. Exampleview.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
Inherited from WidgetDeprecated since 4.28 Use addHandles() instead.
-
Adds one or more handles which are to be tied to the lifecycle of the widget. The handles will be removed when the widget is destroyed.
const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true} ); this.own(handle); // Handle gets removed when the widget is destroyed.
ParameterhandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the widget is destroyed.
-
Inherited from Widget
-
Executes after widget is ready for rendering.
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
Inherited from Widget
-
Renders widget to the DOM immediately.
-
Inherited from Widget
-
Schedules widget rendering. This method is useful for changes affecting the UI.
-
when
InheritedMethodwhen(callback, errback){Promise}
Inherited from Widget -
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.ParametersReturnsType Description Promise Returns a new Promise for the result of callback
.Example// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way let bmGallery = new BasemapGallery(); bmGallery.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 });