Class W3WProjection

W3WProjection class

Hierarchy (View Summary)

Projection
- W3WProjection

Index

Constructors

Properties

Accessors

pointerId token type words

Methods

registerAutoReleaseObject

Constructors

constructor

new W3WProjection(threeWords: string): W3WProjection
Creates a new W3WProjection
Parameters
- threeWords: string
  The three words token
Returns W3WProjection
Overrides Projection.constructor
- Defined in map/projections.ts:648

Properties

`Protected`_pointerId

_pointerId: any

Accessors

pointerId

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

token

get token(): string
Retrieves the token from the What3Words services.

Returns string
The token as a string.
- Defined in map/projections.ts:709
set token(token: string): void
Sets the token for the W3WProjection.
Parameters
- token: string
  An user obtained token from What3Words services.
Returns void
- Defined in map/projections.ts:666

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

words

get words(): string
Retrieves the three words that represent the location.

Returns string
The three words that represent the location as a string.
- Defined in map/projections.ts:694
set words(words: string): void
Sets the words for the W3WProjection.
Parameters
- words: string
  The three words that represent the location.
Returns void
- Defined in map/projections.ts:680

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