Items in green are not available just now, but will be very soon

ubiest.maps.Map class

This class extends MVCObject.

Constructor

Constructor Description
Map(mapDiv:Node, opts?:MapOptions) Creates a new map inside of the given HTML container, which is typically a DIV element.

Methods

Methods Return Value Description
fitBounds(bounds:LatLngBounds) None Sets the map to fit to the given bounds.
getBounds() LatLngBounds Returns the lat/lng bounds of the current viewport. If the map is not yet initialized (i.e. the mapType is still null), or center and zoom have not been set then the result is null or undefined.
getCenter() LatLng
getDiv() Node
getMapTypeId() MapTypeId
getProjection() Projection Returns the current Projection. If the map is not yet initialized (i.e. the mapType is still null) then the result is null. Listen to projection_changed and check its value to ensure it is not null.
getZoom() number
panBy(x:number, y:number) None Changes the center of the map by the given distance in pixels. Note that the map coordinate system increases from west to east (for x values) and north to south (for y values).
panTo(latLng:LatLng) None Changes the center of the map to the given LatLng.
setCenter(latlng:LatLng) None
setMapTypeId(mapTypeId:MapTypeId) None
setOptions(options:MapOptions) None
setZoom(zoom:number) None

Properties

Properties Type Description
controls Array.<MVCArray.<Node>> Additional controls to attach to the map. To add a control to the map, add the control’s <div>to the MVCArray corresponding to the ControlPosition where it should be rendered.
mapTypes MapTypeRegistry A registry of MapType instances by string ID.
overlayMapTypes MVCArray.<MapType> Additional map types to overlay.

Events

Events Arguments Description
bounds_changed None This event is fired when the viewport bounds have changed.
center_changed None This event is fired when the map center property changes.
click MouseEvent This event is fired when the user clicks on the map (but not when they click on a marker or infowindow).
dblclick MouseEvent This event is fired when the user double-clicks on the map. Note that the click event will also fire, right before this one.
drag None This event is repeatedly fired while the user drags the map.
dragend None This event is fired when the user stops dragging the map.
dragstart None This event is fired when the user starts dragging the map.
idle None This event is fired when the map becomes idle after panning or zooming.
maptypeid_changed None This event is fired when the mapTypeId property changes.
mousemove MouseEvent This event is fired whenever the user’s mouse moves over the map container.
mouseout MouseEvent This event is fired when the user’s mouse exits the map container.
mouseover MouseEvent This event is fired when the user’s mouse enters the map container.
pan_east None This event is fired when the user clicks on east button of Pan Control
pan_north None This event is fired when the user clicks on north button of Pan Control
pan_south None This event is fired when the user clicks on south button of Pan Control
pan_west None This event is fired when the user clicks on west button of Pan Control
projection_changed None This event is fired when the projection has changed.
resize None Developers should trigger this event on the map when the div changes size:ubiest.maps.event.trigger(map, ‘resize’) .
rightclick MouseEvent This event is fired when the DOM contextmenu event is fired on the map container.
tilesloaded None This event is fired when the visible tiles have finished loading.
zoom_changed None This event is fired when the map zoom property changes.

ubiest.maps.MapOptions object specification

Properties

Properties Type Description
backgroundColor string Color used for the background of the Map div. This color will be visible when tiles have not yet loaded as the user pans. This option can only be set when the map is initialized.
center LatLng The initial Map center. Required.
disableDefaultUI boolean Enables/disables all default UI. May be overridden individually.
disableDoubleClickZoom boolean Enables/disables zoom and center on double click. Enabled by default.
disableMobileAcceleration boolean Enables/disables GPU accelerated effects on iOS devices (experimental)
disableTransition boolean Enables/disables transition effects when panning and zooming (experimental)
disableZoomEffect boolean Enables/disables zoom effect when zooming
draggable boolean If false, prevents the map from being dragged. Dragging is enabled by default.
draggableCursor string The name or url of the cursor to display on a draggable object.
draggingCursor string The name or url of the cursor to display when an object is dragging.
hideLogo boolean True to hide Ubiest logo in the lower-left corner of the map. Logo is shown by default
keyboardShortcuts boolean If false, prevents the map from being controlled by the keyboard. Keyboard shortcuts are enabled by default.
mapTypeControl boolean The initial enabled/disabled state of the Map type control.
mapTypeControlOptions MapTypeControlOptions The initial display options for the Map type control.
mapTypeId MapTypeId The initial Map mapTypeId. Required.
maxZoom number The maximum zoom level which will be displayed on the map. If omitted, or set to null, the maximum zoom from the current map type is used instead.
minZoom number The minimum zoom level which will be displayed on the map. If omitted, or set to null, the minimum zoom from the current map type is used instead.
panControl boolean The enabled/disabled state of the pan control.
panControlOptions PanControlOptions The display options for the pan control.
scaleControl boolean The initial enabled/disabled state of the scale control.
scaleControlOptions ScaleControlOptions The initial display options for the scale control.
scrollwheel boolean If false, disables scrollwheel zooming on the map. The scrollwheel is enabled by default.
zoom number The initial Map zoom level. Required.
zoomControl boolean The enabled/disabled state of the zoom control.
zoomControlOptions ZoomControlOptions The display options for the zoom control.

ubiest.maps.MapTypeId class

Identifiers for common MapTypes.

Constant

Constant Description
HYBRID This map type displays a transparent layer of major streets on satellite images.
ROADMAP This map type displays a normal street map.
SATELLITE This map type displays satellite images.

ubiest.maps.MapTypeControlOptions object specification

Options for the rendering of the map type control.

Properties

Properties Type Description
mapTypeIds Array.<MapTypeId>|Array.<string> IDs of map types to show in the control.
position ControlPosition Position id. Used to specify the position of the control on the map. The default position is TOP_RIGHT.
style MapTypeControlStyle Style id. Used to select what style of map type control to display.

ubiest.maps.MapTypeControlStyle class

Identifiers for common MapTypesControls.

Constant

Constant Description
DEFAULT Uses the default map type control. The control which DEFAULT maps to will vary according to window size and other factors. It may change in future versions of the API.
DROPDOWN_MENU A dropdown menu for the screen realestate conscious.
HORIZONTAL_BAR The standard horizontal radio buttons bar.

ubiest.maps.PanControlOptions object specification

Options for the rendering of the pan control.

Properties

Properties Type Description
position ControlPosition Position id. Used to specify the position of the control on the map. The default position is TOP_LEFT.

ubiest.maps.ScaleControlOptions object specification

Options for the rendering of the scale control.

Properties

Properties Type Description
position ControlPosition Position id. Used to specify the position of the control on the map. The default position is BOTTOM_LEFT.
style ScaleControlStyle Style id. Used to select what style of scale control to display.

ubiest.maps.ScaleControlStyle class

