ArcGIS Runtime SDK for iOS: AGSRenderingRule Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSRenderingRule Class Reference

Description

An instance of this class represents the rule for how the requested image should be rendered or processed.

A rendering rule defines the processing that is to be done to the ArcGIS image service. An instance of this class can be created from an AGSRenderingRuleInfo or a JSON string that specifies a service-defined or client-defined rendering rule.

See raster functions for a list of functions and the syntax for rendering rules.

See also
AGSImageServiceRaster::renderingRule
Since
100.1
Inheritance diagram for AGSRenderingRule:
AGSObject

Instance Methods

(instancetype) - initWithRenderingRuleInfo:
 
(instancetype) - initWithRenderingRuleJSON:
 

Class Methods

(instancetype) + renderingRuleWithRenderingRuleInfo:
 
(instancetype) + renderingRuleWithRenderingRuleJSON:
 

Properties

AGSRenderingRuleInforenderingRuleInfo
 
NSDictionary< NSString *, id > * renderingRuleJSON
 

Method Documentation

◆ initWithRenderingRuleInfo:

- (instancetype) initWithRenderingRuleInfo: (AGSRenderingRuleInfo *)  renderingRuleInfo

Creates a rendering rule with information about a pre-existing rendering rule available in the ArcGIS image service.

Parameters
renderingRuleInfospecifying a predefined rendering rule in the ArcGIS image service.
Since
100.1

◆ initWithRenderingRuleJSON:

- (instancetype) initWithRenderingRuleJSON: (NSDictionary< NSString *, id > *)  renderingRuleJSON

Creates a rendering rule with provided JSON definition.

Parameters
renderingRuleJSONdefining a new rendering rule.
Since
100.1

◆ renderingRuleWithRenderingRuleInfo:

+ (instancetype) renderingRuleWithRenderingRuleInfo: (AGSRenderingRuleInfo *)  renderingRuleInfo

Creates a rendering rule with information about a pre-existing rendering rule available in the ArcGIS image service.

Parameters
renderingRuleInfospecifying a predefined rendering rule in the ArcGIS image service.
Returns
A new rendering rule.
Since
100.1

◆ renderingRuleWithRenderingRuleJSON:

+ (instancetype) renderingRuleWithRenderingRuleJSON: (NSString *)  renderingRuleJSON

Creates a rendering rule with provided JSON definition.

Parameters
renderingRuleJSONdefining a new rendering rule.
Returns
A new rendering rule.
Since
100.1

Property Documentation

◆ renderingRuleInfo

- (AGSRenderingRuleInfo*) renderingRuleInfo
readnonatomicstrong

Information about a predefined rendering rule in the ArcGIS image service. Either this property or renderingRuleJSON may be populated, but not both.

Since
100.1

◆ renderingRuleJSON

- (NSDictionary<NSString*,id>*) renderingRuleJSON
readnonatomiccopy

JSON definition of a new rendering rule. Either this property or renderingRuleInfo may be populated, but not both.

Since
100.1