LEGEND¶
The size of the legend image is NOT known prior to creation so be careful not to hard-code width and height in the <IMG> tag in the template file.
- IMAGECOLOR [r] [g] [b] | [hexadecimal string]
Color to initialize the legend with (i.e. the background).
r, g and b shall be integers [0..255]. To specify green, the following is used:
IMAGECOLOR 0 255 0
hexadecimal string can be
RGB value: “#rrggbb”. To specify magenta, the following is used:
IMAGECOLOR "#FF00FF"
RGBA value (adding translucence): “#rrggbbaa”. To specify a semi-translucent magenta, the following is used:
IMAGECOLOR "#FF00FFCC"
- INTERLACE [on|off]
Deprecated since version 4.6.
Default is [on]. This keyword is now deprecated in favor of using the FORMATOPTION “INTERLACE=ON” line in the OUTPUTFORMAT declaration.
- KEYSIZE [x][y]
Size of symbol key boxes in pixels. Default is 20 by 10. Minimum values are 5, and maximum values are 200.
- KEYSPACING [x][y]
Spacing between symbol key boxes ([y]) and labels ([x]) in pixels. Default is 5 by 5. Minimum values are 0, and maximum values are 50.
- OUTLINECOLOR [r] [g] [b] | [hexadecimal string]
Color to use for outlining symbol key boxes.
r, g and b shall be integers [0..255]. To specify green, the following is used:
OUTLINECOLOR 0 255 0
hexadecimal string can be
RGB value: “#rrggbb”. To specify magenta, the following is used:
OUTLINECOLOR "#FF00FF"
RGBA value (adding translucence): “#rrggbbaa”. To specify a semi-translucent magenta, the following is used:
OUTLINECOLOR "#FF00FFCC"
- POSITION [ul|uc|ur|ll|lc|lr]
Where to place an embedded legend in the map. Default is lr.
- POSTLABELCACHE [true|false]
Tells MapServer to render this legend after all labels in the cache have been drawn. Useful for adding neatlines and similar elements. Default is false.
- STATUS [on|off|embed]
Is the legend image to be created.
- TEMPLATE [filename]
HTML legend template file.
See also
- TRANSPARENT [on|off]
Deprecated since version 4.6.
Should the background color for the legend be transparent. This flag is now deprecated in favor of declaring transparency within OUTPUTFORMAT declarations. Default is off.