Identifiers for scale control ids.

Constant

Constant Description
DEFAULT The standard scale control.

ubiest.maps.ZoomControlOptions object specification

Options for the rendering of the zoom control.

Properties

Properties Type Description
position ControlPosition Position id. Used to specify the position of the control on the map. The default position is TOP_LEFT.
style ZoomControlStyle Style id. Used to select what style of zoom control to display.

ubiest.maps.ZoomControlStyle class

Identifiers for the zoom control.

Constant

Constant Description
DEFAULT The default zoom control. The control which DEFAULT maps to will vary according to map size and other factors. It may change in future versions of the API.
LARGE The larger control, with the zoom slider in addition to +/- buttons.
SMALL A small control with buttons to zoom in and out.

ubiest.maps.ControlPosition class

Identifiers used to specify the placement of controls on the map. Controls are positioned relative to other controls in the same layout position. Controls that are added first are positioned closer to the edge of the map.

  +----------------+
  + TL    TC    TR +
  + LT          RT +
  +                +
  + LC          RC +
  +                +
  + LB          RB +
  + BL    BC    BR +
  +----------------+

Elements in the top or bottom row flow towards the middle. Elements at the left or right sides flow downwards.

Constant

Constant Description
BOTTOM_CENTER Elements are positioned in the center of the bottom row.
BOTTOM_LEFT Elements are positioned in the bottom left and flow towards the middle. Elements are positioned to the right of the Ubiest logo.
BOTTOM_RIGHT Elements are positioned in the bottom right and flow towards the middle. Elements are positioned to the left of the copyrights.
LEFT_BOTTOM Elements are positioned on the left, above bottom-left elements, and flow upwards.
LEFT_CENTER Elements are positioned in the center of the left side.
LEFT_TOP Elements are positioned on the left, below top-left elements, and flow downwards.
RIGHT_BOTTOM Elements are positioned on the right, above bottom-right elements, and flow upwards.
RIGHT_CENTER Elements are positioned in the center of the right side.
RIGHT_TOP Elements are positioned on the right, below top-right elements, and flow downwards.
TOP_CENTER Elements are positioned in the center of the top row.
TOP_LEFT Elements are positioned in the top left and flow towards the middle.
TOP_RIGHT Elements are positioned in the top right and flow towards the middle.

ubiest.maps.Marker class

This class extends MVCObject.

Constructor

Constructor Description
Marker(opts?:MarkerOptions) Creates a marker with the options specified. If a map is specified, the marker is added to the map upon construction. Note that the position must be set for the marker to display.

Methods

Methods Return Value Description
getClickable() boolean
getCursor() string
getDraggable() boolean
getFlat() boolean
getIcon() string | MarkerImage
getMap() Map
getPosition() LatLng
getShadow() string | MarkerImage
getShape() MarkerShape
getTitle() string
getVisible() boolean
getZIndex() number
setClickable(flag:boolean) None
setCursor(cursor:string) None
setDraggable(flag:boolean) None
setFlat(flag:boolean) None
setIcon(icon:string | MarkerImage) None
setMap(map:Map) None Renders the marker on the specified map. If map is set to null, the marker will be removed.
setOptions(options:MarkerOptions) None
setPosition(latlng:LatLng) None
setShadow(shadow:string | MarkerImage) None
setShape(shape:MarkerShape) None
setTitle(title:string) None
setVisible(visible:boolean) None
setZIndex(zIndex:number) None

Events

Events Arguments Description
click Event This event is fired when the marker icon was clicked.
clickable_changed None This event is fired when the marker’s clickable property changes.
cursor_changed None This event is fired when the marker’s cursor property changes.
dblclick Event This event is fired when the marker icon was double clicked.
drag MouseEvent This event is repeatedly fired while the user drags the marker.
dragend MouseEvent This event is fired when the user stops dragging the marker.
draggable_changed None This event is fired when the marker’s draggable property changes.
dragstart MouseEvent This event is fired when the user starts dragging the marker.
flat_changed None This event is fired when the marker’s flat property changes.
icon_changed None This event is fired when the marker icon property changes.
mousedown Event This event is fired when the DOM mousedown event is fired on the marker icon.
mouseout Event This event is fired when the mouse leaves the area of the marker icon.
mouseover Event This event is fired when the mouse enters the area of the marker icon.
mouseup Event This event is fired for the DOM mouseup on the marker.
position_changed None This event is fired when the marker position property changes.
rightclick Event This event is fired when the marker is right clicked on.
shadow_changed None This event is fired when the marker’s shadow property changes.
shape_changed None This event is fired when the marker’s shape property changes.
title_changed None This event is fired when the marker title property changes.
visible_changed None This event is fired when the marker’s visible property changes.
zindex_changed None This event is fired when the marker’s zIndex property changes.

ubiest.maps.MarkerOptions object specification

Properties

Properties Type Description
clickable boolean If true, the marker receives mouse and touch events. Default value is true.
cursor string Mouse cursor to show on hover
draggable boolean If true, the marker can be dragged. Default value is false.
flat boolean If true, the marker shadow will not be displayed.
icon string | MarkerImage Icon for the foreground
map Map Map on which to display Marker.
position LatLng Marker position. Required.
shadow string | MarkerImage Shadow image
shape MarkerShape Image map region definition used for drag/click.
title string Rollover text
visible boolean If true, the marker is visible
zIndex number All markers are displayed on the map in order of their zIndex, with higher values displaying in front of markers with lower values. By default, markers are displayed according to their vertical position on screen, with lower markers appearing in front of markers further up the screen.

ubiest.maps.MarkerImage class

Constructor

Constructor Description
MarkerImage(url:string,size?:Size,origin?:Point,anchor?:Point,scaledSize?:Size) Defines an image to be used as the icon or shadow for a Marker. ‘origin’ and ‘size’ are used to select a segment of a sprite image and ‘anchor’ overrides the position of the anchor point from its default bottom middle position. The anchor of an image is the pixel to which the system refers in tracking the image’s position. By default, the anchor is set to the bottom middle of the image (coordinates width/2, height). So when a marker is placed at a given LatLng, the pixel defined as the anchor is positioned at the specified LatLng. To scale the image, whether sprited or not, set the value of scaledSize to the size of the whole image and set size, origin and anchor in scaled values. The MarkerImage cannot be changed once constructed.

Properties

Properties Type Description
anchor Point The position at which to anchor an image in correspondance to the location of the marker on the map. By default, the anchor is located along the center point of the bottom of the image.
origin Point The position of the image within a sprite, if any. By default, the origin is located at the top left corner of the image(0, 0).
scaledSize Size The size of the entire image after scaling, if any. Use this property to stretch/shrink an image or a sprite.
size Size The display size of the sprite or image. When using sprites, you must specify the sprite size. If the size is not provided, it will be set when the image loads.
url string The URL of the image or sprite sheet.

