GeographicCoordinates Property

Specifies the geographic coordinates by which nearby Canada Post locations are to be found.

Syntax

 canadapostaddress.getGeographicCoordinates([callback])
 canadapostaddress.setGeographicCoordinates( geographicCoordinates, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getGeographicCoordinates([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setGeographicCoordinates([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

If present, the GeographicCoordinates will be used as the search criteria to locate Canada Post locations when FindLocations is called.

The latitude and longitude should be specified in decimal format and separated by a comma. For example "35.912366,-78.939459"

Data Type

String