Annotation Layer (ArcGISAnnotationLayer)

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


Property Details
blendMode Blend 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
customParameters A sequence of custom parameters appended to the URL of all requests related to a layer.
disablePopup Indicates whether to allow a client to ignore popups defined by the service item.
effect Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work.
enableEditing Indicates whether a client can add, remove or update features in the layer.
id A unique identifying string for the layer.
layerDefinition A layerDefinition object defining the attribute schema and drawing information for the layer.
See layerDefinition properties table.
layerType String indicating the layer type.
Valid value of this property ArcGISAnnotationLayer
opacity The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.
popupInfo A popupInfo object defining the content of popup windows when you click or query a feature.
refreshInterval Refresh 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.
timeAnimation Indicates whether to disable time animation if the layer supports it.
title A user-friendly string title for the layer that can be used in a table of contents.
url The URL to the layer. If the layer is not from a web service but rather a feature collection, then the url property is omitted.
visibility Boolean property determining whether the layer is initially visible in the web map.
visibleLayers[] 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

Property Details
barrierWeight Optional 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
definitionExpression SQL-based definition expression string that narrows the data to be displayed in the layer.
floorInfo Contains floor-awareness information for the layer.
maxScale Integer property used to determine the maximum scale at which the layer is displayed.
minScale Integer property used to determine the minimum scale at which the layer is displayed.

annotationLayer Example

Sample ArcGISAnnotationLayer as an operationalLayer

  "id": "6b153ffefaf94f6b831626db3bdfa1c4",
  "layerDefinition": {
    "barrierWeight": "Medium"
  "layerType": "ArcGISAnnotationLayer",
  "opacity": 1,
  "title": "Parcel_LinesAnno",
  "url": "",
  "visibility": true

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.