AGSPopupMediaInfo Class Reference
Description
Instances of this class represents media that is displayed in a popup for a graphic.
- Since:
- 2.0
Public Member Functions | |
| (void) | - decodeWithJSON: |
| (NSDictionary *) | - encodeToJSON |
| (id) | - initWithJSON: |
| (id) | - initWithTitle:caption:type:value: |
Static Public Member Functions | |
| (AGSPopupMediaInfo *) | + popupMediaInfoWithTitle:caption:type:value: |
Properties | |
| NSString * | caption |
| NSString * | title |
| AGSPopupMediaInfoType | type |
| NSDictionary * | value |
Member Function Documentation
| - (void) decodeWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Decode object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be decoded.
- Since:
- 1.0
| - (NSDictionary *) encodeToJSON | [optional, inherited] |
Encode and return JSON representation for object.
- Returns:
- JSON representation of object.
- Since:
- 1.0
| - (id) initWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Initialize and return object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be created.
- Returns:
- Object decoded from JSON representation.
- Since:
- 1.0
| - (id) initWithTitle: | (NSString *) | title | ||
| caption: | (NSString *) | caption | ||
| type: | (AGSPopupMediaInfoType) | type | ||
| value: | (NSDictionary *) | value | ||
| + (AGSPopupMediaInfo*) popupMediaInfoWithTitle: | (NSString *) | title | ||
| caption: | (NSString *) | caption | ||
| type: | (AGSPopupMediaInfoType) | type | ||
| value: | (NSDictionary *) | value | ||
Property Documentation
- (NSString*) caption [read, write, retain] |
The caption that is displayed for the media. This can contain a literal value, or a placeholder for value from the graphic's attribute for which the popup is displayed. The placeholder needs to be of the form {field_name} where field_name is a key in the graphic's attributes.
- Since:
- 2.0
- (NSString*) title [read, write, retain] |
The title that is displayed for the media. This can contain a literal value, or a placeholder for value from the graphic's attribute for which the popup is displayed. The placeholder needs to be of the form {field_name} where field_name is a key in the graphic's attributes.
- Since:
- 2.0
- (AGSPopupMediaInfoType) type [read, write, assign] |
The type of media.
- Since:
- 2.0
- (NSDictionary*) value [read, write, retain] |
The value for the media. This will be of a different format depending on what the media type is.
If the media Is of type AGSPopupMediaInfoTypeImage, then the value dictionary can have the following keys:
1. linkURL - what the image should link to
2. sourceURL - where to pull the image from
If the media is any type of chart, then the value dictionary will have the following: 1. fields – an array of field names to build the chart from.
2. normalizeField - the field to normalize all values to. (only applicable to line, bar, and column charts.)
- Since:
- 2.0