ArcGIS REST API - ArcGIS Services - Generate Renderer (Feature Service)

URL:http://<layer-url>/generateRenderer
Required Capability:Query
Version Introduced:10.1

Description

This operation is supported from 10.1 onwards.

The generateRenderer operation is performed on a layer/table resource. This operation groups data using the supplied classificationDef (classification definition) and an optional where clause. The result is a renderer object. Use baseSymbol and colorRamp to define the symbols assigned to each class. If the operation is performed on a table, the result is a renderer object containing the data classes and no symbols.

You can provide arguments to the generateRenderer operation as defined in the parameters table below.

Request Parameters

Parameter	Details
f	Description: The response format. The default response format is html. Values: html \| json
classificationDef	Description: The definition with which the renderer is generated. Note: Use either one of ClassBreaks or UniqueValue classification definition. Syntax: classificationDef = classification definition Example: //classBreaks classification definition classificationDef = { "type": "classBreaksDef", "classificationField": "POP2010", "classificationMethod": "esriClassifyNaturalBreaks", "breakCount": 5, "normalizationType": "esriNormalizeByField", "normalizationField": "Area" } //uniqueValue classification definition with symbology classificationDef = { "type": "uniqueValueDef", "uniqueValueFields": ["Type", "AdminClass"], "fieldDelimiter": ",", "baseSymbol": { "type": "esriSLS", "style": "esriSLSSolid", "width": 2 }, "colorRamp": { "type": "algorithmic", "fromColor": [115,76,0,255], "toColor": [255,25,86,255], "algorithm": "esriHSVAlgorithm" } }
where	Description: A where clause for which the data needs to be classified. Any legal SQL where clause operating on the fields in the layer/table is allowed. Example: where = POP2000 > 350000
gdbVersion	Description: The geodatabase version from which the data will be rendered. This parameter applies only if the isDataVersioned property of the layer is true. If this is not specified, the renderer will be generated from the published map’s version. Syntax: gdbVersion=<version> Example: gdbVersion=SDE.DEFAULT

Example Usage

Example 1: Generate Renderer using a unique value classification definition:

http://services.myserver.com/arcgis/rest/services/PoolPermits/FeatureServer/0/generateRenderer?classificationDef={"type":"uniqueValueDef","uniqueValueFields":["Has_Pool"],"fieldDelimiter": ",","baseSymbol":{"type": "esriSFS","style": "esriSLSSolid","width":2},"colorRamp":{"type":"algorithmic","fromColor":[115,76,0,255],"toColor":[255,25,86,255],"algorithm": "esriHSVAlgorithm"}}&where=&f=html

JSON Response Syntax (when symbol is included in classification definition)

            
          
{
 "type": "uniqueValue",
 "field1": "EVENTID",
 "field2": "",
 "field3": "",
 "fieldDelimiter": ",",
 "defaultSymbol": {
  "type": "esriSLS",
  "style": "esriSLSSolid",
  "width": 2
 },
 "defaultLabel": "",
 "uniqueValueInfos": [
  {
   "value": "",
   "label": "",
   "description": "",
   "symbol": {
    "type": "esriSLS",
    "style": "esriSLSSolid",
    "width": 2,
    "color": [
     115,77,0,255
    ]
   }
  },
  {
   "value": "Alberto",
   "label": "Alberto",
   "description": "",
   "symbol": {
    "type": "esriSLS",
    "style": "esriSLSSolid",
    "width": 2,
    "color": [
     120,122,1,255
    ]
   }
  },
  {
   "value": "Beryl",
   "label": "Beryl",
   "description": "",
   "symbol": {
    "type": "esriSLS",
    "style": "esriSLSSolid",
    "width": 2,
    "color": [
     83,133,3,255
    ]
   }
  },
  {
   "value": "Chris",
   "label": "Chris",
   "description": "",
   "symbol": {
    "type": "esriSLS",
    "style": "esriSLSSolid",
    "width": 2,
    "color": [
     39,143,4,255
    ]
   }
  },
  {
   "value": "Debby",
   "label": "Debby",
   "description": "",
   "symbol": {
    "type": "esriSLS",
    "style": "esriSLSSolid",
    "width": 2,
    "color": [
     255,25,86,255
    ]
   }
  }
]
}