java.lang.Object
com.esri.arcgisruntime.raster.RenderingRule
The rule that specifies how images are rendered or processed on an ArcGIS image service.
Raster images whose individual pixels represent elevation values can be rendered in a number of different ways, including representation of slope, aspect, hillshade, and shaded relief. A rendering rule defines how the ArcGIS image service renders its images.
You can create a RenderingRule
from a RenderingRuleInfo
or
a JSON string that specifies a service-defined or client-defined rendering rule.
For a list of functions and the syntax for these rendering rules, see
Raster function objects.
- Since:
- 100.1.0
-
Constructor Summary
ConstructorDescriptionRenderingRule
(RenderingRuleInfo renderingRuleInfo) Creates a RenderingRule from a rendering rule info.RenderingRule
(String renderingRuleJson) Creates a RenderingRule from a rendering rule JSON string. -
Method Summary
Modifier and TypeMethodDescriptionGets the rendering rule info.Gets the JSON used to create this rendering rule.
-
Constructor Details
-
RenderingRule
Creates a RenderingRule from a rendering rule info.- Parameters:
renderingRuleInfo
- info to create this rendering rule- Throws:
IllegalArgumentException
- if renderingRuleInfo is null- Since:
- 100.1.0
-
RenderingRule
Creates a RenderingRule from a rendering rule JSON string.- Parameters:
renderingRuleJson
- the JSON that could either be a raster function object used in the image service REST API or a predefined service rendering rule- Throws:
IllegalArgumentException
- if renderingRuleJson is null or empty- Since:
- 100.1.0
-
-
Method Details
-
getRenderingRuleInfo
Gets the rendering rule info.- Returns:
- the rendering rule info
- Since:
- 100.1.0
-
getRenderingRuleJson
Gets the JSON used to create this rendering rule.- Returns:
- the JSON used to create this rendering rule
- Since:
- 100.1.0
-