ArcGIS Runtime SDK for iOS: AGSCompositeSymbol Class Reference
ArcGIS Runtime SDK for iOS  100.6
AGSCompositeSymbol Class Reference

Description

Instances of this class represent composite symbols. Composite symbols are simply a combination of two or more symbols. Each symbol can represent the same or a different visual aspect, for example the fill, outline, vertex,etc.

For example, consider a composite symbol of an AGSSimpleMarkerSymbol and an AGSSimpleFillSymbol. A polygon displayed with this composite symbol would display the marker at each vertex along the polygon, and fill the interior space of each ring in the polygon.

Since
100
Inheritance diagram for AGSCompositeSymbol:
AGSSymbol AGSObject <AGSJSONSerializable>

Instance Methods

(id< AGSCancelable >) - createSwatchWithBackgroundColor:screen:completion:
 
(id< AGSCancelable >) - createSwatchWithCompletion:
 
(id< AGSCancelable >) - createSwatchWithGeometry:width:height:screen:backgroundColor:completion:
 
(nullable id< AGSCancelable >) - createSwatchWithWidth:height:screen:backgroundColor:completion:
 
(instancetype) - initWithSymbols:
 
(BOOL) - isEqualToSymbol:
 
(nullable id) - toJSON:
 

Class Methods

(instancetype) + compositeSymbol
 
(instancetype) + compositeSymbolWithSymbols:
 
(nullable id< AGSJSONSerializable >) + fromJSON:error:
 

Properties

NSArray< AGSSymbol * > * symbols
 
NSDictionary< NSString *, id > * unknownJSON
 
NSDictionary< NSString *, id > * unsupportedJSON
 

Method Documentation

§ compositeSymbol()

+ (instancetype) compositeSymbol

Initialize an empty composite symbol.

Since
100
Returns
initialized composite symbol

§ compositeSymbolWithSymbols:()

+ (instancetype) compositeSymbolWithSymbols: (NSArray< AGSSymbol * > *)  symbols

Initialize the composite symbol with the provided symbols

Parameters
symbolsThe individual symbols which make up this composite symbol. The symbols are drawn in the order they are stored in the array. The 0th symbol is drawn first, then the next symbol is drawn on top of it, and so on.
Since
100
Returns
initialized composite symbol

§ createSwatchWithBackgroundColor:screen:completion:()

- (id<AGSCancelable>) createSwatchWithBackgroundColor: (nullable AGSColor *)  backgroundColor
screen: (nullable UIScreen *)  screen
completion: (void(^)(AGSImage *__nullable swatch, NSError *__nullable error))  completion 

Creates swatch with provided background color.

Parameters
backgroundColorDesired background color of the image
screenScreen that the swatch will be rendered for. If you specify nil then the main screen will be used.
completionblock that is invoked when operation completes.
Since
100

§ createSwatchWithCompletion:()

- (id<AGSCancelable>) createSwatchWithCompletion: (void(^)(AGSImage *__nullable swatch, NSError *__nullable error))  completion

Creates swatch with provided background color. This method uses main screen's scale to determine the size of the image.

Parameters
completionblock that is invoked when operation completes.
Since
100

§ createSwatchWithGeometry:width:height:screen:backgroundColor:completion:()

- (id<AGSCancelable>) createSwatchWithGeometry: (AGSGeometry *)  geometry
width: (NSInteger)  width
height: (NSInteger)  height
screen: (nullable UIScreen *)  screen
backgroundColor: (nullable AGSColor *)  backgroundColor
completion: (void(^)(AGSImage *__nullable swatch, NSError *__nullable error))  completion 

Creates swatch using provided geometry and other parameters. This is the most configurable of the methods to create swatches. You can pass the pixels per inch that you would like the image to be rendered at. This will determine how many pixels are used to render symbols of sizes that are specified in Points.

Parameters
geometryGeometry of the symbol to be drawn in the swatch image. The coordinates of the specified geometry are in pixels, with the point (0,0) located at the centerpoint of the swatch image. The x-axis increases towards the right-hand side of the swatch image. The y-axis increases towards the top of the swatch image. For example: when creating a swatch for a AGSSimpleMarkerSymbol, specifying a geometry of (10,10) will draw the marker 10 pixels up and to the right of the center of the swatch. The geometry (AGSPoint, AGSPolyline, AGSPolygon) correspond to the symbol (AGSSimpleMarkerSymbol, AGSSimpleLineSymbol, AGSSimpleFillSymbol). The geometry's spatial reference is ignored.
widthDesired width of the image in pixels
heightDesired height of the image in pixels
screenScreen that the swatch will be rendered for. If you specify nil then the main screen will be used.
backgroundColorDesired background color of the image
completionblock that is invoked when operation completes.
Since
100

§ createSwatchWithWidth:height:screen:backgroundColor:completion:()

- (nullable id<AGSCancelable>) createSwatchWithWidth: (NSInteger)  width
height: (NSInteger)  height
screen: (nullable UIScreen *)  screen
backgroundColor: (nullable AGSColor *)  backgroundColor
completion: (void(^)(AGSImage *__nullable swatch, NSError *__nullable error))  completion 

§ fromJSON:error:()

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

Initializes and returns an object from its JSON representation.

Parameters
JSONObjectNSDictionary or NSArray containing the JSON.
errorencountered during the operation, if any.
Since
100

§ initWithSymbols:()

- (instancetype) initWithSymbols: (NSArray< AGSSymbol * > *)  symbols

Initialize the composite symbol with the provided symbols

Parameters
symbolsThe individual symbols which make up this composite symbol. The symbols are drawn in the order they are stored in the array. The 0th symbol is drawn first, then the next symbol is drawn on top of it, and so on.
Since
100
Returns
initialized composite symbol

§ isEqualToSymbol:()

- (BOOL) isEqualToSymbol: (AGSSymbol *)  other

Compares this symbol to another for equality

Parameters
othersymbol to compare this one to
Returns
whether the two symbols are equal or not
Since
100

§ toJSON:()

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

Returns JSON representation for this object.

Parameters
errorencountered during the operation, if any.
Returns
NSDictionary or NSArray containing the JSON.
Since
100

Reimplemented in AGSPortalItem.

Property Documentation

§ symbols

- (NSArray<AGSSymbol*>*) symbols
readwritenonatomiccopy

The individual symbols which make up this composite symbol. The symbols are drawn in the order they are stored in the array. The 0th symbol is drawn first, then the next symbol is drawn on top of it, and so on.

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