LayerOptions | References | ArcGIS Maps SDK for JavaScript

import LayerOptions from "@arcgis/core/popup/LayerOptions.js";

const LayerOptions = await $arcgis.import("@arcgis/core/popup/LayerOptions.js");

Inheritance: LayerOptions→Accessor

Since: ArcGIS Maps SDK 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",
      "isEditable": false,
      "visible": true,
      "format": {
        "places": 2,
        "digitSeparator": true
      }
    }],
  "layerOptions": {
    "showNoDataRecords": true
  }
  }]
}

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	LayerOptionsProperties

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
declaredClass readonly inherited	string	Accessor
returnTopmostRaster	boolean \| null \| undefined
showNoDataRecords	boolean \| null \| undefined

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

returnTopmostRaster

Property

Type: boolean | null | undefined

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

Default value: false

showNoDataRecords

Property

Type: boolean | null | undefined

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

Default value: true

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
clone	clone(): LayerOptions
toJSON inherited	toJSON(): any	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	any	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: any
Returns a new instance of this class.

clone

Method

Signature: clone (): LayerOptions

Creates a deep clone of the LayerOptions class.

Returns: LayerOptions
A deep clone of the LayerOptions instance.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.