4.20. ScalebarObj Class

Next: ShapefileObj Class Previous: ResultCacheMemberObj  

• 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 scalebarObj are always are always embedded inside the mapObj.

Members:

  int height;
  int width;
  int style;      
  int intervals;
  colorObj color;
  colorObj backgroundcolor;            
  colorObj outlinecolor;
  int units;
  int status; //MS_ON, MS_OFF, MS_EMBED
  int position; //for embeded scalebars, MS_UL, MS_UC, ...
  int transparent;
  int interlace;
  int postlabelcache;
  labelObj label;
  colorObj imagecolor;
  int align;

Methods:

     int set(string property_name, new_value)
       Set object property to a new value. Returns -1 on error.
       
     int setimagecolor(int red, int green, int blue)
       Sets the imagecolor propery (baclground) of the object.
       Returns false on error.  

Next: ShapefileObj Class Previous: ResultCacheMemberObj