open2json

Index

Modules

"haversine"

Classes

Provider

Interfaces

Functions

Object literals

Functions

buildOsmQueryString

buildOsmQueryString(bbox: BoundingBox, tagFilters: string[], overpassTimeout: number): string

- Defined in src/query.osm.ts:35
Parameters
- bbox: BoundingBox
- tagFilters: string[]
- overpassTimeout: number
Returns string

buildWikidataQueryString

buildWikidataQueryString(bbox: BoundingBox, options?: ProviderOptions): string

- Defined in src/query.wikidata.ts:52
build query string for wikidata

Parameters
- bbox: BoundingBox
  
  Bounding box in which to query
- Optional options: ProviderOptions
  
  query options
Returns string

conflate

conflate(osmGeoJson: FeatureCollection, wikidataGeoJson: FeatureCollection, options?: ProviderOptions): FeatureCollection

- Defined in src/conflate.ts:13
Conflate two GeoJson objects, copying Wikidata information into matching OpenStreetMap objects. Unmatched Wikidata objects are left out because the default wikidata query is broader than just drinking water fountains.

Parameters
- osmGeoJson: FeatureCollection
  
  GeoJson from OpenStreetMap, standardized.
- wikidataGeoJson: FeatureCollection
  
  GeoJson from Wikidata, standardized.
- Default value options: ProviderOptions = defaultOptions
  
  Provider Options (only the conflateRadius option is used)
Returns FeatureCollection

createFeature

createFeature(obj: any, imageWidth: number): Feature

- Defined in src/standardize.wikidata.ts:30
Parameters
- obj: any
- imageWidth: number
Returns Feature

dropEmpty

dropEmpty(geoJsonArray: FeatureCollection[]): FeatureCollection[]

- Defined in src/index.ts:92
Drop any geoJsons that have zero features

Parameters
- geoJsonArray: FeatureCollection[]
Returns FeatureCollection[]

getFilePath

getFilePath(file: string, width: number): undefined | string

- Defined in src/standardize.wikidata.ts:71
Parameters
- file: string
  
  Filename, without "File:" or similar
- width: number
  
  Width of returned image thumbnail, optional
Returns undefined | string

indexOfSmallest

indexOfSmallest(a: number[]): number

- Defined in src/conflate.ts:97
Parameters
- a: number[]
Returns number

matchByLocation

matchByLocation(wikidataGeoJson: FeatureCollection, osmGeoJson: FeatureCollection, conflateRadius?: number): void

- Defined in src/conflate.ts:42
Parameters
- wikidataGeoJson: FeatureCollection
- osmGeoJson: FeatureCollection
- Default value conflateRadius: number = defaultOptions.conflateRadius
Returns void

matchByQID

matchByQID(wikidataGeoJson: FeatureCollection, osmGeoJson: FeatureCollection): void

- Defined in src/conflate.ts:26
Parameters
- wikidataGeoJson: FeatureCollection
- osmGeoJson: FeatureCollection
Returns void

queryOsm

queryOsm(bbox: BoundingBox, options?: ProviderOptions): Promise<FeatureCollection>

- Defined in src/query.osm.ts:9
Function to query OSM with a bounding box and return simplified geojson object

Parameters
- bbox: BoundingBox
- Default value options: ProviderOptions = defaultOptions
Returns Promise<FeatureCollection>

queryWikidata

queryWikidata(bbox: BoundingBox, options?: ProviderOptions): Promise<FeatureCollection>

- Defined in src/query.wikidata.ts:15
Function to query Wikidata with a bounding box and return results as json. Multiple objects are returned if a wikidata has multiple images or locations. These duplicates can be removed with standardization.

Parameters
- bbox: BoundingBox
  
  Bounding box
- Default value options: ProviderOptions = defaultOptions
  
  Query options
Returns Promise<FeatureCollection>

sanitizeFilename

sanitizeFilename(filename: string): string

- Defined in src/standardize.wikidata.ts:91
Parameters
- filename: string
Returns string

standardizeOsm

standardizeOsm(data: FeatureCollection): FeatureCollection

- Defined in src/standardize.osm.ts:8
standardize into simple geoJson format. Unavailable values are undefined

Parameters
- data: FeatureCollection
  
  data returned by OpenStreetMap overpass API
Returns FeatureCollection

standardizeWikidata

standardizeWikidata(res: any, imageWidth?: number): FeatureCollection

- Defined in src/standardize.wikidata.ts:9
Create GeoJson from wikidata response json. This involves extracting the image and location data, and removing duplicates

Parameters
- res: any
  
  Response from wikidata query
- Default value imageWidth: number = 300
  
  Width of the image thumbnails that should be returned
Returns FeatureCollection

Object literals

Const baselBoundingBox

baselBoundingBox: object

latMax

latMax: number = 47.7

latMin

latMin: number = 47.5

lonMax

lonMax: number = 7.7

lonMin

lonMin: number = 7.5

Const defaultOptions

defaultOptions: object

conflateRadius

conflateRadius: number = 20

overpassTagFilters

