flash.events

# GeolocationEvent - AS3

Package | flash.events
Class | public class GeolocationEvent
Inheritance | GeolocationEvent Event Object

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2, Flash Lite 4

A Geolocation object dispatches GeolocationEvent objects when it receives updates from the location sensor installed on the device.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | altitude : Number The altitude in meters. | GeolocationEvent
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | heading : Number The direction of movement (with respect to true north) in integer degrees. | GeolocationEvent
|  | horizontalAccuracy : Number The horizontal accuracy in meters. | GeolocationEvent
|  | latitude : Number The latitude in degrees. | GeolocationEvent
|  | longitude : Number The longitude in degrees. | GeolocationEvent
|  | speed : Number The speed in meters/second. | GeolocationEvent
|  | target : Object [read-only] The event target. | Event
|  | timestamp : Number The number of milliseconds at the time of the event since the runtime was initialized. | GeolocationEvent
|  | type : String [read-only] The type of event. | Event
|  | verticalAccuracy : Number The vertical accuracy in meters. | GeolocationEvent

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | GeolocationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, latitude:Number = 0, longitude:Number = 0, altitude:Number = 0, hAccuracy:Number = 0, vAccuracy:Number = 0, speed:Number = 0, heading:Number = 0, timestamp:Number = 0) Creates a GeolocationEvent object that contains information about the location of the device. | GeolocationEvent
|  | clone():Event [override] Creates a copy of the GeolocationEvent object and sets the value of each property to match that of the original. | GeolocationEvent
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String [override] Returns a string that contains all the properties of the GeolocationEvent object. | GeolocationEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | UPDATE : String = "update" [static] Defines the value of the type property of a GeolocationEvent event object. | GeolocationEvent

Property Detail

### altitude

property

`altitude:Number`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2, Flash Lite 4

The altitude in meters.

If altitude is not supported by the device, then this property is set to `NaN`.

Implementation
`public function get altitude():Number`
`public function set altitude(value:Number):void`

### heading

property

`heading:Number`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2, Flash Lite 4

The direction of movement (with respect to true north) in integer degrees. This is not the same as "bearing", which returns the direction of movement with respect to another point.

Note: On Android devices, heading is not supported. The value of the `heading` property is always `NaN` (Not a Number).

Implementation
`public function get heading():Number`
`public function set heading(value:Number):void`

### horizontalAccuracy

property

`horizontalAccuracy:Number`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2, Flash Lite 4

The horizontal accuracy in meters.

Implementation
`public function get horizontalAccuracy():Number`
`public function set horizontalAccuracy(value:Number):void`

### latitude

property

`latitude:Number`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2, Flash Lite 4

The latitude in degrees. The latitude values have the following range: (-90 <= `latitude` <= 90). Negative latitude is south and positive latitude is north.

Implementation
`public function get latitude():Number`
`public function set latitude(value:Number):void`

### longitude

property

`longitude:Number`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2, Flash Lite 4

The longitude in degrees. The longitude values have the following range: (-180 <= `longitude` < 180). Negative longitude is west and positive longitude is east.

Implementation
`public function get longitude():Number`
`public function set longitude(value:Number):void`

### speed

property

`speed:Number`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2, Flash Lite 4

The speed in meters/second.

Implementation
`public function get speed():Number`
`public function set speed(value:Number):void`

### timestamp

property

`timestamp:Number`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2, Flash Lite 4

The number of milliseconds at the time of the event since the runtime was initialized. For example, if the device captures geolocation data 4 seconds after the application initializes, then the timestamp property of the event is set to 4000.

Implementation
`public function get timestamp():Number`
`public function set timestamp(value:Number):void`

### verticalAccuracy

property

`verticalAccuracy:Number`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2, Flash Lite 4

The vertical accuracy in meters.

Implementation
`public function get verticalAccuracy():Number`
`public function set verticalAccuracy(value:Number):void`
Constructor Detail

### GeolocationEvent

()
Constructor

`public function GeolocationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, latitude:Number = 0, longitude:Number = 0, altitude:Number = 0, hAccuracy:Number = 0, vAccuracy:Number = 0, speed:Number = 0, heading:Number = 0, timestamp:Number = 0)`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2, Flash Lite 4

Creates a `GeolocationEvent` object that contains information about the location of the device. Event objects are passed as parameters to event listeners.

Parameters

| `type:String` — Specifies the type of the event. Event listeners can access this information through the inherited `type` property. There is only one type of update event: `GeolocationEvent.UPDATE`.
| `bubbles:Boolean` (default = `false`)`` — Indicates whether the event is a bubbling event. Event listeners can access this information through the inherited `bubbles` property.
| `cancelable:Boolean` (default = `false`)`` — Determines whether the event object can be canceled. Event listeners can access this information through the inherited `cancelable` property.
| `latitude:Number` (default = `0`)`` — Returns the latitude in degrees. The values have the following range: (-90 <= Lat <= +90).
| `longitude:Number` (default = `0`)`` — Returns the longitude in degrees. The values have the following range: (-180 <= Long < +180).
| `altitude:Number` (default = `0`)`` — Returns the altitude in meters.
| `hAccuracy:Number` (default = `0`)`` — Returns the horizontal accuracy in meters.
| `vAccuracy:Number` (default = `0`)`` — Returns the vertical accuracy in meters.
| `speed:Number` (default = `0`)`` — Returns the speed in meters/second.
| `heading:Number` (default = `0`)`` — Returns the direction of movement (with respect to True North) in integer degrees.
| `timestamp:Number` (default = `0`)`` — Specifies the timestamp of the geolocation update.

Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

Creates a copy of the GeolocationEvent object and sets the value of each property to match that of the original.

Returns

| `Event` — A new GeolocationEvent object with property values that match those of the original.

### toString

()
method

`override public function toString():String`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

Returns a string that contains all the properties of the GeolocationEvent object. The string is in the following format:

`[GeolocationEvent type=value bubbles=value cancelable=value status=value]`

Returns

| `String` — A string that contains all the properties of the GeolocationEvent object.

Constant Detail

### UPDATE

Constant

`public static const UPDATE:String = "update"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2, Flash Lite 4

Defines the value of the `type` property of a `GeolocationEvent` event object.

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`currentTarget` | The object that is actively processing the event object with an event listener.
`target` | The Geolocation object receiving data.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00