spatial-monorepo

---

spatial-monorepo / core/src / QueryFacade

Interface: QueryFacade

Defined in: packages/core/src/query/QueryFacade.ts:164

Methods

distanceBetween()

distanceBetween(from, to): number

Defined in: packages/core/src/query/QueryFacade.ts:198

Haversine distance between two [lng, lat] points in metres.

Parameters

from

[number, number]

to

[number, number]

Returns

number

---

distanceBetweenUnits()

distanceBetweenUnits(fromId, toId): number

Defined in: packages/core/src/query/QueryFacade.ts:201

Haversine distance between the centroids of two units in metres. Returns Infinity if either id is unknown.

Parameters

fromId

string

toId

string

Returns

number

---

findUnits()

findUnits(filter?): UnitResult[]

Defined in: packages/core/src/query/QueryFacade.ts:169

Find all units matching the given filter (all fields are optional).

Parameters

filter?

category?

UnitCategory

levelId?

string

name?

string

Substring match on any locale value of the name Labels object.

Returns

UnitResult[]

---

getUnit()

getUnit(id): UnitResult | undefined

Defined in: packages/core/src/query/QueryFacade.ts:166

Look up a single unit by its IMDF feature id.

Parameters

id

string

Returns

UnitResult | undefined

---

listFixtures()

listFixtures(filter?): FixtureResult[]

Defined in: packages/core/src/query/QueryFacade.ts:204

List fixtures/furniture, optionally filtered by category or level.

Parameters

filter?

category?

string

levelId?

string

Returns

FixtureResult[]

---

listLevels()

listLevels(): LevelResult[]

Defined in: packages/core/src/query/QueryFacade.ts:207

List all levels ordered by ordinal ascending.

Returns

LevelResult[]

---

pointInUnit()

pointInUnit(lngLat): string | undefined

Defined in: packages/core/src/query/QueryFacade.ts:189

Returns the id of the unit that contains the given [lng, lat] point, or undefined if none match. Searches all levels.

Parameters

lngLat

[number, number]

Returns

string | undefined

---

pointInUnitOnLevel()

pointInUnitOnLevel(lngLat, levelId): string | undefined

Defined in: packages/core/src/query/QueryFacade.ts:195

Returns the id of the unit that contains the given point on a specific level, or undefined if none match.

Parameters

lngLat

[number, number]

levelId

string

Returns

string | undefined

---

unitArea()

unitArea(id): number

Defined in: packages/core/src/query/QueryFacade.ts:177

Area of a unit in square metres. Returns 0 if id not found.

Parameters

id

string

Returns

number

---

unitBBox()

unitBBox(id): [number, number, number, number] | undefined

Defined in: packages/core/src/query/QueryFacade.ts:183

Bounding box [west, south, east, north] of a unit.

Parameters

id

string

Returns

[number, number, number, number] | undefined

---

unitCentroid()

unitCentroid(id): [number, number] | undefined

Defined in: packages/core/src/query/QueryFacade.ts:180

Centroid [lng, lat] of a unit.

Parameters

id

string

Returns

[number, number] | undefined