Class GSBox

Extends GSMapFeature.

GSBox represents a rectangular geographic extent on the map.

Requires: additional-features module

Class Summary
Constructor Attributes Constructor Name and Description
 
GSBox(bounds, options)
Creates a new GSBox
Method Summary
Method Attributes Method Name and Description
 
setBounds(bounds)
Sets this feature's bounds
Methods borrowed from class GSMapFeature:
addContextMenuItem, addEventHandler, addEventListener, addListener, deleteProperty, deselect, disableContextMenu, enableContextMenu, getContextMenu, getProperties, getProperty, isSelectable, isVisible, removeContextMenu, removeContextMenuItem, removeEventHandler, removeEventListener, removeEventListeners, removeListener, select, setContextMenu, setProperty, setTip, setVisible, setZIndex, showInfoWindow, toJson
Events borrowed from class GSMapFeature:
featureClicked, featureRemoved
Class Detail
GSBox(bounds, options)
Creates a new GSBox
Parameters:
{GSBounds} bounds
the geographical extent of the feature
{Object} options Optional
options defining the appearance of the box
{String} options.styles.borderStyle
CSS border-style property, defaults to solid
{String} options.styles.borderColor
CSS border-color property, defaults to #ff0000
{String} options.styles.borderWidth
CSS border-width property, defaults to 1px
{String} options.styles.backgroundColor
CSS background-color property, defaults to transparent
{int} options.opacity
opacity value as a percentage (0 - 100)
Method Detail
setBounds(bounds)
Sets this feature's bounds
Parameters:
{GSBounds} bounds
the new bounds

Documentation generated by JsDoc Toolkit 2.3.2 on Wed Mar 07 2012 11:47:27 GMT+1300 (NZDT)