Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: LayerDrawingOptions
[ AMD Module Require | Legacy Module Require ]
require(["esri/layers/LayerDrawingOptions"], function(LayerDrawingOptions) { /* code goes here */ });
Description
(Added at v2.7)
The LayerDrawingOptions class provides options for setting ArcGISDynamicMapServiceLayer rendering options. Requires ArcGIS Server 10.1 or greater. Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new LayerDrawingOptions(json?) | Creates a new LayerDrawingOptions object. |
Properties
| Name | Type | Summary |
|---|---|---|
| labelingInfo | LabelClass[] | Define labels of dynamicLayers. |
| renderer | Renderer | The renderer to use for the dynamic layer. |
| scaleSymbols | Boolean | Determines if the layer renders the symbols based on scale. |
| showLabels | Boolean | Determines if labels are displayed. |
| transparency | Number | The transparency of the layer. |
Methods
| Name | Return type | Summary |
|---|---|---|
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
Constructor Details
Creates a new LayerDrawingOptions object.
Parameters:
< |
Optional | JSON object representing the LayerDrawingOptions. |
Sample:
require([
"esri/layers/LayerDrawingOptions", ...
], function(LayerDrawingOptions, ... ) {
var layerDrawingOption = new LayerDrawingOptions();
...
});
Property Details
<LabelClass[]
LabelClass[]Define labels of
dynamicLayers. (Added at v3.6)<Renderer
RendererThe renderer to use for the dynamic layer.
Sample:
require([
"esri/layers/LayerDrawingOptions", "esri/renderers/SimpleRenderer", ...
], function(LayerDrawingOptions, SimpleRenderer, ... ) {
var layerDrawingOptions = new LayerDrawingOptions( ... );
var renderer = new SimpleRenderer(symbol);
layerDrawingOptions.renderer = renderer;
...
});
<Boolean
BooleanDetermines if the layer renders the symbols based on scale. When false the layer does not render the symbols based on scale.
Known values:
true | false<Boolean
BooleanDetermines if labels are displayed. When false, labels for the layer are not displayed.
Known values:
true | false<Number
NumberThe transparency of the layer. Values range from 0 to 100 where 0 is opaque and 100 is 100% transparent.
Method Details