Class CoordinateSystem

constructor

• new CoordinateSystem(
      params: {
          definition?: string;
          horizontal?: { unit: Unit };
          id?: string;
          name: string;
          srid?: SRID;
          vertical?: { unit: LinearUnit };
      },
  ): CoordinateSystem

  Parameters

  • params: {
        definition?: string;
        horizontal?: { unit: Unit };
        id?: string;
        name: string;
        srid?: SRID;
        vertical?: { unit: LinearUnit };
    }

    • Optionaldefinition?: string

      The WKT definition of the coordinate system.

    • Optionalhorizontal?: { unit: Unit }

      The horizontal component of the coordinate system.

    • Optionalid?: string

      The id of this coordinate system. If unspecified, will use the SRID or name, if available.

    • name: string

      The name of the coordinate system.

    • Optionalsrid?: SRID

      The optional SRID of this coordinate system.

    • Optionalvertical?: { unit: LinearUnit }

      The vertical component of the coordinate system.

  Returns CoordinateSystem

Optional Readonlydefinition

Optional Readonlyhorizontal

Readonlyname

Optional Readonlysrid

Optional Readonlyvertical

Static Readonlyepsg3857

Static Readonlyepsg4326

Static Readonlyepsg4978

Static Readonlyepsg4979

Static Readonlyequirectangular

Static Readonlyunknown

id

• get id(): string

  The internal identifier of this coordinate system. Used as a key in the coordinate system registry. By order of priority, will return: the custom identifier, the SRID, then the name.

  Returns string

metersPerHorizontalUnit

• get metersPerHorizontalUnit(): number

  Returns the conversion factor between horizontal units and meters.

  Returns number

metersPerVerticalUnit

• get metersPerVerticalUnit(): number

  Returns the conversion factor between vertical units and meters.

  Returns number

equals

• equals(other: CoordinateSystem): boolean

  Returns true if the two coordinate systems are equal.

  Parameters

  • other: CoordinateSystem

  Returns boolean

isEpsg

• isEpsg(code: number): boolean

  Parameters

  • code: number

  Returns boolean

isEquirectangular

• isEquirectangular(): boolean

  Returns true if this coordinate system is the special equirectangular coordinate system (used for spherical mapping).

  Returns boolean

isGeographic

• isGeographic(): boolean

  Returns true if this coordinate system has angular units.

  Returns boolean

isUnknown

• isUnknown(): boolean

  Returns true if this coordinate system is the special unknown coordinate system (used for non-georeferenced scenes).

  Returns boolean

StaticfromWkt

• fromWkt(wkt: string, overrides?: { id?: string }): CoordinateSystem

  Creates a CoordinateSystem from its WKT definition.

  Note: this does not register the coordinate system with proj4.js. Use register instead.

  Parameters

  • wkt: string

    The WKT 1 or WKT 2 definition.

  • Optionaloverrides: { id?: string }

  Returns CoordinateSystem

  The created coordinate system, or throws an error if the definition could not be parsed.

Staticget

• get(srid: string): CoordinateSystem

  Parameters

  • srid: string

  Returns CoordinateSystem

Staticregister

• register(
      id: string,
      definition: string,
      options?: { throwIfFailedToRegisterWithProj?: boolean },
  ): CoordinateSystem

  Registers a coordinate system with the underlying proj and OpenLayers libraries.

  Note: it is recommended to provide WKT definitions instead of proj strings, since they provide more metadata about the CRS (such as name, SRID, etc).

  Note 2: some coordinate systems definitions (such as WKT 2's COMPOUNDCRS) are not supported by the underlying proj library. However, if you are not planning to use any feature of Giro3D that requires the proj library, you may ignore failures and warnings.

  Parameters

  • id: string

    The id of the coordinate system.

  • definition: string

    The WKT or proj definition.

  • Optionaloptions: { throwIfFailedToRegisterWithProj?: boolean }

    Registration options.

    • OptionalthrowIfFailedToRegisterWithProj?: boolean

      If true, any error that occurs when registering the coordinate system definition with proj4.js is re-thrown. Otherwise, a simple warning is logged instead.

  Returns CoordinateSystem

  A CoordinateSystem instance.

  Example

  const wkt = `
  PROJCS["RGF93 v1 / Lambert-93",
      GEOGCS["RGF93 v1",
          DATUM["Reseau_Geodesique_Francais_1993_v1",
              SPHEROID["GRS 1980",6378137,298.257222101],
              TOWGS84[0,0,0,0,0,0,0]],
          PRIMEM["Greenwich",0,
              AUTHORITY["EPSG","8901"]],
          UNIT["degree",0.0174532925199433,
              AUTHORITY["EPSG","9122"]],
          AUTHORITY["EPSG","4171"]],
      PROJECTION["Lambert_Conformal_Conic_2SP"],
      PARAMETER["latitude_of_origin",46.5],
      PARAMETER["central_meridian",3],
      PARAMETER["standard_parallel_1",49],
      PARAMETER["standard_parallel_2",44],
      PARAMETER["false_easting",700000],
      PARAMETER["false_northing",6600000],
      UNIT["metre",1,
          AUTHORITY["EPSG","9001"]],
      AXIS["Easting",EAST],
      AXIS["Northing",NORTH],
      AUTHORITY["EPSG","2154"]]
  `;
  
  const crs = CoordinateSystem.register('EPSG:2154', wkt);
  console.log(crs.name);
  Copy