POLAR reference
    Preparing search index...

    Function useRoutingStore

    Plugin store for routing.

    • Returns a store, creates it if necessary.

      Parameters

      • Optionalpinia: Pinia | null

        Pinia instance to retrieve the store

      • Optionalhot: StoreGeneric

        dev only hot module replacement

      Returns PiniaStore<useRoutingStore>

    Index
    _instance route routingResponseData
    _hotUpdate

    _instance

    _instance: Pinia
    route: number[][]

    The coordinates selected by the user. If all coordinate pairs are filled, a route is requested.

    routingResponseData:
        | {
            features: {
                geometry: { coordinates: number[][]; type: "LineString"; bbox?: BBox };
                properties: {
                    segments: {
                        distance: number;
                        duration: number;
                        steps: { distance: number; duration: number; instruction: string }[];
                    }[];
                };
                type: "Feature";
                bbox?: BBox;
                id?: string
                | number;
            }[];
            type: "FeatureCollection";
            bbox?: BBox;
        }
        | null

    The response of the routing service depending on the route and other chosen options.

    Type Declaration

    • {
          features: {
              geometry: { coordinates: number[][]; type: "LineString"; bbox?: BBox };
              properties: {
                  segments: {
                      distance: number;
                      duration: number;
                      steps: { distance: number; duration: number; instruction: string }[];
                  }[];
              };
              type: "Feature";
              bbox?: BBox;
              id?: string
              | number;
          }[];
          type: "FeatureCollection";
          bbox?: BBox;
      }
      • features: {
            geometry: { coordinates: number[][]; type: "LineString"; bbox?: BBox };
            properties: {
                segments: {
                    distance: number;
                    duration: number;
                    steps: { distance: number; duration: number; instruction: string }[];
                }[];
            };
            type: "Feature";
            bbox?: BBox;
            id?: string
            | number;
        }[]
      • type: "FeatureCollection"

        Specifies the type of GeoJSON object.

      • 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

    • null

    _hotUpdate

    _hotUpdate: any

    Settings
    Member Visibility

    On This Page
    Properties
    Methods