Interface JawgPlacesOptions

Basic options for Places JS.

new JawgPlaces({
  accessToken: '<Access-Token>',
  input: '#my-input'
})
interface JawgPlacesOptions {
    accessToken?: string;
    boundary?: BoudaryOptions;
    clearCross?: boolean;
    debounceDelay?: number;
    focusPoint?: LatLon | (() => LatLon);
    input?: string | HTMLElement;
    language?: string | (() => string);
    layers?: string | string[] | (() => string) | (() => string[]);
    minLength?: number;
    onClear?: (() => void);
    onClick?: ((feature) => void);
    onClose?: (() => void);
    onError?: ((error) => void);
    onFeatures?: ((features) => void);
    resultContainer?: string | HTMLElement;
    reverse?: ReverseOptions;
    searchOnTyping?: boolean;
    showResultIcons?: boolean;
    size?: number;
    sources?: string | string[] | (() => string[]) | (() => string);
}

Hierarchy (view full)

Properties

accessToken? boundary? clearCross? debounceDelay? focusPoint? input? language? layers? minLength? onClear? onClick? onClose? onError? onFeatures? resultContainer? reverse? searchOnTyping? showResultIcons? size? sources?

Properties

Optional accessToken

accessToken?: string

Your personal access token, create your own on the Jawg Lab. This is filled automatically when you get the library with our CDN.

Optional boundary

boundary?: BoudaryOptions

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

Optional clearCross

clearCross?: boolean

Add a clear cross in the right side of the input.

Optional debounceDelay

debounceDelay?: number

Set the number of milliseconds to wait before a search validation. If you press Enter the search will be immediately validated. This option work only when searchOnTyping=true. Default value is 350.

Optional focusPoint

focusPoint?: LatLon | (() => LatLon)

See FocusOptions.point

Type declaration

Optional input

input?: string | HTMLElement

The <input> to transform into a geocoding search bar. This can be either a id (e.g #my-input), class selector (e.g .my-input) or the HTMLElement. With some frameworks/UI libs such as React, you can't use the ref here.

Optional language

language?: string | (() => string)

Return results in a specific language using BCP47 standard (e.g 'en', 'fr', 'de', ...). By default, we use HTTP Header set by the browser and English when not present. Language can be static or dynamic with the function.

Type declaration

    • (): string

    • Returns string

Optional layers

layers?: string | string[] | (() => string) | (() => string[])

Filter the kind of place you want to find. Layers can be static or dynamic with the function.

Type declaration

    • (): string

    • Returns string

Type declaration

    • (): string[]

    • Returns string[]

Optional minLength

minLength?: number

Set the minimum number of characters to trigger a geocoding request. If you press Enter the search will be validated even if the length is not reached. This option work only when searchOnTyping=true. Default value is 0.

Optional onClear

onClear?: (() => void)

Callback triggered when the input is empty.

Type declaration

    • (): void

    • Callback triggered when the input is empty.

      Returns void

Optional onClick

onClick?: ((feature) => void)

Callback triggered when the user click on a result.

Type declaration

    • (feature): void

    • Callback triggered when the user click on a result.

      Parameters

      • feature: Feature

        The feature selected by the user

      Returns void

Param: feature

The feature selected by the user

Optional onClose

onClose?: (() => void)

Callback triggered when the result list is closed/cleared.

Type declaration

    • (): void

    • Callback triggered when the result list is closed/cleared.

      Returns void

Optional onError

onError?: ((error) => void)

Callback triggered when Jawg Places API returns an error.

Type declaration

    • (error): void

    • Callback triggered when Jawg Places API returns an error.

      Parameters

      • error: any

      Returns void

Optional onFeatures

onFeatures?: ((features) => void)

Callback triggered when Jawg Places API returns without error.

Type declaration

    • (features): void

    • Callback triggered when Jawg Places API returns without error.

      Parameters

      • features: Feature[]

        The list of features returned by Jawg Places API

      Returns void

Param: features

The list of features returned by Jawg Places API

Optional resultContainer

resultContainer?: string | HTMLElement

The custom <div> that will contain the geocoding results. By default the container is created by Jawg Places JS. With some frameworks/UI libs such as React, you can't use the ref here.

Optional reverse

reverse?: ReverseOptions

Option to activate reverse geocoding withing the input. You can paste coordinates in the form {lat}/{lon} in the input. The separation can be either / (slash), , (comma) or (space).

Optional searchOnTyping

searchOnTyping?: boolean

Set this to true to activate search on typing, this will also use autocomplete search. Default value is false, you will need to press Enter to validate your search.

Optional showResultIcons

showResultIcons?: boolean

Show icon at the left each results.

Optional size

size?: number

Set the default number of results. Default value is 10.

Optional sources

sources?: string | string[] | (() => string[]) | (() => string)

Filter the originating source of the data. Sources can be static or dynamic with the function.

Type declaration

    • (): string[]

    • Returns string[]

Type declaration

    • (): string

    • Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc