mapscript.referenceMapObj

class mapscript.referenceMapObj

The REFERENCE object

Overview

The referenceMapObj has the following relationships:

../../../_images/referenceMapObj_mapObj.png

Attributes

color

colorObj Color of reference box - see COLOR

extent

rectObj Spatial extent of reference in units of parent map - see EXTENT

height

int Height of reference map in pixels - see SIZE

image

char Filename of reference map image - see IMAGE

map

mapObj immutable Reference to parent mapObj

marker

int Index of a symbol in the map symbol set to use for marker - see MARKER

markername

char Name of a symbol - see MARKER

markersize

int Size of marker - see MARKERSIZE

maxboxsize

int In pixels - see MAXBOXSIZE

minboxsize

int In pixels - see MINBOXSIZE

outlinecolor

colorObj Outline color of reference box - see OUTLINECOLOR

status

int MS_ON or MS_OFF - see STATUS

thisown

The membership flag

width

int Width of reference map in pixels - see SIZE

Methods

__init__()[broncode]
convertToString() char[broncode]

Saves the object to a string. Provides the inverse option for referenceMapObj.updateFromString().

updateFromString(snippet: char) int[broncode]

Update a reference map from a string snippet. Returns MS_SUCCESS or MS_FAILURE