dojo.require("esri.renderers.SimpleRenderer")
esri.renderer.Renderer |_esri.renderer.SimpleRenderer
Name | Summary |
---|---|
new esri.renderer.SimpleRenderer(symbol) | Creates a new SimpleRenderer object with a Symbol parameter. |
new esri.renderer.SimpleRenderer(json) | Creates a new Simple Renderer. |
Name | Type | Summary |
---|---|---|
colorInfo | Object | Deprecated. |
description | String | Description for the renderer. |
label | String | Label for the renderer. |
opacityInfo | Object | Deprecated. |
rotationInfo | Object | Deprecated. |
sizeInfo | Object | Deprecated. |
symbol | Symbol | The symbol for the renderer. |
visualVariables | Object[] | This property allows you to define how to render values in a layer. |
Name | Return type | Summary |
---|---|---|
getColor(graphic, options?) | Color | Gets the color for the Graphic. |
getOpacity(graphic, options?) | Number | Returns the opacity value for the specified graphic. |
getRotationAngle(graphic, options?) | Number | Returns the angle of rotation (in degrees) for the graphic calculated using rotationInfo. |
getSize(graphic, options?) | Number | Return the symbol size (in pixels) for the graphic, calculated using sizeInfo . |
getSymbol(graphic) | Symbol | Gets the symbol for the Graphic. |
getVisualVariablesForType(type) | Object[] | Returns the visual variable of the specified type. |
hasVisualVariables() | Boolean | Indicates if the renderer has defined visualVariables. |
setColorInfo(info) | Renderer | Deprecated. |
setOpacityInfo(info) | Renderer | Deprecated. |
setRotationInfo(info) | Renderer | Deprecated. |
setSizeInfo(info) | Renderer | Deprecated. |
setVisualVariables(visualParams) | None | Sets the renderer with the specified visualVariables. |
toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
< > symbol |
Required | Symbol to use for the renderer. |
< > json |
Required | JSON object representing the SimpleRenderer. |
var simpleJson = { "type": "simple", "label": "", "description": "", "symbol": { "color": [210,105,30,191], "size": 6, "angle": 0, "xoffset": 0, "yoffset": 0, "type": "esriSMS", "style": "esriSMSCircle", "outline": { "color": [0,0,128,255], "width": 0, "type": "esriSLS", "style": "esriSLSSolid" } } }; var rend = new esri.renderer.SimpleRenderer(simpleJson);
Object
> colorInfovisualVariables
property. colorInfo
>< > colors |
Required | An array of colors defining the color ramp. The first color will be used to render minimum data value, and the last color will be used to render maximum data value. At least two colors are required. If there are three or more colors, the intermediate colors will be placed proportionally between the first and the last to create a multi-color ramp. Note: Specify either colors or stops to construct the color ramp. |
< > field |
Required | Name of the feature attribute field that contains the data value. |
< > legendOptions |
Optional | An object providing options for displaying the color ramp in the legend. See the object specification table for legendOptions below. |
< > maxDataValue |
Required | Maximum data value. |
< > minDataValue |
Required | Minimum data value. |
< > normalizationField |
Optional | Name of the feature attribute field by which the data value will be normalized. |
< > stops |
Optional | An array of objects defining the color ramp. Each object defines a stop on the color ramp. At least two stops are required.
colors or stops to construct the color ramp. If you use stops, then you do not need minDataValue and maxDataValue .
{ var stops = [ { value: 50, color: new Color([255,0,0]), label: "50" } ] } |
< > type |
Required | This value must be colorInfo . |
< > valueExpression |
Optional | An Arcade expression evaluating to a number. This expression can reference field values using the $feature global variable and perform mathematical calculations and logical evaluations at runtime. The values returned from this expression are the data used to drive the visualization. Therefore, this property is typically used as an alternative to field in visual variables. |
< > valueExpressionTitle |
Optional | The title identifying and describing the associated Arcade expression as defined in the valueExpression property. This is displayed as the title of the corresponding color ramp in the Legend in the absence of a provided title in the legendOptions property. |
legendOptions
>< > showLegend |
Optional | Indicates whether to show the color ramp in the legend. |
< > title |
Optional | Text that describes the visualization. This is displayed as the title of the corresponding color ramp in the Legend and takes precedence over the field alias or valueExpressionTitle . |
renderer.setColorInfo({ field: "M086_07", minDataValue: 0, maxDataValue: 100, colors: [ new Color([255, 255, 255]), new Color([127, 127, 0]) ] });
String
> descriptionString
> labelObject
> opacityInfovisualVariables
property. opacityInfo
object. (Added at v3.11)legendOptions
>< > showLegend |
Optional | Indicates whether to show the opacity ramp in the legend. |
< > title |
Optional | Text that describes the visualization. This is displayed as the title of the corresponding opacity ramp in the Legend and takes precedence over the field alias or valueExpressionTitle . |
opacityInfo
>< > field |
Required | Name of the feature attribute field that contains the data value. |
< > legendOptions |
Optional | An object providing options for displaying the opacity ramp in the legend. See the object specification table for legendOptions above. |
< > maxDataValue |
Required | Maximum data value. |
< > minDataValue |
Required | Minimum data value. |
< > normalizationField |
Optional | Name of the feature attribute field used to normalize the data value. |
< > opacityValues |
Required | An array of opacity values. Each value must be a number ranging from 0.0 to 1.0. The first value is used for features with minimum data value (or lower), the last value is used for features with maximum data value (or higher). At least two values are required. If there are three or more, the intermediate ones are applied proportionally between the first and last values. You need to specify either opacityValues or stops. |
< > stops |
Required | An array of objects, each with two properties: value and opacity. At least two stops are required. You need to specify opacityValues or stops. If you specify stops, then you do not need minDataValue and maxDataValue . |
< > type |
Required | This value must be opacityInfo . |
< > valueExpression |
Optional | An Arcade expression evaluating to a number. This expression can reference field values using the $feature global variable and perform mathematical calculations and logical evaluations at runtime. The values returned from this expression are the data used to drive the visualization. Therefore, this property is typically used as an alternative to field in visual variables. |
< > valueExpressionTitle |
Optional | The title identifying and describing the associated Arcade expression as defined in the valueExpression property. This is displayed as the title of the corresponding opacity ramp in the Legend in the absence of a provided title in the legendOptions property. |
var opacityInfo = { field:"fieldname", normalizationField: "normalizationField", minDataValue: 0, maxDataValue: 100, // stops: [ // { value: 10, opacity: 0 }, // { value: 39, opacity: 0.5 }, // { value: 68, opacity: 1 } // ] // OR, you can specify alphaValues using: opacityValues: [ 0, 1 ] };
Object
> rotationInfovisualVariables
property. rotationInfo
>< > field |
Required | Name of the feature attribute field that contains the angle of rotation. Or a function that returns the angle of rotation. A function is useful in cases where the angle of rotation is not available in an attribute field but needs to be computed using a mathematical expression or formula. For example, you can specify a function to compute wind or current direction when the underlying data is stored as U or V vectors. View example below. |
< > rotationType |
Optional | Defines the origin and direction of rotation depending on how the angle of rotation was measured. Can be one of the following:
The default value is "geographic". |
< > type |
Required | This value must be rotationInfo . |
< > valueExpression |
Optional | An Arcade expression evaluating to a number. This expression can reference field values using the $feature global variable and perform mathematical calculations and logical evaluations at runtime. The values returned from this expression are the data used to drive the visualization. Therefore, this property is typically used as an alternative to field in visual variables. |
Object
> sizeInfovisualVariables
property. proportionalSymbolInfo
.
See the object specifications table below for a list of its available properties.
In addition, regardless of the type of data described above, you can map a range of data values to a range of symbol sizes.
For point features, maker size is varied in proportion to the data value. For line features, stroke width is varied.
(Added at v3.7)legendOptions
>< > customValues |
Optional | An array of numbers representing the values to use for the stops in the legend. For example, if the size stops in the legend are 13, 171, 286, 404, and 534, you can adjust the stops in the legend to use more rounded numbers by setting them to this property. For example, sizeInfo.legendOptions.customValues = [10, 150, 300, 400, 500] . See the example snippet below. |
< > showLegend |
Optional | Indicates whether to show the size ramp in the legend. |
< > title |
Optional | Text that describes the visualization. This is displayed as the title of the corresponding size ramp in the Legend and takes precedence over the field alias or valueExpressionTitle . |
sizeInfo
>< > expression |
Optional | Deprecated. As of v3.19 use valueExpression instead. Allows a size to be defined based on the scale. "view.scale" is the only expression currently supported. Added at 3.14 |
< > field |
Required | Required name of the feature attribute field that contains the data value. Or a function that returns the data value. |
< > legendOptions |
Optional | An object providing options for displaying the size ramp in the legend. See the object specification table for legendOptions above. |
< > maxDataValue |
Optional | Maximum data value. |
< > maxSize |
Required | Specifies the largest marker size to use at any given map scale. Note: This is required if valueUnit is set to "unknown".
In version 3.13, this could only be set as a number which represented the symbol size in pixels.
Beginning with 3.14, it now is an object that contains:
"maxSize": { "type": "sizeInfo", "expression": "view.scale", "stops": [ {"value": 1128, "size": 80}, {"value": 288895, "size": 80}, {"value": 73957191, "size": 50}, {"value": 591657528, "size": 25} ] } |
< > minDataValue |
Required | Minimum data value (required if valueUnit is "unknown"). |
< > minSize |
Required | Specifies the smallest marker size to use at any given map scale. Note: This is required if valueUnit is set to "unknown".
In version 3.13, this could only be set as a number which represented the symbol size in pixels.
Beginning with 3.14, it now is an object that contains:
"maxSize": { "type": "sizeInfo", "expression": "view.scale", "stops": [ {"value": 1128, "size": 80}, {"value": 288895, "size": 80}, {"value": 73957191, "size": 50}, {"value": 591657528, "size": 25} ] } |
< > normalizationField |
Optional | Name of the feature attribute field used for data normalization. The data value obtained from field is divided by the value obtained from normalizationField before calculating the symbol size. |
< > stops |
Required | Added at 3.14
An array of objects that define the size of the symbol. It takes the following properties:
var stops = [ { "value": 1128, "size": 16 }, { "value": 288895, "size": 16 }, { "value": 73957191, "size": 9 }, { "value": 591657528, "size": 2 } ] |
< > type |
Required | This value must be sizeInfo . |
< > valueExpression |
Optional | An Arcade expression evaluating to a number. This expression can reference field values using the $feature global variable and perform mathematical calculations and logical evaluations at runtime. The values returned from this expression are the data used to drive the visualization. Therefore, this property is typically used as an alternative to field in visual variables. |
< > valueExpressionTitle |
Optional | The title identifying and describing the associated Arcade expression as defined in the valueExpression property. This is displayed as the title of the corresponding size ramp in the Legend in the absence of a provided title in the legendOptions property. |
< > valueRepresentation |
Required | Specifies what the data value measures if it represents a real world distance (required if valueUnit is not "unknown"). The following values are supported:
|
< > valueUnit |
Required | Required unit of measurement if the data represents a real world distance quantity. Valid values are:
"unknown","inches", "feet", "yards", "miles", "nautical-miles", "millimeters", "centimeters", "decimeters", "meters", "kilometers", "decimal-degrees" .
If the data value represents a non-distance quantity (for example traffic count, census data) then valueUnit should be set to "unknown" . |
{ field: "tree_canopy", valueUnit: "meters", valueRepresentation: "diameter" }
//ground area covered by trees measured in square feet. { field: "GroundArea", valueUnit: "feet", valueRepresentation: "area" }Specify
minSize
and maxSize
to smooth out outliers.
Data representing a non-distance quantity.
{ field: "avg_daily_traffic", valueUnit: "unknown", minSize: 1000, minDataValue: 8 }Specify
maxSize
to smooth out outliers.
Map a range of data values to a range of symbol sizes:
{ field: "avg_daily_traffic", valueUnit: "unknown", minSize: 1, maxSize: 10, minDataValue: 1000, maxDataValue: 100000 }To use legendOptions:
renderer.sizeInfo({ field: "POP_PER_DOC", minSize: 2, maxSize: 20, minDataValue: 100, maxDataValue: 10000, valueUnit: "unknown", legendOptions: { customValues: [100, 200, 300, 10000] } });
Symbol
> symbolObject[]
> visualVariablestype
property of the visual variable object to colorInfo. Then define the rest of the object using the colorInfo object specification table.NOTE:This does not apply to VectorFieldRenderer
.type
property of the visual variable object to sizeInfo. Then define the rest of the object using the sizeInfo object specification table.type
property of the visual variable object to opacityInfo. Then define the rest of the object using the opacityInfo object specification table.type
property of the visual variable object to rotationinfo. Then define the rest of the object using the rotationInfo object specification table.Color
< > graphic |
Required | Graphic to get color from. |
< > options |
Optional | This optional parameter supports colorInfo . If none is provided, the Renderer.colorInfo will be used. |
Number
< > graphic |
Required | Returns the opacity value appropriate for the given graphic. This value is calculated based on the opacityInfo definition. |
< > options |
Optional | This optional parameter supports opacityInfo . If none is provided, the Renderer.opacityInfo will be used. |
Number
< > graphic |
Required | An input graphic for which you want to get the angle of rotation. |
< > options |
Optional | This optional parameter supports rotationInfo . If none is provided, the Renderer.rotationInfo will be used. |
sizeInfo
. (Added at v3.7)Number
< > graphic |
Required | The graphic for which you want to calculate the symbol size. |
< > options |
Optional | This optional parameter supports sizeInfo . If none is provided, the Renderer.sizeInfo will be used.
|
Symbol
< > graphic |
Required | Graphic to symbolize. Used when creating a custom renderer. |
Object[]
< > type |
Required | The type of visual variable desired. Supported Values: colorInfo (does not apply to VectorFieldRenderer ) | sizeInfo | opacityInfo |
Boolean
colorInfo
property. (Added at v3.8)Renderer
info
parameter. The info parameter is an object with the same properties as opacityInfo.
(Added at v3.11)Renderer
< > info |
Required | The info parameter is an object with the same properties as opacityInfo. |
renderer.setOpacityInfo( var opacityInfo = { field:"fieldname", normalizeField: "normalizeFieldName", minDataValue: 0, maxDataValue: 100, // stops: [ // { value: 10, opacity: 0 }, // { value: 39, opacity: 0.5 }, // { value: 68, opacity: 1 } // ] // OR, you can specify alphaValues using: opacityValues: [ 0, 1 ] });
rotationInfo
. (Added at v3.7)Renderer
< > info |
Required | An object with the same properties as rotationInfo. |
info
object has the same properties as sizeInfo
.
type
only applies if rendering sizeInfo using visualvariables. setProportionalSymbolInfo
.
Renderer
< > visualParams |
Required | The specified visualVariables. |
Object