Class Map

Object
   |
   +--Map

class Map

Clase principal de la API. Representa un mapa dentro del documento HTML, y contiene los métodos que permiten realizar las operaciones del mapa, como dibujarlo, hacer zoom, hacer paneo, etc.

Constructor Detail

Map

Map(<string> container, <MapOptions> mapOptions)

Construye un nuevo objeto Map.

Parameters:
container - Nombre del elemento HTML que servirá como contenedor del mapa.
mapOptions - (Opcional) - Objeto que contiene configuraciones iniciales para dibujar el mapa

addControl

void addControl(<Control> control, <Position> position, <boolean> draggable)

Agrega un control al mapa.

Parameters:
control - El control para agregar.
position - La ubicación en pixeles en donde debe aparecer el control.
draggable - (Opcional) - Especifica si el control debe ser móvil o estático. Un valor true significa que el control será móvil; un valor false significa que será estático. Por defecto true.

See:
- Control
- NavigatorControl
- SearchBarControl
- MapTypeControl
- ZoneSelectorControl
- InterestPointsControl

addDecoration

void addDecoration(<Decoration> decoration, <GeoPoint> geoPoint)

Agrega una decoración al mapa. Una decoración es cualquier objeto que implemente la interfaz Decoration, por ejemplo un InfoWindow. Al agregarse mediante este método los objetos son agregados a un layer por default del mapa.

Se pueden agregar layers por separado y agregar los decorations directamente al layer (ver clase Layer), y después agregar los layers al mapa. De esta forma se puede tener un control sobre los decorations de forma de agruparlos en layers y tratarlos en conjunto.

Parameters:
decoration - Objeto o decoración para agregar.
geoPoint - Coordenada geográfica en donde se desea agregar la decoración.

See:
- Layer
- addLayer()
- removeDecoration()

addEventListener

void addEventListener(<string> eventId, <Function> listener)

Agrega un controlador de eventos al mapa.

Parameters:
eventId - Nombre del evento a controlar.
listener - Función controladora del evento.

See:
- removeEventListener()

addLayer

void addLayer(<Layer> layer)

Agrega un layer al mapa.

Parameters:
layer - El layer a agregar.

addMapType

void addMapType(<MapType> mapType)

Agrega un tipo de skin al mapa.

Parameters:
mapType - Tipo de skin para agregar.

addOptionToContextMenu

void addOptionToContextMenu(iconLink)

Permite agregar una opción personalizada al menú contextual del mapa.

Parameters:
text - Texto a mostrar en el menú
func - Función a ejecutar.
Esta función recibe 1 parámetro, y es un GeoPoint que corresponde a la coordenada geográfica correspondiente al punto del mapa en donde se hizo clic.
icon - (Opcional)- La URL del ícono a desplegar en el menú contextual.

addToolbar

void addToolbar(<Direction> direction)

Agrega una barra de herramientas en la parte superior del mapa.

Parameters:
direction - (Opcional) - La dirección en que se mostrará la barra de herramientas (horizontal o vertical). Por defecto Direction.HORIZONTAL

clearAllLayers

void clearAllLayers()

Limpia todas los layers del mapa, borrando del dibujo todas las decoraciones que se han agregado, incluyendo el dibujo de rutas.

See:
- Layer
- drawRoute()
- drawInfoWindow()
- addDecoration()

clearCursors

void clearCursors()

Elimina la configuración de cursores del mapa, dejando los cursores por defecto.

clearRouteLayer

void clearRouteLayer()

Limpia la ruta entre dos puntos que se ha dibujado en el mapa.

See:
- drawRoute()

configCursors

void configCursors()

Asocia los cursores de paneo del mapa

doMoreInfo

void doMoreInfo(<GeoPoint> geoPoint, <Function> callback)

Encuentra información de un punto del mapa (calle, altura inicial, altura final).

Parameters:
geoPoint - Coordenada geográfica del punto a buscar información.
callback - Función que se ejecutará con el resultado de la búsqueda de información. El objeto recibido como parámetro por esta función contiene el resultado encontrado. Los campos que contiene este objeto son los siguientes:
• labelName: Nombre de la calle más próxima al punto.
• streetNumber: Numeración del punto dentro del eje.
• leftFrom: Altura inicial del eje por la izquierda.
• leftTo: Altura final del eje por la izquierda.
• rightFrom: Altura inicial del eje por la derecha.
• rightTo: Altura final del eje por la derecha.

draw

void draw(<GeoPoint> center, <int> zoomLevel)

Dibuja el mapa en el centro y nivel de zoom especificados. Es la forma más básica de dibujar un mapa.

