LayerOptions

AMD: require(["esri/popup/LayerOptions"], (LayerOptions) => { /* code goes here */ });
ESM: import LayerOptions from "@arcgis/core/popup/LayerOptions";
Class: esri/popup/LayerOptions
Inheritance: LayerOptions Accessor
Since: ArcGIS API for JavaScript 4.11

The LayerOptions class defines additional options that can be defined for a layer's PopupTemplate.

See also:
Example:
popupTemplate: {
  "title": "ScientificData/SeaTemperature:{ProductName}",
  content: [{
    type: "fields",
    "fieldInfos": [{
      "fieldName": "Raster.ItemPixelValue",
      "label": "Item Pixel Value",
      "isEditableOnLayer": false,
      "visible": true,
      "format": {
        "places": 2,
        "digitSeparator": true
      }
    }],
  "layerOptions": {
    "showNoDataRecords": true
  }
  }]
}

Constructors

new LayerOptions(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Booleanmore details

Applicable to Imagery Layers.

more detailsLayerOptions
Booleanmore details

Applicable to Imagery Layers.

more detailsLayerOptions

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

returnTopmostRaster Boolean

Applicable to Imagery Layers. Indicates whether or not only the topmost raster should be displayed.

Default Value:false
showNoDataRecords Boolean

Applicable to Imagery Layers. Indicates whether records without data should display within the popup.

Default Value:true

Method Overview

Name Return Type Summary Class
LayerOptionsmore details

Creates a deep clone of the LayerOptions class.

more detailsLayerOptions
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsLayerOptions
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsLayerOptions

Method Details

clone(){LayerOptions}

Creates a deep clone of the LayerOptions class.

Returns:
Type Description
LayerOptions A deep clone of the LayerOptions instance.
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

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