OrientedImageryLayer

A layer that can visualize point feature data with additional properties that support the oriented imagery workflow. Oriented imagery enables the use of nontraditional images in ArcGIS as described in the ArcGIS Pro "Introduction to oriented imagery". Each image includes location, orientation, and camera metadata that link image pixels to map locations. Supported imagery includes street-level, mobile, oblique, close-range, and 360-degree images.

An oriented imagery layer stores the locations where each image was acquired, the path to the image file, and the key metadata required to visualize the imagery within a map or scene. The layer is composed of point features representing camera locations, along with attributes that define image metadata and additional information about the real-world feature it represents.

The oriented imagery layer supports feature selection and identify operations in a map view or scene view.

Since

300.0.0

Constructors

Link copied to clipboard
constructor(featureTable: ArcGISFeatureTable)

Creates a new oriented imagery layer object from a feature table containing oriented imagery data. If the feature table does not contain oriented imagery data, the layer will fail to load. ArcGISFeatureTable.layerInfo and ArcGISFeatureLayerInfo.featureServiceType can be checked to verify the feature type before attempting to create an OrientedImageryLayer.

constructor(portalItem: PortalItem, layerId: Long)

Creates a new oriented imagery layer object from a feature service portal item.

constructor(url: String)

Creates a new oriented imagery layer object with a URL. The layer will fail to load if the specified URL is not a valid oriented imagery layer endpoint. A valid oriented imagery layer is a feature service layer whose type is "Oriented Imagery Layer" and that includes the required oriented imagery metadata in the layer-level orientedImageryInfo property.

Properties

Link copied to clipboard

A SQL expression which limits the features available for query and display on the oriented imagery layer. The definition expression string should follow standard SQL syntax as detailed in the SQL reference for query expressions used in ArcGIS document.

Link copied to clipboard

Defines how features are filtered from the display. Use this property to reduce the number of features displayed in the map or scene view. The filter aims to improve data visualization and optimize rendering performance. It only affects the display of features so all features are still available for query methods such as OrientedImageryLayer.selectFeatures: Future.

Link copied to clipboard

The feature table associated with the layer. This property may be null when the layer is created from a URL or a portal item and has not yet loaded. It will be populated once the layer loads successfully.

Link copied to clipboard

The collection of LabelDefinition objects that define how labels are displayed.

Link copied to clipboard

True if features in the layer are labeled, otherwise false.

Link copied to clipboard

The layer ID in the feature service. The layer ID defined in the source. If a layer ID is not provided, the property value is -1.

Link copied to clipboard

The renderer specifies how the features are symbolized.

Link copied to clipboard

The mode defines how the oriented imagery layer is rendered. FeatureRenderingMode.Static mode is better suited for displaying large datasets and for complex symbology because it does not update the layer's display while pan/zoom operations are in progress.

Link copied to clipboard

True if the layer's symbols and labels honor the map's reference scale, otherwise false. If the map has a positive reference scale, and the layer honors it, then symbols and labels are drawn at their specified size when the viewing scale is the same as the reference scale. They will grow or shrink as the view zooms in or out, to keep the symbol a fixed size on the map. If the map has no reference scale, the reference scale is zero, or this oriented imagery layer's scaleSymbols property is false, then the symbols and labels will be drawn at their fixed screen size.

Link copied to clipboard

Properties that are applied when the layer is rendered in a 3D scene using a SceneView object.

Link copied to clipboard

The mode defines whether feature tiling is used to retrieve the features from the feature service. The default tiling mode is FeatureTilingMode.EnabledWhenSupported. If the service supports tiling with full resolution, the user can set any of the tiling modes. If the service only supports quantized tiling and if the user sets the tiling mode to FeatureTilingMode.EnabledWithFullResolutionWhenSupported, the oriented imagery layer falls back to FeatureTilingMode.Disabled on load. If the user sets the tiling mode to FeatureTilingMode.EnabledWhenSupported after, we will clear the cache and set the tiling mode to FeatureTilingMode.EnabledWhenSupported. If the service does not support tiling at all and the user sets either of the enabled modes, the oriented imagery layer falls back to FeatureTilingMode.Disabled on load and attempting to set a different value after load is a no-op.

Link copied to clipboard
val url: String?

The URL of the oriented imagery layer. This property may initially be an empty string. Once the oriented imagery layer loads successfully, it is updated with the layer's URL.

Inherited properties

Link copied to clipboard

The attribution text for the layer.

Link copied to clipboard
open override val canChangeVisibility: Boolean

A flag indicating whether the layer content's visibility can be changed. A flag indicating whether the layer content visibility can be changed. Will return false if an error occurs.

Link copied to clipboard

The description for the layer.

Link copied to clipboard

Defines the properties that allow a layer to be floor-aware. When a layer is configured as floor-aware, it has a FloorAware.floorDefinition property that defines properties that allow a layer to be floor-aware. When it is null (default value) the specific layer does not support floor filtering.

Link copied to clipboard

The full extent of this layer, which is the extent where all layer data is contained. You can use this to zoom to all of the data contained in this layer. For feature layers, the extent is retrieved from its FeatureTable.extent.