Parameters:
center - Punto en donde se dibujará el mapa.
zoomLevel - Nivel de zoom en que se dibujará el mapa.

See:
- drawAddressSearch()
- drawInfoWindow()
- drawRoute()

drawAddressSearch

void drawAddressSearch(<string> addressSearch, <int> zoomLevel, <Function> callback)

Dibuja el mapa centrado en la dirección pasada como parámetro, en el nivel de zoom especificado.

Parameters:
addressSearch - Dirección a buscar, por ejemplo "Moneda 920, Santiago".
zoomLevel - El nivel de zoom para dibujar el mapa.
callback - Función a ejecutar cuando se encuentre la dirección y se dibuje el mapa. Esta función recibe como parámetro un objeto que contiene los siguientes campos:
• streetType: tipo de calle (Avenida, Calle, Pasaje, etc.)
• streetName: nombre de la calle
• number: número
• commune: nombre de la comuna
• province: nombre de la provincia
• region: nombre de la región
• name: nombre completo de la calle (Tipo + Nombre)
• latitude: latitud de la dirección
• longitude: longitud de la dirección.

See:
- draw()

drawInfoWindow

void drawInfoWindow(infoWindow, geoPoint, zoomLevel)

drawIntersectionSearch

void drawIntersectionSearch(<string> intersectionSearch, <int> zoomLevel, <Function> callback)

Dibuja el mapa centrado en la intersección de calles pasada como parámetro, en el nivel de zoom especificado.

Parameters:
intersectionSearch - Intersección a buscar, por ejemplo "Estado, Agustinas, Santiago".
zoomLevel - El nivel de zoom para dibujar el mapa.
callback - Función a ejecutar cuando se encuentre la intersección y se dibuje el mapa. Esta función recibe como parámetro un objeto que contiene los siguientes campos:

See:
- draw()

drawRoute

void drawRoute(<string> fromAddress, <string> toAddress, <boolean> crossType, <boolean> jerarchy, <Function> callback)

Dibuja el mapa con la ruta entre dos direcciones.

Parameters:
fromAddress - Dirección de origen, por ejemplo "Moneda 920, Santiago".
toAddress - Dirección de origen, por ejemplo "Agustinas 260, Santiago".
crossType - Valor booleano que indica que se considera el sentido del tránsito para la determinar la ruta, un valor true indica que debe considerar el sentido del tránsito, y un valor false indica que no se considera el sentido del tránsito.
jerarchy - Valor booleano que indica si se debe considerar la jerarquía de las calles para determinar la ruta (avenidas sobre calles, calles sobre pasajes, etc). Un valor true significa que se considera la jerarquía, y un valor false indica que no se considera.
callback - (Opcional) - Función que se ejecutará al finalizar la búsqueda de la ruta. Esta función recibe como parámetro un array que contiene el detalle de la ruta encontrada. Cada elemento de este array es un objeto que contiene una porción de la ruta, y cada uno contiene los siguientes campos:
• arrow: Indica la acción a seguir:
  • "0": Seguir adelante
  • "1": Doblar a la izquierda
  • "2": Doblar a la derecha
  • "-3": Punto de partida
  • "-2": Punto de llegada
• desc: Descripción del tramo

See:
- draw()

enableEmailByPoint

void enableEmailByPoint()

Habilita la funcionalidad de enviar el mapa por correo electrónico seleccionando un punto mediante el menú contextual del mapa.

enableIntersectionSearch

void enableIntersectionSearch()

Habilita en el mapa la característica de realizar búsquedas por intersección de calles.

See:
- SearchBarControl

enableMoreInfo

void enableMoreInfo()

Habilita la funcionalidad de ver información de un punto del mapa (calle, altura inicial, altura final) seleccionando un punto mediante el menú contextual del mapa.

getActiveMapType

MapType getActiveMapType()

Obtiene el tipo de skin activo del mapa.

Returns:
El tipo de skin activo.

getBoundary

GeoBoundary getBoundary()

Devuelve el área visible del mapa.

Returns:
Las coordenadas que delimitan el área visible del mapa.

getCenter

GeoPoint getCenter()

Obtiene el centro geográfico del mapa.

Returns:
La coordenada geográfica correspondiente al centro del mapa.

getChangeSkinEvent

CustomEvent getChangeSkinEvent()

Retorna el evento que ocurre cuando se cambia el skin del mapa.

getContainer

HTMLElement getContainer()

Obtiene el objeto HTML contenedor del mapa.

Returns:
EL objeto HTML contenedor del mapa.

getDrawEvent

CustomEvent getDrawEvent()

