Click or drag to resize

Telogis.GeoBase.Addresses.AddressFormatter

Verizon Connect Logo
Print this page
Learn more about Verizon Connect GeoBase.
Get information about the latest release
AddressFormatter Class

Contains methods that format address objects over GeoStream, using the GeoStream.Server.JSONAddressFormatter.

Functions
NameDescription
getCountryString (Telogis.GeoBase.Country country, String culture, Function callback, Function errorCallback, Object server)

Converts the given Telogis.GeoBase.Country into a well-formatted string for a given culture.

Arguments

  • country (Telogis.GeoBase.Country) - The address to be formatted.

  • culture (String) - The culture to format the country name for.

  • callback (Function) - The arbitrary function to execute with the results of the request once a reply is received from the server. The results of the call are passed to this as arguments rather than being returned, since the request is asynchronous.

    Arguments

    • formattedAddress (String) - The formatted address returned from the server.

  • (Optional) errorCallback (Function) - An arbitrary callback to execute if an error or timeout occurs when performing the query. Returns the error or timeout that occurred when performing the query. Defaults to null.

    Arguments

    • error (Telogis.Errors.GeoBaseError) - An exception describing the problem that was encountered.

  • server (Object) - An optional object that contains server.url (The address of the GeoStream server as a string) and server.authToken (The GeoStream authentication token to be used for requesting tiles) to be used for this request.

getLabelNames (String culture, Function callback, Function errorCallback, Object server)

Returns a list label names in the given culture.

Arguments

  • culture (String) - The culture to retrive the label names in.

  • callback (Function) - The arbitrary function to execute with the results of the request once a reply is received from the server. The results of the call are passed to this as arguments rather than being returned, since the request is asynchronous.

    Arguments

    • formattedAddress (String) - The formatted address returned from the server.

  • (Optional) errorCallback (Function) - An arbitrary callback to execute if an error or timeout occurs when performing the query. Returns the error or timeout that occurred when performing the query. Defaults to null.

    Arguments

    • error (Telogis.Errors.GeoBaseError) - An exception describing the problem that was encountered.

  • server (Object) - An optional object that contains server.url (The address of the GeoStream server as a string) and server.authToken (The GeoStream authentication token to be used for requesting tiles) to be used for this request.

getLines (Addresses.IAddressData address, String culture, Function callback, Function errorCallback, Object server)

Gets the lines format of the given Addresses.IAddressData with the given culture.

Arguments

  • address (Addresses.IAddressData) - The address to be formatted.

  • culture (String) - The culture to format the address for.

  • callback (Function) - The arbitrary function to execute with the results of the request once a reply is received from the server. The results of the call are passed to this as arguments rather than being returned, since the request is asynchronous.

    Arguments

    • formattedAddress (String) - The formatted address returned from the server.

  • (Optional) errorCallback (Function) - An arbitrary callback to execute if an error or timeout occurs when performing the query. Returns the error or timeout that occurred when performing the query. Defaults to null.

    Arguments

    • error (Telogis.Errors.GeoBaseError) - An exception describing the problem that was encountered.

  • server (Object) - An optional object that contains server.url (The address of the GeoStream server as a string) and server.authToken (The GeoStream authentication token to be used for requesting tiles) to be used for this request.

getLines (Addresses.IAddressData address, String culture, Function callback, Function errorCallback, Object server)

Gets the lines format with the country of the given Addresses.IAddressData with the given culture.

Arguments

  • address (Addresses.IAddressData) - The address to be formatted.

  • culture (String) - The culture to format the address for.

  • callback (Function) - The arbitrary function to execute with the results of the request once a reply is received from the server. The results of the call are passed to this as arguments rather than being returned, since the request is asynchronous.

    Arguments

    • formattedAddress (String) - The formatted address returned from the server.

  • (Optional) errorCallback (Function) - An arbitrary callback to execute if an error or timeout occurs when performing the query. Returns the error or timeout that occurred when performing the query. Defaults to null.

    Arguments

    • error (Telogis.Errors.GeoBaseError) - An exception describing the problem that was encountered.

  • server (Object) - An optional object that contains server.url (The address of the GeoStream server as a string) and server.authToken (The GeoStream authentication token to be used for requesting tiles) to be used for this request.

getLongLineForm (Addresses.IAddressData address, String culture, Function callback, Function errorCallback, Object server)

Gets the long line format of the given Addresses.IAddressData with the given culture.

