Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Controller

Hierarchy

  • Controller

Index

Properties

Methods

Properties

$timeout_

$timeout_: ITimeoutService

dataLayerGroup_

dataLayerGroup_: LayerGroup

dimensions

dimensions: Object

gmfDataSourceBeingFiltered

gmfDataSourceBeingFiltered: any

gmfExternalDataSourcesManager

gmfExternalDataSourcesManager: any

gmfLayerBeingSwipe

gmfLayerBeingSwipe: any

gmfPermalink_

gmfPermalink_: any

gmfSyncLayertreeMap_

gmfSyncLayertreeMap_: any

gmfThemes_

gmfThemes_: any

gmfTreeManager_

gmfTreeManager_: any

groupNodeStates_

groupNodeStates_: Object

layerHelper_

layerHelper_: LayerHelper

layers

layers: BaseLayer[]

map

map: Map

ngeoWMSTime_

ngeoWMSTime_: WMSTime

options

options: any

root

root: any

scope_

scope_: IScope

Methods

$onInit

  • $onInit(): void

afterReorder

  • afterReorder(): void

  • Update the layers order in the map and the treeCtrl in the treeManager after a reorder of the first-level groups. Then update the permalink.

    Returns void

displayMetadata

getFirstParentWithLayerFunctions

getLayer

  • Use the gmfSyncLayertreeMap_ to create and get layer corresponding to this treeCtrl. The layer will be inserted into the map. The layer can be null if the treeCtrl is based on a node inside a mixed node. It this case, the layer will be in the first parent declared as a mixed node.

    Parameters

    Returns BaseLayer | LayerGroup

    The OpenLayers layer or group for the node.

getLegendIconURL

  • Get the icon image URL for the given treeCtrl's layer. It can only return a string for internal WMS layers without multiple childlayers in the node.

    Parameters

    Returns string

    The icon legend URL or undefined.

getLegendsObject

  • Get the legends object (<LayerName: url> for each layer) for the given treeCtrl.

    Parameters

    Returns Object

    A <layerName: url> object that provides a layer for each layer.

getNodeState

  • Return the current state of the given treeCtrl's node. Return a class name that match with the current node activation state.

    Parameters

    Returns string

    'on' or 'off' or 'indeterminate'.

getNumberOfLegendsObject

getResolutionStyle

  • getResolutionStyle(gmfLayer: any): string

  • Return 'out-of-resolution' if the current resolution of the map is out of the min/max resolution in the node.

    Parameters

    • gmfLayer: any

      the GeoMapFish Layer. WMTS layer is also allowed (the type is defined as GmfLayerWMS only to avoid some useless tests to know if a minResolutionHint property can exist on the node).

    Returns string

    'out-of-resolution' or undefined.

getScale_

  • getScale_(): number

isFiltrable

isNodeLegendVisible

  • isNodeLegendVisible(legendNodeId: string): boolean

  • Parameters

    • legendNodeId: string

      The DOM node legend id

    Returns boolean

    Whenever the legend is currently displayed.

isSnappingActivated

listeners

  • Remove layer from this component's layergroup (and then, from the map) on a ngeo layertree destroy event.

    Parameters

    • scope: IScope

      treeCtrl scope.

    • treeCtrl: LayertreeController

      ngeo layertree controller, from the current node.

    Returns void

nodesCount

  • nodesCount(): number

removeAllNodes

  • removeAllNodes(): void

removeNode

  • removeNode(node: any): void

supportsCustomization

  • Determines whether the layer tree controller supports being customized. For example, having its layer opacity changed, displaying its legend, etc.

    If any requirement is met, then the treeCtrl is considered supporting "customization", regardless of what it actually is.

    The requirements are:

    • must not be the root controller, any of the following:
      • it supports legend
      • it supports having the layer opacity being changed

    Parameters

    Returns boolean

    Whether the layer tree controller supports being "customized" or not.

supportsLegend

supportsOpacityChange

tagPopup

  • tagPopup(node: any): void

toggleActive

toggleFiltrableDataSource

  • toggleFiltrableDataSource(ds: any): void

toggleNodeLegend

  • toggleNodeLegend(legendNodeId: string): void

toggleNodeMenu

  • toggleNodeMenu(menuNodeId: string): void

toggleSnapping

toggleSwipeLayer

      updateDimensions_

      updateLayerDimensions_

      • updateLayerDimensions_(layer: Layer<Source, any>, node: any): void

      updateTimeData

      • Update the timeRangeValue property of the data source bound to the given tree controller and the state of the permalink using the given time.

        LayertreeController.prototype.updateTimeData - description

        Parameters

        • layertreeCtrl: LayertreeController

          ngeo layertree controller

        • time: TimeRange

          The start and optionally the end datetime (for time range selection) selected by user

        Returns void

      updateWMSTimeLayerState

      • Update the timeRangeValue property of the data source bound to the given tree controller using the given time. If the tree controller has no data source, it means that it has children and they might have data sources.

        The setting of the TIME parameter on the layer occurs in the gmf.datasource.Manager service

        LayertreeController.prototype.updateWMSTimeLayerState - description

        Parameters

        • layertreeCtrl: LayertreeController

          ngeo layertree controller

        • time: TimeRange

          The start and optionally the end datetime (for time range selection) selected by user

        Returns void

      zoomToResolution

      Generated using TypeDoc