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

Stadia Maps Geospatial APIs

import { Context } from './Context';
import { MatchType } from './MatchType';
import { SourceAttribution } from './SourceAttribution';
import { Precision } from './Precision';
import { AddendumV2 } from './AddendumV2';
import { AddressComponentsV2 } from './AddressComponentsV2';
/**
 * The GeoJSON properties object.
 * @export
 * @interface PropertiesV2
 */
export interface PropertiesV2 {
    /**
     *
     * @type {AddendumV2}
     * @memberof PropertiesV2
     */
    addendum?: AddendumV2 | null;
    /**
     *
     * @type {AddressComponentsV2}
     * @memberof PropertiesV2
     */
    addressComponents?: AddressComponentsV2 | null;
    /**
     * The coarse-grained location of the place (e.g. Seoul, South Korea).
     *
     * In search experiences, this is typically the second line of a result cell.
     * @type {string}
     * @memberof PropertiesV2
     */
    coarseLocation?: string | null;
    /**
     * The level of confidence (0.0 - 1.0) that the result is what you actually searched for.
     *
     * This is not necessarily the same as relevance (results are returned sorted by relevance already),
     * but rather how closely the explicit or inferred components match the result.
     * This is only present for forward geocoding responses (not autocomplete or place details).
     * @type {number}
     * @memberof PropertiesV2
     */
    confidence?: number | null;
    /**
     *
     * @type {Context}
     * @memberof PropertiesV2
     */
    context?: Context | null;
    /**
     * The distance from the search focus point, in kilometers.
     * @type {number}
     * @memberof PropertiesV2
     */
    distance?: number | null;
    /**
     * The address formatted as a single line,
     * following local postal conventions for ordering and separators.
     * @type {string}
     * @memberof PropertiesV2
     */
    formattedAddressLine?: string;
    /**
     * Address components split up into lines,
     * following local postal conventions for ordering and separators.
     * @type {Array<string>}
     * @memberof PropertiesV2
     */
    formattedAddressLines?: Array<string>;
    /**
     * The globally unique identifier for this result.
     *
     * You can use this to uniquely identify a place,
     * and to get the full details from the place details endpoint.
     *
     * NOTE: While GIDs are unique, they may not necessarily be stable in all datasets.
     * @type {string}
     * @memberof PropertiesV2
     */
    gid: string;
    /**
     * The data layer containing the place (e.g. "address" or "poi").
     * @type {string}
     * @memberof PropertiesV2
     */
    layer: string;
    /**
     * The type of match (forward geocoding endpoints only).
     * @type {MatchType}
     * @memberof PropertiesV2
     */
    matchType?: MatchType | null;
    /**
     * The best name for the place, accounting for request language preferences.
     *
     * When building an autocomplete search experience, this is the primary display string.
     * @type {string}
     * @memberof PropertiesV2
     */
    name: string;
    /**
     *
     * @type {Precision}
     * @memberof PropertiesV2
     */
    precision: Precision;
    /**
     * A list of sources from which the result is derived.
     * @type {Array<SourceAttribution>}
     * @memberof PropertiesV2
     */
    sources?: Array<SourceAttribution>;
}
/**
 * Check if a given object implements the PropertiesV2 interface.
 */
export declare function instanceOfPropertiesV2(value: object): value is PropertiesV2;
export declare function PropertiesV2FromJSON(json: any): PropertiesV2;
export declare function PropertiesV2FromJSONTyped(json: any, ignoreDiscriminator: boolean): PropertiesV2;
export declare function PropertiesV2ToJSON(json: any): PropertiesV2;
export declare function PropertiesV2ToJSONTyped(value?: PropertiesV2 | null, ignoreDiscriminator?: boolean): any;
//# sourceMappingURL=PropertiesV2.d.ts.map