Function: placeRef()
function placeRef(description?): object;Defined in: packages/core/src/schemas/fragments.ts:163
A place inside another record: a name, an address, a point
Parameters
| Parameter | Type |
|---|---|
description? | string |
Returns
object
properties
properties: object;properties.address
address: object;properties.address.properties
properties: object;properties.address.properties.country
country: object;properties.address.properties.country.maxLength
maxLength: number = max;properties.address.properties.country.minLength?
minLength?: number = min;properties.address.properties.country.type
type: "string";properties.address.properties.locality
locality: object;properties.address.properties.locality.maxLength
maxLength: number = max;properties.address.properties.locality.minLength?
minLength?: number = min;properties.address.properties.locality.type
type: "string";properties.address.properties.postcode
postcode: object;properties.address.properties.postcode.maxLength
maxLength: number = max;properties.address.properties.postcode.minLength?
minLength?: number = min;properties.address.properties.postcode.type
type: "string";properties.address.properties.region
region: object;properties.address.properties.region.maxLength
maxLength: number = max;properties.address.properties.region.minLength?
minLength?: number = min;properties.address.properties.region.type
type: "string";properties.address.properties.street
street: object;properties.address.properties.street.maxLength
maxLength: number = max;properties.address.properties.street.minLength?
minLength?: number = min;properties.address.properties.street.type
type: "string";properties.address.type
type: "object";properties.cells
cells: object;properties.cells.description
description: string = 'The geohash cells lat and lon are in, coarsest first: precisions 3, 4, 5 and 6';properties.cells.items
items: object;properties.cells.items.maxLength
maxLength: number = max;properties.cells.items.minLength?
minLength?: number = min;properties.cells.items.type
type: "string";properties.cells.maxItems
maxItems: number = 8;properties.cells.type
type: "array";properties.lat
lat: object;properties.lat.maximum
maximum: number = 90;properties.lat.minimum
minimum: number = -90;properties.lat.type
type: "number";properties.lon
lon: object;properties.lon.maximum
maximum: number = 180;properties.lon.minimum
minimum: number = -180;properties.lon.type
type: "number";properties.name
name: object;properties.name.maxLength
maxLength: number = max;properties.name.minLength?
minLength?: number = min;properties.name.type
type: "string";type
type: "object";