AGSExportImageParams Class Reference

---

Description

A class that encapsulates the parameters passed to an export image method.

Defined in:

AGSDynamicLayer.h ( ArcGIS library)

Since:

1.0

List of all members.

Public Member Functions
(AGSEnvelope *)	- adjustEnvelopeForWrapAround
(id)	- initWithEnvelope:timeExtent:size:frame:
(id)	- initWithEnvelope:timeExtent:size:frame:mapWrapAround:
Properties
AGSEnvelope *	envelope
CGRect	frame
BOOL	mapWrapAround
CGSize	size
AGSTimeExtent *	timeExtent

---

Member Function Documentation

- (AGSEnvelope *) adjustEnvelopeForWrapAround

Returns an adjusted envelope if the map is wrapping around. The envelope will have a spatial reference with an adjusted central meridian if need be.

Since:

1.8

- (id) initWithEnvelope:		(AGSEnvelope *)	envelope
timeExtent:		(AGSTimeExtent *)	timeExtent
size:		(CGSize)	size

Initializes an instance of AGSExportImageParams.

Parameters:

	envelope	The envelope to draw.
	timeExtent	The time extent to draw.
	size	The size of the output image.
	frame	The frame used to place the image once it has been returned.

Returns:

A new AGSExportImageParams object.

Since:

1.0

Deprecated:

Deprecated at 1.8. Use initWithEnvelope:timeExtent:size:frame:mapWrapAround: instead.

- (id) initWithEnvelope:		(AGSEnvelope *)	envelope
timeExtent:		(AGSTimeExtent *)	timeExtent
size:		(CGSize)	size
frame:		(CGRect)	frame
mapWrapAround:		(BOOL)	mapWrapAround

Initializes an instance of AGSExportImageParams.

Parameters:

	envelope	The envelope to draw.
	timeExtent	The time extent to draw.
	size	The size of the output image.
	frame	The frame used to place the image once it has been returned.
	mapWrapAround	Whether or not the map's wrapAround property is YES or NO.

Returns:

A new AGSExportImageParams object.

Since:

1.8

---

Property Documentation

- (AGSEnvelope*) envelope [read, write, retain]

The envelope to draw.

Since:

1.0

- (CGRect) frame [read, write, assign]

The frame used to place the image once it has been returned.

Since:

1.0

- (BOOL) mapWrapAround [read, write, assign]

Specifies the map wrap around property for the draw operation.

Since:

1.8

- (CGSize) size [read, write, assign]

The size of the output image.

Since:

1.0

- (AGSTimeExtent*) timeExtent [read, write, retain]

The time extent to draw. Can be nil. Should be ignored by layers that are not time aware.

Since:

1.0