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: ScaleDependentRenderer
[ AMD Module Require | Legacy Module Require ]
require(["esri/renderers/ScaleDependentRenderer"], function(ScaleDependentRenderer) { /* code goes here */ });
Description
(Added at v3.7)
ScaleDependentRenderer provides the capability to apply multiple scale-dependent renderers to a layer. Each renderer is only applied to the layer at specific scale range or zoom range.
More information on working with rendering, smart mapping, and using visual variables can be found in the Data Visualization guide topic and the multiple samples referenced within this topic.Samples
Search for samples that use this class.Class hierarchy
esri/renderers/Renderer |_esri/renderers/ScaleDependentRenderer
Constructors
| Name | Summary |
|---|---|
| new ScaleDependentRenderer(options?) | Create a ScaleDependentRenderer. |
Properties
| Name | Type | Summary |
|---|---|---|
| rangeType | String | Indicates whether rendererInfos uses zoom range or scale range. |
| rendererInfos | Object | An array of objects, where each object defines a renderer and the zoom/scale range to which it applies. |
Methods
| Name | Return type | Summary |
|---|---|---|
| addRendererInfo(info) | ScaleDependentRenderer | Adds the specified renderer info to the array of existing renderers. |
| getColor(graphic, options?) | Color | Gets the color for the Graphic. |
| getOpacity(graphic, options?) | Number | Returns the opacity value for the specified graphic. |
| getRendererInfo(graphic) | Object | Returns the renderer info for the input graphic. |
| getRendererInfoByScale(scale) | Object | Returns the renderer info for the specified scale. |
| getRendererInfoByZoom() | Object | Returns the rendererInfo for the specified zoom level. |
| 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. |
| setRendererInfos(infos) | ScaleDependentRenderer | Replaces existing rendererInfos with new ones. |
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
Constructor Details
Create a ScaleDependentRenderer.
Parameters:
< |
Optional | Various options to configure this renderer. See the list below for details. |
options properties: < |
Optional | An array of objects where each object defines a renderer and the zoom or scale range to which it applies.
|
Sample:
var renderer1 = new DotDensityRenderer({
fields: [{
name: "M163_07",
color: new Color([52, 114, 53])
}],
dotValue: 4000,
dotSize: 2
});
var renderer2 = new DotDensityRenderer({
fields: [{
name: "M163_07",
color: new Color([52, 114, 53])
}],
dotValue: 1000,
dotSize: 2
});
var scaleDependentRenderer = new ScaleDependentRenderer({
rendererInfos: [{
renderer: renderer1,
maxScale: 10000000,
minScale: 20000000
}, {
renderer: renderer2,
maxScale: 5000000,
minScale: 10000000
}]
});
layer.setRenderer(scaleDependentRenderer);Property Details
<String
StringIndicates whether
rendererInfos uses zoom range or scale range. Known values:
"zoom" | "scale"<Object
ObjectAn array of objects, where each object defines a renderer and the zoom/scale range to which it applies.
Method Details
Adds the specified renderer info to the array of existing renderers. In order to view the change call the GraphicsLayer
redraw method. Return type:
ScaleDependentRendererParameters:
< |
Required | An object as defined in the rendererInfos property. |
Gets the color for the Graphic. (Added at v3.8)
Return type:
ColorParameters:
< |
Required | Graphic to get color from. |
< |
Optional | This optional parameter supports colorInfo. If none is provided, the Renderer.colorInfo will be used. |
Returns the opacity value for the specified graphic. This is calculated using the opacityInfo definition. (Added at v3.11)
Return type:
NumberParameters:
< |
Required | Returns the opacity value appropriate for the given graphic. This value is calculated based on the opacityInfo definition. |
< |
Optional | This optional parameter supports opacityInfo. If none is provided, the Renderer.opacityInfo will be used. |
Returns the renderer info for the input graphic. Note that the graphic should be part of a GraphicsLayer (or one of its sub-classes) that is added to the map.
Return type:
ObjectParameters:
< |
Required | The graphic for which you want to get renderer info. |
Returns the renderer info for the specified scale.
Return type:
ObjectParameters:
< |
Required | Returns the renderer info for the specified scale. |
Returns the angle of rotation (in degrees) for the graphic calculated using rotationInfo. (Added at v3.7)
Return type:
NumberParameters:
< |
Required | An input graphic for which you want to get the angle of rotation. |
< |
Optional | This optional parameter supports rotationInfo. If none is provided, the Renderer.rotationInfo will be used. |
Return the symbol size (in pixels) for the graphic, calculated using
sizeInfo. (Added at v3.7)Return type:
NumberParameters:
< |
Required | The graphic for which you want to calculate the symbol size. |
< |
Optional | This optional parameter supports sizeInfo. If none is provided, the Renderer.sizeInfo will be used.
|
Gets the symbol for the Graphic.
Return type:
SymbolParameters:
< |
Required | Graphic to symbolize. Used when creating a custom renderer. |
Replaces existing rendererInfos with new ones. The
infos argument is an array of objects as described in the rendererInfos property.
For the changes to take effect, call GraphicsLayer redraw after calling this method.Return type:
ScaleDependentRendererParameters:
< |
Required | An array of objects as defined in the rendererInfos property. |
Converts object to its ArcGIS Server JSON representation. (Added at v2.1)
Return type:
Object