ubiest.maps.MarkerShape object specification

This object defines the marker shape to use in determination of a marker’s clickable region. The shape consists of two properties — type and coord — which define the general type of marker and coordinates specific to that type of marker.

Properties

Properties Type Description
coords Array.<number> The format of this attribute depends on the value of the type and follows the w3 AREA coords specification found at http://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords.
The coords attribute is an array of integers that specify the pixel position of the shape relative to the top-left corner of the target image. The coordinates depend on the value of type as follows:

  • circle: coords is [x1,y1,r ] where x1,y2 are the coordinates of the center of the circle, and r is the radius of the circle.
  • poly: coords is [x1,y1,x2,y2...xn,yn ] where each x,y pair contains the coordinates of one vertex of the polygon.
  • rect: coords is [x1,y1,x2,y2 ] where x1,y1 are the coordinates of the upper-left corner of the rectangle and x2,y2 are the coordinates of the lower-right coordinates of the rectangle.
type string Describes the shape’s type and can be circle, poly or rect.

ubiest.maps.InfoWindow class

An overlay that looks like a bubble and is often connected to a marker. This class extends MVCObject.

Constructor

Constructor Description
InfoWindow(opts?:InfoWindowOptions) Creates an info window with the given options. An InfoWindow can be placed on a map at a particular position or above a marker, depending on what is specified in the options. Unless auto-pan is disabled, an InfoWindow will pan the map to make itself visible when it is opened. After constructing an InfoWindow, you must call open to display it on the map. The user can click the close button on the InfoWindow to remove it from the map, or the developer can call close() for the same effect.

Methods

Methods Return Value Description
close() None Closes this InfoWindow by removing it from the DOM structure.
getContent() string | Node
getPosition() LatLng
getZIndex() number
open(map?:Map,anchor?:MVCObject) None Opens this InfoWindow on the given map. Optionally, an InfoWindow can be associated with an anchor. In the core API, the only anchor is the Marker class. However, an anchor can be any MVCObject that exposes the position property and optionally anchorPoint for calculating the pixelOffset (see InfoWindowOptions). The anchorPoint is the offset from the anchor’s position to the tip of the InfoWindow.
setContent(content:string | Node) None
setOptions(options:InfoWindowOptions) None
setPosition(position:LatLng) None
setZIndex(zIndex:number) None

Events

Events Arguments Description
closeclick None This event is fired when the close button was clicked.
content_changed None This event is fired when the content property changes.
domready None This event is fired when the <div> containing the InfoWindow’s content is attached to the DOM. You may wish to monitor this event if you are building out your info window content dynamically.
position_changed None This event is fired when the position property changes.
zindex_changed None This event is fired when the InfoWindow’s zIndex changes.

ubiest.maps.InfoWindowOptions object specification

Properties

Properties Type Description
content string|Node Content to display in the InfoWindow. This can be an HTML element, a plain-text string, or a string containing HTML. The InfoWindow will be sized according to the content. To set an explicit size for the content, set content to be a HTML element with that size.
disableAutoPan boolean Disable auto-pan on open. By default, the info window will pan the map so that it is fully visible when it opens.
maxWidth number Maximum width of the infowindow, regardless of content’s width. This value is only considered if it is set before a call to open. To change the maximum width when changing content, call close, setOptions, and then open.
pixelOffset Size The offset, in pixels, of the tip of the info window from the point on the map at whose geographical coordinates the info window is anchored. If an InfoWindow is opened with an anchor, the pixelOffset will be calculated from the top-center of the anchor’s bounds.
position LatLng The LatLng at which to display this InfoWindow. If the InfoWindow is opened with an anchor, the anchor’s position will be used instead.
zIndex number All InfoWindows are displayed on the map in order of their zIndex, with higher values displaying in front of InfoWindows with lower values. By default, InfoWinodws are displayed according to their latitude, with InfoWindows of lower latitudes appearing in front of InfoWindows at higher latitudes. InfoWindows are always displayed in front of markers.

ubiest.maps.Polyline class

A polyline is a linear overlay of connected line segments on the map. This class extends MVCObject.

Constructor

Constructor Description
Polyline(opts?:PolylineOptions) Create a polyline using the passed PolylineOptions, which specify both the path of the polyline and the stroke style to use when drawing the polyline. You may pass either an array ofLatLngs or an MVCArray of LatLngs when constructing a polyline, though simple arrays are converted to MVCArrays within the polyline upon instantiation.

Methods

