@stadiamaps/api
Version:
Stadia Maps Geospatial APIs
49 lines • 2.26 kB
TypeScript
import { AnnotationFilters } from './AnnotationFilters';
/**
*
* @export
* @interface ExtendedDirectionsOptions
*/
export interface ExtendedDirectionsOptions {
/**
* 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 ExtendedDirectionsOptions
*/
format?: ExtendedDirectionsOptionsFormatEnum;
/**
* Optionally includes helpful banners with timing information for turn-by-turn navigation. This is only available in the OSRM format.
* @type {boolean}
* @memberof ExtendedDirectionsOptions
*/
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 ExtendedDirectionsOptions
*/
voiceInstructions?: boolean;
/**
*
* @type {AnnotationFilters}
* @memberof ExtendedDirectionsOptions
*/
filters?: AnnotationFilters;
}
/**
* @export
*/
export declare const ExtendedDirectionsOptionsFormatEnum: {
readonly Json: "json";
readonly Osrm: "osrm";
};
export type ExtendedDirectionsOptionsFormatEnum = (typeof ExtendedDirectionsOptionsFormatEnum)[keyof typeof ExtendedDirectionsOptionsFormatEnum];
/**
* Check if a given object implements the ExtendedDirectionsOptions interface.
*/
export declare function instanceOfExtendedDirectionsOptions(value: object): value is ExtendedDirectionsOptions;
export declare function ExtendedDirectionsOptionsFromJSON(json: any): ExtendedDirectionsOptions;
export declare function ExtendedDirectionsOptionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExtendedDirectionsOptions;
export declare function ExtendedDirectionsOptionsToJSON(json: any): ExtendedDirectionsOptions;
export declare function ExtendedDirectionsOptionsToJSONTyped(value?: ExtendedDirectionsOptions | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=ExtendedDirectionsOptions.d.ts.map