Link copied to clipboard
open override val fullTimeExtent: StateFlow<TimeExtent?>

The full time extent of the layer. If the layer, such as an ArcGISMapImageLayer, has sublayers with different time extents, fullTimeExtent is a union of its sublayer's time extents.

Link copied to clipboard
var id: String

The unique identifying string for the layer, as specified in a map or scene. Other parts of the API use the ID to reference a specific Layer, such as in a set of FeatureFenceParameters or a FacilityLayerDefinition. If not provided, a unique ID is automatically assigned to each Layer upon creation. When changing the ID, ensure the value remains unique so the Layer can be reliably located by ID.

Link copied to clipboard

True if the layer supports identify, false otherwise. The value of this property may not be correct until the layer is in a fully loaded state.

Link copied to clipboard
open override var isPopupEnabled: Boolean

A flag indicating whether the PopupDefinition defined on the PopupSource is enable / disable. Will return false if an error occurs.

Link copied to clipboard
open override var isTimeFilteringEnabled: Boolean

True if the layer filters data based on its GeoView.timeExtent, false otherwise. This is only applicable if the layer's TimeAware.supportsTimeFiltering value is true. If the GeoView.timeExtent value is null, no time filtering is applied and all content is rendered.

Link copied to clipboard
open override var isVisible: Boolean

The layer content's visibility. The layer content visibility. Will return false if an error occurs.

Link copied to clipboard
val item: Item?

The item the layer has been created from.

Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Link copied to clipboard

The maximum scale for the layer. The maximum scale at which this layer is visible. If the map or scene is zoomed in beyond this scale, the layer will not be visible. A value of 0 means there is no maximum scale threshold and the layer will be visible at the smallest scale available for the map or scene. If the value is nil, there is no maximum scale. All of the connected map and scene views will be updated.

Link copied to clipboard

The minimum scale for the layer. The minimum scale at which this layer is visible. If the map or scene is zoomed out beyond this scale, the layer will not be visible. A value of 0 means there is no minimum scale threshold and the layer will be visible at the largest scale available for the map or scene. If the value is nil, there is no minimum scale. All of the connected map and scene views will be updated.

Link copied to clipboard
open override var name: String

The name of this layer.

Link copied to clipboard

The opacity for the layer. The opacity of this layer as a value between 0 (fully transparent) and 1 (fully opaque). The default opacity value is 1.

Link copied to clipboard
open override var popupDefinition: PopupDefinition?

The pop-up definition. The PopupDefinition associated with the popup source. A null if an error occurs or if the popup source is not associated with a pop-up definition.

Link copied to clipboard
open override var refreshInterval: Long?

The objects refresh interval. The refresh interval, in milliseconds. A refresh interval of null means never refresh.

Link copied to clipboard
open override var showInLegend: Boolean

A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.

Link copied to clipboard

The spatial reference of the layer.

Link copied to clipboard
open override val subLayerContents: StateFlow<List<LayerContent>>

The sub layer contents of a layer content.

Link copied to clipboard
open override val supportsTimeFiltering: Boolean

True if the layer supports filtering data based on its time values, false otherwise.

Link copied to clipboard
open override val timeInterval: TimeValue?

The suggested time slider step size for this time aware layer. You can use this information to set the step size for a time slider control. The value is null if no time interval is suggested. The author of the layer's data typically configures this property if the data has been collected on a regular basis. For example, the daily position of a hurricane.

Link copied to clipboard
open override var timeOffset: TimeValue?

The amount of time by which the temporal values of this layer's data points are offset when displaying it in a GeoView. The time offset is subtracted from the time extent set on the layer's GeoView. This is useful if you want to overlay data in multiple layers that lies within different temporal extents. For example, if you want to compare data in one layer for a certain year with data in the same layer from the subsequent year, you can create two layers that reference the same data's service endpoint but set the TimeValue in one of the layers to be one year.

Link copied to clipboard
val visibilityChanged: SharedFlow<Boolean>

A SharedFlow that emits when the visibility of the layer changes.

Functions

Link copied to clipboard

Clears the list of selected features and clears the visible selection halos from the map or scene view.

Link copied to clipboard
open override fun clone(): OrientedImageryLayer
Link copied to clipboard

Returns a list of the currently selected features.

Link copied to clipboard
fun selectFeature(feature: Feature)

Selects the given feature and adds it to the current list of selected features.

Link copied to clipboard

Selects the given features and adds them to the current list of selected features.

Selects the features that match the criteria in the QueryParameters object and adds them to the current list of selected features.

Link copied to clipboard
fun unselectFeature(feature: Feature)

Unselects the given feature and removes it from the current list of selected features.

Link copied to clipboard

Unselects the given features and removes them from the current list of selected features.

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open suspend override fun fetchLegendInfos(): Result<List<LegendInfo>>

Fetches the list of legend info.

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun isVisibleAtScale(scale: Double): Boolean

Returns the layer content's effective visibility at the specified scale. Returns the effective layer content visibility. This effective visibility takes care of the effective visibility of the parents at the specified scale. Will return false if an error occurs.

Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.