Class Reference
Below is a reference for each of the classes in CanvasMap. This includes the "public" functions within each of the classes. There are other functions that you can call but be warned that they may not be supported in the future.
CanvasMap
CanvasMap is the main class for the library and integrates together a MapHeader, ToolContainer, CanvasContainer, MapFooter, and a LayerList.
Elements in a CanvasMap
- CanvasMap - main object for each map on a page
- TheScene - contains the layers
- TheLayers
- TheView - the veiw for the scene
- Elements - the other visible elements (divs) in the canvas map
- TheScene - contains the layers
Index Definitions
Below are definitions for accessing the elements in CanvasMap
Note: Indexes are used to speed up access to the elements instead of using "getElementByID()" because getElementByID() can take quite a bit of time when used on complex web pages.
| CanvasMap.MAP_CONTAINER | Overall container for the entire CanvasMap |
| CanvasMap.MAP_HEADER | Contains the map title |
| CanvasMap.TOOL_CONTAINER | Contains the "ToolTitle" and tools |
| CanvasMap.TOOL_ADD | A tool to add new data to the map |
| CanvasMap.TOOL_EDIT | A tool to edit existing data |
| CanvasMap.TOOL_INFO | A tool to provide information on data in the map (an "i" or arrow) |
| CanvasMap.TOOL_PAN | A tool to pan the map (the hand) |
| CanvasMap.CANVAS_CONTAINER | The DIV tag that surrounds the main canvas that displays the map data |
| CanvasMap.CANVAS | The canvas element that displays the map data |
| CanvasMap.LAYER_LIST | The list of layers that are available for the map |
| CanvasMap.BACKGROUND_LIST | Contains the list of available backgrounds |
| CanvasMap.SEARCH_PANEL | The panel to perform text searches on attributes |
| CanvasMap.TAB_CONTAINER | The DIV element that contains the tabs above the Layer List, Background List, and Search Panel |
| CanvasMap.MAP_FOOTER | The footer at the bottom of the map that can show the SR, coordinate, and other information |
| CanvasMap.MAP_COORDINATES | The current coordinate under the mouse cursor |
| CanvasMap.MAP_SRS | Contains the spatial reference system for the map |
| CanvasMap.MAP_CREDITS | Contains the credits for the map (user set) |
| CanvasMap.NAVIGATION | The navigation controls (zoom in, zoom out, zoom to all) |
| CanvasMap.TOOLS_TITLE | The title in front of the tools. |
Coordinate Unit Defintions
The following definitions are used to specify the units for coordinates that are displayed in the footer and in scale bars.
- COORDINATES_UNITS_DD
- COORDINATES_UNITS_DMS
- COORDINATES_UNITS_METERS
- COORDINATES_UNITS_FEET
Functions
Below is a description of each of the functions available in CanvasMap.
| Function | Description |
|---|---|
| Constructors | |
| CanvasMap() | Creates a new canvas map object |
| Overriden before Initialize() | These functions could be overriden before Initialize() is called (but rarely would be) |
| MouseWheel() | |
| ClickOnTool(NewTool) | |
| Called before Initialize() | These functions should be called to set parameters before Initialize() is called. |
| SetImageFolder(PathToImages) | Sets the path to the images folder if it has changed. |
| SetCoordinateUnits(NewUnits) | Sets the coordinate units displayed in the footer |
| SetElement(ElementIndex,NewElement) | Change the element before it is added to CanvasMap |
| GetElement(ElementIndex) | |
| SetExistingElements(Flag) | True to use existing elements in the DOM rather than have CanvasMap create the elements |
| SetResizeFlag(ResizeFlag) | Set this to false if you do not want a particular element to be resized. |
| SetSupportsResize(Flag) | Set this to false if you do not want CanvasMap to resize the map in the StartMap() function call. |
| SetMapRightOffset(NewOffset) | For resizable maps, distance from the right side of the map to the right side of the page |
| SetMapBottomOffset(NewOffset) | For resizable maps, distance from the bottom of the map to the bottom of the page |
| SetHorizontalMargin(NewMargin) | Distance between the map and the layer list for resizeable maps |
| Function to Initialize the CanvasMap | |
| Initialize([MouseEvents]) | This function puts together the elements set above. The MouseEvents parameter is optional and will turn off mouse event processing (i.e. makes the map static) if true |
| Called After Initialize() and before StartMap() | |
| AddRightSticky(TheElement,MoveFlag,Offset | Makes an element "sticky" to the right side of the page (i.e. the width will resize) |
| AddBottomSticky(TheElement,MoveFlag,Offset) | Makes an element "sticky" to the bottom of the page (i.e. the height will resize) |
| GetScene() | Returns the scene object for the map |
| GetView() | Returns the view object for the map |
| SetProjector(TheProjector) | Sets the projector if the "ScenePosition" information should include geographic coordinates |
| SetMaxBounds(TheBounds) | Sets the maximum reference bounds for the map. |
| SetZoomRange(Min,Max) | |
| SetTool(TheTool) | Sets the initial tool for the map to display |
| SetCurrentTab(TabIndex) | Set the tab that is selected (0 is typically layers, 1 for background, etc.) |
| AddLayer(TheLayer) | Adds a new layer to the map |
| AddBackground(TheLayer) | Adds a new background layer to the map |
| Function to start the map running | |
| StartMap(ResizeFlag) | Starts the map displaying and interacting with the user. Resize should be true to create a resizable map. |
| Called after the map is started | |
| Paint() | Repaints the map (does not typically need to be called from outsize CanvasMap) |
| ZoomIn() | Zooms the map in by a factor of 2 |
| ZoomOut() | Zooms the map out by a factor of 2 |
| ZoomToMax() | Zoom to the maximum bounds set with SetMaxBounds() |
| ZoomToBounds(TheBounds) | Zooms the map to the specified bounds |
| ZoomTo(NewLevel) | Zooms to the specied zoom level |
| SetRefCenter(RefX,RefY) | Positions the map with RefX,RefY in the center. |
| SelectTool(TheTool) | Changes the tool the user is using |
| Resize(ParentElement) | If you implement your own resize handler, call this function to resize the map |
| Static Functions (called after start) | |
| SetPopupWindow(NewWindow) | Registers a popup window right before it is made visible so it can be closed on mouse clicks |
| HidePopupWindow(NewWindow) | Hides any active windows (this does not typically need to be called) |
CMLayer
Layers display spatial data. Each layer is a little different but they call use the functions described here.
Attributes:
- HTMLAttribute - The attribute to use for HTML -based information (typically in a popup window)
| Function | Description |
|---|---|
| Get and Set Calls | |
| SetName(Name) | set the name of the layer as it appears in the layer list |
| GetName() | |
| SetVisible(VisibleFlag) | make the layer visible (VisibleFlag=true) or not (VisibleFlag=false) |
| GetVisible() | |
| SetHTMLAttribute(HTMLAttribute) | Heading for the attribute with HTML to display as information for a feature |
| GetHTMLAttribute() | Returns the HTML attribute |
| SetScene(NewScene) | Set the scene the layer is in (only called by CanvasMap) |
| GetScene() | |
| SetStyle(NewStyle) | Set the style for the layer. This style will be used when the layer is being painted. |
| GetStyle() | Return the current tyles |
| SetBounds(NewBounds) | Set the bounds for the layer. This is typically only called by subclasses |
| SetInfoWindowWidth(newWidth) | Set the width to use for the layer's info window |
| GetInfoWindowWidth() | |
| Functions to Override | |
| GetIconImage() | Returns an image to paint as the layer's icon in the legend |
| HasSettingsDialog() | Override to return true if the layer uses the default settings dialog or provides its own |
| ShowSettingsDialog() | Displays a settings dialog. The default dialog is displayed if the subclass does not override this function |
| SetURL() | Subclasses will typically override this function to implement the data transfer from the server to the client. |
| Overrides for attribute tables | |
| GetNumAttributeRows() | |
| GetNumAttributeColumns() | |
| GetAttributeHeading(Index) | |
| GetAttributeCell(ColumnIndex) | |
| GetAttributeCell(ColumnIndex,RowIndex) | |
| SetSelectedFeature(Index) | |
| UnselectAll() | |
| Overrides for optimizing caching of data | These are more advanced features for layers that manage a cache as the view changes |
| ZoomLevelChanged(TheView) | Called when the zoom level chagnes |
| ViewMoved(TheView) | Called when the view bounds change |
| Mouse Event Handling | |
| In(TheView,RefX,RefY) | |
| MouseDown(TheView,RefX,RefY) | respond to a "mouseDown()" event within the scene. Return true if the layer used the event and other layers should not. |
| MouseMove(TheView,RefX,RefY) | |
| MouseUp(TheView,RefX,RefY) | |
| Painting | |
| Paint(TheView) | |
| Resize(TheView) | |
| PaintSelected(TheView) | |
| GetSearchResults(SearchPhrase,ResultsPanel) | |
CMScene
| Function | Description |
| Functions to call | |
| LayerIndex=AddBackground(TheLayer) | Adds a background to the background layer list |
| SetSelectedBackgroundIndex(Index) | Sets the background that is selected and displayed |
| LayerIndex=AddLayer(TheLayer) | |
| TheLayer=GetLayer(Index) | |
| LayerIndex=GetLayerIndex(TheLayer) | returns the current index for the specified layer |
| MoveLayerUp(Index) | |
| MoveLayerDown(Index) | |
| DeleteLayer(Index) | |
| MoveLayer(TheLayer,NewIndex) | move the specified layer to the location specified. |
| SetAttributeTableElement(NewAttributeTableElement) | Sets the DOM element for the display of the attribute table |
| UnselectAll() | |
| Tyipcally only called by CanvaMap | |
| AddView(TheView) | |
| GetSearchResults(TheText,SearchResults) | |
| ZoomLevelChanged() | |
| ViewMoved(TheView) | |
| Event Handling, called by CanvasMap | |
| In=function(TheView,RefX,RefY) | |
| MouseDown(TheView,RefX,RefY) | |
| MouseMove(TheView,RefX,RefY) | |
| MouseUp(TheView,RefX,RefY) | |
| Resize=function(TheView) | |
| Paint=function(TheView) | |
| Repaint=function() | |
| LayerSettingsChanged=function(TheLayer) | |
| AddLayerList(TheElement) | Add the list of layers (with supported events) to the specified element |
| AddBackgroundList(TheElement) |
CMView
Typically, only the CanvasMap code will call the view. This is for those wishing to create their own layer types.
Below are the currently defined tools:
- TOOL_HAND
- TOOL_INFO
- TOOL_EDIT
- TOOL_ADD
| Function | Description |
| Constructor | |
| CMView() | Tyipcally called by CanvasMap |
| SetMinScale(MinScale) | Setse the minimum scale value used when the zoom is at 0. This is typically 1 for 1 meter = 1 pixel at ZoomLevel=0 |
| SetScene(CMScene) | Tyipcally called by CanvasMap |
| Setup(CanvasID) | Tyipcally called by CanvasMap |
| GetContext() | |
| GetScale() | Computes a scale value based on the zoom level and MinScale |
| GetExtent() | |
| MouseDown(TheEvent) | |
| MouseMove(TheEvent) | |
| MouseUp(TheEvent) | |
| MouseWheel(TheEvent) | |
| MouseUp(TheEvent) | |
| SetMaxBounds(MaxBounds) | |
| SetZoomRange(MinZoom,MaxZoom) | |
| SetRefCenter(RefX,RefY) | |
| GetRefCenter() | Object:RefX,RefY |
| ZoomToBounds(NewBounds) | |
| ZoomIn() | |
| ZoomOut() | |
| ZoomTo(ZoomLevel) | |
| ZoomToMaxBounds() | |
| SetTool(NewTool) | |
| GetTool() | |
| Pixel to Ref Coordinate Conversion | |
| GetPixelXFromRefX(RefX) | |
| GetPixelYFromRefY(RefY) | |
| GetPixelFromRef(RefX,RefY) | Returns an object with PixelX and PixelY |
| GetPixelWidthFromRefWidth(RefWidth) | |
| GetPixelHeightFromRefHeight(RefHeight) | |
| Ref Coordinate to Pixel Coordinate Conversion | |
| GetRefWidthFromPixelWidth(PixelWidth) | |
| GetRefHeightFromPixelHeight(PixelHeight) | |
| GetRefXFromPixelX(PixelX) | |
| GetRefYFromPixelY(PixelY) | |
| Paint Functions | |
| SetStyle(TheStyle) | Called to set the style for the painting |
| RestoreStyle() | Restores the style that was active before the last call to SetStyle() |
| Paint() | Paints the current contents of the scene into the view |
| Functions to convert from reference coordinates to pixel coordinates | |
| InDocumentPixel(PixelX,PixelY) | |
| InCanvasPixel(PixelX,PixelY) | |
| Paint based on pixel coordinates | |
| PaintImage=function(TheImage,PixelX,PixelY) | |
| Functions to paint items in reference coordinates | |
| PaintRefRect(TheBounds) | |
| PaintRefCircle(X,Y,RadiusInPixels) | |
| PaintRefText(X,Y,Text) | |
| PaintRefLine(X1,Y1,X2,Y2) | |
| PaintRefRaster(TheImage,TheRefBounds) | |
| PaintRefImage(RefX,RefY,TheImage) | |
| PaintRefImageScaled(TheImage,RefX,RefY,RefWidth,RefHeight) | |
| PaintRefPoly2(Xs,Ys,Closed) | Paints from arrays and needs to be renamed |
| Painting functions that are compatible with GeoJSON objects | |
| PaintRefPolygon(TheCoordinates) | |
| PaintRefLineString(TheCoordinates) | |
| PaintRefGeometry(TheGeometry) | |
| CreateInfoWindow(ID,RefX,RefY,WindowWidth,WindowHeight,TheHTML) |