Methods Return Value Description
getMap() Map Returns the map on which this poly is attached.
getPath() MVCArray.<LatLng> Retrieves the first path.
setMap(map:Map) None Renders this Polyline or Polygon on the specified map. If map is set to null, the Poly will be removed.
setOptions(options:PolylineOptions) None
setPath((path:MVCArray.<LatLng> | Array.<LatLng>) None Sets the first path. See PolylineOptions for more details.

Events

Events Arguments Description
click MouseEvent This event is fired when the DOM click event is fired on the Polyline.
dblclick MouseEvent This event is fired when the DOM dblclick event is fired on the Polyline.
mousedown MouseEvent This event is fired when the DOM mousedown event is fired on the Polyline.
mousemove MouseEvent This event is fired when the DOM mousemove event is fired on the Polyline.
mouseout MouseEvent This event is fired on Polyline mouseout.
mouseover MouseEvent This event is fired on Polyline mouseover.
mouseup MouseEvent This event is fired when the DOM mouseup event is fired on the Polyline.
rightclick MouseEvent This event is fired when the Polyline is right-clicked on.

ubiest.maps.PolylineOptions object specification

Properties

Properties Type Description
clickable boolean Indicates whether this Polyline handles click events. Defaults to true.
map Map Map on which to display Polyline.
path MVCArray.<LatLng> | Array.<LatLng> The ordered sequence of coordinates of the Polyline. This path may be specified using either a simple array of LatLngs, or an MVCArray of LatLngs. Note that if you pass a simple array, it will be converted to an MVCArray Inserting or removing LatLngs in the MVCArray will automatically update the polyline on the map.
strokeColor string The stroke color. All CSS3 colors are supported except for extended named colors.
strokeOpacity number The stroke opacity between 0.0 and 1.0
strokeWeight number The stroke width in pixels.
zIndex number The zIndex compared to other polys.

ubiest.maps.Polygon class

A polygon (like a polyline) defines a series of connected coordinates in an ordered sequence; additionally, polygons form a closed loop and define a filled region. This class extends MVCObject.

Constructor

Constructor Description
Polygon(opts?:PolygonOptions) Create a polygon using the passed PolygonOptions, which specify the polygon’s path, the stroke style for the polygon’s edges, and the fill style for the polygon’s interior regions. A polygon may contain one or more paths, where each path consists of an array of LatLngs. You may pass either an array of LatLngs or an MVCArray of LatLngs when constructing these paths. Arrays are converted to MVCArrays within the polygon upon instantiation.

Methods

Methods Return Value Description
getMap() Map Returns the map on which this poly is attached.
getPath() MVCArray.<LatLng> Retrieves the first path.
getPaths() MVCArray.<MVCArray.<LatLng>> Retrieves the paths for this Polygon.
setMap(map:Map) None Renders this Polyline or Polygon on the specified map. If map is set to null, the Poly will be removed.
setOptions(options:PolygonOptions) None
setPath(path:MVCArray.<LatLng>|Array.<LatLng>) None Sets the first path. See PolylineOptions for more details.
setPaths(paths:MVCArray.<MVCArray.<LatLng>> | MVCArray.<LatLng> | Array.<Array.<LatLng>> | Array.<LatLng>) None Sets the path for this Polygon.

Events

Events Arguments Description
click MouseEvent This event is fired when the DOM click event is fired on the Polygon.
dblclick MouseEvent This event is fired when the DOM dblclick event is fired on the Polygon.
mousedown MouseEvent This event is fired when the DOM mousedown event is fired on the Polygon.
mousemove MouseEvent This event is fired when the DOM mousemove event is fired on the Polygon.
mouseout MouseEvent This event is fired on Polygon mouseout.
mouseover MouseEvent This event is fired on Polygon mouseover.
mouseup MouseEvent This event is fired when the DOM mouseup event is fired on the Polygon.
rightclick MouseEvent This event is fired when the Polygon is right-clicked on.

ubiest.maps.PolygonOptions object specification

Properties

Properties Type Description
clickable boolean Indicates whether this Polygon handles click events. Defaults to true.
fillColor string The fill color. All CSS3 colors are supported except for extended named colors.
fillOpacity number The fill opacity between 0.0 and 1.0
map Map Map on which to display Polygon.
paths MVCArray.<MVCArray.<LatLng>> | MVCArray.<LatLng> | Array.<Array.<LatLng>> | Array.<LatLng> The ordered sequence of coordinates that designates a closed loop. Unlike polylines, a polygon may consist of one or more paths. As a result, the paths property may specify one or more arrays of LatLng coordinates. Simple polygons may be defined using a single array of LatLngs. More complex polygons may specify an array of arrays. Any simple arrays are convered into MVCArrays. Inserting or removing LatLngs from the MVCArray will automatically update the polygon on the map.
strokeColor string The stroke color. All CSS3 colors are supported except for extended named colors.
strokeOpacity number The stroke opacity between 0.0 and 1.0
strokeWeight number The stroke width in pixels.
zIndex number The zIndex compared to other polys.

ubiest.maps.Rectangle class

A rectangle on the map. This class extends MVCObject.

Constructor

Constructor Description
Rectangle(opts?:RectangleOptions) Create a rectangle using the passed RectangleOptions, which specify the bounds and style.

Methods

Methods Return Value Description
getBounds() LatLngBounds Returns the bounds of this rectangle.
getMap() Map Returns the map on which this rectangle is displayed.
setBounds(bounds:LatLngBounds) None Sets the bounds of this rectangle.
setMap(map:Map) None Renders the rectangle on the specified map. If map is set to null, the rectangle will be removed.
setOptions(options:RectangleOptions) None

Events

Events Arguments Description
click MouseEvent This event is fired when the DOM click event is fired on the Rectangle.
dblclick MouseEvent This event is fired when the DOM dblclick event is fired on the Rectangle.
mousedown MouseEvent This event is fired when the DOM mousedown event is fired on the Rectangle.
mousemove MouseEvent This event is fired when the DOM mousemove event is fired on the Rectangle.
mouseout MouseEvent This event is fired on Rectangle mouseout.
mouseover MouseEvent This event is fired on Rectangle mouseover.
mouseup MouseEvent This event is fired when the DOM mouseup event is fired on the Rectangle.
rightclick MouseEvent This event is fired when the Rectangle is right-clicked on.

ubiest.maps.RectangleOptions object specification

Properties

Properties Type Description
bounds LatLngBounds The bounds.
clickable boolean Indicates whether this Rectangle handles click events. Defaults to true.
fillColor string The fill color. All CSS3 colors are supported except for extended named colors.
fillOpacity number The fill opacity between 0.0 and 1.0
map Map Map on which to display Rectangle.
strokeColor string The stroke color. All CSS3 colors are supported except for extended named colors.
strokeOpacity number The stroke opacity between 0.0 and 1.0
strokeWeight number The stroke width in pixels.
zIndex number The zIndex compared to other polys.

ubiest.maps.Circle class

A circle on the map. This class extends MVCObject.

Constructor

Constructor Description
Circle(opts?:CircleOptions) Create a circle using the passed CircleOptions, which specify the center, radius, and style.

Methods

Methods Return Value Description
getBounds() LatLngBounds Gets the LatLngBounds of this Circle.
getCenter() LatLng Returns the center of this circle.
getMap() Map Returns the map on which this circle is displayed.
getRadius() number Returns the radius of this circle (in meters).
setCenter(center:LatLng) None Sets the center of this circle.
setMap(map:Map) None Renders the circle on the specified map. If map is set to null, the circle will be removed.
setOptions(options:CircleOptions) None
setRadius(radius:number) None Sets the radius of this circle (in meters).

Events

Events Arguments Description
click MouseEvent This event is fired when the DOM click event is fired on the Circle.
dblclick MouseEvent This event is fired when the DOM dblclick event is fired on the Circle.
mousedown MouseEvent This event is fired when the DOM mousedown event is fired on the Circle.
mousemove MouseEvent This event is fired when the DOM mousemove event is fired on the Circle.
mouseout MouseEvent This event is fired on Circle mouseout.
mouseover MouseEvent This event is fired on Circle mouseover.
mouseup MouseEvent This event is fired when the DOM mouseup event is fired on the Circle.
rightclick MouseEvent This event is fired when the Circle is right-clicked on.

ubiest.maps.CircleOptions object specification

Properties

Properties Type Description
center LatLng The center
clickable boolean Indicates whether this Circle handles click events. Defaults to true.
fillColor string The fill color. All CSS3 colors are supported except for extended named colors.
fillOpacity number The fill opacity between 0.0 and 1.0
map Map Map on which to display Circle.
radius number The radius in meters on the Earth’s surface
strokeColor string The stroke color. All CSS3 colors are supported except for extended named colors.
strokeOpacity number The stroke opacity between 0.0 and 1.0
strokeWeight number The stroke width in pixels.
zIndex number The zIndex compared to other polys.

ubiest.maps.OverlayView class

You can implement this class if you want to display custom types of overlay objects on the map. This class extends MVCObject.

Constructor

Constructor Description
OverlayView() You should inherit from this class by setting your overlay’s prototype to new OverlayView.prototype. You must implement three methods: onAdd(), draw(), and onRemove(). In the add() method, you should create DOM objects and append them as children of the panes. In the draw() method, you should position these elements. In the onRemove() method, you should remove the objects from the DOM. You must call setMap() with a valid Map object to trigger the call to the onAdd() method and setMap(null) in order to trigger the onRemove() method. The setMap() method can be called at the time of construction or at any point afterward when the overlay should be re-shown after removing. The draw() method will then be called whenever a map property changes that could change the position of the element, such as zoom, center, or map type.

Methods

Methods Return Value Description
draw() None Implement this method to draw or update the overlay. This method is called after onAdd() and when the position from projection.fromLatLngToPixel() would return a new value for a given LatLng. This can happen on change of zoom, center, or map type. It is not necessarily called on drag or resize.
getMap() Map
getPanes() MapPanes Returns the panes in which this OverlayView can be rendered. Only available after draw has been called.
getProjection() MapCanvasProjection Returns the MapCanvasProjection object associated with this OverlayView. Only available after draw has been called.
onAdd() None Implement this method to initialize the overlay DOM elements. This method is called once after setMap() is called with a valid map. At this point, panes and projection will have been initialized.
onRemove() None Implement this method to remove your elements from the DOM. This method is called once following a call to setMap(null).
setMap(map:Map) None Adds the overlay to the map.

ubiest.maps.MapPanes object specification

This object contains the DOM elements in which overlays are rendered. They are listed below with ‘Pane 0′ at the bottom and ‘Pane 6′ at the top.

Properties

Properties Type Description
floatPane Node This pane contains the info window. It is above all map overlays. (Pane 6).
floatShadow Node This pane contains the info window shadow. It is above the overlayImage, so that markers can be in the shadow of the info window. (Pane 4).
mapPane Node This pane is the lowest pane and is above the tiles. (Pane 0).
overlayImage Node This pane contains the marker foreground images. (Pane 3).
overlayLayer Node This pane contains polylines, polygons, ground overlays and tile layer overlays. (Pane 1).
overlayMouseTarget Node This pane contains transparent elements that receive DOM mouse events for the markers. It is above the floatShadow, so that markers in the shadow of the info window can be clickable. (Pane 5).
overlayShadow Node This pane contains the marker shadows. (Pane 2).

ubiest.maps.MapCanvasProjection object specification

Methods

Methods Return Value Description
fromContainerPixelToLatLng(pixel:Point) LatLng Computes the geographical coordinates from pixel coordinates in the map’s container.
fromDivPixelToLatLng(pixel:Point) LatLng Computes the geographical coordinates from pixel coordinates in the div that holds the draggable map.
fromLatLngToContainerPixel(latLng:LatLng) Point Computes the pixel coordinates of the given geographical location in the DOM element the map’s outer container.
fromLatLngToDivPixel(latLng:LatLng) Point Computes the pixel coordinates of the given geographical location in the DOM element that holds the draggable map.
getWorldWidth() number The width of the world in pixels in the current zoom level.

ubiest.maps.Geocoder class

A service for converting between an address and a LatLng.

Constructor

Constructor Description
Geocoder() Creates a new instance of a Geocoder that sends geocode requests to Ubiest servers.

Methods

Methods Return Value Description
geocode(request:GeocoderRequest, callback:function(Array.<GeocoderResult>,GeocoderStatus))) None Geocode a request.

