require(["esri/layers/OrientedImageryLayer"], (OrientedImageryLayer) => { /* code goes here */ });
import OrientedImageryLayer from "@arcgis/core/layers/OrientedImageryLayer.js";
esri/layers/OrientedImageryLayer
Overview
An Oriented Imagery Layer is a single spatial layer that can be created from a Feature Service; or ArcGIS Online or ArcGIS Enterprise portal items.
Oriented Imagery layers are composed of discrete features (or camera locations), each of which has a Geometry that allows it to be rendered in either a 2D MapView as a graphic with spatial context. These features also contain data attributes that provide additional information about the real-world feature it represents; attributes may be viewed in popup windows and used for rendering the layer.
The layer fetches the imagery data once you select a point on the map. It uses a custom BestImage logic to determine the most accurate image for a selected point and display it in the viewer widget.
Refer to the section on querying, analyzed to learn more about how to query your Oriented Imagery data.
Creating an OrientedImageryLayer
OrientedImageryLayers may be created in one of two ways: from a service URL or an ArcGIS portal item ID.
Reference a service URL
To create an OrientedImageryLayer instance from a service, you must set the url property to the REST endpoint of a layer in a Feature Service. For a layer to be visible in a view, it must be added to the Map referenced by the view. See Map.add() for information about adding layers to a map.
require(["esri/layers/OrientedImageryLayer"], function(OrientedImageryLayer){
const layer = new OrientedImageryLayer({
url: "url-to-oriented-imagery-service"
});
map.add(layer); // adds the layer to the map
});
Reference an ArcGIS portal Item ID
You can also create an OrientedImageryLayer from its ID if it exists as an item in ArcGIS Online or ArcGIS Enterprise. For example, the following snippet shows how to add a new OrientedImageryLayer instance to a map using the portalItem property.
// points to a hosted Feature Layer with Oriented Imagery Layer as a sub layer in ArcGIS Online
const layer = new OrientedImageryLayer({
portalItem: { // autocasts as esri/portal/PortalItem
id: "2c65c47b75654a078038abae52c58f70"
}
});
map.add(layer); // adds the layer to the map
Known Limitations
- Locations with a very high density of features may not display all available features at small scales.
- Very large datasets may require potentially long initial load times, particularly at small scales. Server-side and client-side feature tile caching allow features to load much faster after the initial data download. We are continuously improving our feature fetching strategy and load time efficiency in each release.
- See also
Constructors
-
new OrientedImageryLayer(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Exampleconst layer = new OrientedImageryLayer({ url: "url-to-image-service" }); map.add(layer); // adds the layer to the map
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer. more details | OrientedImageryLayer | |
Number | Camera orientation defining the first rotation around z-axis of the camera. more details | OrientedImageryLayer | |
Number | The height of camera above the ground when the imagery was captured. more details | OrientedImageryLayer | |
Number | Camera orientation defining the second rotation around x-axis of the camera in the positive counterclockwise direction. more details | OrientedImageryLayer | |
Number | Camera orientation defining the final rotation around z-axis of the camera in the positive clockwise direction. more details | OrientedImageryLayer | |
Number | Modifies the extent of the image's ground footprint. more details | OrientedImageryLayer | |
String | The name of the class. more details | Accessor | |
String | Prefix used to build the DEM url path in conjunction with the elevationSource attribute. more details | OrientedImageryLayer | |
String | Suffix used to build the DEM url path in conjunction with the elevationSource attribute. more details | OrientedImageryLayer | |
String | Prefix used to build the depth image url path in conjunction with the depth image attribute. more details | OrientedImageryLayer | |
String | Suffix used to build the depth image url path in conjunction with the depth image attribute. more details | OrientedImageryLayer | |
Effect | Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to how image filters work. more details | OrientedImageryLayer | |
ConstantElevation|ElevationSource | The source of elevation, that will be used to compute ground to image transformations. more details | OrientedImageryLayer | |
Number | The farthest usable distance of the imagery from the camera position. more details | OrientedImageryLayer | |
FeatureEffect | The featureEffect can be used to draw attention features of interest. more details | OrientedImageryLayer | |
FeatureReductionBinning|FeatureReductionCluster|FeatureReductionSelection | Configures the method for reducing the number of point features in the view. more details | OrientedImageryLayer | |
Extent | The full extent of the layer. more details | Layer | |
Number | The camera's scope in horizontal direction. more details | OrientedImageryLayer | |
Number | Defines the unit that will be used for all horizontal measurements. more details | OrientedImageryLayer | |
String | The unique ID assigned to the layer. more details | Layer | |
String | Prefix used to build the image url path in conjunction with the image attribute. more details | OrientedImageryLayer | |
String | Suffix used to build the image url path in conjunction with the image attribute. more details | OrientedImageryLayer | |
Number | The orientation of the camera in degrees relative to the scene when the image was captured. more details | OrientedImageryLayer | |
String | Indicates how the layer should display in the LayerList widget. more details | Layer | |
Boolean | Indicates whether the layer's resources have loaded. more details | Layer | |
Error | The Error object returned if an error occurred while loading. more details | Layer | |
String | Represents the status of a load operation. more details | Layer | |
Object[] | A list of warnings which occurred while loading. more details | Layer | |
Number | Maximum search distance to be used while querying the feature service specified in the Oriented Imagery Layer. more details | OrientedImageryLayer | |
Number | The maximum scale (most zoomed in) at which the layer is visible in the view. more details | OrientedImageryLayer | |
Number | The minimum scale (most zoomed out) at which the layer is visible in the view. more details | OrientedImageryLayer | |
Number | The nearest usable distance of the imagery from the camera position. more details | OrientedImageryLayer | |
Number | The opacity of the layer. more details | Layer | |
Object[] | Determines the order in which features are drawn in the view. more details | OrientedImageryLayer | |
Number[] | Semicolon-delimited string used to store standard deviation values. more details | OrientedImageryLayer | |
String | String that defines the imagery type used in the particular Oriented Imagery Layer. more details | OrientedImageryLayer | |
Map|Basemap|Ground|GroupLayer | The parent to which the layer belongs. more details | Layer | |
Boolean | Enable persistence of the layer in a WebMap or WebScene. more details | OrientedImageryLayer | |
String | Defines the unit of time used in the viewer's time selector tool. more details | OrientedImageryLayer | |
String | The title of the layer used to identify it in places such as the LayerList widget. more details | Layer | |
String | The layer type provides a convenient way to check the type of the layer without the need to import specific layer modules. more details | Layer | |
Number | The camera's scope in the vertical direction. more details | OrientedImageryLayer | |
String | Defines the primary unit to be used for all vertical measurements. more details | OrientedImageryLayer | |
String | Prefix used to build the video url path in conjunction with the image attribute. more details | OrientedImageryLayer | |
String | Suffix used to build the video url path in conjunction with the image attribute. more details | OrientedImageryLayer | |
Boolean | Indicates if the layer is visible in the View. more details | Layer |
Property Details
-
blendMode String
-
Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer. Unlike the method of using transparency which can result in a washed-out top layer, blend modes can create a variety of very vibrant and intriguing results by blending a layer with the layer(s) below it.
When blending layers, a
top layer
is a layer that has a blend mode applied. All layers underneath the top layer arebackground layers
. The default blending mode isnormal
where the top layer is simply displayed over the background layer. While this default behavior is perfectly acceptable, the use of blend modes on layers open up a world of endless possibilities to generate creative maps.The layers in a GroupLayer are blended together in isolation from the rest of the map.
In the following screenshots, the vintage shaded relief layer is displayed over a firefly world imagery layer. The
color
blend mode is applied to the vintage shaded relief and the result looks like a new layer.Known Limitations
- The blendMode in 3D SceneViews is supported on BaseTileLayer, ImageryTileLayer, OpenStreetMapLayer, TileLayer, VectorTileLayer, WCSLayer, WebTileLayer, WMTSLayer and GroupLayer.
- The blendMode is not supported in the Legend.
- See print for known printing limitations.
The following factors will affect the blend result:
- Order of all layers
- Layer opacity
- Opacity of features in layers
- Visibility of layers
- By default, the very bottom layer in a map is drawn on a transparent background. You can change the MapView's background color.
Blend mode Description normal The top layer is displayed over the background layer. The data of the top layer block the data of background layer where they overlap. average Takes the mathematical average of top and background layers. Result of average
blend mode is often similar to the effect of setting the layer's opacity to 50%.Lighten blend modes:
The following blend modes create lighter results than all layers. In lighten blend modes, pure black colors in the top layer become transparent allowing the background layer to show through. White in the top layer will stay unchanged. Any color that is lighter than pure black is going to lighten colors in the top layer to varying degrees all way to pure white.
Lighten blend modes can be useful when lightening dark colors of the top layer or removing black colors from the result. The
plus
,lighten
andscreen
modes can be used to brighten layers that have faded or dark colors on a dark background.Blend mode Description lighten Compares top and background layers and retains the lighter color. Colors in the top layer become transparent if they are darker than the overlapping colors in the background layer allowing the background layer to show through completely. Can be thought of as the opposite of darken
blend mode.lighter Colors in top and background layers are multiplied by their alphas (layer opacity and layer's data opacity. Then the resulting colors are added together. All overlapping midrange colors are lightened in the top layer. The opacity of layer and layer's data will affect the blend result. plus Colors in top and background layers are added together. All overlapping midrange colors are lightened in the top layer. This mode is also known as add
orlinear-dodge
.screen Multiplies inverted colors in top and background layers then inverts the colors again. The resulting colors will be lighter than the original color with less contrast. Screen can produce many different levels of brightening depending on the luminosity values of the top layer. Can be thought of as the opposite of the multiply
mode.color-dodge Divides colors in background layer by the inverted top layer. This lightens the background layer depending on the value of the top layer. The brighter the top layer, the more its color affects the background layer. Decreases the contrast between top and background layers resulting in saturated mid-tones and blown highlights. Darken blend modes:
The following blend modes create darker results than all layers. In darken blend modes, pure white in the top layer will become transparent allowing the background layer to show through. Black in the top layer will stay unchanged. Any color that is darker than pure white is going to darken a top layer to varying degrees all the way to pure black.
The
multiply
blend mode is often used to highlight shadows, show contrast, or accentuate an aspect of a map. For example, you can usemultiply
blend mode on a topographic map displayed over hillshade when you want to have your elevation show through the topographic layer. See the intro to layer blending sample.The
multiply
anddarken
modes can be used to have dark labels of the basemap to show through top layers. See the darken blending sample.The
color-burn
mode works well with colorful top and background layers since it increases saturation in mid-tones. It increases the contrast by tinting pixels in overlapping areas in top and bottom layers more towards the top layer color. Use this blend mode, when you want an effect with more contrast thanmultiply
ordarken
.The following screenshots show how the
multiply
blend mode used for creating a physical map of the world that shows both boundaries and elevation.Blend mode Description darken Emphasizes the darkest parts of overlapping layers. Colors in the top layer become transparent if they are lighter than the overlapping colors in the background layer, allowing the background layer to show through completely. multiply Emphasizes the darkest parts of overlapping layers by multiplying colors of the top layer and the background layer. Midrange colors from top and background layers are mixed together more evenly. color-burn Intensifies the dark areas in all layers. It increases the contrast between top and background layers, by tinting colors in overlapping area towards the top color. To do this it inverts colors of the background layer, divides the result by colors of the top layer, then inverts the results. Contrast blend modes:
The following blend modes create contrast by both lightening the lighter areas and darkening the darker areas in the top layer by using lightening or darkening blend modes to create the blend. The contrast blend modes will lighten the colors lighter than 50% gray ([128,128,128]), and darken the colors darker than 50% gray. 50% gray will be transparent in the top layer. Each mode can create a variety of results depending on the colors of top and background layers being blended together. The
overlay
blend mode makes its calculations based on the brightness of the colors in the background layer while all of the other contrast blend modes make their calculations based on the brightness of the top layer. Some of these modes are designed to simulate the effect of shining a light through the top layer, effectively projecting upon the layers beneath it.Contrast blend modes can be used to increase the contrast and saturation to have more vibrant colors and give a punch to your layers. For example, you can duplicate a layer and set
overlay
blend mode on the top layer to increase the contrast and tones of your layer. You can also add a polygon layer with a white fill symbol over a dark imagery layer and applysoft-light
blend mode to increase the brightness in the imagery layer.The following screenshots show an effect of the
overlay
blend mode on a GraphicsLayer. The left image shows when the buffer graphics layer has thenormal
blend mode. As you can see, the gray color for the buffer polygon is blocking the intersecting census tracts. The right image shows when theoverlay
blend mode is applied to the buffer graphics layer. Theoverlay
blend mode darkens or lightens the gray buffer polygon depending on the colors of the background layer while the census tracts layer is shining through. See this in action.Normal blend mode Overlay blend mode Blend mode Description overlay Uses a combination of multiply
andscreen
modes to darken and lighten colors in the top layer with the background layer always shining through. The result is darker color values in the background layer intensify the top layer, while lighter colors in the background layer wash out overlapping areas in the top layer.soft-light Applies a half strength screen
mode to lighter areas and half strengthmultiply
mode to darken areas of the top layer. You can think of thesoft-light
as a softer version of theoverlay
mode.hard-light Multiplies or screens the colors, depending on colors of the top layer. The effect is similar to shining a harsh spotlight on the top layer. vivid-light Uses a combination of color-burn
orcolor-dodge
by increasing or decreasing the contrast, depending on colors in the top layer.Component blend modes:
The following blend modes use primary color components, which are hue, saturation and luminosity to blend top and background layers. You can add a feature layer with a simple renderer over any layer and set
hue
,saturation
,color
orluminosity
blend mode on this layer. With this technique, you create a brand new looking map.The following screenshots show where the topo layer is blended with world hillshade layer with
luminosity
blend mode. The result is a drastically different looking map which preserves the brightness of the topo layer while adapting the hue and saturation of the hillshade layer.Blend mode Description hue Creates an effect with the hue of the top layer and the luminosity and saturation of the background layer. saturation Creates an effect with the saturation of the top layer and the hue and luminosity of the background layer. 50% gray with no saturation in the background layer will not produce any change. luminosity Creates effect with the luminosity of the top layer and the hue and saturation of the background layer. Can be thought of as the opposite of color
blend mode.color Creates an effect with the hue and saturation of the top layer and the luminosity of the background layer. Can be thought of as the opposite of luminosity
blend mode.Composite blend modes:
The following blend modes can be used to mask the contents of top, background or both layers.
Destination
modes are used to mask the data of the top layer with the data of the background layer.Source
modes are used to mask the data of the background layer with the data of the top layer.
The
destination-in
blend mode can be used to show areas of focus such as earthquakes, animal migration, or point-source pollution by revealing the underlying map, providing a bird’s eye view of the phenomenon. Check out multiple blending and groupLayer blending samples to see composite blend modes in action.The following screenshots show feature and imagery layers on the left side on their own in the order they are drawn in the view. The imagery layer that contains land cover classification rasters. The feature layer contains 2007 county crops data. The right image shows the result of layer blending where
destination-in
blendMode is set on the imagery layer. As you can see, the effect is very different from the original layers. The blended result shows areas of cultivated crops only (where both imagery and feature layers overlap).Blend mode Description destination-over Destination/background layer covers the top layer. The top layer is drawn underneath the destination layer. You'll see the top layer peek through wherever the background layer is transparent or has no data. destination-atop Destination/background layer is drawn only where it overlaps the top layer. The top layer is drawn underneath the background layer. You'll see the top layer peek through wherever the background layer is transparent or has no data. destination-in Destination/background layer is drawn only where it overlaps with the top layer. Everything else is made transparent. destination-out Destination/background layer is drawn where it doesn't overlap the top layer. Everything else is made transparent. source-atop Source/top layer is drawn only where it overlaps the background layer. You will see the background layer peek through where the source layer is transparent or has no data. source-in Source/top layer is drawn only where it overlaps with the background layer. Everything else is made transparent. source-out Source/top layer is drawn where it doesn't overlap the background layer. Everything else is made transparent. xor Top and background layers are made transparent where they overlap. Both layers are drawn normal everywhere else. Invert blend modes:
The following blend modes either invert or cancel out colors depending on colors of the background layer. These blend modes look for variations between top and background layers. For example, you can use
difference
orexclusion
blend modes on two imagery layers of forest covers to visualize how forest covers changed from one year to another.The
invert
blend mode can be used to turn any light basemap into a dark basemap to accommodate those who work in low-light conditions. The following screenshots show how setting theinvert
blend mode set on a feature layer with a simple renderer turns the world terrain basemap into a dark themed basemap in no time.Blend mode Description difference Subtracts the darker of the overlapping colors from the lighter color. When two pixels with the same value are subtracted, the result is black. Blending with black produces no change. Blending with white inverts the colors. This blending mode is useful for aligning layers with similar content. exclusion Similar to the difference
blend mode, except that the resulting image is lighter overall. Overlapping areas with lighter color values are lightened, while darker overlapping color values become transparent.minus Subtracts colors of the top layer from colors of the background layer making the blend result darker. In the case of negative values, black is displayed. invert Inverts the background colors wherever the top and background layers overlap. The invert blend mode inverts the layer similar to a photographic negative. reflect This blend mode creates effects as if you added shiny objects or areas of light in the layer. Black pixels in the background layer are ignored as if they were transparent. Possible Values:"average"|"color-burn"|"color-dodge"|"color"|"darken"|"destination-atop"|"destination-in"|"destination-out"|"destination-over"|"difference"|"exclusion"|"hard-light"|"hue"|"invert"|"lighten"|"lighter"|"luminosity"|"minus"|"multiply"|"normal"|"overlay"|"plus"|"reflect"|"saturation"|"screen"|"soft-light"|"source-atop"|"source-in"|"source-out"|"vivid-light"|"xor"
- Default Value:normal
- See also
-
cameraHeading Number
-
Camera orientation defining the first rotation around z-axis of the camera. Defined in degrees. Heading values are measured in the positive clockwise direction where north is defined as 0 degrees. -999 is used when the orientation is unknown.
Example// point images without cameraHeading to north using camera heading layer.cameraHeading = 90;
-
cameraHeight Number
-
The height of camera above the ground when the imagery was captured. The units are in meters. Camera height is used to determine the visible extent of the image, large values will result in a greater view extent. Values should not be less than 0.
Example// Adds value to images without a cameraHeight layer.cameraHeight = 100;
-
cameraPitch Number
-
Camera orientation defining the second rotation around x-axis of the camera in the positive counterclockwise direction. Defined in degrees. The pitch is 0 degrees when the camera is facing straight down to ground. The valid range of pitch value is from 0 to 180 degrees, with 180 degrees for a camera facing straight up and 90 degrees for a camera facing horizon.
Example// Adds pitch value to images without a cameraPitch layer.cameraPitch = 90;
-
cameraRoll Number
-
Camera orientation defining the final rotation around z-axis of the camera in the positive clockwise direction. The camera housing rotation is defined in degrees. Valid values range from -90 to +90.
Example// Adds roll value to images without a cameraRoll layer.cameraRoll = 0;
-
coveragePercent Number
-
Modifies the extent of the image's ground footprint. The ground footprint of each image is computed to search for images that contain the selected location, which is identified as the red cross on the map. Valid values are from -50 to 50. Negative percentage values shrink the size of the ground footprint and positive values increase the size of the ground footprint.
Example// Adds a coveragePercent value to image footprint layer.coveragePercent = 40;
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
demPathPrefix String
-
Prefix used to build the DEM url path in conjunction with the elevationSource attribute.
-
demPathSuffix String
-
Suffix used to build the DEM url path in conjunction with the elevationSource attribute.
-
depthImagePathPrefix String
-
Prefix used to build the depth image url path in conjunction with the depth image attribute.
-
depthImagePathSuffix String
-
Suffix used to build the depth image url path in conjunction with the depth image attribute.
-
Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to how image filters work. This powerful capability allows you to apply css filter-like functions to layers to create custom visual effects to enhance the cartographic quality of your maps. This is done by applying the desired effect to the layer's
effect
property as a string or an array of objects to set scale dependent effects.Notes
- Set featureEffect property if different effects need to be applied features that meet or fail a specified filter.
- If all of the following four properties are applied, then they will be applied in this order:
featureEffect
, effect, opacity and blendMode.
Known Limitations
- The effect is not supported in 3D SceneViews.
- The effect cannot be applied to a layer with a heatmap renderer.
- The effect is not supported in layers with featureReduction of type
cluster
enabled. - See print for known printing limitations.
- Default Value:null
- See also
Examples// the following effect will be applied to the layer at all scales // brightness will be applied first, then hue-rotate followed by contrast // changing order of the effects will change the final result layer.effect = "brightness(5) hue-rotate(270deg) contrast(200%)";
// set a scale dependent bloom effect on the layer layer.effect = [ { scale: 36978595, value: "drop-shadow(3px, 3px, 4px)" }, { scale: 18489297, value: "drop-shadow(2px, 2px, 3px)" }, { scale: 4622324, value: "drop-shadow(1px, 1px, 2px)" } ];
-
-
The source of elevation, that will be used to compute ground to image transformations. The elevation source can be a digital elevation model (DEM) or a constant value. A tile image service can be used as the digital elevation model. The unit of constant elevation value should be in meters.
-
farDistance Number
-
The farthest usable distance of the imagery from the camera position. FarDistance is used to determine the extent of the image footprint, which is used to determine if an image is returned when you click on the map, and for creating optional footprint features. The units are in meters. Far distance should be always greater than 0.
Example// Adds farDistance value to features without it layer.farDistance = 60;
-
featureEffect FeatureEffectautocast
-
The featureEffect can be used to draw attention features of interest. It allows for the selection of features via a filter, and an includedEffect and excludedEffect are applied to those features that respectively pass or fail the filter requirements.
Notes
- Set the effect property if the effect needs to be applied to the entire layer.
- If the
featureEffect
is set on the layer, it will be inherited bylayerView.featureEffect
unless the developer overrides it on the layer view. ThelayerView.featureEffect
will take precedence overlayer.featureEffect
if both properties are set. - If all of the following four properties are applied, then they will be applied in this order:
featureEffect
, effect, opacity and blendMode.
Known Limitations
- FeatureEffect is not supported in the following scenarios:
- In 3D SceneViews
- In a layer rendered with a HeatmapRenderer
- When FeatureReductionCluster is enabled
- See print for known printing limitations.
Examples// gray out features that fall outside of the 3 mile buffer of the mouse's location // by setting feature effect on excluded features layer.featureEffect = new FeatureEffect({ filter: new FeatureFilter({ geometry: filterGeometry, spatialRelationship: "intersects", distance: 3, units: "miles" }), excludedEffect: "grayscale(100%) opacity(30%)" });
// Apply a drop-shadow feature effect to the features that intersect the borough boundaries, // while applying blur and brightness effects to the features that are excluded from filter criteria. // The resulting map will make it easier to spot if the residents are more likely to experience deprivation // if they live on a borough boundary. const featureFilter = new FeatureFilter({ where: "BoroughEdge='true'" }); layer.featureEffect = new FeatureEffect({ filter: featureFilter, includedEffect: "drop-shadow(3px, 3px, 3px, black)", excludedEffect: "blur(1px) brightness(65%)" });
-
Configures the method for reducing the number of point features in the view. By default this property is
null
, which indicates the layer view should draw every feature.There are three types of feature reduction:
selection
,cluster
, andbinning
.- Selection only applies to points in a SceneView and involves thinning overlapping features so no features intersect on screen. This has been available since version 4.4.
- Cluster groups points in a MapView into clusters defined in screen space. Each cluster is a point whose size is proportional to the number of features within the cluster. This has been available since version 4.14.
- Binning spatially groups points in a MapView into bins clearly defining the area aggregating features in map space. This has been available since version 4.24.
- See also
Examples// clusters points based on their spatial proximity to other points layer.featureReduction = { type: "cluster", clusterRadius: 100 };
// thins features in the view layer.featureReduction = { type: "selection" };
// Aggregates features to bins layer.featureReduction = { type: "binning", renderer: { type: "simple", // autocasts as new SimpleRenderer() symbol: { type: "simple-fill", // autocasts as new SimpleFillSymbol() outline: { // autocasts as new SimpleLineSymbol() width: 0.5, color: "white" } }, visualVariables: [{ type: "color", field: "aggregateCount", stops: [ { value: 1, color: "white" }, { value: 1000, color: "blue" } ] }] }, popupTemplate: { content: "This bin contains <b>{aggregateCount}</b> features.", fieldInfos: [{ fieldName: "aggregateCount", format: { digitSeparator: true, places: 0 } }] } };
-
The full extent of the layer. By default, this is worldwide. This property may be used to set the extent of the view to match a layer's extent so that its features appear to fill the view. See the sample snippet below.
Example// Once the layer loads, set the view's extent to the layer's fullextent layer.when(function(){ view.extent = layer.fullExtent; });
-
horizontalFieldOfView Number
-
The camera's scope in horizontal direction. The units are in degrees and valid values range from 0 to 360.
Examplelayer.horizontalFieldOfView = 40;
-
horizontalMeasurementUnit Number
-
Defines the unit that will be used for all horizontal measurements. The unit will be obtained from the layer coordinate system and will be used for display purposes only.
Examplelayer.horizontalMeasurementUnit = 0;
-
The unique ID assigned to the layer. If not set by the developer, it is automatically generated when the layer is loaded.
-
imagePathPrefix String
-
Prefix used to build the image url path in conjunction with the image attribute.
-
imagePathSuffix String
-
Suffix used to build the image url path in conjunction with the image attribute.
-
imageRotation Number
-
The orientation of the camera in degrees relative to the scene when the image was captured. The rotation is added in addition to the camera roll. The value can range from -360 to +360.
-
Indicates how the layer should display in the LayerList widget. The possible values are listed below.
Value Description show The layer is visible in the table of contents. hide The layer is hidden in the table of contents. hide-children If the layer is a GroupLayer, BuildingSceneLayer, KMLLayer, MapImageLayer, TileLayer or WMSLayer, hide the children layers from the table of contents. Possible Values:"show"|"hide"|"hide-children"
- Default Value:"show"
-
Indicates whether the layer's resources have loaded. When
true
, all the properties of the object can be accessed.- Default Value:false
-
The Error object returned if an error occurred while loading.
- Default Value:null
-
Represents the status of a load operation.
Value Description not-loaded The object's resources have not loaded. loading The object's resources are currently loading. loaded The object's resources have loaded without errors. failed The object's resources failed to load. See loadError for more details. Possible Values:"not-loaded"|"loading"|"failed"|"loaded"
- Default Value:not-loaded
-
A list of warnings which occurred while loading.
-
maximumDistance Number
-
Maximum search distance to be used while querying the feature service specified in the Oriented Imagery Layer. The maximum distance can never be less than zero.
Examplelayer.maximumDistance = 100;
-
maxScale Number
-
The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of
0
means the layer does not have a maximum scale. The maxScale value should always be smaller than the minScale value, and greater than or equal to the service specification.- Default Value:0
Examples// The layer will not be visible when the view is zoomed in beyond a scale of 1:1,000 layer.maxScale = 1000;
// The layer's visibility is not restricted to a maximum scale. layer.maxScale = 0;
-
minScale Number
-
The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of
0
means the layer does not have a minimum scale. The minScale value should always be larger than the maxScale value, and lesser than or equal to the service specification.- Default Value:0
Examples// The layer will not be visible when the view is zoomed out beyond a scale of 1:3,000,000 layer.minScale = 3000000;
// The layer's visibility is not restricted to a minimum scale. layer.minScale = 0;
-
nearDistance Number
-
The nearest usable distance of the imagery from the camera position. The units are in meters. Near distance can never be less than 0.
-
The opacity of the layer. This value can range between
1
and0
, where0
is 100 percent transparent and1
is completely opaque.- Default Value:1
Example// Makes the layer 50% transparent layer.opacity = 0.5;
-
Determines the order in which features are drawn in the view. You can sort features by a field value or the value returned from an Arcade expression in ascending or descending order.
When
null
(default), features are drawn in the order they are returned from the service or client.Known Limitations
- This property only controls feature drawing order in MapView. Configuring feature drawing order in SceneView is not supported.
- This property does not control the drawing order of clusters. It only applies to individual features.
- Feature drawing order configurations defined with Arcade expressions cannot be saved to webmaps.
- Currently, you can only sort features by one field or expression.
- Properties
-
field String
The number or date field whose values will be used to sort features.
valueExpression StringAn Arcade expression following the specification defined by the Arcade Feature Z Profile. Expressions may reference field values using the
$feature
profile variable and must return a number or a date representing the z-value used to sort features.order StringDefault Value:ascendingThe sort order. If
ascending
, then features with smaller data values (they usually have smaller symbols in size visualizations) will be drawn on top of features with larger data values. Ifdescending
, then features with larger data values (usually larger symbols in size visualizations) will be drawn on top of features with smaller data values. If date values are used, thenascending
means features with older values will be drawn on top of features with more recent dates. Adescending
order for dates indicates features with more recent values will be drawn on top of features with older values.Possible Values:"ascending"|"descending"
- Default Value:null
- See also
Examples// Features with smaller population values will // be rendered on top of larger features. layer.orderBy = [{ field: "POPULATION" }];
// Features with larger population values will // be rendered on top of smaller features. layer.orderBy = [{ field: "POPULATION", order: "descending" }];
// Orders features by date in descending order. // The most recent features will be rendered // on top of older features. layer.orderBy = [{ field: "Alarm_Date", order: "descending" }];
// Orders features by storm warning duration in descending order. // Warnings with longer durations // be rendered on top of warnings with shorter durations. layer.orderBy = [{ valueExpression: "DateDiff($feature.Watch_End, $feature.Watch_Start, 'hours' )", order: "descending" }];
// Orders features by data values used in a size visual variable const sizeVariable = layer.renderer.visualVariables.find( vv => vv.type === "size"); const { field, valueExpression } = sizeVariable; layer.orderBy = [{ field, valueExpression, order: "ascending" }];
-
Semicolon-delimited string used to store standard deviation values. The standard deviation values are in the following order and format: Camera location in XY direction; camera height; camera heading; camera pitch; camera roll; near distance; far distance; elevation (all in meters).
-
orientedImageryType String
-
String that defines the imagery type used in the particular Oriented Imagery Layer. Valid values: 360, horizontal, inspection, nadir, oblique.
Possible Values:"horizontal"|"nadir"|"oblique"|"360"|"inspection"
Examplelayer.orientedImageryType = "oblique";
-
-
The parent to which the layer belongs.
-
persistenceEnabled Boolean
-
- Default Value:true
-
timeIntervalUnit String
-
Defines the unit of time used in the viewer's time selector tool. Images will be filtered in the viewer based on the Time Unit value defined here. Valid values: days, hours, minutes, months, weeks, years
Possible Values:"days"|"hours"|"minutes"|"months"|"weeks"|"years"
Examplelayer.verticalFieldOfView = 20;
-
The title of the layer used to identify it in places such as the LayerList widget.
If the layer is loaded from a portal item, the title of the portal item will be used. If a layer is loaded as part of a webmap or a webscene, then the title of the layer as stored in the webmap/webscene will be used.
-
The layer type provides a convenient way to check the type of the layer without the need to import specific layer modules.
Possible Values:"base-dynamic"|"base-elevation"|"base-tile"|"bing-maps"|"building-scene"|"csv"|"dimension"|"elevation"|"feature"|"geojson"|"geo-rss"|"graphics"|"group"|"imagery"|"imagery-tile"|"integrated-mesh"|"kml"|"line-of-sight"|"map-image"|"map-notes"|"media"|"ogc-feature"|"open-street-map"|"oriented-imagery"|"point-cloud"|"route"|"scene"|"georeferenced-image"|"stream"|"tile"|"unknown"|"unsupported"|"vector-tile"|"wcs"|"web-tile"|"wfs"|"wms"|"wmts"|"voxel"|"subtype-group"|"knowledge-graph"|"knowledge-graph-sublayer"
-
verticalFieldOfView Number
-
The camera's scope in the vertical direction. The units are in degrees and valid values range from 0 to 180.
Examplelayer.verticalFieldOfView = 20;
-
verticalMeasurementUnit String
-
Defines the primary unit to be used for all vertical measurements. Valid values: feet, meter.
Possible Values:"feet"|"meter"
Examplelayer.verticalMeasurementUnit = "meter";
-
videoPathPrefix String
-
Prefix used to build the video url path in conjunction with the image attribute.
-
videoPathSuffix String
-
Suffix used to build the video url path in conjunction with the image attribute.
-
Indicates if the layer is visible in the View. When
false
, the layer may still be added to a Map instance that is referenced in a view, but its features will not be visible in the view.- Default Value:true
Example// The layer is no longer visible in the view layer.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. more details | Accessor | ||
Cancels a load() operation if it is already in progress. more details | Layer | ||
Promise<LayerView> | Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it. more details | Layer | |
Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer). more details | Layer | ||
Boolean | Emits an event on the instance. more details | Layer | |
Promise<object> | Fetches custom attribution data for the layer when it becomes available. more details | Layer | |
Boolean | Indicates whether there is an event listener on the instance that matches the provided event name. more details | Layer | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Boolean |
| Layer | |
Boolean |
| Layer | |
Boolean |
| Layer | |
Promise | Loads the resources referenced by this class. more details | Layer | |
Object | Registers an event handler on the instance. more details | Layer | |
Removes a group of handles owned by the object. more details | Accessor | ||
Promise |
| Layer |
Method Details
-
addHandles(handleOrHandles, groupKey)inherited
-
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.
-
Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it. This method is used internally and there is no use case for invoking it directly.
Parametersview *The parent view.
options ObjectoptionalAn object specifying additional options. See the object specification table below for the required properties of this object.
Specificationsignal AbortSignaloptionalA signal to abort the creation of the layerview.
ReturnsType Description Promise<LayerView> Resolves with a LayerView instance. - See also
-
destroy()inherited
-
Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer). The layer can no longer be used once it has been destroyed.
The destroyed layer will be removed from its parent object like Map, WebMap, WebScene, Basemap, Ground, or GroupLayer.
-
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameterstype StringThe name of the event.
event ObjectoptionalThe event payload.
ReturnsType Description Boolean true
if a listener was notified
-
Fetches custom attribution data for the layer when it becomes available.
ReturnsType Description Promise<object> Resolves to an object containing custom attribution data for the layer.
-
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.
-
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()
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()
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()
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.
-
Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.
This method must be called by the developer when accessing a resource that will not be loaded in a View.
The
load()
method only triggers the loading of the resource the first time it is called. The subsequent calls return the same promise.It's possible to provide a
signal
to stop being interested into aLoadable
instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.Parametersignal AbortSignaloptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortError
when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise Resolves when the resources have loaded.
-
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersAn event or an array of events to listen for.
listener FunctionThe function to call when the event fires.
ReturnsType 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); });
-
removeHandles(groupKey)inherited
-
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");
-
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.Parameterscallback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe function to execute when the promise fails.
ReturnsType Description Promise Returns a new promise for the result of callback
that may be used to chain additional functions.Example// Although this example uses MapView, any class instance that is a promise may use when() in the same way let view = new MapView(); view.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 });
Type Definitions
-
ConstantElevation Object
-
The unit of constant elevation value measured in meters.
- Property
-
constantElevation Number
The constant associated with the elevation source.
-
ElevationSource Object
-
The elevation source.
Event Overview
Name | Type | Summary | Class |
---|---|---|---|
{view: View,layerView: LayerView} |
Fires after the layer's LayerView is created and rendered in a view. more details |
Layer | |
{view: View,error: Error} |
Fires when an error emits during the creation of a LayerView after a layer has been added to the map. more details |
Layer | |
{view: View,layerView: LayerView} |
Fires after the layer's LayerView is destroyed and no longer renders in a view. more details |
Layer |
Event Details
-
layerview-createinherited
-
Fires after the layer's LayerView is created and rendered in a view.
- Properties
-
view View
The view in which the
layerView
was created.layerView LayerViewThe LayerView rendered in the view representing the layer in
layer
. - See also
Example// This function will fire each time a layer view is created for this // particular view. layer.on("layerview-create", function(event){ // The LayerView for the layer that emitted this event event.layerView; });
-
layerview-create-errorinherited
-
Fires when an error emits during the creation of a LayerView after a layer has been added to the map.
- Properties
-
view View
The view that failed to create a layerview for the layer emitting this event.
error ErrorAn error object describing why the layer view failed to create.
- See also
Example// This function fires when an error occurs during the creation of the layer's layerview layer.on("layerview-create-error", function(event) { console.error("LayerView failed to create for layer with the id: ", layer.id, " in this view: ", event.view); });