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

Stadia Maps Geospatial APIs

import { Coordinate } from './Coordinate';
/**
 *
 * @export
 * @interface HeightResponse
 */
export interface HeightResponse {
    /**
     * An identifier to disambiguate requests (echoed by the server).
     * @type {string}
     * @memberof HeightResponse
     */
    id?: string;
    /**
     *
     * @type {Array<Coordinate>}
     * @memberof HeightResponse
     */
    shape?: Array<Coordinate>;
    /**
     * The input polyline.
     * @type {string}
     * @memberof HeightResponse
     */
    encodedPolyline?: string;
    /**
     * The list of heights for each point, in meters. Present only if `range` is `false`. Null values indicate missing data.
     * @type {Array<number>}
     * @memberof HeightResponse
     */
    height?: Array<number>;
    /**
     * The list of ranges and heights for each point in the shape, where each entry is an array of length 2. Present only if `range` is `true`. In each pair, the first element represents the range or distance along the input locations. It is the cumulative distance along the previous coordinates in the shape up to the current coordinate. This value for the first coordinate in the shape will always be 0. The second element in the pair represents the height or elevation at the associated coordinate. The height is null if no height data exists for a given location. Both values are expressed in meters.
     * @type {Array<Array<number>>}
     * @memberof HeightResponse
     */
    rangeHeight?: Array<Array<number>>;
}
/**
 * Check if a given object implements the HeightResponse interface.
 */
export declare function instanceOfHeightResponse(value: object): value is HeightResponse;
export declare function HeightResponseFromJSON(json: any): HeightResponse;
export declare function HeightResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): HeightResponse;
export declare function HeightResponseToJSON(json: any): HeightResponse;
export declare function HeightResponseToJSONTyped(value?: HeightResponse | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=HeightResponse.d.ts.map