- Legend to Symbols
-
Namespace
The namespace is really just an object where further objects and their methods and properties are attached bundling up all the functionality using a unique name.
Interface
The Interface is a contract by which the implementing class adheres. It describes a desired behavior and enforces adherence for any class that implements the interface.
Class
Classes define types of objects that will be used by the application.
Method
A function associated with a class or object.
Field
A variable associated with a class or object.
Inherited Method
A function inherited from the parent class. The present documentation scheme differentiates between a direct or indirect inheritance relationship.
Inherited Field
A variable inherited from the parent class. The present documentation scheme differentiates between a direct or indirect inheritance relationship.
Event
Events are actions that occur because of user interaction. They are normally used in combination with functions, and the function will not be executed before the event occurs.
Class Index
A
ovi.mapsapi.search.Address
Interface defining Address.
ovi.mapsapi.util.ApplicationContext
An observeable singleton offering authentication support for services like search and routing.
B
ovi.mapsapi.map.component.Behavior
The behavior component is a collection of other components.
ovi.mapsapi.gfx.BitmapImage
The BitmapImage class loads a bitmap (PNG, GIF, JPEG and others) from a web server and makes it available as an GFX image.
ovi.mapsapi.geo.BoundingBox
A bounding box defines a rectangular area in a geographic coordinate system.
ovi.mapsapi.util.Brush
Defines property of brush in filling the shapes.
ovi.mapsapi.map.component.InfoBubbles.Bubble
Interface defining a bubble which will be shown on the map by ovi.mapsapi.map.component.InfoBubbles.
C
ovi.mapsapi.gfx.CanvasPainter
The canvas painter renders an ovi.mapsapi.gfx.IDL into a DOM node using a
CANVAS tag.
ovi.mapsapi.map.Circle
The class defines an Object in the shape of circle.
ovi.mapsapi.map.component.panning.Click
This component will pan the map, if the user clicks into the map.
ovi.mapsapi.gfx.Color
The static color class offers methods to deal with 32-bit integer color values.
ovi.mapsapi.map.component.Component
The component concept is used to extend the basic map with additional functionality.
ovi.mapsapi.map.Container
A Container is used to group Objects, thus allowing it to operate on a whole group of objects without the need to iteratively visit each Object (that is for changing the visibility).
ovi.mapsapi.geo.Coordinate
The coordinate represents a geographical position.
ovi.mapsapi.map.component.Copyright
A component which helps to adapt the position of the branding
ovi.mapsapi.util.Coroutine
There are many different ways how to run code in a none blocking way.
ovi.mapsapi.geo.Corridor
Interface defining a Corridor.
D
ovi.mapsapi.dom.DataTransfer
This class is a browser independent implementation of the HTML 5 DataTransfer interface.
ovi.mapsapi.map.Display
Class to display a portion of a geographical map, allowing multiple optional layers (Containers) and Objects to be added to it.
ovi.mapsapi.map.component.zoom.DoubleClick
This component will zoom the map if the user double clicks into it.
ovi.mapsapi.map.component.zoom.DoubleTap
This component will zoom the map if the user taps twice into the map at a touch screen and will zoom-in the view.
ovi.mapsapi.map.component.panning.Drag
This component will enable the map drag with the left mouse button or with the finger at a touch screen.
ovi.mapsapi.dom.DragEvent
This event is fired for all kind of drag operations.
ovi.mapsapi.dom.DragEventTarget
This class is a virtual interface that does only exist for documentational purpose.
ovi.mapsapi.map.component.objects.DragMarker
This component implements the default draggability for markers.
E
ovi.mapsapi.dom.Event
The event class is an object implementing the W3C Event interface.
ovi.mapsapi.map.Object.Event
All events fired by an ovi.mapsapi.map.Object or it's derived classes including the ovi.mapsapi.map.Display class will be implement this interface.
ovi.mapsapi.dom.EventTarget
The EventTarget class is a special interface that can be implemented either by using this class as a mixin for any JavaScript class or it can be applied at runtime to any DOM node or JavaScript object by simply casting it to an EventTarget.
ovi.mapsapi.util.Coroutine.ExecutionContext
The execution context of a coroutine is an in software emulated execution context, compareable to the native execution context of a normal JavaScript function, with the difference that the coroutine execution context can be suspended and recovered.
F
ovi.mapsapi.Features
The API provides mechanisms to individually load specific features like "routing" or "search".
ovi.mapsapi.dom.FocusEvent
This event is fired if a target receives or loses the focus.
ovi.mapsapi.dom.FocusEventTarget
This class is a virtual interface that does only exist for documentational purpose.
G
ovi.mapsapi.search.component.GeocodeComponent
Shows results of a Geocoding on the Display.
ovi.mapsapi.map.component.zoom.Gesture
This component will zoom the map if the user makes a zoom gesture at a touch screen.
ovi.mapsapi.gfx.Graphics
A two dimensional graphics context that produces an Image Description Language which can be rendered into a real image using a ovi.mapsapi.gfx.Painter.
ovi.mapsapi.gfx.GraphicsImage
The
GraphicsImage class can be used to render images within the client at runtime.
I
ovi.mapsapi.util.IBox
Interface defining a box which keeps number values for top, right, bottom and left.
ovi.mapsapi.util.IBrush
Interface defining a Brush Object.
ovi.mapsapi.geo.ICoordinate
Interface defining a GEO coordinate.
ovi.mapsapi.gfx.IDL
IDL is the abbreviation for Image Description Language.
ovi.mapsapi.map.IHitArea
An interface to describe a hit area.
ovi.mapsapi.gfx.Image
The image class is an abstract base class for all kind of image implementations.
ovi.mapsapi.language.Info
The static Info class that provides utilities regarding languages.
ovi.mapsapi.map.component.InfoBubbles
Adds the possibility to manage bubbles to the map.
ovi.mapsapi.util.IPen
Interface defining a Pen Object.
ovi.mapsapi.util.IPoint
Interface defining a 2D coordinate.
ovi.mapsapi.geo.IProjection
Each class, which implements this interface, has to provide translations between normalized projected points and GEO coordinates.
K
ovi.mapsapi.dom.KeyboardEvent
This event is fired if a key at the keyboard is pressed or released.
ovi.mapsapi.dom.KeyboardEventTarget
This class is a virtual interface that does only exist for documentational purpose.
ovi.mapsapi.map.component.panning.Kinetic
The kinetic component will add kinetic panning possibilities to the display.
ovi.mapsapi.map.component.panning.KineticMovement
This is no component, it is the state of a kinetic movement as being returned by the kinetic components startMovement() method.
L
ovi.mapsapi.search.Location
Interface defining Location.
ovi.mapsapi.search.LocationFilter
Interface defining LocationFilter.
M
ovi.mapsapi.language.Manager
The language manager is a service class providing translation facilities.
ovi.mapsapi.positioning.Manager
This class is providing a function set, from the specification of the W3C geolocation API.
ovi.mapsapi.routing.Manager
The Manager acts as a proxy to the routing service and is responsible for storing the currently selected routes.
ovi.mapsapi.search.Manager
The Manager acts as a proxy to the search service and provides methods for retrieving search results.
ovi.mapsapi.util.Task.Manager
The Task Manager is a scheduler responsible for controlling the sequence of tasks to be processed.
ovi.mapsapi.routing.Maneuver
Interface defining a Maneuver.
ovi.mapsapi.map.Display.MapViewChangeEvent
This event is fired by a ovi.mapsapi.map.Display instance for the different event types of a map view change sequence, which are ovi.mapsapi.map.Display#event:mapviewchangestart, ovi.mapsapi.map.Display#event:mapviewchangeupdate and ovi.mapsapi.map.Display#event:mapviewchangeend.
ovi.mapsapi.map.Marker
A marker defines an Object that may display an icon on the map view.
ovi.mapsapi.routing.Mode
Interface defining a Mode for a route calculation.
ovi.mapsapi.dom.MouseEvent
This event is fired for all kind of mouse behaves.
ovi.mapsapi.dom.MouseEventTarget
This class is a virtual interface that does only exist for documentational purpose.
ovi.mapsapi.map.component.zoom.MouseWheel
This component will zoom the map if the user taps twice into the map at a touch screen and will zoom-in the view.
O
ovi.mapsapi.map.Object
A Object is the abstract base class for all visual objects shown in map, including the map itself.
ovi.mapsapi.util.OList
A class to provide an observable list.
ovi.mapsapi.util.OObject
A class to provide an Object which has inheritable and observable properties.
ovi.mapsapi.map.component.InfoBubbles.Options
Interface defining the info bubbles' options (keys)
ovi.mapsapi.util.Task.Options
The possible options to be supplied to the ovi.mapsapi.util.Task constructor.
ovi.mapsapi.map.component.OverlaysSelector
The OverlaysSelector allows activating / deactivating map overlay buttons.
ovi.mapsapi.map.component.Overview
Defines a panel showing an overview of the map of the currently visible viewport.
P
Singleton, which provides package loading infrastructure
ovi.mapsapi.dom.Page
The Page class is a special abstract interface, it must be used as a query for a document or a DOM node and will return an object that implements the Page interface and is bound to the supplied document or to the document of the supplied DOM node.
ovi.mapsapi.gfx.Painter
The painter class is an abstract base class for all painter implementations.
ovi.mapsapi.util.Pen
Defines properties of a pen in drawing shape and text.
ovi.mapsapi.geo.PixelProjection
A class to provide translations between projected pixel coordinates and GEO coordinates.
ovi.mapsapi.search.Place
Interface defining Place.
ovi.mapsapi.util.Point
A class to represent a 2D coordinate.
ovi.mapsapi.map.Polygon
In contrast to a Polyline, it is assumed that the last coordinate within the path is connected with the first coordinate, and thus the path constructs an enclosed geometry.
ovi.mapsapi.map.Polyline
A Polyline has multiple points that are traversed in order.
ovi.mapsapi.positioning.component.PositioningComponent
It provides a component to switch on and off positioning.
ovi.mapsapi.map.Circle.Properties
Interface defining the Properties (keys) that can be passed to the constructor.
ovi.mapsapi.map.Container.Properties
Interface defining the Properties (keys) that can be passed to the constructor.
ovi.mapsapi.map.Display.Properties
Interface defining the Properties (keys) that can be passed to the constructor.
ovi.mapsapi.map.Marker.Properties
Interface defining the Properties (keys) that can be passed to the constructor of all classes derived from ovi.mapsapi.map.Marker.
ovi.mapsapi.map.Object.Properties
Interface defining the Properties (keys) that can be passed to the constructor of all classes derived from ovi.mapsapi.map.Object.
ovi.mapsapi.map.Polygon.Properties
Interface defining the Properties (keys) that can be passed to the constructor.
ovi.mapsapi.map.Polyline.Properties
Interface defining the Properties (keys) that can be passed to the constructor or the method.
ovi.mapsapi.map.Rectangle.Properties
Interface defining the Properties (keys) that can be passed to the constructor.
ovi.mapsapi.map.Spatial.Properties
Interface defining the Properties (keys) that can be passed to the constructor of all classes derived from ovi.mapsapi.map.Spatial.
ovi.mapsapi.map.StandardMarker.Properties
Interface defining the Properties (keys) that can be passed to the constructor.
ovi.mapsapi.map.Provider
An abstract class for map provider.
ovi.mapsapi.geo.Proximity
Interface defining a Proximity.
R
ovi.mapsapi.map.Rectangle
The class defines an Object with rectangular shape.
ovi.mapsapi.util.Rectangle
A Rectangle specifies an area in a 2D coordinate space which is enclosed by the Rectangle object's topLeft and bottomRight point (x,y).
ovi.mapsapi.map.component.RightClick
RightClick adds direct user-interaction to the map.
ovi.mapsapi.routing.component.RightClick
RightClick adds direct user-interaction for routing part to the map.
ovi.mapsapi.search.component.RightClick
RightClick adds direct user-interaction for search to the map.
ovi.mapsapi.routing.Route
Interface defining a Route.
ovi.mapsapi.routing.RouteLeg
Interface defining a RouteLeg.
ovi.mapsapi.routing.component.RouteResultSet
This result set can be initiated with a response of a calculate route request and provides some useful methods to handle this response in combination with a map.
ovi.mapsapi.routing.RouteSegment
A route segment defines a portion of the route.
ovi.mapsapi.routing.RouteSummary
Interface defining RouteSummary.
ovi.mapsapi.routing.component.RouteView
RouteView provides visual representation of route maneuver in a placeable UI component
S
ovi.mapsapi.map.component.ScaleBar
Defines a panel providing a scalebar.
ovi.mapsapi.util.Coroutine.Scope
The scope represents the variable object of an execution context.
ovi.mapsapi.search.component.SearchComponent
Shows results of a Search on the Display.
ovi.mapsapi.search.component.SearchResultSet
This result set can be initiated with a response of a search request and provides some useful methods to handle this response in combination with a map.
ovi.mapsapi.routing.ServiceError
Interface defining a routing service error.
ovi.mapsapi.search.ServiceError
Interface defining a search service error.
ovi.mapsapi.geo.Shape
An observable geo shape (derives from Strip) that holds its geometry also in a geo quad tree and allows testing for containment, square based clipping and nearest by analysis.
ovi.mapsapi.map.Spatial
The abstract base class for all objects which have a GEO spatial dimension.
ovi.mapsapi.map.StandardMarker
Object using a predefined shape for its display.
ovi.mapsapi.geo.Strip
An observable geo array that stores geo coordinates in an optimized way and allows specialized operations on top of them.
ovi.mapsapi.util.Strip
A special array that contains objects, but all objects must have the same type and the same properties.
ovi.mapsapi.gfx.SvgParser.SvgMarkupInfo
An abstract interface for documentational purpose only.
ovi.mapsapi.gfx.SvgPainter
The SVG painter renders an ovi.mapsapi.gfx.IDL into a DOM node using an
SVG tag.
ovi.mapsapi.gfx.SvgParser
A SVG parser can be used to convert a SVG string into ovi.mapsapi.gfx.IDL.
T
ovi.mapsapi.map.component.panning.Tap
This component will pan the map, if the user taps at the touch screen and into the map.
ovi.mapsapi.util.Task
A task is a job that is executed continuously, it shall be used like a cooperative thread.
ovi.mapsapi.util.Task.Manager.TaskSwitchException
A special singleton that is thrown as exception if certain methods are called from inside the
run method of a task.
ovi.mapsapi.dom.TextEvent
This event is fired if some text is entered from whatever source, so either keyboard, clipboard or from some other source.
ovi.mapsapi.dom.Touch
The Touch class represents a single touch on the surface.
ovi.mapsapi.dom.TouchEvent
This event is fired if the user somehow does something with a touch screen, for example on mobile phones having such, but as well at desktop computers (such as laptops) where the browser and screen support this.
ovi.mapsapi.dom.TouchEventTarget
This class is a virtual interface that does only exist for documentational purpose.
ovi.mapsapi.map.component.TypeSelector
Provides a user interface to change the current base map type.
U
ovi.mapsapi.ui.UIComponent
The base class for UI components.
V
ovi.mapsapi.util.Vector3D
A class representing a three dimensional vector.
ovi.mapsapi.map.component.ViewControl
Defines a panel providing controls for heading, tilt and pan(setting the center position).
ovi.mapsapi.gfx.VmlPainter
The VML painter renders an ovi.mapsapi.gfx.IDL into a VML tag to be used with Internet Explorer.
W
ovi.mapsapi.routing.Waypoint
Interface defining a Waypoint.
ovi.mapsapi.routing.WaypointParameterList
The WaypointParameterList wraps a list of waypoints in potentially different representations.
ovi.mapsapi.routing.component.Waypoints
Waypoints provides a visual interface to allow the settings of start and destination points for a route, as well as clearing a route
ovi.mapsapi.dom.WheelEvent
This event is fired if a wheel is moved, mostly used for the scroll wheel at the mouse, but it may be as well fired for other kind of wheels.
Z
ovi.mapsapi.map.component.ZoomBar
Defines and controls a control panel to zoom the map.