AGSSimpleRenderer Class Reference

Description

A simple renderer based on a single symbol.

Instances of this class represent simple renderers. Renderers symbolize all graphics in a graphics layer or features in a feature layer according to a given scheme. This is easier than symbolizing each graphic individually.

Simple renderers use a simple scheme - the same symbol is used for all graphics and features.

Since

100

Inheritance diagram for AGSSimpleRenderer:

Instance Methods
(instancetype)	- initWithSymbol:
(BOOL)	- isEqualToRenderer:
(AGSSymbol *)	- symbolForFeature:
(AGSSymbol *)	- symbolForFeature:applyAttributeOverrides:
(AGSSymbol *)	- symbolForGraphic:
(AGSSymbol *)	- symbolForGraphic:applyAttributeOverrides:
(nullable id)	- toJSON:

Class Methods
(nullable id< AGSJSONSerializable >)	+ fromJSON:error:
(instancetype)	+ simpleRenderer
(instancetype)	+ simpleRendererWithSymbol:

Properties
NSString *	label
NSString *	rendererDescription
NSString *	rotationExpression
AGSRotationType	rotationType
AGSRendererSceneProperties *	sceneProperties
AGSSymbol *	symbol
NSDictionary< NSString *, id > *	unknownJSON
NSDictionary< NSString *, id > *	unsupportedJSON

Method Documentation

fromJSON:error:

+ (nullable id<AGSJSONSerializable>) fromJSON: (id)  JSONObject error: (NSError **)  error

staticrequiredinherited

Initializes and returns an object from its JSON representation.

Parameters

JSONObject	NSDictionary or NSArray containing the JSON.
error	encountered during the operation, if any.

Since

100

initWithSymbol:

- (instancetype) initWithSymbol:

(nullable AGSSymbol *)

symbol

Initialize renderer with desired symbol.

Parameters

symbol

The symbol to be used to render all graphics.

Returns

A new simple renderer object.

Since

100

isEqualToRenderer:

- (BOOL) isEqualToRenderer:

(AGSRenderer *)

other

Compares two renderers for equality.

Parameters

other

renderer to compare this one to.

Returns

YES if other is equal to self, otherwise NO.

Since

100

simpleRenderer

+ (instancetype) simpleRenderer

Initialize renderer without any symbol.

Returns

A new simple renderer object.

Since

100

simpleRendererWithSymbol:

+ (instancetype) simpleRendererWithSymbol:

(nullable AGSSymbol *)

symbol

Initialize renderer with desired symbol.

Parameters

symbol

The symbol to be used to render all graphics.

Returns

A new simple renderer object.

Since

100

symbolForFeature:

- (AGSSymbol*) symbolForFeature:

(AGSFeature *)

feature

Creates a symbol for the feature based on the scheme used by this renderer.

Parameters

feature

The feature to determine the symbol for.

Returns

A new symbol for the feature.

Since

100

symbolForFeature:applyAttributeOverrides:

- (AGSSymbol*) symbolForFeature:		(AGSFeature *)	feature
applyAttributeOverrides:		(BOOL)	applyAttributeOverrides

Creates a symbol for the feature based on the scheme used by this renderer and optionally apply attribute overrides.

If applyAttributeOverrides is set to YES and renderer contains an override expression, this method will return a symbol modified by the expression. If the expression cannot be properly evaluated due to missing fields or external data, then the original symbol is returned.

Parameters

feature	The feature to determine the symbol for.
applyAttributeOverrides	If set YES, applies the override attributes from the renderer.

Returns

A symbol for the feature.

Since

105

symbolForGraphic:

- (AGSSymbol*) symbolForGraphic:

(AGSGraphic *)

graphic

Creates a symbol for the graphic based on the scheme used by this renderer.

Parameters

graphic

The graphic to determine the symbol for.

Returns

A symbol for the graphic.

Since

100

symbolForGraphic:applyAttributeOverrides:

- (AGSSymbol*) symbolForGraphic:		(AGSGraphic *)	graphic
applyAttributeOverrides:		(BOOL)	applyAttributeOverrides

Creates a symbol for the graphic based on the scheme used by this renderer and optionally apply attribute overrides.

Parameters

graphic	The graphic to determine the symbol for.
applyAttributeOverrides	If set YES, applies the override attributes from the renderer.

Returns

A symbol for the graphic.

Since

100.5

toJSON:

- (nullable id) toJSON: (NSError **)  error

requiredinherited

Returns JSON representation for this object.

Parameters

error

encountered during the operation, if any.

Returns

NSDictionary or NSArray containing the JSON.

Since

100

Reimplemented in AGSPortalItem.

Property Documentation

label

- (NSString*) label

readwritenonatomiccopy

The label for the renderer.

Since

100

rendererDescription

- (NSString*) rendererDescription

readwritenonatomiccopy

The description for the renderer

Since

100

rotationExpression

- (NSString*) rotationExpression

readwritenonatomiccopyinherited

Constant value or an expression that specifies the angle of rotation based on a feature's attribute value. When an attribute name is specified in rotationExpression, it's enclosed in square brackets, for example, [Rotation].

Since

100

rotationType

- (AGSRotationType) rotationType

readwritenonatomicassigninherited

Controls the origin and direction of rotation. If the rotationType is defined as AGSRotationTypeTypeArithmetic, the symbol is rotated from East in a counter-clockwise direction where East is the 0° axis. If the rotationType is defined as AGSRotationTypeGeographic, the symbol is rotated from North in a clockwise direction where North is the 0° axis.

Since

100

sceneProperties

- (AGSRendererSceneProperties*) sceneProperties

readwritenonatomicstronginherited

Properties to apply only when rendering data in 3D scenes using AGSSceneView.

Since

100

symbol

- (AGSSymbol*) symbol

readwritenonatomicstrong

The symbol for the renderer.

Since

100

unknownJSON

- (NSDictionary<NSString*,id>*) unknownJSON

readrequirednonatomiccopyinherited

A dictionary of values that was in the source JSON but was unparsed by API.

Returns

NSDictionary containing the unknown JSON.

Since

100

unsupportedJSON

- (NSDictionary<NSString*,id>*) unsupportedJSON

readnonatomiccopyinherited

A dictionary of values that are supported by the REST API, but not exposed through the SDK API.

Returns

NSDictionary containing the unsupported JSON.

Since

100