AtlasCT.com
User Manual v5.0

Address

The Address class represent a specific address information, with its coordinates.


Summary
The Address class represent a specific address information, with its coordinates.
The Address constructor; Creates a new Address instance by a separate address fields.
The Address constructor; Creates a new Address instance by a full address value.
The house number value of the address.
The street name of the address.
The city name of the address.
The state name of the address.
The zip code value of the address.
The country name of the address.
The full address value.
The geographical location of the address.
The zoom level of the address.
The name value of the address.
The description of the address.
The default icon url of the address.
The bounding box of the address.
The z position of the address.
The minimum zoom level of the address.
The maximum zoom level of the address.
The country code of the address.
The admin areas array of the address.
The simple data array of the address.

Constructors

Address

Address(string houseNumber
string street
string city
string state
string zipCode
string country)

The Address constructor; Creates a new Address instance by a separate address fields.

Parameters

houseNumberThe house number value of the address.
streetThe street name of the address.
cityThe city name of the address.
stateThe state name of the address.
zipCodeThe zip code value of the address.
countryThe country name of the address.

Address

Address(string fullAddress)

The Address constructor; Creates a new Address instance by a full address value.

Parameters

fullAddressA full address value.

Properties

houseNumber

string houseNumber

The house number value of the address. 

street

string street

The street name of the address. 

city

string city

The city name of the address. 

state

string state

The state name of the address. 

zipCode

string zipCode

The zip code value of the address. 

country

string country

The country name of the address. 

fullAddress

string fullAddress

The full address value. 

coordinate

Coordinate coordinate

The geographical location of the address. 

zoomLevel

int zoomLevel

The zoom level of the address. 

name

string name

The name value of the address. 

description

string description

The description of the address. 

hrefIcon

string hrefIcon

The default icon url of the address. 

boundingBox

Bounds boundingBox

The bounding box of the address. 

zPos

int zPos

The z position of the address. 

minZoomLevel

int minZoomLevel

The minimum zoom level of the address. 

maxZoomLevel

int maxZoomLevel

The maximum zoom level of the address. 

countryCode

string countryCode

The country code of the address. 

adminAreas

AdminAreas adminAreas

The admin areas array of the address. 

simpleData

SimpleData simpleData

The simple data array of the address. 

Address(string fullAddress)
The Address constructor; Creates a new Address instance by a full address value.
This is the base class of the provided coordinates classes.