4.9. LegendObj Class

Next: LineObj Class Previous: LayerObj Class  

LegendObj Class

• Constant names and class member variable names are case-sensitive in PHP.
• Several MapScript functions (all those that access files in the back end such as ms_newMapObj(), drawMap(), etc.) will affect the value of the current working directory (CWD) in the PHP environment. This will be fixed eventually but in the meantime you should be careful about these side-effects.

Constructor:

  Instances of legendObj are always are always embedded inside the mapObj.

Members:

   int height;
   int width;
   int keysizex;      
   int keysizey;
   int keyspacingx;
   int keyspacingy;
   colorObj outlinecolor; //Color of outline of box, -1 for no outline
   int status; //MS_ON, MS_OFF, MS_EMBED
   int position; //for embeded legends, MS_UL, MS_UC, ...
   int transparent;
   int interlace;
   int postlabelcache; //MS_TRUE, MS_FALSE
   labelObj label;
   colorObj imagecolor;
   string   template
    
Methods:

   int set(string property_name, new_value)
       Set object property to a new value. Returns -1 on error.

Next: LineObj Class Previous: LayerObj Class