@stadiamaps/api
Version:
Stadia Maps Geospatial APIs
72 lines • 2.58 kB
TypeScript
import { GeocodingSource } from './GeocodingSource';
import { GeocodingLayer } from './GeocodingLayer';
/**
*
* @export
* @interface ReverseQuery
*/
export interface ReverseQuery {
/**
* The latitude of the point at which to perform the search.
* @type {number}
* @memberof ReverseQuery
*/
pointLat?: number;
/**
* The longitude of the point at which to perform the search.
* @type {number}
* @memberof ReverseQuery
*/
pointLon?: number;
/**
* The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.
* @type {number}
* @memberof ReverseQuery
*/
boundaryCircleRadius?: number;
/**
* A list of country codes in ISO 3116-1 alpha-2 or alpha-3 format.
* @type {Array<string>}
* @memberof ReverseQuery
*/
boundaryCountry?: Array<string>;
/**
* The GID of an area to limit the search to.
* @type {string}
* @memberof ReverseQuery
*/
boundaryGid?: string;
/**
* A list of layers to limit the search to.
* @type {Array<GeocodingLayer>}
* @memberof ReverseQuery
*/
layers?: Array<GeocodingLayer>;
/**
* A list of sources to limit the search to.
* @type {Array<GeocodingSource>}
* @memberof ReverseQuery
*/
sources?: Array<GeocodingSource>;
/**
* The maximum number of results to return.
* @type {number}
* @memberof ReverseQuery
*/
size?: number;
/**
* A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.
* @type {string}
* @memberof ReverseQuery
*/
lang?: string;
}
/**
* Check if a given object implements the ReverseQuery interface.
*/
export declare function instanceOfReverseQuery(value: object): value is ReverseQuery;
export declare function ReverseQueryFromJSON(json: any): ReverseQuery;
export declare function ReverseQueryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReverseQuery;
export declare function ReverseQueryToJSON(json: any): ReverseQuery;
export declare function ReverseQueryToJSONTyped(value?: ReverseQuery | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=ReverseQuery.d.ts.map