import "@arcgis/map-components/components/arcgis-oriented-imagery-viewer";The Oriented Imagery Viewer component allows the user to explore and use their oriented images.
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
auto-destroy-disabled | boolean | |
current-coverage-visible | boolean | |
data-capture-enabled | boolean | |
disabled | boolean | |
gallery-opened | boolean | |
icon | string | |
image-enhancement-tool-active | boolean | |
imageGalleryEnabledreadonly | | boolean |
image-overlays-opened | boolean | |
is-additional-coverage-visible | boolean | |
is-additional-point-sources-visible | boolean | |
label | string | |
| ||
map-image-conversion-tool-state | boolean | |
navigation-tool-active | boolean | |
oriented-imagery-layer-item-id | string | |
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ||
referencePointreadonly | |
autoDestroyDisabled
autoDestroyDisabled: booleanIf true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy method when you are done to prevent memory leaks.
- Attribute
- auto-destroy-disabled
- Default value
- false
currentCoverageVisible
currentCoverageVisible: booleanToggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer.
- Attribute
- current-coverage-visible
- Default value
- true
dataCaptureEnabled
dataCaptureEnabled: booleanIndicates whether the data capture tools are enabled in the oriented imagery viewer for digitization.
- Attribute
- data-capture-enabled
- Default value
- false
disabled
disabled: booleanWhen false, the view click interaction is enabled for the oriented imagery viewer widget.
- Attribute
- disabled
- Default value
- false
galleryOpened
galleryOpened: booleanIndicates if the image gallery functionality is available in the widget.
- Attribute
- gallery-opened
- Default value
- false
icon
icon: stringIcon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
- See also
- Attribute
- icon
- Default value
- "oriented-imagery-widget"
imageEnhancementToolActive
imageEnhancementToolActive: booleanIndicates if the image enhancement tool is active.
- Attribute
- image-enhancement-tool-active
- Default value
- false
imageGalleryEnabled
imageGalleryEnabled: booleanWhen true, the image gallery functionality is available in the widget.
- Default value
- false
imageOverlaysOpened
imageOverlaysOpened: booleanIndicates whether the image overlays tab in the oriented imagery viewer is open.
- Attribute
- image-overlays-opened
- Default value
- false
isAdditionalCoverageVisible
isAdditionalCoverageVisible: booleanIndicates if the additional footprint polygons are visible for the selected image loaded in the viewer.
- Attribute
- is-additional-coverage-visible
- Default value
- false
isAdditionalPointSourcesVisible
isAdditionalPointSourcesVisible: booleanIndicates if the additional camera locations are visible for the selected image loaded in the viewer.
- Attribute
- is-additional-point-sources-visible
- Default value
- false
mapImageConversionToolState
mapImageConversionToolState: booleanIndicates if the map-image location tool is available in the widget.
- Attribute
- map-image-conversion-tool-state
- Default value
- false
navigationToolActive
navigationToolActive: booleanWhen true, the navigation tool is available in the widget.
- Attribute
- navigation-tool-active
- Default value
- false
orientedImageryLayerItemId
orientedImageryLayerItemId: string- Attribute
- oriented-imagery-layer-item-id
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"- Attribute
- position
- Default value
- "bottom-left"
referenceElement
referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | stringBy assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
- Attribute
- reference-element
referencePoint
referencePoint: PointThis property provides the location of an image pixel in Map coordinates when using map-image conversion tool.
Slots
Events
| Event | Type |
|---|---|
CustomEvent<{ name: "layer" | "imageGalleryEnabled"; }> | |
CustomEvent<void> |
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "layer" | "imageGalleryEnabled"; }>Emitted when the value of a property is changed. Use this to listen to changes to properties.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReady
arcgisReady: CustomEvent<void>Emitted when the component associated with a map or scene view is is ready to be interacted with.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods
| Method | Signature |
|---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
const arcgisOrientedImageryViewer = document.querySelector("arcgis-oriented-imagery-viewer");
document.body.append(arcgisOrientedImageryViewer);
await arcgisOrientedImageryViewer.componentOnReady();
console.log("arcgis-oriented-imagery-viewer is ready to go!");- Returns
- Promise<void>