legendObj
final class legendObj (View source)
Instances of legendObj are always are always embedded inside the mapObj_.
Properties
| int | $height | ||
| colorObj | $imagecolor | ||
| int | $keysizex | ||
| int | $keysizey | ||
| int | $keyspacingx | ||
| int | $keyspacingy | ||
| labelObj | $label | ||
| colorObj | $outlinecolor | Color of outline of box, -1 for no outline |
|
| int | $position | for embedded legends, MS_UL, MS_UC, . |
|
| int | $postlabelcache | MS_TRUE, MS_FALSE |
|
| int | $status | MS_ON, MS_OFF, MS_EMBED |
|
| string | $template | ||
| 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.
Update a legend 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
updateFromString(string $snippet)
Update a legend from a string snippet. Returns MS_SUCCESS/MS_FAILURE.