@itwin/core-backend/lib/esm/GeographicCRSServices.d.ts

iTwin.js backend components

/** @packageDocumentation
 * @module iModels
 */
import { Range2dProps } from "@itwin/core-geometry";
/** Describes a coordinate reference system produced by [[getAvailableCoordinateReferenceSystems]].
 * @beta
 */
export interface AvailableCoordinateReferenceSystemProps {
    /** The name of the coordinate reference system. It can be presented to the user in the UI as an identifier for the coordinate reference system. */
    name: string;
    /** The description of the coordinate reference system. It can be presented to the user in the UI as extra information for the coordinate reference system. */
    description: string;
    /** Indicate if the coordinate reference system is deprecated. A coordinate reference system is deprecated if it is no longer recommended for use.
     *  A deprecated coordinate reference system can usually be substituted by a more accurate one. It is possible that an existing project uses a deprecated coordinate reference system.
     *  However, for new projects, it is recommended to use a non-deprecated coordinate reference system.
     */
    deprecated: boolean;
    /** Extent of the coordinate reference system. This is the area where the coordinate reference system can be used.
     *  Outside of this area, the coordinate reference system may not be accurate. The extent is defined by a range of longitude and latitude values.
     *  Minimum longitude and latitude correspond to crsExtent.low.x and crsExtent.low.y, respectively.
     *  Maximum longitude and latitude correspond to crsExtent.high.x and crsExtent.high.y, respectively.
     */
    crsExtent: Range2dProps;
}
/** Arguments supplied to [[getAvailableCoordinateReferenceSystems]].
 * @beta
 */
export interface GetAvailableCoordinateReferenceSystemsArgs {
    /** If provided, only return coordinate reference systems that contain the given extent. Minimum longitude and latitude correspond to extent.low.x and extent.low.y, respectively.
     * Maximum longitude and latitude correspond to extent.high.x and extent.high.y, respectively.
     */
    extent?: Range2dProps;
    /** If true, returns additional coordinate reference systems with extents spanning the entire Earth's surface.
     * @default false
     */
    includeWorld?: boolean;
}
/** Get a list of Geographic Coordinate Reference Systems.
 * @param options Specifies the parameters to filter the returned list.
 * @returns The list of Geographic Coordinate Reference Systems, according to the supplied parameters.
 * @beta
 */
export declare function getAvailableCoordinateReferenceSystems(args: GetAvailableCoordinateReferenceSystemsArgs): Promise<AvailableCoordinateReferenceSystemProps[]>;
//# sourceMappingURL=GeographicCRSServices.d.ts.map