require(["esri/widgets/OrientedImageryViewer/OrientedImageryViewerViewModel"], (OrientedImageryViewerViewModel) => { /* code goes here */ });
import OrientedImageryViewerViewModel from "@arcgis/core/widgets/OrientedImageryViewer/OrientedImageryViewerViewModel.js";
esri/widgets/OrientedImageryViewer/OrientedImageryViewerViewModel
Provides the logic for the OrientedImageryViewer widget.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Changes the image brightness loaded in the viewer. | OrientedImageryViewerViewModel | ||
Changes the image contrast loaded in the viewer. | OrientedImageryViewerViewModel | ||
Toggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer. | OrientedImageryViewerViewModel | ||
The name of the class. | Accessor | ||
When | OrientedImageryViewerViewModel | ||
When | OrientedImageryViewerViewModel | ||
Indicates if the image has been loaded onto the oriented imagery viewer. | OrientedImageryViewerViewModel | ||
Indicates if the additional footprint polygons are visible for the selected image loaded in the viewer. | OrientedImageryViewerViewModel | ||
Indicates if the additional camera locations are visible for the selected image loaded in the viewer. | OrientedImageryViewerViewModel | ||
OrientedImageryLayer associated with the widget. | OrientedImageryViewerViewModel | ||
Indicates if the map-image location tool available in the widget. | OrientedImageryViewerViewModel | ||
Changes the image sharpness loaded in the viewer. | OrientedImageryViewerViewModel |
Property Details
-
brightness
brightness 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
contrast 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
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 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. Whentrue
the view click interaction will be defaulted to map navigation.- Default Value:false
-
imageGalleryEnabled
imageGalleryEnabled 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
imageLoaded Boolean
-
Indicates if the image has been loaded onto the oriented imagery viewer.
- Default Value:false
-
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.
- Default Value:false
-
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) shows the camera locations for additional images that depict the location selected by the user.
-
layer
layer OrientedImageryLayer
-
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
mapImageConversionToolState 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
-
sharpness
sharpness 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
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
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.
-
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"); }
-
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");