Class: LightMenu

Menu.Desktop LightMenu

ClassicTree

new LightMenu(isReload)

modules/menu/desktop/classicTree.js, line 23
Name Type Description
isReload boolean Flag indicating if tree is reloaded
Fires:
  • ModelList#event:RadioRequestModelListGetCollection
  • Autostart#event:RadioTriggerAutostartInitializedModul
Listens to Events:
  • Autostart#event:RadioTriggerAutostartStartModul
  • LayerClassicView#event:UpdateClassicTree
  • ModelList#event:updateOverlayerView
  • LayerClassicView#event:setIndexOnModels

Extends

Methods

inherited addCatalogFolderView(model){void}

modules/menu/desktop/listViewMain.js, line 84
Add Catalog Folder View
Name Type Description
model * to do

inherited addDesktopFolderView(model){void}

modules/menu/desktop/listViewMain.js, line 92
Add Desktop Folder View
Name Type Description
model * to do

addItems(models){void}

modules/menu/desktop/classicTree.js, line 185
Add the items
Name Type Description
models Array Array of models

inherited addStaticLinkView(model){void}

modules/menu/desktop/listViewMain.js, line 116
Add Static Link View
Name Type Description
model * to do

inherited addToolView(model){void}

modules/menu/desktop/listViewMain.js, line 108
Add Tool View
Name Type Description
model * to do

inherited addViewpointView(model){void}

modules/menu/desktop/listViewMain.js, line 100
Add Viewpoint View
Name Type Description
model * to do

addViews(models){void}

modules/menu/desktop/listViewLight.js, line 48
Add Views
Name Type Description
models * to do

checkFolderFilter(folderModel, filterString){boolean}

modules/menu/desktop/classicTree.js, line 354
Recursive function to filter hierarchical folder structures
Name Type Description
folderModel model Input folder model
filterString String Filter string
Returns:
if a child model (layer or folder) name applies to filter

getLength(lightModels, length){Number}

modules/menu/desktop/classicTree.js, line 216
Get the total length of items in the given model collection
Name Type Description
lightModels Array The collection to count all items in
length Number The current length count
Returns:
total length

hasMatchingParent(model, searchTerm){boolean}

modules/menu/desktop/classicTree.js, line 382
Recursive function to determine if model has a matching parent node
Name Type Description
model * Input model
searchTerm * The searchTerm to compare with
Returns:
if a parent model (folder) name applies to filter

inherited parseViews(models){void}

modules/menu/desktop/listViewMain.js, line 48
Parse Views
Name Type Description
models Array to do

removeLayerById(id){void}

modules/menu/desktop/classicTree.js, line 333
Removes a layer from the layer tree and thus from the map.
Name Type Description
id String The ID of the layer (tree) model

inherited removeView(){void}

modules/menu/desktop/listViewMain.js, line 123
Remove View

render(){void}

modules/menu/desktop/listViewLight.js, line 32
Renders the data to DOM.

renderFilterField(){void}

modules/menu/desktop/classicTree.js, line 176
Renders the filter input field on top of the tree.

inherited renderMain(){void}

modules/menu/desktop/listViewMain.js, line 25
Render Main

renderSubTree(parentId, firstTime){void}

modules/menu/desktop/classicTree.js, line 94
Renders all layers and folders recursively starting from the given parent
Name Type Description
parentId string The id of the parent to start from
firstTime boolean Flag indicating if the tree is initially build

inherited renderTopMenu(){void}

modules/menu/desktop/listViewMain.js, line 36
Render the top menu

renderTree(firstRender){void}

modules/menu/desktop/classicTree.js, line 66
Renders the tree.
Name Type Description
firstRender Boolean Whether it's the first render run or not.

setAllDescendantsInvisible(parentId){void}

modules/menu/desktop/classicTree.js, line 291
Sets all models (layer/folder/tools) of a parent id to invisible in the tree in mobile mode folders are closed
Name Type Description
parentId String id of the parent model

setAllDescendantsVisible(parentId){void}

modules/menu/desktop/classicTree.js, line 316
Sets all models (layer/folder/tools) of a parent id to visible in the tree
Name Type Description
parentId String id of the parent model

setIndexOnModels(lightModels, length, keepOrder){Number}

modules/menu/desktop/classicTree.js, line 239
Sets the `selectionIDX` property on all items in the given collection, respecting childs by recursive method calls.
Name Type Description
lightModels Array The collection to set the index for
length Number The number used as index to start from
keepOrder Boolean Flag indicating if existing order should be kept
Returns:
next index to use

setSelectionIndexForModels(lightModels){void}

modules/menu/desktop/classicTree.js, line 204
Method used to initially set the `selectionIDX` property on all layer and folder instances. The order defined in the `config.json` is used here. Should only be called initially, may reset custom order when called later on
Name Type Description
lightModels Array The light models to handle the index with

setVisibleByParentIsExpanded(parentId){void}

modules/menu/desktop/classicTree.js, line 274
Sets all children visible or invisible depending on the parents attribute `isExpanded`
Name Type Description
parentId String The Id of the parent whose children should be set visible

startModul(modulId){void}

