Renderer QML Type
The base type for renderers. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: | |
| Inherited By: | ClassBreaksRenderer, DictionaryRenderer, HeatmapRenderer, SimpleRenderer, and UniqueValueRenderer |
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 symbolForFeature(Feature feature)
- Symbol symbolForFeatureWithOverrides(Feature feature, bool applyAttributeOverrides)
- Symbol symbolForGraphic(Graphic graphic)
- Symbol symbolForGraphicWithOverrides(Graphic graphic, bool applyAttributeOverrides)
Detailed Description
Note: You cannot declare or create a component of this type in QML code.
Renderers use a scheme to symbolize graphics in a graphics overlay or features in a feature layer. Applying a renderer to a layer alleviates the need to individually set the symbol for every graphic or feature in that layer. Renderers define the type, color and size of the symbol. Some renderers will apply the same symbol to every graphic or feature in the layer. Other renderers apply different symbols to each graphic or feature based on attribute values.
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.
rendererType : Enums.RendererType |
Returns the renderer type (read-only).
See also Enums.RendererType.
rotationExpression : string |
The expression that specifies the angle of rotation based on an attribute value.
When an attribute name is specified in rotationExpression, it is enclosed in square brackets, for example, [Rotation].
rotationType : Enums.RotationType |
The origin and direction of rotation.
If the rotationType is defined as arithmetic, the symbol is rotated from east in a counterclockwise direction where east is the 0 axis. If the rotationType is defined as geographic, the symbol is rotated from north in a clockwise direction where north is the 0 axis.
See also Enums.RotationType.
[default] sceneProperties : RendererSceneProperties |
The scene properties from this renderer.
unknownJson : jsobject |
Returns the unknown JSON from the source JSON.
See also JsonSerializable.
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 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.
This method was introduced in Esri.ArcGISRuntime 100.5.
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.
This method was introduced in Esri.ArcGISRuntime 100.5.