Interface BoudaryOptions

Set of options when you are looking for places in a particular region.

new JawgPlaces({
  boundaries: {
    countries: 'fra',
    point: { lat: 0, lon: 0 },
    gids: ['whosonfirst:locality:101751119']
  }
})
interface BoudaryOptions {
    circle: CircleOptions | (() => CircleOptions);
    countries: string | string[] | (() => string[]) | (() => string);
    gids: string | string[] | (() => string[]) | (() => string);
    rectangle: RectangleOptions | (() => RectangleOptions);
}

Properties

circle countries gids rectangle

Properties

circle

circle: CircleOptions | (() => CircleOptions)

Search within a circular region. Circle can be static or dynamic with the function.

Type declaration

countries

countries: string | string[] | (() => string[]) | (() => string)

Add a restriction by alpha-2 or alpha-3 ISO-3166 country code. Countries can be static or dynamic with the function.

Type declaration

    • (): string[]

    • Returns string[]

Type declaration

    • (): string

    • Returns string

gids

gids: string | string[] | (() => string[]) | (() => string)

Add a restriction by GIDs. GIDs can be static or dynamic with the function.

Type declaration

    • (): string[]

    • Returns string[]

Type declaration

    • (): string

    • Returns string

rectangle

rectangle: RectangleOptions | (() => RectangleOptions)

Search within a rectangular region. Rectangle can be static or dynamic with the function.

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc