@arcgis/map-components/dist/components/arcgis-oriented-imagery-viewer/customElement.d.ts

ArcGIS Map Components

/// <reference types="@arcgis/core/interfaces.d.ts" />
/// <reference types="../../index.d.ts" />
import { Use } from '@arcgis/lumina/controllers';
import { default as OrientedImageryLayer } from '@arcgis/core/layers/OrientedImageryLayer.js';
import { default as OrientedImageryViewer } from '@arcgis/core/widgets/OrientedImageryViewer.js';
import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
import { PropertyValues } from 'lit';
import { ArcgisReferenceElement } from '../../utils/component-utils';

declare const useOrientedImageryViewerWidget: (component: LitElement & Pick<OrientedImageryViewer, "icon" | "label" | "viewModel" | "layer" | "disabled" | "currentCoverageVisible" | "dataCaptureEnabled" | "galleryOpened" | "imageEnhancementToolActive" | "isAdditionalCoverageVisible" | "isAdditionalPointSourcesVisible" | "mapImageConversionToolState" | "navigationToolActive"> & {
    state?: unknown;
    viewModel?: __esri.OrientedImageryViewerViewModel | undefined;
    closed?: boolean;
    icon: import('@arcgis/components-utils').Nil | string;
    label: import('@arcgis/components-utils').Nil | string;
    referenceElement?: ArcgisReferenceElement | string;
    position: __esri.UIPosition;
    arcgisReady: import('@arcgis/lumina').EventEmitter;
    arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
        name: string;
    }> | undefined;
    el: HTMLElement & {
        childElem?: HTMLElement & {
            ownedBy?: HTMLElement;
        };
        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView;
    };
    autoDestroyDisabled: boolean;
    destroy: () => Promise<void>;
}) => OrientedImageryViewer;
/**
 * The Oriented Imagery Viewer component allows the user to explore and use their oriented images.
 *
 * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-oriented-imagery-viewer/)
 */
export declare class ArcgisOrientedImageryViewer extends LitElement {
    /**
     * If 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](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-oriented-imagery-viewer/#destroy) method when you are done to
     * prevent memory leaks.
     *
     * @default false
     */
    autoDestroyDisabled: boolean;
    /**
     * Toggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer.
     *
     * @default true
     */
    currentCoverageVisible: boolean;
    /**
     * Indicates whether the data capture tools are enabled in the oriented imagery viewer for digitization.
     *
     * @default false
     */
    dataCaptureEnabled: boolean;
    /**
     * When `false`, the view click interaction is enabled for the oriented imagery viewer widget.
     *
     * @default false
     */
    disabled: boolean;
    /**
     * Indicates if the image gallery functionality is available in the widget.
     *
     * @default false
     */
    galleryOpened: boolean;
    /**
     * Icon which represents the component.
     * Typically used when the component is controlled by another component (e.g. by the Expand component).
     *
     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
     * @default "oriented-imagery-widget"
     */
    icon: string;
    /**
     * Indicates if the image enhancement tool is active.
     *
     * @default false
     */
    imageEnhancementToolActive: boolean;
    /**
     * When `true`, the image gallery functionality is available in the widget.
     *
     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#imageGalleryEnabled)
     *
     * @default false
     */
    readonly imageGalleryEnabled: boolean;
    /**
     * Indicates whether the image overlays tab in the oriented imagery viewer is open.
     *
     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#imageOverlaysOpened)
     *
     * @default false
     */
    imageOverlaysOpened: boolean;
    /**
     * Indicates if the additional footprint polygons are visible for the selected image loaded in the viewer.
     *
     * @default false
     */
    isAdditionalCoverageVisible: boolean;
    /**
     * Indicates if the additional camera locations are visible for the selected image loaded in the viewer.
     *
     * @default false
     */
    isAdditionalPointSourcesVisible: boolean;
    /**
     * The widget's label.
     *
     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)
     */
    label: string | nullish;
    /**
     * Specifies the current [OrientedImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html) to use.
     *
     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#layer)
     */
    layer: nullish | OrientedImageryLayer;
    /**
     * Indicates if the map-image location tool is available in the widget.
     *
     * @default false
     */
    mapImageConversionToolState: boolean;
    /**
     * When `true`, the navigation tool is available in the widget.
     *
     * @default false
     */
    navigationToolActive: boolean;
    orientedImageryLayerItemId?: string;
    /** @default "bottom-left" */
    position: __esri.UIPosition;
    /**
     * By 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.
     *
     * @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
     */
    referenceElement?: ArcgisReferenceElement | string;
    /**
     * This property provides the location of an image pixel in Map coordinates when using map-image conversion tool.
     *
     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-OrientedImageryViewer.html#referencePoint)
     */
    readonly referencePoint: nullish | __esri.Point;
    /** Permanently destroy the component. */
    destroy(): Promise<void>;
    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
    readonly arcgisPropertyChange: TargetedEvent<this, {
        name: "layer" | "imageGalleryEnabled";
    }>;
    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
    readonly arcgisReady: TargetedEvent<this, void>;
}
export {};