Class LayertreeTreeManager

Hierarchy

  • LayertreeTreeManager

Properties

$injector_ $timeout_ gettextCatalog_ gmfThemes_ groupsToAddInThisDigestLoop_ initialLevelFirstGroups_ layerHelper_ ngeoStateManager_ numberOfGroupsToAddInThisDigestLoop ogcServers_ promiseForGroupsToAddInThisDigestLoop_ root rootCtrl rootScope_

Methods

addFirstLevelGroup_ addFirstLevelGroups addGroupByLayerName addGroupByName addSecondLevelGroups getFirstLevelGroupFullState_ getOgcServer getTreeCtrlByNodeId handleThemesChange_ notifyCantAddGroups_ parseTreeNodes refreshFirstLevelGroups_ removeAll removeGroup removePopup_ reorderChild_ setFirstLevelGroupFullState_ setFirstLevelGroups setInitialFirstLevelGroups setSearchedChild toggleNodeCheck_ updateTreeGroupsState_

Properties

$injector_

$injector_: IInjectorService

$timeout_

$timeout_: ITimeoutService

gettextCatalog_

gettextCatalog_: gettextCatalog

gmfThemes_

gmfThemes_: any

groupsToAddInThisDigestLoop_

groupsToAddInThisDigestLoop_: any[]

initialLevelFirstGroups_

initialLevelFirstGroups_: any[]

layerHelper_

layerHelper_: LayerHelper

ngeoStateManager_

ngeoStateManager_: StatemanagerService

numberOfGroupsToAddInThisDigestLoop

numberOfGroupsToAddInThisDigestLoop: number

Number of groups to add to the layertree during one single Angular digest loop.

ogcServers_

ogcServers_: any

A reference to the OGC servers loaded by the theme service.

promiseForGroupsToAddInThisDigestLoop_

promiseForGroupsToAddInThisDigestLoop_: IPromise<void>

root

root: any

The root node and its children used to generate the layertree (with the same ordre).

rootCtrl

rootCtrl: LayertreeController

The controller of the (unique) root layer tree. The array of top level layer trees is available through rootCtrl.children. The order doesn't match with the ordre of the displayed layertree.

rootScope_

rootScope_: IScope

Methods

addFirstLevelGroup_

  • addFirstLevelGroup_(group: any): boolean

  • Add a group as tree's children without consideration of this service 'mode'. Add it only if it's not already in the tree.

    Returns

    true if the group has been added.

    Parameters

    • group: any

      The group to add.

    Returns boolean

addFirstLevelGroups

  • Add some groups as tree's children. If the service use mode 'flush', the previous tree's children will be removed. Add only groups that are not already in the tree.

    Returns

    True if the group has been added. False otherwise.

    Parameters

    • firstLevelGroups: any[]

      An array of gmf theme group.

    • Optional opt_add: boolean

      if true, force to use the 'add' mode this time.

    • Optional opt_silent: boolean

      if true notifyCantAddGroups_ is not called.

    Returns boolean

addGroupByLayerName

  • Retrieve a group by the name of a layer that is contained in this group (first found). This group will be added in the tree. Do nothing if any corresponding group is found.

    Parameters

    • layerName: string

      Name of the layer inside the group to add.

    • Optional opt_add: boolean

      if true, force to use the 'add' mode this time.

    • Optional opt_silent: boolean

      if true notifyCantAddGroups_ is not called

    Returns void

addGroupByName

  • Retrieve a group (first found) by its name and add in the tree. Do nothing if any corresponding group is found.

    Parameters

    • groupName: string

      Name of the group to add.

    • Optional opt_add: boolean

      if true, force to use the 'add' mode this time.

    Returns void

addSecondLevelGroups

  • Add some groups as tree's children. If the service use mode 'flush', the previous tree's children will be removed. Add only groups that are not already in the tree.

    NB: The first level group is added, second-level tree is set active when it corresponds to the searched group.

    Returns

    True if the group has been added. False otherwise.

    Parameters

    • firstLevelGroups: any[]

      An array of gmf theme group.

    • groupName: string

      The group's name to add.

    • Optional opt_add: boolean

      if true, force to use the 'add' mode this time.

    • Optional opt_silent: boolean

      if true notifyCantAddGroups_ is not called.

    Returns boolean

getFirstLevelGroupFullState_

getOgcServer

getTreeCtrlByNodeId

handleThemesChange_

  • handleThemesChange_(): void

  • Called when the themes change. Get the OGC servers, then listen to the tree manager Layertree controllers array changes. The themes could have been changed so it also call a refresh of the layertree.

    Returns void

notifyCantAddGroups_

  • notifyCantAddGroups_(groups: any[]): void

  • Display a notification that informs that the given groups are already in the tree.

    Parameters

    • groups: any[]

      An array of groups that already in the tree.

    Returns void

parseTreeNodes

refreshFirstLevelGroups_

  • refreshFirstLevelGroups_(themes: any[]): void

  • Keep the state of each existing first-level-groups in the layertree then remove it and recreate it with nodes that come from the new theme and the corresponding saved state (when possible, otherwise, juste take the corresponding new node). FIXME: Currently doesn't save nor restore the opacity.

    Parameters

    • themes: any[]

      the array of themes to be based on.

    Returns void

removeAll

removeGroup

  • Remove a group from this tree's children. The first group that is found ( based on its name) will be removed. If any is found, nothing will append.

    Parameters

    • group: any

      The group to remove.

    Returns void

removePopup_

reorderChild_

  • reorderChild_(array: any[], old_index: number, new_index: number): void

  • Parameters

    • array: any[]

      An array of groups.

    • old_index: number

      The old index before reorder (the current one).

    • new_index: number

      The new index after reorder.

    Returns void

setFirstLevelGroupFullState_

setFirstLevelGroups

  • Set some groups as tree's children. If the service use mode 'flush', the previous tree's children will be removed. Add only groups that are not already in the tree.

    Returns

    True if the group has been added. False otherwise.

    Parameters

    • firstLevelGroups: any[]

      An array of gmf theme group.

    Returns boolean

setInitialFirstLevelGroups

  • Parameters

    • firstGroups: any[]

      The groups we add to the layertree

    Returns void

setSearchedChild

  • Enable/disable the tree child (node) and apply it to children if present.

    Parameters

    • node: any

      The child object in the tree.

    • enabled: boolean

      If the child is active or not in the layer-tree.

    Returns void

toggleNodeCheck_

  • toggleNodeCheck_(node: any, names: string[]): void

  • Set the child nodes metadata isChecked if its name is among the list of given names. If a child node also has children, check those instead.

    Parameters

    • node: any

      The original node.

    • names: string[]

      Array of node names to check (i.e. that should have their checkbox checked)

    Returns void

updateTreeGroupsState_

  • updateTreeGroupsState_(groups: any[], removedGroups: any[]): void

  • Update the application state with the list of first level groups in the tree.

    Parameters

    • groups: any[]

      current firstlevel groups of the tree.

    • removedGroups: any[]

      groups removed within this operation.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc