POLAR reference
    Preparing search index...

    Function useAddressSearchStore

    Plugin store for the address search.

    Index

    Properties

    _instance chosenAddress search searchResults selectedGroupId

    Properties

    _instance

    _instance: Pinia
    chosenAddress:
        | {
            geometry: | { coordinates: number[]; type: "Point"; bbox?: BBox }
            | { coordinates: number[][]; type: "MultiPoint"; bbox?: BBox }
            | { coordinates: number[][]; type: "LineString"; bbox?: BBox }
            | { coordinates: number[][][]; type: "MultiLineString"; bbox?: BBox }
            | { coordinates: number[][][]; type: "Polygon"; bbox?: BBox }
            | { coordinates: number[][][][]; type: "MultiPolygon"; bbox?: BBox };
            properties: GeoJsonProperties;
            title: string;
            type: "Feature" | "reverse_geocoded";
            bbox?: BBox;
            id?: string | number;
        }
        | null

    Address GeoJSON object as returned by a search service. The result and its fields differ depending on the used backend. The callback is used whenever the user clicks on a search result or started a one-result search, which results in an auto-select of the singular result.

    Type Declaration

    • {
          geometry:
              | { coordinates: number[]; type: "Point"; bbox?: BBox }
              | { coordinates: number[][]; type: "MultiPoint"; bbox?: BBox }
              | { coordinates: number[][]; type: "LineString"; bbox?: BBox }
              | { coordinates: number[][][]; type: "MultiLineString"; bbox?: BBox }
              | { coordinates: number[][][]; type: "Polygon"; bbox?: BBox }
              | { coordinates: number[][][][]; type: "MultiPolygon"; bbox?: BBox };
          properties: GeoJsonProperties;
          title: string;
          type: "Feature" | "reverse_geocoded";
          bbox?: BBox;
          id?: string | number;
      }
      • geometry:
            | { coordinates: number[]; type: "Point"; bbox?: BBox }
            | { coordinates: number[][]; type: "MultiPoint"; bbox?: BBox }
            | { coordinates: number[][]; type: "LineString"; bbox?: BBox }
            | { coordinates: number[][][]; type: "MultiLineString"; bbox?: BBox }
            | { coordinates: number[][][]; type: "Polygon"; bbox?: BBox }
            | { coordinates: number[][][][]; type: "MultiPolygon"; bbox?: BBox }

        The feature's geometry

      • properties: GeoJsonProperties

        Properties associated with this feature.

      • title: string

        A fieldName to use for display purposes.

      • type: "Feature" | "reverse_geocoded"
      • Optionalbbox?: BBox

        Bounding box of the coordinate range of the object's Geometries, Features, or Feature Collections. The value of the bbox member is an array of length 2*n where n is the number of dimensions represented in the contained geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries. https://tools.ietf.org/html/rfc7946#section-5

      • Optionalid?: string | number

        A value that uniquely identifies this feature in a https://tools.ietf.org/html/rfc7946#section-3.2.

    • null
    search: (
        input: string,
        autoselect?: "first" | "only" | "never",
    ) => Promise<void>

    This function is solely meant for programmatic access and is not used by direct user input.

    Type Declaration

      • (input: string, autoselect?: "first" | "only" | "never"): Promise<void>

      • Parameters

        • input: string

          Search string to be used.

        • autoselect: "first" | "only" | "never" = 'never'

          Whether to automatically select a result. Defaults to 'never' so that results will be presented as if the user searched for them. Using 'only' will autoselect if a single result was returned; using 'first' will autoselect the first of an arbitrary amount of results >=1.

        Returns Promise<void>

    searchResults:
        | symbol
        | {
            categoryId: string;
            categoryLabel: string;
            features: {
                features: {
                    geometry: | { coordinates: number[]; type: "Point"; bbox?: BBox }
                    | { coordinates: number[][]; type: "MultiPoint"; bbox?: BBox }
                    | { coordinates: number[][]; type: "LineString"; bbox?: BBox }
                    | { coordinates: (...)[][][]; type: "MultiLineString"; bbox?: BBox }
                    | { coordinates: (...)[][][]; type: "Polygon"; bbox?: BBox }
                    | { coordinates: (...)[][][]; type: "MultiPolygon"; bbox?: BBox };
                    properties: GeoJsonProperties;
                    title: string;
                    type: "Feature" | "reverse_geocoded";
                    bbox?: BBox;
                    id?: string | number;
                }[];
                type: "FeatureCollection";
                bbox?: BBox;
            };
            groupId: string;
        }[]

    The results of the search sorted by searchMethod.

    selectedGroupId: string

    ID of the currently selected group. Changing this triggers a new search with the currently set value for inputValue if it has at least one character.

    Settings

    Member Visibility

    On This Page

    Properties