Class CMMainContainer extends CMPanel
CMMainContainer Class
Main class to contain the other elements and objects that make up a CMMainContainer.
The elements for a CMMainContainer are held in an array,
Copyright (C) 2020, Humboldt State University, Jim Graham
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General
Public License as published by the Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see
Settings Group: MainContainer
| Setting | Name | Type | Options | Default | Comments |
|---|---|---|---|---|---|
| Scene3D | 3D Scene | CMTYPE_BOOLEAN | false | true to create a 3D scene instead of a 2D scene | |
| AllowMouseEvents | Allow Mouse Events | CMTYPE_BOOLEAN | true | false to create a static map | |
| Resize | Resize | CMTYPE_BOOLEAN | false | true to have the map automatically resize when the window is resized | |
| ImageFolder | Image Folder | CMTYPE_STRING | ../Images/ | (jjg no longer used) path to the folder with the images for the main container (e.g. tool icons) | |
| MapNumber | MapNumber | CMTYPE_INTEGER | 0 | true to have the map automatically resize when the window is resized | |
| MainContainerElementID | MainContainer Element ID | CMTYPE_STRING | CM_MapContainer | ||
| MainContainerClassName | MainContainer Class Name | CMTYPE_STRING | CM_MapContainer | ||
| CanvasContainerID | Canvas Container ID | CMTYPE_STRING | CM_CanvasContainer | ||
| CanvasContainerClassName | Canvas Container Class Name | CMTYPE_STRING | CM_CanvasContainer | ||
| CanvasContainerWithoutPanelsClassName | Canvas Container Without Panels Class Name | CMTYPE_STRING | CM_CanvasContainerWithoutPanels | ||
| CanvasID | Canvas ID | CMTYPE_STRING | CM_Canvas | ||
| CanvasClassName | Canvas Class Name | CMTYPE_STRING | CM_Canvas | ||
| PanelFooterID | Footer Panel ID | CMTYPE_STRING | |||
| PanelToolID | Tool Panel ID | CMTYPE_STRING | |||
| PanelButtonsID | Button Panel ID | CMTYPE_STRING | |||
| ControlsLocation | Controls Location | CMTYPE_ENUMERATED | "None", "MainContainer", "CanvasContainer" | MainContainer | specify whether to have the controls in a panel in the main container or on top of the map |
| IncludeLayerList | Include Layer List | CMTYPE_BOOLEAN | true | true to add the panel with the list of foreground layers | |
| IncludeBackgroundPanel | IncludeBackgroundPanel | CMTYPE_BOOLEAN | true | true to add the panel with the list of background layrs | |
| IncludeSearchPanel | IncludeSearchPanel | CMTYPE_BOOLEAN | true | true to add the search options | |
| IncludeDevEditor | Include Dev Editor | CMTYPE_BOOLEAN | false | true to add the development editor panels |
Static Functions
| Returns | Function | Throws |
|---|---|---|
| SetPopupWindow(NewPopupWindow) | ||
| AddPopupWindow(NewPopupWindow) | ||
| HidePopupWindows() | ||
| AddGlobalEventListener() | ||
| RemoveGlobalEventListener() |
Object Functions
Inherited From: CMPanel
| Returns | Function | Throws |
|---|---|---|
| SetCoordinateUnits(CoordinateUnits) | ||
| SimpleMap() | ||
| CanvasFullScreen() | ||
| Initialize(TheView) | ||
| TheScene | GetScene() | |
| GetGeo() | ||
| GetLayerForegrounds() | ||
| GetLayerBackgrounds() | ||
| TheView | GetView() | |
| TheToolPanel | GetToolPanel() | |
| footer | GetPanelFooter() | |
| SetProjector(TheProjector) | ||
| TheProjector | GetProjector() | |
| SelectTool(ViewToolDef) | ||
| AddLayer(NewLayer) | ||
| AddBackground(NewLayer) | ||
| AddBackgrounds(NewLayer) | ||
| SetSelectedBackgroundIndex() | ||
| ZoomIn() | ||
| ZoomOut() | ||
| ZoomToMax() | ||
| ZoomToBounds(TheBounds) | ||
| ZoomTo(ZoomLevel) | ||
| SetRefCenter(RefX, RefY) | ||
| StartMap(ResizeFlag) | ||
| Resize() |
Static Functions
SetPopupWindow(NewPopupWindow)
Sets the current popup window and hides any existing windows
Parameters:
NewPopupWindow - the DOM element with the visible window
AddPopupWindow(NewPopupWindow)
Adds a new popup window. Existing popup windows will remain open
Parameters:
NewPopupWindow - the DOM element with the visible window
HidePopupWindows()
Sets the current popup window and hides any existing windows
AddGlobalEventListener()
RemoveGlobalEventListener()
Investigating handling more complex mouse movements