ubiest.maps.GeocoderRequest object specification

The specification for a geocoding request to be sent to the Geocoder.

Properties

Properties Type Description
address UbiAddress Address. Optional.
location LatLng LatLng about which to search. Optional.

ubiest.maps.GeocoderStatus class

The status returned by the Geocoder on the completion of a call to geocode().

Constant

Constant Description
ERROR There was a problem contacting the Ubiest servers.
INVALID_REQUEST This GeocoderRequest was invalid.
OK The response contains a valid GeocoderResponse.
REQUEST_DENIED The webpage is not allowed to use the geocoder.
UNKNOWN_ERROR A geocoding request could not be processed due to a server error. The request may succeed if you try again.
ZERO_RESULTS No result was found for this GeocoderRequest.

ubiest.maps.GeocoderResult object specification

A single geocoder result retrieved from the geocode server. A geocode request may return multiple result objects. Note that though this result is “JSON-like,” it is not strictly JSON, as it indirectly includes a LatLng object.

Properties

Properties Type Description
address_components Array.<GeocoderAddressComponent> An array of GeocoderAddressComponents
geometry GeocoderGeometry A GeocoderGeometry object
types Array.<string> An array of strings denoting the type of the returned geocoded element. A type consists of a unique string identifying the geocode result. (For example, “administrative_area_level_1″, “country”, etc.)

ubiest.maps.GeocoderAddressComponent object specification

A single address component within a GeocoderResult. A full address may consist of multiple address components.

Properties

Properties Type Description
long_name string The full text of the address component
short_name string The abbreviated, short text of the given address component
types Array.<string> An array of strings denoting the type of this address component

ubiest.maps.GeocoderGeometry object specification

Geometry information about this GeocoderResult

Properties

Properties Type Description
location LatLng The latitude/longitude coordinates of this result

ubiest.maps.DirectionsRenderer class

Renders directions retrieved in the form of a DirectionsResult object retrieved from the DirectionsService. This class extends MVCObject.

Constructor

Constructor Description
DirectionsRenderer(opts?:DirectionsRendererOptions) Creates the renderer with the given options. Directions can be rendered on a map (as visual overlays) or additionally on a <div> panel (as textual instructions).

Methods

Method Return value Description
getDirections() DirectionsResult Returns the renderer’s current set of directions.
getMap() Map Returns the map on which the DirectionsResult is rendered.
getPanel() Node Returns the panel <div> in which the DirectionsResult is rendered.
getRouteIndex() number Returns the current (zero-based) route index in use by this DirectionsRenderer object.
setDirections(directions:DirectionsResult) None Set the renderer to use the result from the DirectionsService. Setting a valid set of directions in this manner will display the directions on the renderer’s designated map and panel.
setMap(map:Map) None This method specifies the map on which directions will be rendered. Pass null to remove the directions from the map.
setOptions(options:DirectionsRendererOptions) None Change the options settings of this DirectionsRenderer after initialization.
setPanel(panel:Node) None This method renders the directions in a <div>. Pass null to remove the content from the panel.
setRouteIndex(routeIndex:number) None Set the (zero-based) index of the route in the DirectionsResult object to render. By default, the first route in the array will be rendered.

Events

Events Arguments Description
dragstart None This event is fired when the user starts dragging a change to the directions path.
dragend None This event is fired when the user finishes dragging a change to the directions path.
directions_changed None This event is fired when the rendered directions change, either when a new DirectionsResult is set or after the user finishes dragging a change to the directions path.

