Description

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

Since: 100.0

Inheritance diagram for AGSClassBreak:

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

Method Documentation

◆ classBreak

+ (instancetype) classBreak

Initialize an AGSClassBreak.

Returns: A new class break

Since: 100

◆ classBreakWithDescription:label:minValue:maxValue:symbol:

+ (instancetype) classBreakWithDescription:	(NSString *)	description
label:	(NSString *)	label
minValue:	(double)	minValue
maxValue:	(double)	maxValue
symbol:	(AGSSymbol *)	symbol

Initialize an AGSClassBreak.

Parameters

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.

Returns: A new class break

Since: 100

◆ classBreakWithDescription:label:minValue:maxValue:symbol:alternateSymbols:

+ (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.

Parameters

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.

Since: 100.13

◆ 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

◆ initWithDescription:label:minValue:maxValue:symbol:

- (instancetype) initWithDescription:	(NSString *)	description
label:	(NSString *)	label
minValue:	(double)	minValue
maxValue:	(double)	maxValue
symbol:	(AGSSymbol *)	symbol

Initialize an AGSClassBreak.

Parameters

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.

Returns: A new class break

Since: 100

◆ initWithDescription:label:minValue:maxValue:symbol:alternateSymbols:

- (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.

Parameters

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.

Since: 100.13

◆ isEqualToClassBreak:

- (BOOL) isEqualToClassBreak: (AGSClassBreak *) other

Compares this class break to another for equality.

Parameters

other class break to compare this one to

Returns: whether equal or not

Since: 100

◆ 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

◆ alternateSymbols

- (NSArray<AGSSymbol *>*) alternateSymbols

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.

Since: 100.13

◆ breakDescription

- (NSString*) breakDescription

readwritenonatomiccopy

A description of the class break. "Cities with a population under 100,000", for example.

Since: 100

◆ label

- (NSString*) label

readwritenonatomiccopy

A label for the class break. "0 - 100000", for example.

Since: 100

◆ maxValue

- (double) maxValue

readwritenonatomicassign

The maximum value of the range that defines the break.

Since: 100

◆ minValue

- (double) minValue

readwritenonatomicassign

The minimum value of the range that defines the break.

Since: 100

◆ symbol

- (AGSSymbol*) symbol

readwritenonatomicstrong

A symbol used to represent elements in the class break.

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

Description

Instance Methods

Class Methods

Properties

Method Documentation

◆ classBreak

◆ classBreakWithDescription:label:minValue:maxValue:symbol:

◆ classBreakWithDescription:label:minValue:maxValue:symbol:alternateSymbols:

◆ fromJSON:error:

◆ initWithDescription:label:minValue:maxValue:symbol:

◆ initWithDescription:label:minValue:maxValue:symbol:alternateSymbols:

◆ isEqualToClassBreak:

◆ toJSON:

Property Documentation

◆ alternateSymbols

◆ breakDescription

◆ label

◆ maxValue

◆ minValue

◆ symbol

◆ unknownJSON

◆ unsupportedJSON