AGSSimpleLineSymbol Class Reference


Description

Instances of this class represent simple line symbols. Symbols describe how graphics look on the map. Different symbols are used for graphics with different geometry types. Line symbols are used to display those graphics which are based on a polyline geometry. Simple line symbols display graphics using predefined line style patterns such as solid, dash, dot, etc.

Defined in:
AGSLineSymbol.h ( ArcGIS library)
Since:
1.0
Inheritance diagram for AGSSimpleLineSymbol:
AGSSymbol <AGSCoding>

List of all members.

Public Member Functions

(void) - decodeWithJSON:
(NSDictionary *) - encodeToJSON
(id) - initWithColor:
(id) - initWithColor:width:
(id) - initWithJSON:
(UIImage *) - swatchForGeometryType:size:

Static Public Member Functions

(id) + simpleLineSymbol
(AGSSimpleLineSymbol *) + simpleLineSymbolWithColor:
(AGSSimpleLineSymbol *) + simpleLineSymbolWithColor:width:

Properties

UIColor * color
AGSSimpleLineSymbolStyle style
CGFloat width

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) initWithColor: (UIColor *)  color  
Since:
1.8
- (id) initWithColor: (UIColor *)  color
width: (CGFloat)  width 
Since:
1.8
- (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) simpleLineSymbol  

Initialize autoreleased symbol with defaults.

Returns:
A new, autoreleased, simple line symbol object.
Since:
1.0
+ (AGSSimpleLineSymbol*) simpleLineSymbolWithColor: (UIColor *)  color  

Initialize autoreleased symbol with specified properties.

Parameters:
color A color for the line
Returns:
A new, autoreleased, simple line symbol object.
Since:
1.8
+ (AGSSimpleLineSymbol*) simpleLineSymbolWithColor: (UIColor *)  color
width: (CGFloat)  width 

Initialize autoreleased symbol with specified properties.

Parameters:
color A color for the line
width The width of the line
Returns:
A new, autoreleased, simple line symbol object.
Since:
1.8
- (UIImage *) swatchForGeometryType: (AGSGeometryType geometryType
size: (CGSize)  size 

Returns an image that represents a swatch for a particular geometry type.

Parameters:
geometryType The type of the geometry determines what kind of swatch is drawn.
size Size of the output swatch.
Returns:
UIImage of the drawn swatch.

Property Documentation

- (UIColor*) color [read, write, retain, inherited]

Symbol color.

Since:
1.0
- (AGSSimpleLineSymbolStyle) style [read, write, assign]

The line style. Possible values include

  • AGSSimpleLineSymbolStyleDash
  • AGSSimpleLineSymbolStyleDot
  • AGSSimpleLineSymbolStyleDashDot
  • AGSSimpleLineSymbolStyleDashDotDot
  • AGSSimpleLineSymbolStyleInsideFrame
  • AGSSimpleLineSymbolStyleNull
  • AGSSimpleLineSymbolStyleSolid

Default is AGSSimpleLineSymbolStyleSolid.

Since:
1.0
- (CGFloat) width [read, write, assign]

Width of line symbol in pixels. Default is 1.0.

Since:
1.0