Class EditingSnappingService

Hierarchy

  • EditingSnappingService

Constructors

constructor

Properties

cacheFileDataSource_ cache_ gmfDatasourceFileGroup_ gmfSnappingConfig_ gmfSnappingOptions_ gmfThemes_ gmfTreeManager_ http_ injector_ listenerKeys_ mapViewChangePromise_ map_ ngeoFeaturesSnapInteraction_ ngeoFeatures_ ngeoSnappingSource_ ogcServers_ q_ rootScope_ timeout_ treeCtrlsUnregister_

Methods

activateItem_ deactivateItem_ ensureSnapInteractionsOnTop getOGCServer_ getWFSConfig_ handleFileDataSourceVisibleChange_ handleFileGroupDataSourcesCollectionAdd_ handleFileGroupDataSourcesCollectionRemove_ handleMapMoveEnd_ handleThemesChange_ handleTreeCtrlStateChange_ isSnappingActiveForTreeCtrl_ loadAllItems_ loadItemFeatures_ refresh refreshSnappingSource_ registerTreeCtrl_ setMap unregisterAllTreeCtrl_

Constructors

constructor

  • The snapping service of GMF. Responsible of collecting the treeCtrls that support snapping and store them here. As soon as a treeCtrl state becomes 'on', a WFS GetFeature request is issued to collect the features at the map view location. A new request is sent every time the map is panned or zoomed for each treeCtrl that are still 'on'.

    Features returned by these requests get bound to a ol.interaction.Snap, which allows the snapping to occur on other places where vector features are drawn or modified.

    Ng Inject

    Ngdoc

    service

    Ngname

    gmfSnapping

    Parameters

    • $http: IHttpService

      Angular $http service.

    • $q: IQService

      The Angular $q service.

    • $rootScope: IScope

      Angular rootScope.

    • $injector: IInjectorService

      Angular injector.

    • $timeout: ITimeoutService

      Angular timeout service.

    • gmfDatasourceFileGroup: any

      Group that contains file data sources.

    • gmfSnappingConfig: any

      Snapping configuration options for the features in the Draw tool and in the "Layer Import / Local" tool.

    • gmfThemes: any

      The gmf Themes service.

    • gmfTreeManager: any

      The gmf TreeManager service.

    • ngeoFeatures: Collection<Feature<Geometry>>

      Collection of features.

    • gmfSnappingOptions: any

      The options.

    Returns EditingSnappingService

Properties

cacheFileDataSource_

cacheFileDataSource_: Object

A cache for the File data sources that are added in the FileGroup, i.e. for example when a KML is added, then a File data source is added to the FileGroup's collection, and their features need to be snappable.

cache_

cache_: Object

A cache containing all available snappable items, in which the listening of the state of the treeCtrl is registered and unregistered.

gmfDatasourceFileGroup_

gmfDatasourceFileGroup_: any

gmfSnappingConfig_

gmfSnappingConfig_: any

gmfSnappingOptions_

gmfSnappingOptions_: any

gmfThemes_

gmfThemes_: any

gmfTreeManager_

gmfTreeManager_: any

http_

http_: IHttpService

injector_

injector_: IInjectorService

listenerKeys_

listenerKeys_: EventsKey[]

mapViewChangePromise_

mapViewChangePromise_: IPromise<void>

Reference to the promise taking care of calling all GetFeature requests of the currently active cache items after the map view changed. Used to cancel if the map view changes often within a short period of time.

map_

map_: Map

ngeoFeaturesSnapInteraction_

ngeoFeaturesSnapInteraction_: CustomSnap

ngeoFeatures_

ngeoFeatures_: Collection<Feature<Geometry>>

ngeoSnappingSource_

ngeoSnappingSource_: VectorSource<unknown>

ogcServers_

ogcServers_: any

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

q_

q_: IQService

rootScope_

rootScope_: IScope

timeout_

timeout_: ITimeoutService

treeCtrlsUnregister_

treeCtrlsUnregister_: (() => void)

Type declaration

    • (): void

    • Returns void

Methods

activateItem_

  • activateItem_(item: CacheItem): void

  • Activate a cache item by adding a Snap interaction to the map and launch the initial request to get the features.

    Parameters

    Returns void

deactivateItem_

ensureSnapInteractionsOnTop

  • In order for a ol.interaction.Snap to work properly, it has to be added to the map after any draw interactions or other kinds of interactions that interacts with features on the map.

    This method can be called to make sure the Snap interactions are on top.

    Returns void

getOGCServer_

getWFSConfig_

  • getWFSConfig_(treeCtrl: LayertreeController): WFSConfig

  • Get the configuration required to do WFS requests (for snapping purpose) from a Layertree controller that has a leaf node.

    The following requirements must be met in order for a treeCtrl to be considered supporting WFS:

    1. ogcServers objects are loaded
    2. its node type property is equal to WMS
    3. in its node childLayers property, the queryable property is set to true
    4. the ogcServer defined in 3) has the wfsSupport property set to true.

    Returns

    The configuration object.

    Parameters

    Returns WFSConfig

handleFileDataSourceVisibleChange_

  • handleFileDataSourceVisibleChange_(fileDataSource: default): void

  • Called when the "visible" property of a File data source changes. Add or remove the Snap interaction for that data source depending on the property value.

    Parameters

    • fileDataSource: default

    Returns void

handleFileGroupDataSourcesCollectionAdd_

  • handleFileGroupDataSourcesCollectionAdd_(evt: Event | BaseEvent): void

  • Called when a File data source is added to the File Group (imported geospatial files). Make its features snappable.

    Parameters

    • evt: Event | BaseEvent

      Event

    Returns void

handleFileGroupDataSourcesCollectionRemove_

  • handleFileGroupDataSourcesCollectionRemove_(evt: Event | BaseEvent): void

  • Called when a File data source is removed from the File Group. Remove the features from being snappable.

    Parameters

    • evt: Event | BaseEvent

      Event

    Returns void

handleMapMoveEnd_

  • handleMapMoveEnd_(): void

  • Called when the map view changes. Load all active cache items after a small delay. Cancel any currently delayed call, if required.

    Returns void

handleThemesChange_

  • handleThemesChange_(): void

  • Called when the themes change. Get the OGC servers, then listen to the tree manager Layertree controllers array changes.

    Returns void

handleTreeCtrlStateChange_

isSnappingActiveForTreeCtrl_

loadAllItems_

loadItemFeatures_

  • loadItemFeatures_(item: CacheItem): void

  • For a specific cache item, issue a new WFS GetFeatures request. The returned features set in the item collection of features (they replace any existing ones first).

    Parameters

    Returns void

refresh

refreshSnappingSource_

registerTreeCtrl_

  • registerTreeCtrl_(treeCtrl: LayertreeController): void

  • Registers a newly added Layertree controller 'leaf'. If it's snappable, create and add a cache item with every configuration required to do the snapping. It becomes active when its state is set to 'on'.

    Parameters

    Returns void

setMap

unregisterAllTreeCtrl_

  • unregisterAllTreeCtrl_(): void

  • Unregisters all removed layertree controllers 'leaf'. Remove the according cache item and deactivate it as well. Unregister events.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc