Class GSMapFeature

GSMapFeature is an abstract base class for all feature types rendered onto the map.

Class Summary

Constructor Attributes	Constructor Name and Description
	GSMapFeature(options) This class is abstract and should not be used directly.

Method Summary

Method Attributes	Method Name and Description
	addContextMenuItem(menuItem) Adds a context menu item for this component.
	addEventHandler(eventType, func) Calls the handler function provided when the given event is triggered on this feature.
	addEventListener(eventType, func, scope) Registers the given function as a handler for DOM events of the specified type occurring on the component's target element.
	addListener(obj) Adds the specified object as a listener on this object.
	deleteProperty(name) Deletes the named property for this feature
	deselect() Abstract method that should be overriden by subclasses
	disableContextMenu() Disables this component's context menu
	enableContextMenu() Enables this component's context menu if it has been set
	getContextMenu() Returns the context menu for this component
	getProperties() Returns all user-defined properties for this feature
	getProperty(name) Gets the named property for this feature
	isSelectable() Returns a boolean value indicating whether the map feature is selectable
	isVisible() Returns a boolean value indicating the visibility of this map feature
	removeContextMenu() Removes this component's context menu
	removeContextMenuItem(menuItem) Removes the passed in context menu item from the list of menu items dynamically added by this component to its context menu
	removeEventHandler(token) Removes the event handler function represented by the token parameter from this feature
	removeEventListener(token) Removes the event listener function represented by the token parameter from this feature
	removeEventListeners() Removes all registered event listeners from the component's target element
	removeListener(obj) Removes the specified object as a listener from this object
	select() Abstract method that should be overriden by subclasses
	setContextMenu(contextMenu) Sets the context menu for this component
	setProperty(name, value) Sets a new property for this feature
	setTip(text, options) Sets a tool tip for this map feature
	setVisible(value) Sets the visibility of this map feature
	setZIndex(zIndex) Sets the z-index property of this feature
	showInfoWindow(html, options) Displays the specified HTML markup in the info window above this feature
	toJson() Outputs a JSON representation of this map feature

Event Summary

Event Attributes	Event Name and Description
	featureClicked(feature)
	featureRemoved(feature)

Parameters:

{GSMenuItem} menuItem

the menu item to set

Throws:

{Error}

if an attempt is made to add a context menu item before a context menu has been set

---

Parameters:

{String} eventType

the event that should trigger the handler function

{Function} func

the function to be invoked when the event is triggered

Deprecated:

use GSMapFeature#addEventListener instead

Returns:

{Object} a token that can be passed to the GSMapFeature.removeEventHandler() method to remove the event handler

---

Parameters:

{String} eventType

the event type to add the listener for. Can be one of: click, mousedown, mouseup, mouseover, mouseout

{Function} func

The function to invoke when the event is triggered

{Object} scope Optional

the scope (this reference) in which the function is executed

Throws:

{Error}

if this component does not define a reference to its DOM element

Returns:

{Object} a token that can be passed to the GSEventManager#removeEventListener to remove the event listener.

---

Parameters:

{Object} obj

the object that should be added as a listener

Returns:

{boolean} true if the object was successfully added as a listener

---

Parameters:

{String} name

the name of the property to delete

---

---

---

Returns:

{GSContextMenu} the context menu belonging to this component

---

Returns:

{GSContextMenu} the compoonents's context menu

---

Returns:

{Object} user-defined properties

---

Parameters:

{String} name

the name of the property to get

---

Returns:

{boolean} true if this map feature is selectable

---

Returns:

{boolean} true if this map feature is currently visible on the map

---

Returns:

{GSContextMenu} the context menu that was removed, or null if no context menu was set

---

Parameters:

{GSMenuItem} menuItem

the menu item to remove

Returns:

{boolean} true if the menu item was removed from the component's list of menu items, false if the menu item was not contained in the list

---

Parameters:

{Object} token

a token identifying the event handler to be removed

Deprecated:

use GSMapFeature#removeEventListener instead

---

Parameters:

{Object} token

a token identifying the event handler to be removed

---

---

Parameters:

{Object} obj

the object that should be removed as a listener

Returns:

{boolean} true if the specified listener object was removed successfully

---

---

Parameters:

{GSContextMenu} contextMenu

the context menu to display in response to right-click events on this component

---

Parameters:

{String} name

the name of the property to set

{Mixed} value

the value to set

---

Parameters:

{String} text

the text to display in the tool tip

{Object} options Optional

an object literal specifying optional configuration properties

{boolean} options.fixed

if true the tip is statically positioned relative to its owning element. If not fixed the tip will follow the mouse while its within the boundaries of the owning element (defaults to false)

{int} options.showDelay

the delay the onShow method is called, defaults to 100ms

{int} options.hideDelay

the delay the onHide method is called, defaults to 100ms

{int} options.maxDisplayChars

the maximum number of characters that will be displayed in the tool tip

{String} options.className

the CSS class name to apply to the tip element, if not provided the tip will use a default style

{GSPoint} options.offset

the pixel offset for the tip. If the fixed option is true the tip is positioned relative to the top-left corner of the owning element, otherwise it is positioned relative to the mouse position

---

Parameters:

{boolean} value

true if this feature should be visible on the map

---

Parameters:

{int} zIndex

the zIndex to use for this feature

---

Parameters:

{String} html

the HTML markup to display in the info window.

{Object} options Optional

optional parameters for configuring the map's info window

{String} options.title

the text to be displayed in the info window title bar

{boolean} options.maximizable

if true a maximize button will be provided for maximizing the info window

{Mixed} options.maxContent

a DOM node or HTML string to be displayed when the info window is maximized

{GSDimension} options.maxSize

the size the info window body should be maximized to. If not specified will resize to relative to the map window up to the internal maximum size (1000 x 800px)

{Function} options.onopen

a function to be called when the info window is opened

{Function} options.onclose

a function to be called when the info window is closed

{boolean} options.showCloseButton

if true a close button will be displayed on the info window, defaults to true

Throws:

{Error}

if html is undefined

---

Returns:

{String} a JSON string

Parameters:

{GSMapFeature} feature

the feature that was clicked

---

Parameters:

{GSMapFeature} feature

the feature that was removed

---