Renderer QML Type
A base class for renderers that use a collection of one or more symbols to display features in a Layer or graphics in a GraphicsOverlay. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: | |
| Inherited By: | ClassBreaksRenderer, DictionaryRenderer, HeatmapRenderer, SimpleRenderer, and UniqueValueRenderer |
- List of all members, including inherited members
- Renderer is part of QML Type List.
Properties
- json : jsobject
- rendererType : Enums.RendererType
- rotationExpression : string
- rotationType : Enums.RotationType
- sceneProperties : RendererSceneProperties
- unknownJson : jsobject
- unsupportedJson : jsobject
Signals
Methods
- Renderer clone()
- bool equals(Renderer renderer)
- Symbol symbolForDynamicEntity(DynamicEntity dynamicEntity)
- Symbol symbolForDynamicEntityObservation(DynamicEntityObservation dynamicEntityObservation)
- Symbol symbolForDynamicEntityObservationWithAttributeOverrides(DynamicEntityObservation dynamicEntityObservation, bool applyAttributeOverrides)
- Symbol symbolForDynamicEntityWithAttributeOverrides(DynamicEntity dynamicEntity, bool applyAttributeOverrides)
- Symbol symbolForFeature(Feature feature)
- Symbol symbolForFeatureWithOverrides(Feature feature, bool applyAttributeOverrides)
- Symbol symbolForGraphic(Graphic graphic)
- Symbol symbolForGraphicWithOverrides(Graphic graphic, bool applyAttributeOverrides)
Detailed Description
If the renderer contains more than a single symbol, it uses the rules to determine the symbol to apply to each geoelement, based on one or several attribute values. There are three basic types of renderers:
- SimpleRenderer - simple renderers use a single symbol for all geoelements.
- UniqueValueRenderer - unique value renders define a different symbol for each unique value of an attribute.
- ClassBreaksRenderer - class break renderers define a different symbol for each range of numeric values.
To symbolize and display the geoelements, apply the renderer to the FeatureLayer::renderer or the GraphicsOverlay::renderer.
A GraphicsOverlay can contain graphics with different geometry dimensions, such as a Point and Polygon. A Renderer, however, can only provide symbols with one geometry dimension. Therefore, if you apply a renderer to a graphics overlay, only graphics with the specified geometry dimension are displayed. All other graphics are not visible.
If you apply a Symbol directly to a graphic, the symbol displays in preference to the GraphicsOverlay::renderer.
For raster data, rendering is handled by a RasterRenderer.
Note: You cannot declare or create a component of this type in QML code.
This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.
| Type | Default Property |
|---|---|
| RendererSceneProperties | sceneProperties |
See also JsonSerializable.
Property Documentation
json : jsobject |
The JSON representation of this object.
This JSON can be used to instantiate the type instance.
[read-only] rendererType : Enums.RendererType |
Returns the renderer type (read-only).
See also Enums.RendererType.
rotationExpression : string |
The expression describing how attributes values are translated into a rotation to be applied to the GeoElement.
When an attribute name is specified in rotationExpression, it is enclosed in square brackets, for example, [Rotation].
rotationType : Enums.RotationType |
Indicates whether the rotation calculated from the rotationExpression is interpreted as arithmetic or geographic.
The options are:
- Enums.RotationTypeArithmetic - rotation is along the x-axis, with positive rotation being counter-clockwise.
- Enums.RotationTypeGeographic - rotation is along the y-axis, with positive rotation being clockwise.
Enums.RotationTypeArithmetic if an error occurs.
[default] sceneProperties : RendererSceneProperties |
The scene properties from this renderer.
This can be used to make changes to how a GeoElement is displayed in a SceneView.
[read-only] unknownJson : jsobject |
Returns the unknown JSON from the source JSON.
See also JsonSerializable.
[read-only] unsupportedJson : jsobject |
Returns the unsupported data from the source JSON.
See also JsonSerializable.
Signal Documentation
rotationExpressionChanged() |
Emitted when the rotationExpression property changes.
Note: The corresponding handler is onRotationExpressionChanged.
rotationTypeChanged() |
Emitted when the rotationType property changes.
Note: The corresponding handler is onRotationTypeChanged.
scenePropertiesChanged() |
Emitted when the sceneProperties property changes.
Note: The corresponding handler is onScenePropertiesChanged.
Method Documentation
Renderer clone() |
Creates a deep copy of this object.
bool equals(Renderer renderer) |
Compares two renderers for equality.
Returns whether this instance and the other renderer are equal.
|
Returns the symbol that should be used to visualize the given dynamic entity.
- dynamicEntity - The dynamic entity.
If the renderer is a DictionaryRenderer and its associated DictionarySymbolStyle references a style file hosted on ArcGIS Online or an ArcGIS Enterprise portal (also referred to as a web style), this method returns null. If the layer has rendered and the symbol is already drawn on the view, this method returns a valid MultilayerSymbol. If you want to get the symbol before the layer is rendered, use DictionarySymbolStyle.
This method was introduced in Esri.ArcGISRuntime 200.1.
|
Returns the symbol that should be used to visualize the given dynamic entity observation.
- dynamicEntityObservation - The dynamic entity observation.
If the renderer is a DictionaryRenderer and its associated DictionarySymbolStyle references a style file hosted on ArcGIS Online or an ArcGIS Enterprise portal (also referred to as a web style), this method returns null. If the layer has rendered and the symbol is already drawn on the view, this method returns a valid MultilayerSymbol. If you want to get the symbol before the layer is rendered, use DictionarySymbolStyle.
This method was introduced in Esri.ArcGISRuntime 200.1.
|
Returns the symbol that should be used to visualize the given dynamic entity observation with override attributes from the renderer.
- dynamicEntityObservation - The dynamic entity observation.
- applyAttributeOverrides - If set to
true, this applies the override attributes from the renderer to the symbol.
If applyAttributeOverrides is set to true, this method will get the symbol from the renderer and override the symbol properties with the overrides available on the renderer. These include visual variable size, color, opacity and rotation. If the override expression or attributes contain any information not known to either the renderer or observation (such as "scale"), that override will not be applied. If the override attributes are applied successfully a multilayer symbol will be returned else the original symbol will be returned.
If the renderer is a DictionaryRenderer and its associated DictionarySymbolStyle references a style file hosted on ArcGIS Online or an ArcGIS Enterprise portal (also referred to as a web style), this method returns null. If the layer has rendered and the symbol is already drawn on the view, this method returns a valid MultilayerSymbol. If you want to get the symbol before the layer is rendered, use DictionarySymbolStyle.
This method was introduced in Esri.ArcGISRuntime 200.1.
|
Returns the symbol that should be used to visualize the given dynamic entity with override attributes from the renderer.
- dynamicEntity - The dynamic entity.
- applyAttributeOverrides - If set to
true, this applies the override attributes from the renderer to the symbol.
If applyAttributeOverrides is set to true, this method will get the symbol from the renderer and override the symbol properties with the overrides available on the renderer. These include visual variable size, color, opacity and rotation. If the override expression or attributes contain any information not known to either the renderer or dynamic entity (such as "scale"), that override will not be applied. If the override attributes are applied successfully a multilayer symbol will be returned else the original symbol will be returned.
If the renderer is a DictionaryRenderer and its associated DictionarySymbolStyle references a style file hosted on ArcGIS Online or an ArcGIS Enterprise portal (also referred to as a web style), this method returns null. If the layer has rendered and the symbol is already drawn on the view, this method returns a valid MultilayerSymbol. If you want to get the symbol before the layer is rendered, use DictionarySymbolStyle.
This method was introduced in Esri.ArcGISRuntime 200.1.
Returns the symbol from the given feature.
If the renderer is a DictionaryRenderer and its associated DictionarySymbolStyle references a style file hosted on ArcGIS Online or an ArcGIS Enterprise portal (also referred to as a web style), this method returns null. If the layer has rendered and the symbol is already drawn on the view, this method returns a valid MultilayerSymbol. If you want to get the symbol before the layer is rendered, use DictionarySymbolStyle.
Returns the symbol that should be used to visualize the given feature with override attributes from renderer
If applyAttributeOverrides is set to true this method will get the symbol from the renderer and override the symbol properties with the overrides available on the renderer. There are four possible visual variable overrides which are size, color, rotation, and opacity.
If the override expression or attributes contain any information not known to the renderer or feature it will not be evaluated eg "scale", and thus the override will not be applied.
If the override attributes are applied successfully, then the returned symbol will be a MultilayerSymbol otherwise, the original symbol will be returned.
If the renderer is a DictionaryRenderer and its associated DictionarySymbolStyle references a style file hosted on ArcGIS Online or an ArcGIS Enterprise portal (also referred to as a web style), this method returns null. If the layer has rendered and the symbol is already drawn on the view, this method returns a valid MultilayerSymbol. If you want to get the symbol before the layer is rendered, use DictionarySymbolStyle.
This method was introduced in Esri.ArcGISRuntime 100.5.
Returns the symbol from the given graphic.
If the renderer is a DictionaryRenderer and its associated DictionarySymbolStyle references a style file hosted on ArcGIS Online or an ArcGIS Enterprise portal (also referred to as a web style), this method returns null. If the layer has rendered and the symbol is already drawn on the view, this method returns a valid MultilayerSymbol. If you want to get the symbol before the layer is rendered, use DictionarySymbolStyle.
Returns the symbol that should be used to visualize the given graphic with override attributes from renderer
If applyAttributeOverrides is set to true this method will get the symbol from the renderer and override the symbol properties with the overrides available on the renderer. There are four possible visual variable overrides which are size, color, rotation, and opacity.
If the override expression or attributes contain any information not known to the renderer or graphic it will not be evaluated eg "scale" and thus the override will not be applied.
If the override attributes are applied successfully, then the returned symbol will be a MultilayerSymbol otherwise, the original symbol will be returned.
If the renderer is a DictionaryRenderer and its associated DictionarySymbolStyle references a style file hosted on ArcGIS Online or an ArcGIS Enterprise portal (also referred to as a web style), this method returns null. If the layer has rendered and the symbol is already drawn on the view, this method returns a valid MultilayerSymbol. If you want to get the symbol before the layer is rendered, use DictionarySymbolStyle.
This method was introduced in Esri.ArcGISRuntime 100.5.