Retorna el evento que ocurre cuando se dibuja el mapa.

See:
- draw()
- drawInfoWindow()
- drawAddressSearch()
- drawRoute()

getGeoPointFromEvent

GeoPoint getGeoPointFromEvent(<MouseEvent> ev)

Obtiene la coordenada geográfica del mapa en donde ha ocurrido un evento del mouse.

Parameters:
ev - El evento ocurrido.

Returns:
La coordenada geográfica correspondiente al punto del mapa en donde ha ocurrido el evento.

See:
- getPixelPointFromEvent()

getLayers

Layer[] getLayers()

Obtiene los layers pertenecientes al mapa.

Returns:
Devuelve un array con los layers del mapa.

See:
- Layer

getMapTypes

MapType[] getMapTypes()

Obtiene los tipos de skin que se han asociado al mapa.

Returns:
Retorna un array con los tipos de skin asociados.

getPanEvent

CustomEvent getPanEvent()

Retorna el evento que ocurre cuando se hace paneo en el mapa.

getPixelPointFromEvent

PixelPoint getPixelPointFromEvent(<MouseEvent> ev)

Obtiene el punto del mapa en donde ha ocurrido un evento del mouse.

Parameters:
ev - El evento ocurrido.

Returns:
El punto en pixeles del mapa en donde ha ocurrido el evento.

See:
- getGeoPointFromEvent()

getSize

Size getSize()

Devuelve el tamaño del mapa.

Returns:
El tamaño en pixeles del mapa.

getZoomEvent

CustomEvent getZoomEvent()

Retorna el evento que ocurre cuando se cambia el nivel de zoom del mapa.

getZoomLevel

int getZoomLevel()

Obtiene el nivel de zoom actual del mapa.

Returns:
El nivel de zoom actual del mapa.

panDirection

void panDirection(<int> dx, <int> dy)

Desplaza el mapa en una cantidad de pixeles determinada.

Parameters:
dx - La cantidad de pixeles a desplazar en la dirección horizontal.
dy - La cantidad de pixeles a desplazar en la dirección vertical.

refresh

void refresh()

Redibuja el mapa.

removeDecoration

void removeDecoration(<Decoration> decoration)

Quita una decoración previamente agregada al mapa.

Parameters:
decoration - Objeto o decoración para eliminar.

See:
- addDecoration()

removeEventListener

void removeEventListener(<string> eventId, <Function> listener)

Remueve un controlador de eventos del mapa.

Parameters:
eventId - Nombre del evento.
listener - Función controladora del evento que se removerá.

See:
- addEventListener()

removeLayer

void removeLayer(<Layer> layer)

Elimina un layer del mapa.

Parameters:
layer - El layer a eliminar.

removeMapType

void removeMapType(<MapType> mapType)

Quita un tipo de skin previamente agregado al mapa.

Parameters:
mapType - Tipo de skin a quitar.

setMapType

void setMapType(<MapType> mapType)

Establece el tipo de skin activo del mapa. Este tipo de skin debe haberse agregado previamente.

Parameters:
mapType - Tipo de skin para dejar activo.

showErrorMessage

void showErrorMessage(<string> message)

Muestra un mensaje de error en el centro del mapa. El mensaje desaparece después de 3 segundos.

Parameters:
message - El mensaje a desplegar.

showInformationMessage

void showInformationMessage(<string> message)

Muestra un mensaje de información en el centro del mapa. El mensaje desaparece después de 3 segundos.

Parameters:
message - El mensaje a desplegar.

showWarningMessage

void showWarningMessage(<string> message)

Muestra un mensaje de advertencia en el centro del mapa. El mensaje desaparece después de 3 segundos.

Parameters:
message - El mensaje a desplegar.

updateDrawInfoWindow

void updateDrawInfoWindow(<InfoWindow> infoWindow, <GeoPoint> geoPoint, <int> zoomLevel)

Dibuja el mapa con un InfoWindow centrado en el punto especificado y en el nivel de zoom especificado.

Parameters:
infoWindow - El objeto InfoWindow que aparecerá centrado en el mapa.
geoPoint - La coordenada que corresponde al centro del mapa.
zoomLevel - El nivel de zoom para dibujar el mapa.

See:
- draw()

zoomIn

void zoomIn()

Cambia el nivel de zoom del mapa a 1 nivel menor que el actual.

zoomOut

void zoomOut()

Cambia el nivel de zoom del mapa a 1 nivel mayor que el actual.

zoomTo

void zoomTo(<int> zoomLevel)

Cambia el nivel de zoom del mapa al nivel especificado.

Parameters:
zoomLevel - El nivel de zoom que se aplicará.