AGSCalloutTemplate Class Reference


Description

Instances of this class represent a simple implementation of AGSInfoTemplateDelegate. Tokens of the form ${...} in the titleTemplate/detailTemplate are replaced at runtime with corresponding values from the graphic's attributes. The final text is then displayed in the callout.

For example, consider a graphic which has an attribute STATE_NAME with the value California. To display the attribute's value in the callout's title, you need to set ${STATE_NAME} as the titleTemplate. The token ${STATE_NAME} will then be automatically substituted with the value California when the callout is displayed.

Defined in:
AGSInfoTemplateDelegate.h ( ArcGIS library)
Since:
1.0
See also:
AGSMapViewDelegate for events related to showing the callout.
Inheritance diagram for AGSCalloutTemplate:
<AGSInfoTemplateDelegate>

List of all members.

Public Member Functions

(NSString *) - detailForGraphic:screenPoint:mapPoint:
(NSString *) - titleForGraphic:screenPoint:mapPoint:

Properties

NSString * detailTemplate
NSString * titleTemplate

Member Function Documentation

- (NSString *) detailForGraphic: (AGSGraphic *)  graphic
screenPoint: (CGPoint)  screen
mapPoint: (AGSPoint *)  map 

Detail string to be displayed in the callout.

Parameters:
graphic The graphic to display detail for.
screen The coordinates at which the graphic callout will be displayed.
map The coordinates at which the graphic callout will be displayed.
Returns:
The detail text for the callout.
Since:
1.0
- (NSString *) titleForGraphic: (AGSGraphic *)  graphic
screenPoint: (CGPoint)  screen
mapPoint: (AGSPoint *)  map 

Title text to be displayed in the callout.

Parameters:
graphic The graphic to display a title for.
screen The coordinates at which the graphic callout will be displayed.
map The coordinates at which the graphic callout will be displayed.
Returns:
The title text for the callout.
Since:
1.0

Property Documentation

- (NSString*) detailTemplate [read, write, copy]

Template used to display the detail string in the callout.

Since:
1.0
- (NSString*) titleTemplate [read, write, copy]

Template used to display the title in the callout.

Since:
1.0