ubiest.maps.DirectionsRendererOptions object specification

This object defines the properties that can be set on a DirectionsRenderer object.

Properties

Properties Type Description
directions DirectionsResult The directions to display on the map and/or in a <div> panel, retrieved as a DirectionsResult object from DirectionsService.
draggable boolean If true, allows the user to drag and modify the paths of routes rendered by this DirectionsRenderer on dragging release. Only origin, destination and waypoints are draggable.
hideRouteList boolean This property indicates whether the renderer should provide UI to select amongst alternative routes. By default, this flag is false and a user-selectable list of routes will be shown in the directions’ associated panel. To hide that list, set hideRouteList to true.
infoWindow InfoWindow The InfoWindow in which to render text information when a marker is clicked. Existing info window content will be overwritten and its position moved. If no info window is specified, the DirectionsRenderer will create and use its own info window. This property will be ignored if suppressInfoWindows is set to true.
map Map Map on which to display the directions.
markerOptions MarkerOptions Options for the markers. All markers rendered by the DirectionsRenderer will use these options.
panel Node The <div> in which to display the directions steps.
polylineOptions PolylineOptions Options for the polylines. All polylines rendered by the DirectionsRenderer will use these options.
preserveViewport boolean By default, the input map is centered and zoomed to the bounding box of this set of directions. If this option is set to true, the viewport is left unchanged, unless the map’s center and zoom were never set.
routeIndex number The index of the route within the DirectionsResult object. The default value is 0.
suppressInfoWindows boolean Suppress the rendering of info windows.
suppressMarkers boolean Suppress the rendering of markers.
suppressPolylines boolean Suppress the rendering of polylines.

ubiest.maps.DirectionsService class

A service for computing directions between two or more places.

Constructor

Constructor Description
DirectionsService() Creates a new instance of a DirectionsService that sends directions queries to Ubiest servers.

Methods

Method Return value Description
route(request:DirectionsRequest, callback:function(DirectionsResult, DirectionsStatus))) None Issue a directions search request.

ubiest.maps.DirectionsRequest object specification

A directions query to be sent to the DirectionsService.

Properties

Properties Type Description
avoidHighways boolean If true, instructs the Directions service to avoids highways where possible. Optional.
avoidTolls boolean If true, instructs the Directions service to avoids toll roads where possible. Optional.
destination LatLng | UbiAddress Location of destination. This can be specified as either a UbiAddress to be geocoded or a LatLng. Required.
origin LatLng | UbiAddress Location of origin. This can be specified as either a UbiAddress to be geocoded or a LatLng. Required.
provideRouteAlternatives boolean Whether or not route alternatives should be provided. Optional.
travelMode DirectionsTravelMode Type of routing requested. Required.
unitSystem DirectionsUnitSystem Preferred unit system to use when displaying distance. Defaults to the unit system used in the country of origin.
waypoints Array.<DirectionsWaypoint> Array of intermediate waypoints. Directions will be calculated from the origin to the destination by way of each waypoint in this array. Optional.

ubiest.maps.DirectionsTravelMode class

The valid travel modes that can be specified in a DirectionsRequest.

Constant

Constant Description
DRIVING Specifies a driving directions request.
WALKING Specifies a walking directions request.

ubiest.maps.DirectionsUnitSystem class

The valid unit systems that can be specified in a DirectionsRequest.

Constant

Constant Description
IMPERIAL Specifies that distances in the DirectionsResult should be expressed in imperial units.
METRIC Specifies that distances in the DirectionsResult should be expressed in metric units.

ubiest.maps.DirectionsWaypoint object specification

A DirectionsWaypoint represents a location between origin and destination through which the trip should be routed.

Properties

Properties Type Description
location LatLng | UbiAddress Waypoint location. Can be an address UbiAddress or LatLng.

ubiest.maps.DirectionsStatus class

The status returned by the DirectionsService on the completion of a call to route().

Constant

Constant Description
INVALID_REQUEST The DirectionsRequest provided was invalid.
MAX_WAYPOINTS_EXCEEDED Too many DirectionsWaypoints were provided in the DirectionsRequest. The total allowed waypoints is 8, plus the origin and destination.
NOT_FOUND At least one of the origin, destination, or waypoints could not be geocoded.
OK The response contains a valid DirectionsResult.
REQUEST_DENIED The webpage is not allowed to use the directions service.
UNKNOWN_ERROR A directions request could not be processed due to a server error. The request may succeed if you try again.
ZERO_RESULTS No route could be found between the origin and destination.

ubiest.maps.DirectionsResult object specification

The directions response retrieved from the directions server. You can render these using a DirectionsRenderer or parse this object and render it yourself. Note that though this result is “JSON-like,” it is not strictly JSON, as it indirectly includes LatLng objects.

Properties

Properties Type Description
routes Array.<DirectionsRoute> An array of DirectionsRoutes, each of which contains information about the legs and steps of which it is composed. There will only be one route unless the DirectionsRequest was made with provideRouteAlternatives set to true.

ubiest.maps.DirectionsRoute object specification

A single route containing a set of legs in a DirectionsResult. Note that though this object is “JSON-like,” it is not strictly JSON, as it directly and indirectly includes LatLng objects.

Properties

Properties Type Description
bounds LatLngBounds The bounds for this route.
copyrights string Copyrights text to be displayed for this route.
legs Array.<DirectionsLeg> An array of DirectionsLegs, each of which contains information about the steps of which it is composed. There will be one leg for each waypoint or destination specified. So a route with no waypoints will contain one DirectionsLeg and a route with one waypoint will contain two. (This property was formerly known as “routes”.)
overview_path Array.<LatLng> An array of LatLngs representing the entire course of this route. The path is simplified in order to make it suitable in contexts where a small number of vertices is required (such as Static Maps API URLs).

ubiest.maps.DirectionsLeg object specification

A single leg consisting of a set of steps in a DirectionsResult. Some fields in the leg may not be returned for all requests. Note that though this result is “JSON-like,” it is not strictly JSON, as it directly and indirectly includes LatLng objects.

Properties

Properties Type Description
distance DirectionsDistance The total distance covered by this leg. This property may be undefined as the distance may be unknown.
duration DirectionsDuration The total duration of this leg. This property may be undefined as the duration may be unknown.
end_address string The address of the destination of this leg.
end_location LatLng The DirectionsService calculates directions between locations by using the nearest transportation option (usually a road) at the start and end locations. end_location indicates the actual geocoded destination, which may be different than the end_location of the last step if, for example, the road is not near the destination of this leg.
start_address string The address of the origin of this leg.
start_location LatLng The DirectionsService calculates directions between locations by using the nearest transportation option (usually a road) at the start and end locations. start_location indicates the actual geocoded origin, which may be different than the start_location of the first step if, for example, the road is not near the origin of this leg.
steps Array.<DirectionsStep> An array of DirectionsSteps, each of which contains information about the individual steps in this leg.
ne_location LatLng Upper-right corner of bounds for this leg
sw_location LatLng Lower-left corner of bounds for this leg

