Class BNGProjection

BNGProjection class

Hierarchy (View Summary)

Projection
- BNGProjection

Index

Constructors

Properties

Accessors

easting gridReference northing pointerId type

Methods

registerAutoReleaseObject setFields

Constructors

constructor

new BNGProjection(params: { easting: number; northing: number }): BNGProjection
Creates a new BNGProjection
Parameters
- params: { easting: number; northing: number }
  The parameters object
  - easting: number
    The easting coordinate
  - northing: number
    The northing coordinate
Returns BNGProjection
Overrides Projection.constructor
- Defined in map/projections.ts:317

Properties

`Protected`_pointerId

_pointerId: any

Accessors

easting

get easting(): number
Retrieves the easting of the point.

Returns number
The easting of the point as a number.
- Defined in map/projections.ts:384

gridReference

get gridReference(): string
Retrieves the grid reference of the point.

Returns string
The grid reference of the point as a string.
- Defined in map/projections.ts:369
set gridReference(gridReference: string): void
Sets the grid reference of the point.
Parameters
- gridReference: string
  The grid reference of the point.
Returns void
- Defined in map/projections.ts:355

northing

get northing(): number
Retrieves the northing of the point.

Returns number
The northing of the point as a number.
- Defined in map/projections.ts:399

pointerId

get pointerId(): any
Returns any
Inherited from Projection.pointerId
- Defined in map/projections.ts:100

type

get type(): ProjectionType
Retrieves the specific type of the projection.

Returns ProjectionType
The type of the projection as a ProjectionType enumeration.
Inherited from Projection.type
- Defined in map/projections.ts:117

Methods

`Protected`registerAutoReleaseObject

registerAutoReleaseObject(pointerId: any): void
Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.
Parameters
- pointerId: any
  The pointer ID to register
Returns void
Inherited from Projection.registerAutoReleaseObject
- Defined in core/gemautoreleaseobject.ts:14

setFields

setFields(params: { easting: number; northing: number }): void
Sets the easting and northing of the point.
Parameters
- params: { easting: number; northing: number }
  The parameters object
  - easting: number
    The easting coordinate of the point.
  - northing: number
    The northing coordinate of the point.
Returns void
- Defined in map/projections.ts:338