ngw-map | NextGIS Frontend

Index

References

createWebMap

Classes

Interfaces

Functions

References

createWebMap

Re-exports createWebMap

Type aliases

AdapterConstructor

AdapterConstructor: () => Promise<Type<LayerAdapter> | any>

Type declaration

- (): Promise<Type<LayerAdapter> | any>
- Returns Promise<Type<LayerAdapter> | any>

CallbackFilter

CallbackFilter<F, L>: (opt: LayerDefinition<F, L>) => boolean

Type parameters

F: Feature = Feature
L = any

Type declaration

- (opt: LayerDefinition<F, L>): boolean
- Parameters
  - opt: LayerDefinition<F, L>
  Returns boolean

ControlPosition

ControlPosition: "top-right" | "top-left" | "bottom-right" | "bottom-left"

ControlPositions

ControlPositions: ControlPosition

deprecated: use ControlPosition instead

ControlsOptions

ControlsOptions<O, K>: { [ control in K]: O[K] }

Type parameters

O: MapControls = MapControls
K: keyof O = keyof O

Cursor

Available cursor names from https://developer.mozilla.org/ru/docs/Web/CSS/cursor

DataLayerFilter

DataLayerFilter<F, L>: CallbackFilter<F, L>

Type parameters

F: Feature = Feature
L = any

FeatureLayerAdapter

FeatureLayerAdapter<P, G, O, M, L>: VectorLayerAdapter<M, L, O, Feature<G, P>>

Generic shortcut to define VectorLayerAdapter from feature

Type parameters

P: FeatureProperties = FeatureProperties
G: Geometry = Geometry
O: VectorAdapterOptions = VectorAdapterOptions
M = any
L = any

HtmlDef

HtmlDef: string | HTMLElement

LayerAdapter

LayerAdapter<M, L, O>: MainLayerAdapter<M, L, O> | VectorLayerAdapter<M, L, O>

Type parameters

M = any
L = any
O: AdapterOptions = AdapterOptions

LayerAdapterDefinition

LayerAdapterDefinition<K>: K | Type<LayerAdapters[K]> | Promise<Type<LayerAdapters[K]> | undefined>

Type parameters

K: keyof LayerAdapters = string

LayerDef

LayerDef: string | LayerAdapter

Available argument types for methods with map layers identification.

example

webMap.addLayer('GEOJSON', { id: 'my_layer' }).then((layer) =>{
  webMap.addLayerData(layer, geojson);
  webMap.addLayerData('my_layer', geojson);
});

NgwIdentifyEvent

NgwIdentifyEvent<F, G>: NgwIdentify & { getIdentifyItems: any }

Type parameters

F = FeatureProperties
G: Geometry = Geometry

NgwResourceDefinition

NgwResourceDefinition: number | [number, string] | NgwLayerOptions

OnBeforeLayerAdd

OnBeforeLayerAdd: (e: { adapter?: Type<LayerAdapter>; options: AdapterOptions & Record<string, any> }) => { adapter?: Type<LayerAdapter>; options?: AdapterOptions } | undefined

Type declaration

- (e: { adapter?: Type<LayerAdapter>; options: AdapterOptions & Record<string, any> }): { adapter?: Type<LayerAdapter>; options?: AdapterOptions } | undefined
- Parameters
  - e: { adapter?: Type<LayerAdapter>; options: AdapterOptions & Record<string, any> }
    - Optional adapter?: Type<LayerAdapter>
    - options: AdapterOptions & Record<string, any>
  Returns { adapter?: Type<LayerAdapter>; options?: AdapterOptions } | undefined

OnClick

OnClick: OnClickSync | onClickAsync

OnClickSync

OnClickSync: () => void

Type declaration

- (): void
- Returns void

OnLayerClickOptions

OnLayerClickOptions<F, L>: OnLayerMouseOptions<F, L>

deprecated: use OnLayerMouseOptions instead

Type parameters

F: Feature = Feature
L = LayerAdapter

OnLayerSelectType

OnLayerSelectType: "api" | "click" | "hover"

OnToggleClick

OnToggleClick: OnToggleClickSync | onToggleClickAsync

OnToggleClickSync

OnToggleClickSync: (status: boolean) => void

Type declaration

- (status: boolean): void
- Parameters
  - status: boolean
  Returns void

PopupOnCloseFunction

PopupOnCloseFunction: (args: LayerDefinition) => void

Type declaration

- (args: LayerDefinition): void
- Parameters
  - args: LayerDefinition
  Returns void

VectorAdapterLayerType

VectorAdapterLayerType: "polygon" | "point" | "line"

onClickAsync

