Description
A symbol that changes based on distance from the camera.
Instances of this class represent a symbol that changes based on the distance, in meters, between the scene viewpoint's camera and the GeoElement that the symbol is assigned to.
A Range links a symbol to a minimum and maximum distance, the symbol is then only visible between that distance. The Ranges then links to the AGSDistanceCompositeSceneSymbol which will be used by a GeoElement and display each symbol within it's set distance.
- Since
- 100
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: |
| (BOOL) | - isEqualToSymbol: |
| (nullable id) | - toJSON: |
Class Methods | |
| (instancetype) | + distanceCompositeSceneSymbol |
| (nullable id< AGSJSONSerializable >) | + fromJSON:error: |
Properties | |
| NSArray< AGSDistanceSymbolRange * > * | ranges |
| NSDictionary< NSString *, id > * | unknownJSON |
| NSDictionary< NSString *, id > * | unsupportedJSON |
Method Documentation
◆ createSwatchWithBackgroundColor:screen:completion:
| - (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.
- Parameters
-
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.
- Since
- 100
◆ createSwatchWithCompletion:
| - (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.
- Parameters
-
completion block 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 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.
- Parameters
-
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 nilthen the main screen will be used.backgroundColor The desired background color of the image. completion A block that is invoked when operation completes.
- Since
- 100
◆ createSwatchWithWidth:height:screen:backgroundColor:completion:
| - (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 | |
◆ distanceCompositeSceneSymbol
| + (instancetype) distanceCompositeSceneSymbol |
◆ fromJSON:error:
|
staticrequiredinherited |
Initializes and returns an object from its JSON representation.
- Parameters
-
JSONObject NSDictionaryorNSArraycontaining the JSON.error encountered during the operation, if any.
- Since
- 100
◆ isEqualToSymbol:
| - (BOOL) isEqualToSymbol: | (AGSSymbol *) | other |
Compares this symbol to another for equality.
- Parameters
-
other The other symbol to compare this one to.
- Returns
YESif the two symbols are equal, otherwiseNO.
- Since
- 100
◆ toJSON:
|
requiredinherited |
Returns JSON representation for this object.
- Parameters
-
error encountered during the operation, if any.
- Returns
NSDictionaryorNSArraycontaining the JSON.
- Since
- 100
Reimplemented in AGSPortalItem.
Property Documentation
◆ ranges
|
readwritenonatomiccopy |
The ranges used by the symbol.
Each range links a symbol to a minimum and maximum distance, the symbol is then only visible between that distance. Ranges in the collection can have the same minimum and maximum distance. They can also have overlapping distances, which will cause their symbols to be displayed simultaneously if the camera is within that distance.
- Since
- 100
◆ unknownJSON
|
readrequirednonatomiccopyinherited |
A dictionary of values that was in the source JSON but was unparsed by API.
- Returns
NSDictionarycontaining the unknown JSON.
- Since
- 100
◆ unsupportedJSON
|
readnonatomiccopyinherited |
A dictionary of values that are supported by the REST API, but not exposed through the SDK API.
- Returns
NSDictionarycontaining the unsupported JSON.
- Since
- 100
