AGSFacilityGraphic Class Reference


Description

A graphic that can be used as input to the solve operation of an AGSServiceAreaTask or AGSClosestFacilityTask. This graphic will also be returned in an array if the returnFacilities parameter of an AGSServiceAreaTask or AGSClosestFacilityTask is set to true.

Since:
1.8
Inheritance diagram for AGSFacilityGraphic:
AGSGraphic <AGSCoding> <AGSCoding>

List of all members.

Public Member Functions

(void) - decodeWithJSON:
(NSDictionary *) - encodeToJSON
(id) - initWithGeometry:symbol:attributes:infoTemplateDelegate:
(id) - initWithJSON:
(id) - initWithPoint:name:

Static Public Member Functions

(id) + graphicWithGeometry:symbol:attributes:infoTemplateDelegate:
(id) + graphicWithPoint:name:

Properties

NSMutableDictionary * attributes
AGSGeometrygeometry
id< AGSInfoTemplateDelegateinfoTemplateDelegate
AGSGraphicsLayerlayer
NSString * name
AGSSymbolsymbol
BOOL visible

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) graphicWithGeometry: (AGSGeometry *)  geometry
symbol: (AGSSymbol *)  symbol
attributes: (NSMutableDictionary *)  attributes
infoTemplateDelegate: (id< AGSInfoTemplateDelegate >)  infoTemplateDelegate 

Returns autoreleased graphic object. Only the geometry argument is mandatory.

Parameters:
geometry The geometry defining the graphic.
symbol The symbol used to draw the graphic. Can be nil.
attributes Name-value pairs of fields and field values associated with the graphic.
infoTemplateDelegate The template describing how to display attributes in the callout. Can be nil.
Returns:
A new, autoreleased, graphic object.
Since:
1.0
+ (id) graphicWithPoint: (AGSPoint *)  pt
name: (NSString *)  name 

Initialize a new, autoreleased AGSFacilityGraphic.

Parameters:
pt The location of the facility.
name The name of the facility.
Returns:
A new, autoreleased AGSFacilityGraphic.
Since:
1.8
- (id) initWithGeometry: (AGSGeometry *)  geometry
symbol: (AGSSymbol *)  symbol
attributes: (NSMutableDictionary *)  attributes
infoTemplateDelegate: (id< AGSInfoTemplateDelegate >)  infoTemplateDelegate 

Initialize the graphic object. Only the geometry argument is mandatory.

Parameters:
geometry The geometry defining the graphic.
symbol The symbol used to draw the graphic. Can be nil.
attributes Name-value pairs of fields and field values associated with the graphic.
infoTemplateDelegate The template describing how to display attributes in the callout. Can be nil.
Returns:
A new graphic 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) initWithPoint: (AGSPoint *)  pt
name: (NSString *)  name 

Initialize a new AGSFacilityGraphic.

Parameters:
pt The location of the facility.
name The name of the facility.
Returns:
A new AGSFacilityGraphic.
Since:
1.8

Property Documentation

- (NSMutableDictionary*) attributes [read, write, retain, inherited]

Attributes representing additional information about this graphic. Consists of key-value pairs of field names and field values.

Since:
1.0
- (AGSGeometry*) geometry [read, write, retain, inherited]

The geometry that defines the graphic's shape and location.

Since:
1.0
- (id<AGSInfoTemplateDelegate>) infoTemplateDelegate [read, write, assign, inherited]

Template describing how the callout should display this graphic's attributes.

See also:
AGSCalloutTemplate
Since:
1.0
- (AGSGraphicsLayer*) layer [read, assign, inherited]

The graphics layer that this graphic belongs to, if any.

Since:
1.8
- (NSString*) name [read, write, assign]

An string representing the name of the facility.

Since:
1.8
- (AGSSymbol*) symbol [read, write, retain, inherited]

The symbol for the graphic.

Since:
1.0
- (BOOL) visible [read, write, assign, inherited]

Whether or not the graphic is visible in the layer.

Since:
2.1