ArcGIS Runtime SDK for iOS: AGSLevelLayerDefinition Class Reference
ArcGIS Runtime SDK for iOS  100.14
AGSLevelLayerDefinition Class Reference

Description

Defines the properties of the layer that contains floor levels for a floor-aware map or scene.

A floor level describes the footprint of each occupiable floor contained in a managed facility.

See also
AGSGeoModelFloorDefinition
Since
100.12
Inheritance diagram for AGSLevelLayerDefinition:
AGSObject <AGSJSONSerializable>

Instance Methods

(instancetype) - initWithLayerID:levelIDField:levelNumberField:shortNameField:longNameField:verticalOrderField:facilityIDField:
 
(nullable id) - toJSON:
 

Class Methods

(nullable id< AGSJSONSerializable >) + fromJSON:error:
 
(instancetype) + levelLayerDefinitionWithLayerID:levelIDField:levelNumberField:shortNameField:longNameField:verticalOrderField:facilityIDField:
 

Properties

NSString * facilityIDField
 
NSString * layerID
 
NSString * levelIDField
 
NSString * levelNumberField
 
NSString * longNameField
 
NSString * shortNameField
 
NSDictionary< NSString *, id > * unknownJSON
 
NSDictionary< NSString *, id > * unsupportedJSON
 
NSString * verticalOrderField
 

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

◆ initWithLayerID:levelIDField:levelNumberField:shortNameField:longNameField:verticalOrderField:facilityIDField:

- (instancetype) initWithLayerID: (NSString *)  layerID
levelIDField: (NSString *)  levelIDField
levelNumberField: (NSString *)  levelNumberField
shortNameField: (NSString *)  shortNameField
longNameField: (NSString *)  longNameField
verticalOrderField: (NSString *)  verticalOrderField
facilityIDField: (NSString *)  facilityIDField 

Creates a new AGSLevelLayerDefinition object with the provided arguments.

Parameters
layerIDAn ID that specifies a layer in the map or scene that describes floor levels.
levelIDFieldThe name of the attribute field that contains each level feature's unique identifier.
levelNumberFieldThe name of the attribute field that contains each level feature's level number specific to its facility.
shortNameFieldThe name of the attribute field that contains each level feature's short name.
longNameFieldThe name of the attribute field that contains each level feature's long name.
verticalOrderFieldThe name of the attribute field that contains each level feature's vertical order. The vertical order defines the order of display in a floor filtering UI component, and it also references the floor levels of an Indoor Positioning System.
facilityIDFieldThe name of the attribute field that contains each level feature's facility identifier (a foreign key to the layer that contains facility features).
Since
100.12

◆ levelLayerDefinitionWithLayerID:levelIDField:levelNumberField:shortNameField:longNameField:verticalOrderField:facilityIDField:

+ (instancetype) levelLayerDefinitionWithLayerID: (NSString *)  layerID
levelIDField: (NSString *)  levelIDField
levelNumberField: (NSString *)  levelNumberField
shortNameField: (NSString *)  shortNameField
longNameField: (NSString *)  longNameField
verticalOrderField: (NSString *)  verticalOrderField
facilityIDField: (NSString *)  facilityIDField 

Creates a new AGSLevelLayerDefinition object with the provided arguments.

Parameters
layerIDAn ID that specifies a layer in the map or scene that describes floor levels.
levelIDFieldThe name of the attribute field that contains each level feature's unique identifier.
levelNumberFieldThe name of the attribute field that contains each level feature's level number specific to its facility.
shortNameFieldThe name of the attribute field that contains each level feature's short name.
longNameFieldThe name of the attribute field that contains each level feature's long name.
verticalOrderFieldThe name of the attribute field that contains each level feature's vertical order. The vertical order defines the order of display in a floor filtering UI component, and it also references the floor levels of an Indoor Positioning System.
facilityIDFieldThe name of the attribute field that contains each level feature's facility identifier (a foreign key to the layer that contains facility features).
Since
100.12

◆ 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

◆ facilityIDField

- (NSString*) facilityIDField
readnonatomiccopy

The name of the attribute field that contains each floor level feature's facility identifier (a foreign key to the layer that contains facility features).

Since
100.12

◆ layerID

- (NSString*) layerID
readnonatomiccopy

An ID that specifies a layer in the map or scene that contains floor level features.

Since
100.12

◆ levelIDField

- (NSString*) levelIDField
readnonatomiccopy

The name of the attribute field that contains each floor level feature's unique identifier.

Since
100.12

◆ levelNumberField

- (NSString*) levelNumberField
readnonatomiccopy

The name of the attribute field that contains each floor level feature's level number specific to its facility.

Since
100.12

◆ longNameField

- (NSString*) longNameField
readnonatomiccopy

The name of the attribute field that contains each floor level feature's long name.

Since
100.12

◆ shortNameField

- (NSString*) shortNameField
readnonatomiccopy

The name of the attribute field that contains each floor level feature's short name.

Since
100.12

◆ 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

◆ verticalOrderField

- (NSString*) verticalOrderField
readnonatomiccopy

The name of the attribute field that contains each floor level feature's vertical order.

The vertical order defines the order of display in a floor filtering UI component, and it also references the floor levels of an Indoor Positioning System.

Since
100.12