ArcGIS Runtime SDK for iOS
100.15
|
Defines a set of symbols that make up a single symbol.
Instances of this class represent composite symbols. Composite symbol contains an array of symbols that can be used to compose more complex 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.
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 |
+ (instancetype) compositeSymbol |
Initialize an empty composite symbol.
+ (instancetype) compositeSymbolWithSymbols: | (NSArray< AGSSymbol * > *) | symbols |
Initialize the composite symbol with the provided symbols
symbols | 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. |
- (id<AGSCancelable>) createSwatchWithBackgroundColor: | (nullable AGSColor *) | backgroundColor | |
screen: | (nullable AGSScreen *) | screen | |
completion: | (void(^)(AGSImage *__nullable swatch, NSError *__nullable error)) | completion | |
Creates swatch with provided background color.
backgroundColor | Desired background color of the image. |
screen | Screen that the swatch will be rendered for. If you specify nil then the main screen will be used. |
completion | A block that is invoked when the operation completes. |
- (id<AGSCancelable>) createSwatchWithCompletion: | (void(^)(AGSImage *__nullable swatch, NSError *__nullable error)) | completion |
Creates a swatch with a clear background color. This method uses main screen's scale to determine the size of the image.
completion | block that is invoked when operation completes. |
- (id<AGSCancelable>) createSwatchWithGeometry: | (AGSGeometry *) | geometry | |
width: | (NSInteger) | width | |
height: | (NSInteger) | height | |
screen: | (nullable AGSScreen *) | screen | |
backgroundColor: | (nullable AGSColor *) | backgroundColor | |
completion: | (void(^)(AGSImage *__nullable swatch, NSError *__nullable error)) | completion | |
Creates a swatch using the 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.
geometry | The geometry of the symbol to be drawn in the swatch image. The specified geometry is in DIPs, with the point {0,0} located at the center of the swatch image. The X-axis increases towards the right side of the swatch image. The Y-axis increases towards the top of the swatch image. For example: when creating a swatch for an AGSMarkerSymbol , specifying a geometry of {10,10} will draw the marker 10 DIPs up and to the right of the center of the swatch. The geometry type (AGSPoint , AGSPolyline , AGSPolygon ) should correspond to the symbol type (AGSMarkerSymbol , AGSLineSymbol , AGSFillSymbol ). The geometry's spatial reference is ignored. |
width | Desired width of the image in pixels. |
height | Desired height of the image in pixels. |
screen | The screen that the swatch will be rendered for. If you specify nil then the main screen will be used. |
backgroundColor | The desired background color of the image. |
completion | A block that is invoked when operation completes. |
- (nullable id<AGSCancelable>) createSwatchWithWidth: | (NSInteger) | width | |
height: | (NSInteger) | height | |
screen: | (nullable AGSScreen *) | screen | |
backgroundColor: | (nullable AGSColor *) | backgroundColor | |
completion: | (void(^)(AGSImage *__nullable swatch, NSError *__nullable error)) | completion | |
|
staticrequiredinherited |
Initializes and returns an object from its JSON representation.
JSONObject | NSDictionary or NSArray containing the JSON. |
error | encountered during the operation, if any. |
- (instancetype) initWithSymbols: | (NSArray< AGSSymbol * > *) | symbols |
Initialize the composite symbol with the provided symbols
symbols | 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. |
- (BOOL) isEqualToSymbol: | (AGSSymbol *) | other |
Compares this symbol to another for equality.
other | The other symbol to compare this one to. |
YES
if the two symbols are equal, otherwise NO
.
|
requiredinherited |
Returns JSON representation for this object.
error | encountered during the operation, if any. |
NSDictionary
or NSArray
containing the JSON. Reimplemented in AGSPortalItem.
|
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.
|
readrequirednonatomiccopyinherited |
A dictionary of values that was in the source JSON but was unparsed by API.
NSDictionary
containing the unknown JSON.
|
readnonatomiccopyinherited |
A dictionary of values that are supported by the REST API, but not exposed through the SDK API.
NSDictionary
containing the unsupported JSON.