ArcGIS Runtime SDK for iOS: AGSClassBreak Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSClassBreak Class Reference

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:
AGSObject <AGSJSONSerializable>

Instance Methods

(instancetype) - initWithDescription:label:minValue:maxValue:symbol:
 
(BOOL) - isEqualToClassBreak:
 
(nullable id) - toJSON:
 

Class Methods

(instancetype) + classBreak
 
(instancetype) + classBreakWithDescription:label:minValue:maxValue:symbol:
 
(nullable id< AGSJSONSerializable >) + fromJSON:error:
 

Properties

NSString * breakDescription
 
NSString * label
 
double maxValue
 
double minValue
 
AGSSymbolsymbol
 
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
descriptionA description of the class break. "Cities with a population under 100,000", for example.
labelA label for the class break. "0 - 100000", for example.
minValueThe minimum value of the range that defines the break.
maxValueThe maximum value of the range that defines the break.
symbolA symbol used to represent elements in the class break.
Returns
A new class break
Since
100

◆ 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

◆ 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
descriptionA description of the class break. "Cities with a population under 100,000", for example.
labelA label for the class break. "0 - 100000", for example.
minValueThe minimum value of the range that defines the break.
maxValueThe maximum value of the range that defines the break.
symbolA symbol used to represent elements in the class break.
Returns
A new class break
Since
100

◆ isEqualToClassBreak:

- (BOOL) isEqualToClassBreak: (AGSClassBreak *)  other

Compares this class break to another for equality.

Parameters
otherclass 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
errorencountered during the operation, if any.
Returns
NSDictionary or NSArray containing the JSON.
Since
100

Reimplemented in AGSPortalItem.

Property Documentation

◆ 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