@stadiamaps/api
Version:
Stadia Maps Geospatial APIs
113 lines • 4.8 kB
TypeScript
import { CostingOptions } from './CostingOptions';
import { Coordinate } from './Coordinate';
import { MatrixCostingModel } from './MatrixCostingModel';
import { AnnotationFilters } from './AnnotationFilters';
import { DistanceUnit } from './DistanceUnit';
import { RoutingLanguages } from './RoutingLanguages';
/**
*
* @export
* @interface OptimizedRouteRequest
*/
export interface OptimizedRouteRequest {
/**
*
* @type {DistanceUnit}
* @memberof OptimizedRouteRequest
*/
units?: DistanceUnit;
/**
*
* @type {RoutingLanguages}
* @memberof OptimizedRouteRequest
*/
language?: RoutingLanguages;
/**
* The level of directional narrative to include. Locations and times will always be returned, but narrative generation verbosity can be controlled with this parameter.
* @type {string}
* @memberof OptimizedRouteRequest
*/
directionsType?: OptimizedRouteRequestDirectionsTypeEnum;
/**
* The output response format. The default JSON format is extremely compact and ideal for web or data-constrained use cases where you want to fetch additional attributes on demand in small chunks. The OSRM format is much richer and is configurable with significantly more info for turn-by-turn navigation use cases.
* @type {string}
* @memberof OptimizedRouteRequest
*/
format?: OptimizedRouteRequestFormatEnum;
/**
* Optionally includes helpful banners with timing information for turn-by-turn navigation. This is only available in the OSRM format.
* @type {boolean}
* @memberof OptimizedRouteRequest
*/
bannerInstructions?: boolean;
/**
* Optionally includes voice instructions with timing information for turn-by-turn navigation. This is only available in the OSRM format.
* @type {boolean}
* @memberof OptimizedRouteRequest
*/
voiceInstructions?: boolean;
/**
*
* @type {AnnotationFilters}
* @memberof OptimizedRouteRequest
*/
filters?: AnnotationFilters;
/**
* An identifier to disambiguate requests (echoed by the server).
* @type {string}
* @memberof OptimizedRouteRequest
*/
id?: string;
/**
* The list of locations. The first and last are assumed to be the start and end points, and all intermediate points are locations that you want to visit along the way.
* @type {Array<Coordinate>}
* @memberof OptimizedRouteRequest
*/
locations: Array<Coordinate>;
/**
*
* @type {MatrixCostingModel}
* @memberof OptimizedRouteRequest
*/
costing: MatrixCostingModel;
/**
*
* @type {CostingOptions}
* @memberof OptimizedRouteRequest
*/
costingOptions?: CostingOptions;
/**
* If greater than zero, attempts to include elevation along the route at regular intervals. The "native" internal resolution is 30m, so we recommend you use this when possible. This number is interpreted as either meters or feet depending on the unit parameter.
* Elevation for route sections containing a bridge or tunnel is interpolated linearly. This doesn't always match the true elevation of the bridge/tunnel, but it prevents sharp artifacts from the surrounding terrain. This functionality is unique to the routing endpoints and is not available via the elevation API.
* NOTE: This has no effect on the OSRM response format.
* @type {number}
* @memberof OptimizedRouteRequest
*/
elevationInterval?: number;
}
/**
* @export
*/
export declare const OptimizedRouteRequestDirectionsTypeEnum: {
readonly None: "none";
readonly Maneuvers: "maneuvers";
readonly Instructions: "instructions";
};
export type OptimizedRouteRequestDirectionsTypeEnum = (typeof OptimizedRouteRequestDirectionsTypeEnum)[keyof typeof OptimizedRouteRequestDirectionsTypeEnum];
/**
* @export
*/
export declare const OptimizedRouteRequestFormatEnum: {
readonly Json: "json";
readonly Osrm: "osrm";
};
export type OptimizedRouteRequestFormatEnum = (typeof OptimizedRouteRequestFormatEnum)[keyof typeof OptimizedRouteRequestFormatEnum];
/**
* Check if a given object implements the OptimizedRouteRequest interface.
*/
export declare function instanceOfOptimizedRouteRequest(value: object): value is OptimizedRouteRequest;
export declare function OptimizedRouteRequestFromJSON(json: any): OptimizedRouteRequest;
export declare function OptimizedRouteRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): OptimizedRouteRequest;
export declare function OptimizedRouteRequestToJSON(json: any): OptimizedRouteRequest;
export declare function OptimizedRouteRequestToJSONTyped(value?: OptimizedRouteRequest | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=OptimizedRouteRequest.d.ts.map