onClickAsync: () => Promise<void>

Type declaration

- (): Promise<void>
- Returns Promise<void>

onToggleClickAsync

onToggleClickAsync: (status: boolean) => Promise<void>

Type declaration

- (status: boolean): Promise<void>
- Parameters
  - status: boolean
  Returns Promise<void>

Functions

createNgwMap

createNgwMap(options: NgwMapOptions<any, any>): Promise<NgwMap>

- Defined in packages/ngw-map/src/index.ts:14
Parameters
- options: NgwMapOptions<any, any>
Returns Promise<NgwMap>

createToggleControl

createToggleControl<C>(createButtonControl: (options: ButtonControlOptions) => C, options: ToggleControlOptions): C & ToggleControl

- Defined in packages/webmap/src/components/controls/createToggleControl.ts:11
The toggle is a button with status.

internal
Type parameters
- C = any
Parameters
- createButtonControl: (options: ButtonControlOptions) => C
  - - (options: ButtonControlOptions): C
    - Parameters
      - options: ButtonControlOptions
      Returns C
- options: ToggleControlOptions
Returns C & ToggleControl

detectGeometryType

detectGeometryType(geojson: GeoJsonObject): GeoJsonGeometryTypes

- Defined in packages/webmap/src/utils/geometryTypes.ts:32
internal
Parameters
- geojson: GeoJsonObject
Returns GeoJsonGeometryTypes

findMostFrequentGeomType

findMostFrequentGeomType(arr: ("Point" | "MultiPoint" | "LineString" | "MultiLineString" | "Polygon" | "MultiPolygon" | "GeometryCollection")[]): GeoJsonGeometryTypes

- Defined in packages/webmap/src/utils/geometryTypes.ts:12
internal
Parameters
- arr: ("Point" | "MultiPoint" | "LineString" | "MultiLineString" | "Polygon" | "MultiPolygon" | "GeometryCollection")[]
Returns GeoJsonGeometryTypes

getWebMap

getWebMap<T>(id: number): T

- Defined in packages/webmap/src/container.ts:5
Type parameters
- T: WebMap<any, any, any, WebMapEvents, MapOptions<any, any>, T> = WebMap<any, any, any, WebMapEvents, MapOptions<any, any>>
Parameters
- id: number
Returns T

updateGeoJsonAdapterOptions

updateGeoJsonAdapterOptions<O>(opt: O): O

- Defined in packages/webmap/src/utils/updateGeoJsonAdapterOptions.ts:30
internal
Type parameters
- O: GeoJsonAdapterOptions<Feature<Geometry, GeoJsonProperties>, any, Record<string, any>, Record<string, any>, O> = GeoJsonAdapterOptions<Feature<Geometry, GeoJsonProperties>, any, Record<string, any>, Record<string, any>>
Parameters
- opt: O
Returns O

Index

References

Classes

Interfaces

Type aliases

Functions

References

createWebMap

Type aliases

AdapterConstructor

Type declaration

Returns Promise<Type<LayerAdapter> | any>

CallbackFilter

Type parameters

F: Feature = Feature

L = any

Type declaration

Parameters

opt: LayerDefinition<F, L>

Returns boolean

ControlPosition

ControlPositions

ControlsOptions

Type parameters

O: MapControls = MapControls

K: keyof O = keyof O

Cursor

DataLayerFilter

Type parameters

F: Feature = Feature

L = any

FeatureLayerAdapter

Type parameters

P: FeatureProperties = FeatureProperties

G: Geometry = Geometry

O: VectorAdapterOptions = VectorAdapterOptions

M = any

L = any

HtmlDef

LayerAdapter

Type parameters

M = any

L = any

O: AdapterOptions = AdapterOptions

LayerAdapterDefinition

Type parameters

K: keyof LayerAdapters = string

LayerDef

NgwIdentifyEvent

Type parameters

F = FeatureProperties

G: Geometry = Geometry

NgwResourceDefinition

OnBeforeLayerAdd

Type declaration

Parameters

e: { adapter?: Type<LayerAdapter>; options: AdapterOptions & Record<string, any> }

Optional adapter?: Type<LayerAdapter>

options: AdapterOptions & Record<string, any>

Returns { adapter?: Type<LayerAdapter>; options?: AdapterOptions } | undefined

OnClick

OnClickSync

Type declaration

Returns void

OnLayerClickOptions

Type parameters

F: Feature = Feature

L = LayerAdapter

OnLayerSelectType

OnToggleClick

OnToggleClickSync

Type declaration

Parameters

status: boolean

Returns void

PopupOnCloseFunction

Type declaration

Parameters

args: LayerDefinition

Returns void