Class ProjectionAPI

Hierarchy

  • ProjectionAPI

Constructors

constructor

Properties

espgWorker

Methods

addProjection checkProj checkProjBomber defaultEpsgLookup epsgLookup normalizeProj projectExtent projectGeoJson projectGeometry setEpsgLookup

Constructors

constructor

Properties

Protected espgWorker

espgWorker: EpsgLookup

Methods

addProjection

  • Add a projection definition.

    Parameters

    • code: string | number

      the projection code to add.

    • proj4formula: string

      the formula for the projection.

    Returns void

checkProj

  • Check whether or not a spatialReference is supported by proj4 library. Attempt to load from epsg source if not.

    Parameters

    • spatialReference: any

      to be checked to see if it's supported by proj4. Can be ESRI SR object or a EPSG string.

    Returns Promise<boolean>

    true if proj was defined or was able to download definition. false if out of luck

checkProjBomber

Private defaultEpsgLookup

epsgLookup

  • Fetch a projection string from an EPSG service

    Parameters

    • code: string | number

      an EPSG projection code to look up

    Returns Promise<string>

    resolves with proj4 projection string, or rejects if not found

normalizeProj

  • Convert a projection to an string that is compatible with proj4. If it is an ESRI SpatialReference or an integer it will be converted.

    Parameters

    • proj: any

      an ESRI SpatialReference, integer or string. Strings will be unchanged and unchecked, ints and SpatialReference objects will be converted.

    Returns string

    A string in the form EPSG:#### or a WKT

projectExtent

  • Reproject an Extent object on the client. Does not require network traffic, but may not handle conversion between projection types as well. Internally it tests 8 points along each edge and takes the max extent of the result. To project an extent without warping, convert to a polygon and do a standard geometry projection (result will not be guaranteed to retain Extent characteristics)

    Parameters

    • destProj: SrDef

      the spatial reference of the result (as SpatialReference, integer WKID or an EPSG string)

    • extent: Extent

      to reproject

    Returns Promise<Extent>

    resolves with the reprojected extent

projectGeoJson

  • Reproject a GeoJSON object in place. Note the .crs of the object will not be updated or corrected.

    Parameters

    • geoJson: any
    • inputSR: string | number
    • outputSR: string | number

    Returns Promise<any>

    resolves with projected geoJson

projectGeometry

  • Project a geometry using local calculations (proj4)

    Parameters

    • destProj: SrDef

      the spatial reference of the result (as SpatialReference, integer WKID or an EPSG string)

    • geometry: BaseGeometry

      a RAMP API Geometry object

    Returns Promise<BaseGeometry>

    resolve in a RAMP API Geometry object with co-ordinates in the destination projection

setEpsgLookup

  • Provide an alternate lookup function to find proj4 projection strings based off EPSG codes. Be aware this setting is page-wide, and will impact any instance of RAMP running. Function signature should be f(code: string | number): Promise<string>. The function should be able to parse codes that are

    • just the integer part of an EPSG code (e.g. 1234)
    • a string in EPSG format (e.g. 'EPSG:1234')
    • a string in URN format (e.g. 'urn:ogc:def:crs:EPSG::1234')

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc