Class GSIcon

Specifies the images that are used to represent a feature on the map.

Class Summary
Constructor Attributes	Constructor Name and Description
	GSIcon(copy) Creates a new `GSIcon`.

Property Summary
Property Attributes	Property Name and Description
	alt The text to be displayed as a tool tip when the user mouses over the icon
	cls An optional CSS class to be applied to the icon
	iconInfoWindowOffset The pixel offset relative to the top left corner of the icon that should be used to position the info window with respect to this icon's pixel coordinate
	iconOffset The pixel offset for the top left corner of the icon image relative to the feature's pixel coordinate
	imageMap An int array that specifies the x/y coordinates of the image map that defines the clickable part of the icon image
	imageMapShape The image map shape.
	imageSize The size of the icon foreground image
	imageSrc The URL for the icon foreground image
	printSize The size of the icon print image
	printSrc The URL for the icon print image
	shadowSize The size of the icon shadow image
	shadowSrc The URL for the icon shadow image

Method Summary
Method Attributes	Method Name and Description
	toJson() Outputs a JSON representation of this icon
	toString() Outputs information about this icon as a String

Class Detail

GSIcon(copy)

Creates a new GSIcon. If a reference to an existing icon is provided as the copy parameter its properties will be copied to the new icon instance.

Parameters:
{GSIcon} copy: an existing icon whose properties will be copied to the new icon

Property Detail

{String} alt

The text to be displayed as a tool tip when the user mouses over the icon

{String} cls

An optional CSS class to be applied to the icon

{GSPoint} iconInfoWindowOffset

The pixel offset relative to the top left corner of the icon that should be used to position the info window with respect to this icon's pixel coordinate

{GSPoint} iconOffset

The pixel offset for the top left corner of the icon image relative to the feature's pixel coordinate

{Array} imageMap

An int array that specifies the x/y coordinates of the image map that defines the clickable part of the icon image

{String} imageMapShape

The image map shape. Can be one of rect, circle, poly. Defaults to poly.

{GSDimension} imageSize

The size of the icon foreground image

{String} imageSrc

The URL for the icon foreground image

{GSDimension} printSize

The size of the icon print image

{String} printSrc

The URL for the icon print image

{GSDimension} shadowSize

The size of the icon shadow image

{String} shadowSrc

The URL for the icon shadow image

Method Detail

{String} toJson()

Outputs a JSON representation of this icon

Returns:: {String} a JSON string

{String} toString()

Outputs information about this icon as a String

Returns:: {String} information about this icon as a String