ArcGIS Runtime SDK for iOS
100.15
|
A class break object used to categorize a group of values that fall within a range of values.
The AGSClassBreak
is used to categorize a group of values that fall within a range defined by AGSClassBreak::minValue
and AGSClassBreak::maxValue
properties. A value is determined to be within this range if it is greater than the AGSClassBreak::minValue
but less than or equal to the AGSClassBreak::maxValue
. When written as an algebraic equation, it would look like (AGSClassBreak::minValue
< value <= AGSClassBreak::maxValue
).
For example, assume you wanted to create a set of AGSClassBreak
categories based on the following integers (0, 0, 1, 1, 2, 4, 6, 6, 7, 10).
The following table would be helpful in defining the AGSClassBreak
range settings
categorized group of values | count | label | minValue | maxValue |
---|---|---|---|---|
0 | 2 | none | -1 | 0 |
1-2 | 3 | one to two | 0 | 2 |
3-5 | 1 | three to five | 2 | 5 |
6-10 | 4 | six to ten | 5 | 10 |
Instance Methods | |
(instancetype) | - initWithDescription:label:minValue:maxValue:symbol: |
(instancetype) | - initWithDescription:label:minValue:maxValue:symbol:alternateSymbols: |
(BOOL) | - isEqualToClassBreak: |
(nullable id) | - toJSON: |
Class Methods | |
(instancetype) | + classBreak |
(instancetype) | + classBreakWithDescription:label:minValue:maxValue:symbol: |
(instancetype) | + classBreakWithDescription:label:minValue:maxValue:symbol:alternateSymbols: |
(nullable id< AGSJSONSerializable >) | + fromJSON:error: |
Properties | |
NSArray< AGSSymbol * > * | alternateSymbols |
NSString * | breakDescription |
NSString * | label |
double | maxValue |
double | minValue |
AGSSymbol * | symbol |
NSDictionary< NSString *, id > * | unknownJSON |
NSDictionary< NSString *, id > * | unsupportedJSON |
+ (instancetype) classBreak |
+ (instancetype) classBreakWithDescription: | (NSString *) | description | |
label: | (NSString *) | label | |
minValue: | (double) | minValue | |
maxValue: | (double) | maxValue | |
symbol: | (AGSSymbol *) | symbol | |
Initialize an AGSClassBreak
.
description | A description of the class break. "Cities with a population under 100,000", for example. |
label | A label for the class break. "0 - 100000", for example. |
minValue | The minimum value of the range that defines the break. |
maxValue | The maximum value of the range that defines the break. |
symbol | A symbol used to represent elements in the class break. |
+ (instancetype) classBreakWithDescription: | (NSString *) | description | |
label: | (NSString *) | label | |
minValue: | (double) | minValue | |
maxValue: | (double) | maxValue | |
symbol: | (nullable AGSSymbol *) | symbol | |
alternateSymbols: | (NSArray< AGSSymbol * > *) | alternateSymbols | |
Creates a new class break object with alternate symbols.
A class break can have alternate symbols to the primary symbol. Alternate symbols allow you to tailor the visualization of class break at different scales by selecting a different symbol for different scales. Alternate symbols are supported only when the class break's primary symbol and alternate symbols are of type AGSMultilayerSymbol
and have AGSSymbolReferenceProperties
defining valid min/max scales at which the symbol becomes visible. The renderer will pick only one symbol at a given map scale. If the map's scale falls within the primary symbol's scale range, the primary symbol is used. If not, then the first alternate symbol matching the current map scale is used for rendering. A symbol becomes visible if the map scale is less than or equal to symbol's minimum scale and greater than symbol's maximum scale. For more information on Scale-based symbol classes and alternate symbols see the following documentation: https://pro.arcgis.com/en/pro-app/latest/help/mapping/layer-properties/scale-based-symbol-classes.htm.
description | A description of the class break. For example, "Cities with a population under 100,000". |
label | A label for the class break. For example, "0 - 100000". |
minValue | The minimum value of the range that defines the break. |
maxValue | The maximum value of the range that defines the break. |
symbol | A symbol used to represent elements in the class break. |
alternateSymbols | The alternate symbols for the class break. Only AGSMultilayerSymbol is supported as alternates. |
|
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) initWithDescription: | (NSString *) | description | |
label: | (NSString *) | label | |
minValue: | (double) | minValue | |
maxValue: | (double) | maxValue | |
symbol: | (AGSSymbol *) | symbol | |
Initialize an AGSClassBreak
.
description | A description of the class break. "Cities with a population under 100,000", for example. |
label | A label for the class break. "0 - 100000", for example. |
minValue | The minimum value of the range that defines the break. |
maxValue | The maximum value of the range that defines the break. |
symbol | A symbol used to represent elements in the class break. |
- (instancetype) initWithDescription: | (NSString *) | description | |
label: | (NSString *) | label | |
minValue: | (double) | minValue | |
maxValue: | (double) | maxValue | |
symbol: | (nullable AGSSymbol *) | symbol | |
alternateSymbols: | (NSArray< AGSSymbol * > *) | alternateSymbols | |
Creates a new class break object with alternate symbols.
A class break can have alternate symbols to the primary symbol. Alternate symbols allow you to tailor the visualization of class break at different scales by selecting a different symbol for different scales. Alternate symbols are supported only when the class break's primary symbol and alternate symbols are of type AGSMultilayerSymbol
and have AGSSymbolReferenceProperties
defining valid min/max scales at which the symbol becomes visible. The renderer will pick only one symbol at a given map scale. If the map's scale falls within the primary symbol's scale range, the primary symbol is used. If not, then the first alternate symbol matching the current map scale is used for rendering. A symbol becomes visible if the map scale is less than or equal to symbol's minimum scale and greater than symbol's maximum scale. For more information on Scale-based symbol classes and alternate symbols see the following documentation: https://pro.arcgis.com/en/pro-app/latest/help/mapping/layer-properties/scale-based-symbol-classes.htm.
description | A description of the class break. For example, "Cities with a population under 100,000". |
label | A label for the class break. For example, "0 - 100000". |
minValue | The minimum value of the range that defines the break. |
maxValue | The maximum value of the range that defines the break. |
symbol | A symbol used to represent elements in the class break. |
alternateSymbols | The alternate symbols for the class break. Only AGSMultilayerSymbol is supported as alternates. |
- (BOOL) isEqualToClassBreak: | (AGSClassBreak *) | other |
Compares this class break to another for equality.
other | class break to compare this one to |
|
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 alternate symbols for the class break's primary symbol.
Symbols in this array should be of type AGSMultilayerSymbol
and must have AGSSymbolReferenceProperties
set with valid minimum and maximum scales at which symbol becomes visible. The renderer will pick only one symbol at a given map scale. If the map's scale falls within the primary symbol's scale range, primary symbol is used. If not, then the first alternate symbol matching the current map scale is used for rendering. A symbol becomes visible if the map scale is less than or equal to symbol's minimum scale and greater than symbol's maximum scale.
|
readwritenonatomiccopy |
A description of the class break. "Cities with a population under 100,000", for example.
|
readwritenonatomiccopy |
A label for the class break. "0 - 100000", for example.
|
readwritenonatomicassign |
The maximum value of the range that defines the break.
|
readwritenonatomicassign |
The minimum value of the range that defines the break.
|
readwritenonatomicstrong |
A symbol used to represent elements in the class break.
|
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.