scalebarObj
final class scalebarObj (View source)
Instances of scalebarObj are always embedded inside the mapObj_.
Properties
| int | $align | ||
| colorObj | $backgroundcolor | ||
| colorObj | $color | ||
| int | $height | ||
| colorObj | $imagecolor | ||
| int | $intervals | ||
| labelObj | $label | ||
| colorObj | $outlinecolor | ||
| int | $position | for embedded scalebars, MS_UL, MS_UC, . |
|
| int | $postlabelcache | ||
| int | $status | MS_ON, MS_OFF, MS_EMBED |
|
| int | $style | ||
| int | $units | ||
| int | $width |
Methods
Saves the object to a string. Provides the inverse option for updateFromString.
Free the object properties and break the internal references.
Set object property to a new value.
Sets the imagecolor property (baclground) of the object.
Update a scalebar from a string snippet. Returns MS_SUCCESS/MS_FAILURE.
Details
final string
convertToString()
Saves the object to a string. Provides the inverse option for updateFromString.
final void
free()
Free the object properties and break the internal references.
Note that you have to unset the php variable to free totally the resources.
final int
set(string $property_name, $new_value)
Set object property to a new value.
final int
setImageColor(int $red, int $green, int $blue)
Sets the imagecolor property (baclground) of the object.
Returns MS_SUCCESS or MS_FAILURE on error.
final int
updateFromString(string $snippet)
Update a scalebar from a string snippet. Returns MS_SUCCESS/MS_FAILURE.