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

Description

Each unique value that is symbolized differently by a unique value renderer.

Instances of this class represent a unique value of matching attributes that must be symbolized by a unique value renderer.

Since
100
Inheritance diagram for AGSUniqueValue:
AGSObject <AGSJSONSerializable>

Instance Methods

(instancetype) - initWithDescription:label:symbol:values:
 
(BOOL) - isEqualToUniqueValue:
 
(nullable id) - toJSON:
 

Class Methods

(nullable id< AGSJSONSerializable >) + fromJSON:error:
 
(instancetype) + uniqueValue
 
(instancetype) + uniqueValueWithDescription:label:symbol:values:
 

Properties

NSString * label
 
AGSSymbolsymbol
 
NSDictionary< NSString *, id > * unknownJSON
 
NSDictionary< NSString *, id > * unsupportedJSON
 
NSString * valueDescription
 
NSArray< id > * values
 

Method Documentation

◆ 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:symbol:values:

- (instancetype) initWithDescription: (NSString *)  description
label: (NSString *)  label
symbol: (AGSSymbol *)  symbol
values: (NSArray< id > *)  values 

Initialize a new unique value (or unique combination of values) and a symbol used to display elements with this value in an AGSUniqueValueRenderer.

Parameters
descriptionA description of the unique value. "Parcels zoned for residential use", for example.
labelA label for the unique value. "Residential", for example.
symbolA symbol used to represent elements with this unique value.
valuesAn NSArray containing id types that define a unique value or unique combination of values.
Returns
A new unique value.
Since
100

◆ isEqualToUniqueValue:

- (BOOL) isEqualToUniqueValue: (AGSUniqueValue *)  other

Compares this unique value to another for equality.

Parameters
otherunique value 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.

◆ uniqueValue

+ (instancetype) uniqueValue

Initialize a unique value.

Returns
A new unique value.
Since
100

◆ uniqueValueWithDescription:label:symbol:values:

+ (instancetype) uniqueValueWithDescription: (NSString *)  description
label: (NSString *)  label
symbol: (AGSSymbol *)  symbol
values: (NSArray< id > *)  values 

Initialize a new unique value (or unique combination of values) and a symbol used to display elements with this value in an AGSUniqueValueRenderer.

Parameters
descriptionA description of the unique value. "Parcels zoned for residential use", for example.
labelA label for the unique value. "Residential", for example.
symbolA symbol used to represent elements with this unique value.
valuesAn NSArray containing id types that define a unique value or unique combination of values.
Returns
A new unique value.
Since
100

Property Documentation

◆ label

- (NSString*) label
readwritenonatomiccopy

A label for the unique value. "Residential", for example.

Since
100

◆ symbol

- (AGSSymbol*) symbol
readwritenonatomicstrong

A symbol used to represent elements with this unique value.

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

◆ valueDescription

- (NSString*) valueDescription
readwritenonatomiccopy

A description of the unique value. "Parcels zoned for residential use", for example.

Since
100

◆ values

- (NSArray<id>*) values
readwritenonatomiccopy

An NSArray containing id types that define a unique value or unique combination of values.

Since
100