Annotation layers can be created by referencing a layer from a feature service. Annotation layers honor any feature templates configured in the source document.

Referenced by: operationalLayers

Properties

PropertyDetails
blendModeBlend modes are used to create various effects by blending colors of top and background layers. normal blend mode is the default.
Valid values: average, color, color-burn, color-dodge, 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
customParametersA sequence of custom parameters appended to the URL of all requests related to a layer.
disablePopupIndicates whether to allow a client to ignore popups defined by the service item.
displayExpressionInfoObject defining Arcade expression that will return a display name used for listing features. This Arcade expression profile expects the returnType to be always a string.
effectEffect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work.
enableEditingIndicates whether a client can add, remove or update features in the layer. Applicable only if the layer has editing capability.
idA unique identifying string for the layer.
itemIdOptional string containing the item ID of the service if it’s registered on ArcGIS Online or your organization’s portal.
layerDefinitionA layerDefinition object defining the attribute schema and drawing information for the layer.
See layerDefinition properties table.
layers[]An array of sublayer objects. These objects represent annotation subclasses and are used to control their visibility and scale ranges
layerTypeString indicating the layer type.
Valid value of this property ArcGISAnnotationLayer
opacityThe degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
popupInfoA popupInfo object defining the content of popup windows when you click or query a feature.
refreshIntervalRefresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled.
timeAnimationIndicates whether to disable time animation if the layer supports it. Default value is true.
titleA user-friendly string title for the layer that can be used in a table of contents.
urlThe URL to the layer. If the layer is not from a web service but rather a feature collection, then the url property is omitted.
visibilityBoolean property determining whether the layer is initially visible in the web map.
visibilityTimeExtentRepresents time extent that will control when a layer should be visible based on webmap’s current time. Visibility time extent only affects the layer visibility and will not filter the data.
visibleLayers[]Deprecated, use layers instead. An array of sublayer ids that should appear visible. These ids refer to subsets of the Annotation features in the AnnotationLayer, identified by their AnnotationClassId.

layerDefinition properties

PropertyDetails
barrierWeightOptional weight of features in AnnotationLayers and DimensionLayers when considered as barriers to labeling. If not set but required, the default value is assumed to be High.
Valid values:
  • High
  • Low
  • Medium
  • None
definitionExpressionSQL-based definition expression string that narrows the data to be displayed in the layer.
drawUnplacedAnnotationIndicates whether unplaced annotation features are visible.
floorInfoContains floor-awareness information for the layer.
maxScaleInteger property used to determine the maximum scale at which the layer is displayed.
minScaleInteger property used to determine the minimum scale at which the layer is displayed.
timeInfoAn object that defines properties to enable time on a layer or table.
unplacedAnnotationColorSpecifies the color used to render unplaced annotation features. If not set, they use the color of placed annotations.

annotationLayer Example

Sample ArcGISAnnotationLayer as an operationalLayer

{
"id": "6b153ffefaf94f6b831626db3bdfa1c4",
"layerDefinition": {
"barrierWeight": "Medium"
},
"layerType": "ArcGISAnnotationLayer",
"opacity": 1,
"title": "Parcel_LinesAnno",
"url": "https://rtc-100-8.esri.com/arcgis/rest/services/Anno/Loudoun_Clipped/FeatureServer/3",
"visibility": true
}