overpassTagFilters: string[] = [// see https://wiki.openstreetmap.org/wiki/Overpass_API/Language_Guide#Tag_request_clauses_.28or_.22tag_filters.22.29'amenity=drinking_water','drinking_water=yes',]

overpassTimeout

overpassTimeout: number = 30

overpassUrl

overpassUrl: string = "https://z.overpass-api.de/api/interpreter"

wdEntityClasses

wdEntityClasses: string[] = ['Q1630622', // drinking water fountain (Q1630622)'Q483453', // fountain (Q483453)'Q43483', // water well (Q43483)]

wdImageWidth

wdImageWidth: number = 350

wdLangs

wdLangs: string = "en,de,fr,it,es"

Const difficultArea

difficultArea: object

latMax

latMax: number = 55

latMin

latMin: number = 51

lonMax

lonMax: number = 15

lonMin

lonMin: number = 14

Const osmGeoJson

osmGeoJson: object

features

features: (object | object)[] = [{type: 'Feature',id: 'node/567050952',properties: {name: 'Fischermädchen-Brunnen',id: 'node/567050952',},geometry: { type: 'Point', coordinates: [7.5875386, 47.5512434] },},{type: 'Feature',id: 'node/575614798',properties: {id: 'node/575614798',},geometry: { type: 'Point', coordinates: [7.5873847, 47.555435] },},{type: 'Feature',id: 'node/583590302',properties: {name: 'Augustiner-Brunnen',id: 'node/583590302',},geometry: { type: 'Point', coordinates: [7.59034, 47.5579655] },},]

type

type: "FeatureCollection" = "FeatureCollection"

Const standardOsmGeoJson

standardOsmGeoJson: object

features

features: (object | object)[] = [{"type": "Feature","properties": {"name": "Froschbrunnen","id_osm": "node/201499848"},"geometry": {"type": "Point","coordinates": [8.0518839,47.386667]}},{"type": "Feature","properties": {"id_osm": "node/260353812"},"geometry": {"type": "Point","coordinates": [8.1844675,47.350443]}},{"type": "Feature","properties": {"id_osm": "node/260353813"},"geometry": {"type": "Point","coordinates": [8.1863668,47.3499435]}},{"type": "Feature","properties": {"id_osm": "node/260353814"},"geometry": {"type": "Point","coordinates": [8.1847468,47.3611431]}}]

type

type: "FeatureCollection" = "FeatureCollection"

Const standardWikiGeoJson

standardWikiGeoJson: object

features

features: object[] = [{"type": "Feature","properties": {"id_wikidata": "Q22952244","ispotable": true,"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/d3/Bourogne%2C_Lavoir_du_corps_de_garde.jpg/300px-Bourogne%2C_Lavoir_du_corps_de_garde.jpg","name": "fontaine-lavoir du corps de garde"},"geometry": {"type": "Point","coordinates": [6.919,47.5613]}},{"type": "Feature","properties": {"id_wikidata": "Q56570011","ispotable": true,"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/d3/Schwanengasse-Brunnen_(Schwan_-_Heinz_Schwarz_1956)_05.jpg/300px-Schwanengasse-Brunnen_(Schwan_-_Heinz_Schwarz_1956)_05.jpg","name": "Schwanengasse fountain"},"geometry": {"type": "Point","coordinates": [7.4391,46.9463]}},{"type": "Feature","properties": {"id_wikidata": "Q56721751","ispotable": false,"image": "https://upload.wikimedia.org/wikipedia/commons/thumb/9/98/Zwillingsbrunnen_Bundeshaus_03.jpg/300px-Zwillingsbrunnen_Bundeshaus_03.jpg","name": "twin fountains Federal Palace"},"geometry": {"type": "Point","coordinates": [7.44432,46.94638]}}]

type

type: "FeatureCollection" = "FeatureCollection"

Const zuriBoundingBox

zuriBoundingBox: object

latMax

latMax: number = 47.36852337512103

latMin

latMin: number = 47.363692917827215

lonMax

lonMax: number = 8.539960384368896

lonMin

lonMin: number = 8.535035848617554

Index

Modules

Classes

Interfaces

Functions

Object literals

Functions

buildOsmQueryString

Parameters

bbox: BoundingBox

tagFilters: string[]

overpassTimeout: number

Returns string

buildWikidataQueryString

Parameters

bbox: BoundingBox

Optional options: ProviderOptions

Returns string

conflate

Parameters

osmGeoJson: FeatureCollection

wikidataGeoJson: FeatureCollection

Default value options: ProviderOptions = defaultOptions

Returns FeatureCollection

createFeature

Parameters

obj: any

imageWidth: number

Returns Feature

dropEmpty

Parameters

geoJsonArray: FeatureCollection[]

Returns FeatureCollection[]

getFilePath

Parameters

file: string

width: number

Returns undefined | string

indexOfSmallest

Parameters

a: number[]

Returns number

matchByLocation

Parameters

wikidataGeoJson: FeatureCollection

osmGeoJson: FeatureCollection

Default value conflateRadius: number = defaultOptions.conflateRadius

Returns void

matchByQID

Parameters

wikidataGeoJson: FeatureCollection

osmGeoJson: FeatureCollection

Returns void

queryOsm

Parameters

bbox: BoundingBox

Default value options: ProviderOptions = defaultOptions

Returns Promise<FeatureCollection>

queryWikidata

Parameters

bbox: BoundingBox

Default value options: ProviderOptions = defaultOptions

Returns Promise<FeatureCollection>

sanitizeFilename

Parameters

filename: string

Returns string

standardizeOsm

Parameters

data: FeatureCollection

Returns FeatureCollection

standardizeWikidata

Parameters

res: any

Default value imageWidth: number = 300

Returns FeatureCollection

Object literals

Const baselBoundingBox

latMax

latMin