LayerOptions
require(["esri/support/LayerOptions"], function(LayerOptions) { /* code goes here */ });esri/support/LayerOptionsThe LayerOptions class defines additional options that can be defined for a layer's PopupTemplate.
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 Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| Boolean | Applicable to Imagery Layers. more details | more details | LayerOptions |
Property Details
The name of the class. The declared class name is formatted as
esri.folder.className.
- showNoDataRecordsBoolean
Applicable to Imagery Layers. Indicates whether records without data should display within the popup.
- Default Value:true
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| LayerOptions | Creates a deep clone of the LayerOptions class. more details | more details | LayerOptions | |
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | LayerOptions | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | LayerOptions |
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 a product in the ArcGIS platform. The object passed into the input
jsonparameter 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 ObjectA 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() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.