ArcGIS Runtime SDK for iOS: AGSPopup Class Reference
ArcGIS Runtime SDK for iOS  100.6
AGSPopup Class Reference

Description

Instances of this class represent a popup which associates a geo-element with popup definition for the purpose of displaying in an AGSPopupsViewController.

Since
100
Inheritance diagram for AGSPopup:
AGSObject

Instance Methods

(NSString *) - formattedValueForField:
 
(instancetype) - initWithGeoElement:
 
(instancetype) - initWithGeoElement:popupDefinition:
 
(nullable NSString *) - stringForTemplatedString:
 

Class Methods

(instancetype) + popupWithGeoElement:
 
(instancetype) + popupWithGeoElement:popupDefinition:
 

Properties

id< AGSGeoElementgeoElement
 
AGSPopupDefinitionpopupDefinition
 
AGSSymbolsymbol
 
NSString * title
 

Method Documentation

§ formattedValueForField:()

- (NSString*) formattedValueForField: (AGSPopupField *)  popupField

Returns a string you can use in a display for the popup's field value. String will have the proper formatting based on the field type and AGSPopupField configuration.

Parameters
popupFieldThe field for which a properly formatted value is desired
Returns
user-friendly string representing the value
Since
100

§ initWithGeoElement:()

- (instancetype) initWithGeoElement: (id< AGSGeoElement >)  geoElement

Initialize the popup for the provided geo-element. A default popup definition will be created based on the geo-element's attributes or schema specifying how the geo-element should be represented in the popup.

Parameters
geoElementfor which to create a popup
Returns
A new popup
Since
100

§ initWithGeoElement:popupDefinition:()

- (instancetype) initWithGeoElement: (id< AGSGeoElement >)  geoElement
popupDefinition: (nullable AGSPopupDefinition *)  popupDefinition 

Initialize the popup for the provided geo-element based on the popup definition.

Parameters
geoElementfor which to create a popup
popupDefinitionspecifying how the geo-element should be represented in the popup If you pass nil for the popupDefinition a default one will be created for you based on the geo-element's attributes or schema.
Returns
A new popup
Since
100

§ popupWithGeoElement:()

+ (instancetype) popupWithGeoElement: (id< AGSGeoElement >)  geoElement

Initialize the popup for the provided geo-element. A default popup definition will be created based on the geo-element's attributes or schema specifying how the geo-element should be represented in the popup.

Parameters
geoElementfor which to create a popup
Returns
A new popup
Since
100

§ popupWithGeoElement:popupDefinition:()

+ (instancetype) popupWithGeoElement: (id< AGSGeoElement >)  geoElement
popupDefinition: (nullable AGSPopupDefinition *)  popupDefinition 

Initialize the popup for the provided geo-element based on the popup definition.

Parameters
geoElementfor which to create a popup
popupDefinitionspecifying how the geo-element should be represented in the popup If you pass nil for the popupDefinition a default one will be created for you based on the geo-element's attributes or schema.
Returns
A new popup
Since
100

§ stringForTemplatedString:()

- (nullable NSString*) stringForTemplatedString: (NSString *)  templatedString

Substitutes attribute templates in a string with actual values.

Since
100

Property Documentation

§ geoElement

- (id<AGSGeoElement>) geoElement
readnonatomicstrong

The geoElement which this popup is associated with.

Since
100

§ popupDefinition

- (AGSPopupDefinition*) popupDefinition
readnonatomicstrong

A popup definition that dictates which information belonging to the geo-element should be displayed in the popup and how it should be formatted.

Since
100

§ symbol

- (AGSSymbol*) symbol
readnonatomicstrong

The popup symbol.

Since
100

§ title

- (NSString*) title
readnonatomiccopy

The text to display as the popup title.

Since
100