ubiest.maps.DirectionsStep object specification

A single DirectionsStep in a DirectionsResult. Some fields may be undefined. Note that though this object is “JSON-like,” it is not strictly JSON, as it directly includes LatLng objects.

Properties

Properties Type Description
distance DirectionsDistance The distance covered by this step. This property may be undefined as the distance may be unknown.
duration DirectionsDuration The typical time required to perform this step in seconds and in text form. This property may be undefined as the duration may be unknown.
end_location LatLng The ending location of this step.
instructions string Instructions for this step.
start_location LatLng The starting location of this step.
ne_location LatLng Upper-right corner of bounds for turn at beginning of this step
sw_location LatLng Lower-left corner of bounds for turn at beginning of this step

ubiest.maps.DirectionsDistance object specification

A representation of distance as a numeric value and a display string.

Properties

Properties Type Description
text string A string representation of the distance value, using the DirectionsUnitSystem specified in the request.
value number The distance in meters.

ubiest.maps.DirectionsDuration object specification

A representation of duration as a numeric value and a display string.

Properties

Properties Type Description
text string A string representation of the duration value.
value number The duration in seconds.

ubiest.maps.UbiAddress object specification

Properties

Properties Type Description
amc1 string Country code (3 characters). Either one of amc1 or amd1 is required.
amd1 string Country name. Either one of amc1 or amd1 is required.
amd2 string Administrative division.
amd3 string Sub-Administrative division.
amd4 string Municipality. Either one of amd4 or zip is required.
zip string Zip code. Either one of amd4 or zip is required.
addr string Street address
num number Civic number

ubiest.maps.MapType object specification

This interface defines map type. This interface is typically used for base maps such as road, satellite or hybrid maps. Immutable.

Methods

Methods Return Value Description
getTile(tileCoord:Point,zoom:number,ownerDocument:Document) Node Returns a tile for the given tile coordinate (x, y) and zoom level. This tile will be appended to the given ownerDocument.
releaseTile(tile:Node) None Releases the given tile, performing any necessary cleanup. The provided tile will have already been removed from the document. Optional.

Properties

Properties Type Description
alt string Alt text to display when this MapType’s button is hovered over in the MapTypeControl. Optional.
maxZoom number The maximum zoom level for the map when displaying this MapType. Required for base MapTypes, ignored for overlay MapTypes.
minZoom number The minimum zoom level for the map when displaying this MapType. Optional; defaults to 0.
name string Name to display in the MapTypeControl. Optional.
projection Projection The Projection used to render this MapType. Optional; defaults to Mercator.
radius number Radius of the planet for the map, in meters. Optional; defaults to Earth’s equatorial radius of 6378137 meters.
tileSize Size The dimensions of each tile. Required.

ubiest.maps.MapTypeRegistry class

This class extends MVCObject.

Constructor

Constructor Description
MapTypeRegistry() The MapTypeRegistry holds the collection of custom map types available to the map for its use. The API consults this registry when providing the list of avaiable map types within controls, for example.

Methods

Methods Return Value Description
set(id:string,mapType:MapType) None Sets the registry to associate the passed string identifier with the passed MapType.

ubiest.maps.Projection object specification

Methods

Methods Return Value Description
fromLatLngToPoint(latLng:LatLng) Point Translates from the LatLng cylinder to the Point plane. This interface specifies a function which implements translation from given LatLng values to world coordinates on the map projection. The Maps API calls this method when it needs to plot locations on screen. Projection objects must implement this method.
fromPointToLatLng(pixel:Point) LatLng This interface specifies a function which implements translation from world coordinates on a map projection to LatLng values. The Maps API calls this method when it needs to translate actions on screen to positions on the map. Projection objects must implement this method.
fromLatLngToPixel(latLng:LatLng,zoom:number) Point Translates from the LatLng cylinder to the Point plane considering the zoom level. This interface specifies a function which implements translation from given LatLng values to world coordinates on the map projection. The Maps API calls this method when it needs to plot locations on screen. Projection objects must implement this method.
fromPointToLatLng(pixel:Point,zoom:number) LatLng This interface specifies a function which implements translation from world coordinates on a map projection to LatLng values considering the zoom level. The Maps API calls this method when it needs to translate actions on screen to positions on the map. Projection objects must implement this method.

ubiest.maps.ImageMapType class

This class implements the MapType interface and is provided for rendering image tiles.

Constructor

Constructor Description
ImageMapType(opts:ImageMapTypeOptions) Constructs an ImageMapType using the provided ImageMapTypeOptions

ubiest.maps.ImageMapTypeOptions object specification

This class is used to create a MapType that renders image tiles.

Properties

Properties Type Description
alt string Alt text to display when this MapType’s button is hovered over in the MapTypeControl.
getTileUrl Function(Point, number):string Returns a string (URL) for given tile coordinate (x, y) and zoom level. This function should have a signature of: getTileUrl(Point, number):string
isPng boolean Is the image a PNG? This is needed by some old browsers.
maxZoom number The maximum zoom level for the map when displaying this MapType.
minZoom number The minimum zoom level for the map when displaying this MapType. Optional.
name string Name to display in the MapTypeControl.
opacity number The opacity to apply to the tiles. The opacity should be specified as a float value between 0 and 1.0, where 0 is fully transparent and 1 is fully opaque.
tileSize Size The tile size.

ubiest.maps.MapsEventListener object specification

This class is opaque. It has no methods and no constructor. Its instances are returned from addListener(), addDomListener() and are eventually passed back to removeListener().

ubiest.maps.event namespace

Static Methods

Static Methods Return Value Description
addDomListener(instance:Object,eventName:string, handler:Function,capture?:boolean) MapsEventListener Cross browser event handler registration. This listener is removed by calling removeListener(handle) for the handle that is returned by this function.
addDomListenerOnce(instance:Object,eventName:string, handler:Function,capture?:boolean) MapsEventListener Wrapper around addDomListener that removes the listener after the first event.
addListener(instance:Object,eventName:string, handler:Function) MapsEventListener Adds the given listener function to the given event name for the given object instance. Returns an identifier for this listener that can be used with removeListener().
addListenerOnce(instance:Object,eventName:string, handler:Function) MapsEventListener Like addListener, but the handler removes itself after handling the first event.
clearInstanceListeners(instance:Object) None Removes all listeners for all events for the given instance.
clearListeners(instance:Object,eventName:string) None Removes all listeners for the given event for the given instance.
removeListener(listener:MapsEventListener) None Removes the given listener, which should have been returned by addListener above.
trigger(instance:Object, eventName:string,var_args:*) None Triggers the given event. All arguments after eventName are passed as arguments to the listeners.

