Available Packages

Below are the packages that contain classes with functions that are avialable for scripting

• Includes -

Available Functions

Below is a list of the functions that are available from CanvasMap.These functions are going to be placed under 'controlled change' where developers will be notified at least a year in advance before they change. If you see functions you would recommend changes to or would like to see additional functions added to this list, please contact SchoonerTurtles.

---

Includes Package

CanvasMap

Static Functions

Returns	Function	Throws
	SetPopupWindow(NewPopupWindow)
	HidePopupWindow()
	MouseWheel()

Object Functions

Returns	Function	Throws
	SetImageFolder()
	SetCoordinateUnits()
	SetElement(ElementIndex, Element)
TheElement	GetElement(ElementIndex)
	Initialize(AllowMouseEvents)
	AddRightSticky(TheElement, MoveFlag, Offset)
	AddBottomSticky(TheElement, MoveFlag, Offset)
TheScene	GetScene()
TheView	GetView()
	SetProjector(TheProjector)
	SetMaxBounds(TheBounds)
	SetZoomRange(MinZoom, MaxZoom)
	SelectTool(NewTool)
	SetCurrentTab(TabIndex)
	AddLayer(NewLayer)
	AddBackground(NewLayer)
	StartMap(ResizeFlag)
	ZoomIn()
	ZoomOut()
	ZoomToMax()
	ZoomToBounds(TheBounds)
	ZoomTo(ZoomLevel)
	SetRefCenter(RefX, RefY)
	Resize(ParentElement)

CMLayer

Object Functions

Returns	Function	Throws
	SetName(Name)
Name	GetName()
	SetVisible(Visible)
Visible	GetVisible()
	SetClickable(Clickable)
	GetClickable()
	IsVisible()
	SetBounds(NewBounds)
Bounds	GetBounds()
	SetProjector(NewProjector)
TheProjector	GetProjector()
TheScene	GetScene()
	SetStyle(NewStyle)
TheStyle	GetStyle()
TheStyle	SetInfoWindowWidth()
	SetSelectedFeature(NewFeatureIndex)
	UnselectAll()
	SetMouseOverFeature(NewFeatureIndex)
FeatureIndex	ResetMouseOverFeature()
	SetProperty(Key, Value)
Value	GetProperty(Key, Default)
	SetPropertyAttribute(Key, Value)
Value	GetPropertyAttribute(Key)
	SetFeatureProperties(Key, FeatureProperties)
	SetFeatureProperty(Key, FeatureIndex, Value)
Value	GetFeatureProperty(Key, FeatureIndex, Default)
	SetFeatureFillStyle(FeatureIndex, NewFillStyle)
	SetIconImage(TheURL, OffsetX, OffsetY)
	SetFeatureIconImage(TheURL, OffsetX, OffsetY)
	ShowSettingsDialog()
	SetURL(URL, NewView)
	OnLoad()
NumAttributes	GetNumAttributeRows()
NumColumns	GetNumAttributeColumns()
	GetAttributeHeading(ColumnIndex)
	GetAttributeCell(ColumnIndex, RowIndex)
	GetAttributeArrayByHeading(Heading)

CMScene

Object Functions

Returns	Function	Throws
LayerIndex	AddBackground(TheLayer)
	SetSelectedBackgroundIndex(BackgroundIndex)
	SetBackgroundStyle(BackgroundStyle)
	GetLayer(Index)
LayerIndex	GetLayerIndex(TheLayer)
	MoveLayerUp(Index)
	MoveLayerDown(Index)
	DeleteLayer(Index)
	MoveLayer(TheLayer, NewIndex)
	AddMapElement(TheElement)
	MouseDown(TheView, RefX, RefY)
	MouseMove(TheView, RefX, RefY)
	MouseUp(TheView, RefX, RefY)
	Resize(TheView)
	Paint(TheView)
	Repaint(TheView)
	IncrementRepaintBlocks()
	DecrementRepaintBlocks()
	LayerSettingsChanged(TheLayer)
	AddLayerList(TheElement)
	AddBackgroundList(TheElement)
	SetAttributeTableElement(NewAttributeTableElement)
	UnselectAll()

CMView

Object Functions

Returns	Function	Throws
	GetContext()
The	GetExtent()
Flag	MouseDown()
Flag	MouseMove()
Flag	MouseUp()
Flag	MouseWheel()
	SetMaxBounds(MaxBounds)
	SetZoomRange(MinZoom, MaxZoom)
	SetRefCenter(RefX, RefY)
Result	GetRefCenter()
	ZoomToBounds(NewBounds)
	ZoomIn()
	ZoomOut()
	ZoomTo(ZoomLevel)
	ZoomToMaxBounds()
ZoomLevel	GetZoomLevel()
	SetTool(NewTool)
NewTool	GetTool()
PixelX	GetPixelXFromRefX(RefX)
PixelY	GetPixelYFromRefY(RefY)
PixelCoordinate	GetPixelFromRef(RefX, RefY)
PixelWidth	GetPixelWidthFromRefWidth(RefWidth)
PixelHeight	GetPixelHeightFromRefHeight(RefHeight)
RefWidth	GetRefWidthFromPixelWidth(PixelWidth)
RefHeight	GetRefHeightFromPixelHeight(PixelHeight)
RefX	GetRefXFromPixelX(PixelX)
RefY	GetRefYFromPixelY(PixelY)
	SetStyle(NewStyle, SaveCurrentStyle)
	SaveStyle()
	RestoreStyle()
	Paint()
	PaintImage(TheImage, PixelX, PixelY)
	PaintBackground()
	PaintCircle(X, Y, RadiusInPixels)
	PaintRect(PixelXMin, PixelXMax, PixelYMin, PixelYMax)
	PaintRoundedRect(PixelXMin, PixelXMax, PixelYMin, PixelYMax, PixelXRadius, PixelYRadius)
	PaintRefBounds(TheBounds)
	PaintRefRect(XMin, XMax, YMin, YMax)
	PaintRefCircle(X, Y, RadiusInPixels)
	PaintRefText(X, Y, Text)
	PaintRefLine(X1, Y1, X2, Y2)
	PaintRefPoly2(Xs, Ys, Closed, Stroke)
	PaintRefImage(TheImage, RefX, RefY)
	PaintRefImageScaled(TheImage, RefX, RefY, RefWidth, RefHeight)
	PaintRefPolygon(TheCoordinates)
	PaintRefLineString(TheCoordinates)
	PaintRefPoly(TheCoordinates, Closed)
	PaintRefGeometry(TheGeometry)
	CreateInfoWindow(ID, RefX, RefY, WindowWidth, WindowHeight, TheHTML)