Home Reference Source
import {FeatureAPI} from 'guide4you/src/api/FeatureAPI.js'
public class | source

FeatureAPI

Constructor Summary

Public Constructor
public

Member Summary

Private Members
private

mainAPI_: API

private

Method Summary

Public Methods
public

drawFeature(options: object): Promise<Feature>

draw a feature

public

modifyFeature(features: ol.Feature[] | ol.Feature, options: Object)

Modify a given Feature.

public

selectFeature(): Promise<{feature: Feature, layer: VectorLayer}>

Select a feature with a single click

Public Constructors

public constructor() source

Private Members

private mainAPI_: API source

private map_: G4UMap source

Public Methods

public drawFeature(options: object): Promise<Feature> source

draw a feature

Params:

NameTypeAttributeDescription
options object
  • optional
  • default: {}
options.style StyleLike
  • optional
options.type string
  • optional
  • default: 'Point'

possible values are: 'Point', 'LineString', 'Polygon', 'MultiPoint', 'MultiLineString', 'MultiPolygon' or 'Circle'

Return:

Promise<Feature>

public modifyFeature(features: ol.Feature[] | ol.Feature, options: Object) source

Modify a given Feature. The end function needs to be called to indicate that a modifying process is completed.

Params:

NameTypeAttributeDescription
features ol.Feature[] | ol.Feature
options Object
options.style StyleLike
  • optional

public selectFeature(): Promise<{feature: Feature, layer: VectorLayer}> source

Select a feature with a single click

Return:

Promise<{feature: Feature, layer: VectorLayer}>