ubiest.maps.MouseEvent object specification

This object is returned from various mouse events on the map and overlays, and contains all the fields shown below.

Properties

Properties Type Description
latLng LatLng The latitude/longitude that was below the cursor when the event occurred.
pixel Point The x/y screen coordinate that was below the cursor when the event occurred.

ubiest.maps.LatLng class

LatLng is a point in geographical coordinates, latitude and longitude.
Notice that although usual map projections associate longitude with the x-coordinate of the map, and latitude with the y-coordinate, the latitude coordinate is always written first, followed by the longitude.
Notice also that you cannot modify the coordinates of a LatLng. If you want to compute another point, you have to create a new one.

Constructor

Constructor Description
LatLng(lat:number,lng:number) Notice the ordering of latitude and longitude.

Methods

Methods Return Value Description
equals(other:LatLng) boolean Comparison function.
lat() number Returns the latitude in degrees.
lng() number Returns the longitude in degrees.
toString() string Converts to string representation.
toUrlValue(precision?:number) string Returns a string of the form “lat,lng” for this LatLng. We round the lat/lng values to 6 decimal places by default.

ubiest.maps.LatLngBounds class

A LatLngBounds instance represents a rectangle in geographical coordinates, including one that crosses the 180 degrees longitudinal meridian.

Constructor

Constructor Description
LatLngBounds(sw?:LatLng, ne?:LatLng) Constructs a rectangle from the points at its south-west and north-east corners.

Methods

Methods Return Value Description
contains(latLng:LatLng) boolean Returns true if the given lat/lng is in this bounds.
equals(other:LatLngBounds) boolean Returns true if this bounds approximately equals the given bounds.
extend(point:LatLng) LatLngBounds Extends this bounds to contain the given point.
getCenter() LatLng Computes the center of this LatLngBounds
getNorthEast() LatLng Returns the north-east corner of this bounds.
getSouthWest() LatLng Returns the south-west corner of this bounds.
intersects(other:LatLngBounds) boolean Returns true if this bounds shares any points with this bounds.
isEmpty() boolean Returns if the bounds are empty.
toSpan() LatLng Converts the given map bounds to a lat/lng span.
toString() string Converts to string.
toUrlValue(precision?:number) string Returns a string of the form “lat_lo,lng_lo,lat_hi,lng_hi” for this bounds, where “lo” corresponds to the southwest corner of the bounding box, while “hi” corresponds to the northeast corner of that box.
union(other:LatLngBounds) LatLngBounds Extends this bounds to contain the union of this and the given bounds.

ubiest.maps.Point class

Constructor

Constructor Description
Point(x:number, y:number) A point on a two-dimensional plane.

Methods

Methods Return Value Description
equals(other:Point) boolean Compares two Points
toString() string Returns a string representation of this Point.

Properties

Properties Type Description
x number The X coordinate
y number The Y coordinate

ubiest.maps.Size class

Constructor

Constructor Description
Size(width:number, height:number, widthUnit?:string, heightUnit?:string) Two-dimensonal size, where width is the distance on the x-axis, and height is the distance on the y-axis.

Methods

Methods Return Value Description
equals(other:Size) boolean Compares two Sizes
toString() string Returns a string representation of this Size.

Properties

Properties Type Description
height number The height along the y-axis, in pixels.
width number The width along the x-axis, in pixels.

ubiest.maps.MVCObject class

Constructor

Constructor Description
MVCObject() Base class implementing KVO.

Methods

Methods Return Value Description
bindTo(key:string, target:MVCObject,targetKey?:string, noNotify?:boolean) None Binds a View to a Model.
changed(key:string) None Generic handler for state changes. Override this in derived classes to handle arbitrary state changes.
get(key:string) * Gets a value.
notify(key:string) None Notify all observers of a change on this property. This notifies both objects that are bound to the object’s property as well as the object that it is bound to.
set(key:string, value:*) None Sets a value.
setValues(values:Object) None Sets a collection of key-value pairs
unbind(key:string) None Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.
unbindAll() None Removes all bindings.

ubiest.maps.MVCArray class

Constructor

Constructor Description
MVCArray(array?:Array) A mutable MVC Array.

Methods

Methods Return Value Description
clear() None Removes all elements from the array.
forEach(callback:function(*, number))) None Iterate over each element, calling the provided callback. The callback is called for each element like: callback(element, index).
getArray() Array Returns a reference to the underlying Array. Warning: if the Array is mutated, no events will be fired by this object.
getAt(i:number) * Get an element at the specified index.
getLength() number Returns the number of elements in this array.
insertAt(i:number, elem:*) None Inserts an element at the specified index.
pop() * Removes the last element of the array and returns that element.
push(elem:*) number Adds one element to the end of the array and returns the new length of the array.
removeAt(i:number) * Removes an element from the specified index.
setAt(i:number, elem:*) None Sets an element at the specified index

Events

Events Arguments Description
insert_at number This event is fired when insertAt() is called. The event passes the index that was passed to insertAt().
remove_at number,* This event is fired when removeAt() is called. The event passes the index that was passed to removeAt()and the element that was removed from the array.
set_at number,* This event is fired when setAt() is called. The event passes the index that was passed to setAt() and the element that was previously in the array at that index.

ubiest.maps.geometry.encoding namespace

Utilities for polyline encoding and decoding.

Static Methods

Static Methods Return Value Description
decodePath(encodedPath:string) Array.<LatLng> Decodes an encoded path string into a sequence of LatLngs.
decodeLevels(encodedLevels:string) Array.<number> Decode an encoded levels string into an array of levels (from 0 to 3).
encodePath(path: Array.<LatLng>|MVCArray.<LatLng>) string Encodes a sequence of LatLngs into an encoded path string.

ubiest.maps.geometry.spherical namespace

Utility functions for computing geodesic angles, distances and areas. The default radius is Earth’s radius of 6378137 meters.

Static Methods

Static Methods Return Value Description
computeDistanceBetween(from:LatLng, to:LatLng, radius?:number) number Computes the distance between two LatLngs.
computeOffset(from:LatLng, distance:number, heading:number, radius?:number) LatLng Computes the LatLng produced by starting from a given LatLng and heading a given distance.

ubiest.maps.MapMask

Semi-transparent wait layer to show over the map while loading tiles, directions, or other on-map informations.

Constructor

Constructor Description
MapMask(map:ubiest.maps.Map) A wait layer.

Methods

Methods Return Value Description
show() None Shows the wait layer over the map.
hide() None Hides the wait layer.

.

 
 
 
This website uses cookies to enhance your experience. This website uses cookies, also third parties cookies, to deliver contents and advertising more relevant to you and your interests.
For more information, or to change your cookie settings, click here.
By closing this banner, scrolling this page or selecting any elements on this page, you agree to their use. OK