@stadiamaps/api/dist/generated/models/MatrixResponse.d.ts

Stadia Maps Geospatial APIs

import { Warning } from './Warning';
import { Coordinate } from './Coordinate';
import { RoutingLongUnits } from './RoutingLongUnits';
import { MatrixDistance } from './MatrixDistance';
/**
 *
 * @export
 * @interface MatrixResponse
 */
export interface MatrixResponse {
    /**
     * An identifier to disambiguate requests (echoed by the server).
     * @type {string}
     * @memberof MatrixResponse
     */
    id?: string;
    /**
     * The list of starting locations determined by snapping to the nearest appropriate point on the road network for the costing model. All locations appear in the same order as the input.
     * @type {Array<Coordinate>}
     * @memberof MatrixResponse
     */
    sources: Array<Coordinate>;
    /**
     * The list of ending locations determined by snapping to the nearest appropriate point on the road network for the costing model. All locations appear in the same order as the input.
     * @type {Array<Coordinate>}
     * @memberof MatrixResponse
     */
    targets: Array<Coordinate>;
    /**
     * The matrix of starting and ending locations, along with the computed distance and travel time. The array is row-ordered. This means that the time and distance from the first location to all others forms the first row of the array, followed by the time and distance from the second source location to all target locations, etc.
     * @type {Array<Array<MatrixDistance>>}
     * @memberof MatrixResponse
     */
    sourcesToTargets: Array<Array<MatrixDistance>>;
    /**
     *
     * @type {Array<Warning>}
     * @memberof MatrixResponse
     */
    warnings?: Array<Warning>;
    /**
     *
     * @type {RoutingLongUnits}
     * @memberof MatrixResponse
     */
    units: RoutingLongUnits;
}
/**
 * Check if a given object implements the MatrixResponse interface.
 */
export declare function instanceOfMatrixResponse(value: object): value is MatrixResponse;
export declare function MatrixResponseFromJSON(json: any): MatrixResponse;
export declare function MatrixResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): MatrixResponse;
export declare function MatrixResponseToJSON(json: any): MatrixResponse;
export declare function MatrixResponseToJSONTyped(value?: MatrixResponse | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=MatrixResponse.d.ts.map