Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

@usig-gcba/recorridos

1.0.7 • Public • Published

Recorridos

Este servicio permite consultar recorridos entre dos puntos dentro de la Ciudad de Buenos Aires, ya sea en transporte publico o en bicicleta.

Instalación

npm install @usig-gcba/recorridos

Cómo usarlo

ES6

import { Recorridos } from '@usig-gcba/recorridos';
 
const recorridos = Recorridos.init();

API

Recorridos

init(opciones?: Object) => Recorridos

  • opciones: objecto de configuracion con cualquiera de las siguientes propiedades:
Opcion Tipo Default Descripcion
tipo String transporte Idioma de los mensajes del mapa
precargar Number 5 Idioma de los mensajes del mapa
opciones_caminata Number 800 Idioma de los mensajes del mapa
opciones_medios_colectivo boolean true Idioma de los mensajes del mapa
opciones_medios_subte boolean true Idioma de los mensajes del mapa
opciones_medios_tren boolean true Idioma de los mensajes del mapa
max_results Number 15 Idioma de los mensajes del mapa

buscarRecorridos(origen: Object, destino: Object, id: String, options: Object) => Promise<Array[RecorridoObject]>

Dadas dos ubicaciones origen/destino y ciertas opciones de busqueda consulta los recorridos posibles.

Recorrido

getGeoJson(recorrido: RecorridoObject) => Promise

Devuelve la representacion del recorrido en formato geoJson

Parámetros
  • recorrido: RecorridoObject recorrido.
Return
  • Promise con el geoJson del recorrido.

getPlan(recorrido: Object) => Promise

Devuelve el plan del recorrido

Parámetros
  • recorrido: RecorridoObject recorrido.
Return
  • Promise con el plan del recorrido.

removePublicLayer(layerName: String)

Remueve una capa en base a su nombre

  • layerName: String indicando el nombre de la capa

addMarker(latlng: Object, visible: boolean, draggable: boolean, goTo: boolean, activate: boolean, clickable: boolean, options: Object) => markerId: Number

Agrega un marcador en la posicion especificada, retornando su id

Parámetros
  • latlng: Object posicion del marcador
    • lat: Number latitud
    • lng: Number longitud
  • visible: boolean indicando si el marcador debe estar visible
  • draggable: boolean indicando si el marcador puede ser arrastrado
  • goTo: boolean indicando si el mapa debe recentrarse en el marcador
  • activate: boolean indicando si se debe activar el marcador
  • clickable: boolean indicando si el marcador puede ser clickeado
  • options: Object datos a guardar dentro del marcador
Return
  • markerId: Number id del marcador generado

selectMarker(markerId: String)

Selecciona el marcador indicado

Parámetros
  • markerId: Number id del marcador a seleccionar

selectMarker(markerId: String) => boolean

Pregunta si el marcador esta activo

Parámetros
  • markerId: Number id del marcador a analizar

removeMarker(markerId: String)

Remueve el marcador indicado

Parámetros
  • markerId: Number id del marcador a remover
Return
  • seleccionado: boolean indicando si el marcador esta seleccionado

addLocationMarker(position: Object, recenter: boolean, zoomIn: boolean) => L.Marker

Agrega al mapa un marcador de ubicación actual en la posicion especificada

Parámetros
  • position: Object posicion del marcador
    • coords: Object
      • latitude: Number latitud
      • longitude: Number longitud
  • recenter: boolean indicando si el mapa debe recentrarse en la posicion del marcador
  • zoomIn: boolean indicando si se debe ajustar el nivel de zoom
Return
  • marker: L.marker marcador agregado

mostrarRecorrido(recorrido: Object)

Agrega un recorrido al mapa

Parámetros
  • recorrido: Object recorrido a ser agregado. El mismo debe seguir cierta estructura

ocultarRecorrido(recorrido: Object)

Remueve el recorrido del mapa

Parámetros
  • recorrido: Object recorrido a ser removido.

RecorridoObject

Objeto que representa a un recorrido. El servicio devuelve este tipo de objetos al realizar una búsqueda.

Install

npm i @usig-gcba/recorridos

DownloadsWeekly Downloads

2

Version

1.0.7

License

USIG

Unpacked Size

81.3 kB

Total Files

13

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar