AGSClassBreak Class Reference

Description

A class break object used to categorize a group of values that fall within a range of values.

The class break is used to categorize a group of values that fall within a range of minValue and maxValue settings. When defining this categorization group, the value to be categorized must be greater than the minValue but less than or equal to the maxValue. When written as an algebraic equation, it would look like (minValue < value <= maxValue). The AGSClassBreaksRenderer applies the associated symbol to features or graphics which have values that fall within the specified range.

Since

100

Inheritance diagram for AGSClassBreak:

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

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

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

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