modules/menu/desktop/listViewLight.js, line 60
Start Modul
Name Type Description
modulId * to do

Menu.Desktop LightMenu

LightMenu

new LightMenu()

modules/menu/desktop/listViewLight.js, line 16
Fires:
  • ModelList#event:RadioRequestModelListGetCollection
  • ModelList#event:UpdateLightTree
  • Autostart#event:RadioTriggerAutostartInitializedModul
Listens to Events:
  • Autostart#event:RadioTriggerAutostartStartModul

Extends

Methods

inherited addCatalogFolderView(model){void}

modules/menu/desktop/listViewMain.js, line 84
Add Catalog Folder View
Name Type Description
model * to do

inherited addDesktopFolderView(model){void}

modules/menu/desktop/listViewMain.js, line 92
Add Desktop Folder View
Name Type Description
model * to do

addItems(models){void}

modules/menu/desktop/classicTree.js, line 185
Add the items
Name Type Description
models Array Array of models

inherited addStaticLinkView(model){void}

modules/menu/desktop/listViewMain.js, line 116
Add Static Link View
Name Type Description
model * to do

inherited addToolView(model){void}

modules/menu/desktop/listViewMain.js, line 108
Add Tool View
Name Type Description
model * to do

inherited addViewpointView(model){void}

modules/menu/desktop/listViewMain.js, line 100
Add Viewpoint View
Name Type Description
model * to do

addViews(models){void}

modules/menu/desktop/listViewLight.js, line 48
Add Views
Name Type Description
models * to do

checkFolderFilter(folderModel, filterString){boolean}

modules/menu/desktop/classicTree.js, line 354
Recursive function to filter hierarchical folder structures
Name Type Description
folderModel model Input folder model
filterString String Filter string
Returns:
if a child model (layer or folder) name applies to filter

getLength(lightModels, length){Number}

modules/menu/desktop/classicTree.js, line 216
Get the total length of items in the given model collection
Name Type Description
lightModels Array The collection to count all items in
length Number The current length count
Returns:
total length

hasMatchingParent(model, searchTerm){boolean}

modules/menu/desktop/classicTree.js, line 382
Recursive function to determine if model has a matching parent node
Name Type Description
model * Input model
searchTerm * The searchTerm to compare with
Returns:
if a parent model (folder) name applies to filter

inherited parseViews(models){void}

modules/menu/desktop/listViewMain.js, line 48
Parse Views
Name Type Description
models Array to do

removeLayerById(id){void}

modules/menu/desktop/classicTree.js, line 333
Removes a layer from the layer tree and thus from the map.
Name Type Description
id String The ID of the layer (tree) model

inherited removeView(){void}

modules/menu/desktop/listViewMain.js, line 123
Remove View

render(){void}

modules/menu/desktop/listViewLight.js, line 32
Renders the data to DOM.

renderFilterField(){void}

modules/menu/desktop/classicTree.js, line 176
Renders the filter input field on top of the tree.

inherited renderMain(){void}

modules/menu/desktop/listViewMain.js, line 25
Render Main

renderSubTree(parentId, firstTime){void}

modules/menu/desktop/classicTree.js, line 94
Renders all layers and folders recursively starting from the given parent
Name Type Description
parentId string The id of the parent to start from
firstTime boolean Flag indicating if the tree is initially build

inherited renderTopMenu(){void}

modules/menu/desktop/listViewMain.js, line 36
Render the top menu

renderTree(firstRender){void}

modules/menu/desktop/classicTree.js, line 66
Renders the tree.
Name Type Description
firstRender Boolean Whether it's the first render run or not.

setAllDescendantsInvisible(parentId){void}

modules/menu/desktop/classicTree.js, line 291
Sets all models (layer/folder/tools) of a parent id to invisible in the tree in mobile mode folders are closed
Name Type Description
parentId String id of the parent model

setAllDescendantsVisible(parentId){void}

modules/menu/desktop/classicTree.js, line 316
Sets all models (layer/folder/tools) of a parent id to visible in the tree
Name Type Description
parentId String id of the parent model

setIndexOnModels(lightModels, length, keepOrder){Number}

modules/menu/desktop/classicTree.js, line 239
Sets the `selectionIDX` property on all items in the given collection, respecting childs by recursive method calls.
Name Type Description
lightModels Array The collection to set the index for
length Number The number used as index to start from
keepOrder Boolean Flag indicating if existing order should be kept
Returns:
next index to use

setSelectionIndexForModels(lightModels){void}

modules/menu/desktop/classicTree.js, line 204
Method used to initially set the `selectionIDX` property on all layer and folder instances. The order defined in the `config.json` is used here. Should only be called initially, may reset custom order when called later on
Name Type Description
lightModels Array The light models to handle the index with

setVisibleByParentIsExpanded(parentId){void}

modules/menu/desktop/classicTree.js, line 274
Sets all children visible or invisible depending on the parents attribute `isExpanded`
Name Type Description
parentId String The Id of the parent whose children should be set visible

startModul(modulId){void}

modules/menu/desktop/listViewLight.js, line 60
Start Modul
Name Type Description
modulId * to do