Arguments

  • address (Addresses.IAddressData) - The address to be formatted.

  • culture (String) - The culture to format the address for.

  • callback (Function) - The arbitrary function to execute with the results of the request once a reply is received from the server. The results of the call are passed to this as arguments rather than being returned, since the request is asynchronous.

    Arguments

    • formattedAddress (String) - The formatted address returned from the server.

  • (Optional) errorCallback (Function) - An arbitrary callback to execute if an error or timeout occurs when performing the query. Returns the error or timeout that occurred when performing the query. Defaults to null.

    Arguments

    • error (Telogis.Errors.GeoBaseError) - An exception describing the problem that was encountered.

  • server (Object) - An optional object that contains server.url (The address of the GeoStream server as a string) and server.authToken (The GeoStream authentication token to be used for requesting tiles) to be used for this request.

getLongLineFormWithCountry (Addresses.IAddressData address, String culture, Function callback, Function errorCallback, Object server)

Gets the long line format with the country name of the given Addresses.IAddressData with the given culture.

Arguments

  • address (Addresses.IAddressData) - The address to be formatted.

  • culture (String) - The culture to format the address for.

  • callback (Function) - The arbitrary function to execute with the results of the request once a reply is received from the server. The results of the call are passed to this as arguments rather than being returned, since the request is asynchronous.

    Arguments

    • formattedAddress (String) - The formatted address returned from the server.

  • (Optional) errorCallback (Function) - An arbitrary callback to execute if an error or timeout occurs when performing the query. Returns the error or timeout that occurred when performing the query. Defaults to null.

    Arguments

    • error (Telogis.Errors.GeoBaseError) - An exception describing the problem that was encountered.

  • server (Object) - An optional object that contains server.url (The address of the GeoStream server as a string) and server.authToken (The GeoStream authentication token to be used for requesting tiles) to be used for this request.

getOrderedComponents (String culture, Function callback, Function errorCallback, Object server)

Returns the order of the properties that represent parts of an address, as a user in the given culture might expect to enter them.

Arguments

  • culture (String) - The culture to order the components for.

  • callback (Function) - The arbitrary function to execute with the results of the request once a reply is received from the server. The results of the call are passed to this as arguments rather than being returned, since the request is asynchronous.

    Arguments

    • formattedAddress (String) - The formatted address returned from the server.

  • (Optional) errorCallback (Function) - An arbitrary callback to execute if an error or timeout occurs when performing the query. Returns the error or timeout that occurred when performing the query. Defaults to null.

    Arguments

    • error (Telogis.Errors.GeoBaseError) - An exception describing the problem that was encountered.

  • server (Object) - An optional object that contains server.url (The address of the GeoStream server as a string) and server.authToken (The GeoStream authentication token to be used for requesting tiles) to be used for this request.

getShortLineForm (Addresses.IAddressData address, String culture, Function callback, Function errorCallback, Object server)

Gets the short line format of the given Addresses.IAddressData with the given culture.

Arguments

  • address (Addresses.IAddressData) - The address to be formatted.

  • culture (String) - The culture to format the address for.

  • callback (Function) - The arbitrary function to execute with the results of the request once a reply is received from the server. The results of the call are passed to this as arguments rather than being returned, since the request is asynchronous.

    Arguments

    • formattedAddress (String) - The formatted address returned from the server.

  • (Optional) errorCallback (Function) - An arbitrary callback to execute if an error or timeout occurs when performing the query. Returns the error or timeout that occurred when performing the query. Defaults to null.

    Arguments

    • error (Telogis.Errors.GeoBaseError) - An exception describing the problem that was encountered.

  • server (Object) - An optional object that contains server.url (The address of the GeoStream server as a string) and server.authToken (The GeoStream authentication token to be used for requesting tiles) to be used for this request.

getShortLineFormWithCity (Addresses.IAddressData address, String culture, Function callback, Function errorCallback, Object server)

Gets the short line format with the City of the given Addresses.IAddressData with the given culture.

Arguments

  • address (Addresses.IAddressData) - The address to be formatted.

  • culture (String) - The culture to format the address for.

  • callback (Function) - The arbitrary function to execute with the results of the request once a reply is received from the server. The results of the call are passed to this as arguments rather than being returned, since the request is asynchronous.

    Arguments

    • formattedAddress (String) - The formatted address returned from the server.

  • (Optional) errorCallback (Function) - An arbitrary callback to execute if an error or timeout occurs when performing the query. Returns the error or timeout that occurred when performing the query. Defaults to null.

    Arguments

    • error (Telogis.Errors.GeoBaseError) - An exception describing the problem that was encountered.

  • server (Object) - An optional object that contains server.url (The address of the GeoStream server as a string) and server.authToken (The GeoStream authentication token to be used for requesting tiles) to be used for this request.