mapscript.legendObj¶
- class mapscript.legendObj¶
The LEGEND object
Overview
The legendObj has the following relationships:
Attributes
height
int Legend height
imagecolor
colorObj
Legend background color - see IMAGECOLORkeysizex
int Width in pixels of legend keys - see KEYSIZE
keysizey
int Height in pixels of legend keys - see KEYSIZE
keyspacingx
int Horizontal padding around keys in pixels - see KEYSPACING
keyspacingy
int Vertical padding around keys in pixels - see KEYSPACING
label
map
mapObj
immutable Instances of legendObj are always are always embedded inside the mapObjoutlinecolor
colorObj
Key outline color, -1 for no outline - see OUTLINECOLORposition
int Used for embedded legends, see POSITION
postlabelcache
int
MS_TRUE
,MS_FALSE
- see POSTLABELCACHEstatus
template
char See TEMPLATE
thisown
The membership flag
transparent
int Allows transparency for an embedded legend - see TRANSPARENT
width
int Legend width
Methods
- __init__()[Quellcode]¶
- convertToString() char [Quellcode]¶
Output the
legendObj
object as a Mapfile string. Provides the inverse option forlegendObj.updateFromString()
.
- updateFromString(snippet: char) int [Quellcode]¶
Update a
legendObj
from a string snippet. ReturnsMS_SUCCESS
orMS_FAILURE