RouteURL class
Una RouteURL representa una dirección URL a las operaciones de ruta de Azure Maps.
- Extends
Constructores
| RouteURL(Pipeline, string) | Crea una instancia de RouteURL. |
Propiedades heredadas
| maps |
Valor de cadena de dirección URL base. |
Métodos
| calculate |
Devuelve una ruta entre un origen y un destino, pasando por los puntos de acceso si se especifican. La ruta tendrá en cuenta factores como el tráfico actual y las velocidades típicas de la carretera en el día solicitado de la semana y la hora del día. La información devuelta incluye la distancia, el tiempo de desplazamiento estimado y una representación de la geometría de ruta. También hay disponible información de enrutamiento adicional, como el orden optimizado del punto de acceso o las instrucciones de turno por turno, en función de las opciones seleccionadas. El servicio de enrutamiento proporciona un conjunto de parámetros para una descripción detallada del modelo de consumo específico del vehículo. Consulte Modelo de consumo para obtener una explicación detallada de los conceptos y parámetros implicados. Si De lo contrario, usa Get Route Directions API: https://docs.microsoft.com/rest/api/maps/route/getroutedirections |
| calculate |
Nota: Esta API está actualmente en versión preliminar y puede estar sujeta a cambios importantes. Calcula una matriz de resúmenes de ruta para un conjunto de rutas definidas por ubicaciones de origen y destino. Para cada origen determinado, este servicio calcula el costo del enrutamiento desde ese origen a cada destino determinado. El conjunto de orígenes y el conjunto de destinos se pueden considerar como los encabezados de columna y fila de una tabla y cada celda de la tabla contiene los costos de enrutamiento desde el origen hasta el destino de esa celda. Para cada ruta, se calculan los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar las rutas que se van a calcular mediante Routing Directions API. Si el parámetro waitForResults de la solicitud se establece en false (valor predeterminado), esta API devuelve un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado). El cálculo de una matriz de rutas se considera una operación de larga duración. Una operación de larga duración implica que después de que se acepte la solicitud inicial (HTTP 202), se sondeará el resultado final hasta que esté disponible. Cada solicitud de sondeo reinicia el tiempo de espera del abortador, si se especificó uno. Usa post Route Matrix API: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview |
| calculate |
Calcule un conjunto de ubicaciones a las que se puede llegar desde el punto de origen en función del presupuesto de combustible, energía o tiempo especificado. Se devuelve un límite de polígono (o Isochrone) en una orientación en sentido contrario a las agujas del reloj, así como el centro de polígono preciso que fue el resultado del punto de origen. El polígono devuelto se puede usar para su posterior procesamiento, como Búsqueda Inside Geometry para buscar POIs en el Isochrone proporcionado. Usa Get Route Range API: https://docs.microsoft.com/rest/api/maps/route/getrouterange |
Métodos heredados
| new |
Método estático que se usa para crear un nuevo objeto Pipeline con Credential proporcionado. |
Detalles del constructor
RouteURL(Pipeline, string)
Crea una instancia de RouteURL.
new RouteURL(pipeline: Pipeline, mapsUrl?: string)Parámetros
- pipeline
- Pipeline
Llame a MapsURL.newPipeline() para crear una canalización predeterminada o proporcione una canalización personalizada.
- mapsUrl
-
string
Una cadena de dirección URL que apunta a Azure Maps servicio, el valor predeterminado es "https://atlas.microsoft.com".
Si no se especifica ningún protocolo, por ejemplo "atlas.microsoft.com", https se supone que.
Detalles de las propiedades heredadas
mapsUrl
Valor de cadena de dirección URL base.
mapsUrl: stringValor de propiedad
string
Heredado deMapsURL.mapsUrl
Detalles del método
calculateRouteDirections(Aborter, GeoJSON.Position[], CalculateRouteDirectionsOptions)
Devuelve una ruta entre un origen y un destino, pasando por los puntos de acceso si se especifican. La ruta tendrá en cuenta factores como el tráfico actual y las velocidades típicas de la carretera en el día solicitado de la semana y la hora del día. La información devuelta incluye la distancia, el tiempo de desplazamiento estimado y una representación de la geometría de ruta. También hay disponible información de enrutamiento adicional, como el orden optimizado del punto de acceso o las instrucciones de turno por turno, en función de las opciones seleccionadas.
El servicio de enrutamiento proporciona un conjunto de parámetros para una descripción detallada del modelo de consumo específico del vehículo. Consulte Modelo de consumo para obtener una explicación detallada de los conceptos y parámetros implicados.
Si options.postBody se especifica, usa Post Route Directions API: https://docs.microsoft.com/rest/api/maps/route/postroutedirections
De lo contrario, usa Get Route Directions API: https://docs.microsoft.com/rest/api/maps/route/getroutedirections
function calculateRouteDirections(aborter: Aborter, coordinates: GeoJSON.Position[], options?: CalculateRouteDirectionsOptions): Promise<CalculateRouteDirectionsResponse>Parámetros
- aborter
- Aborter
Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.
- coordinates
-
GeoJSON.Position[]
Matriz de coordenadas a través de la cual se calcula la ruta.
Cada coordenada es una matriz de [longitude, latitude]. Se requiere un mínimo de dos coordenadas.
La primera es el origen y la última es el destino de la ruta.
Las coordenadas opcionales entre actúan como WayPoints en la ruta. Puede pasar hasta 150 WayPoints.
- options
- CalculateRouteDirectionsOptions
Devoluciones
Promise<CalculateRouteDirectionsResponse>
calculateRouteMatrix(Aborter, CalculateRouteMatrixRequestBody, CalculateRouteMatrixOptions)
Nota: Esta API está actualmente en versión preliminar y puede estar sujeta a cambios importantes. Calcula una matriz de resúmenes de ruta para un conjunto de rutas definidas por ubicaciones de origen y destino. Para cada origen determinado, este servicio calcula el costo del enrutamiento desde ese origen a cada destino determinado. El conjunto de orígenes y el conjunto de destinos se pueden considerar como los encabezados de columna y fila de una tabla y cada celda de la tabla contiene los costos de enrutamiento desde el origen hasta el destino de esa celda. Para cada ruta, se calculan los tiempos de viaje y las distancias. Puede usar los costos calculados para determinar las rutas que se van a calcular mediante Routing Directions API. Si el parámetro waitForResults de la solicitud se establece en false (valor predeterminado), esta API devuelve un código de respuesta 202 a lo largo de una dirección URL de redireccionamiento en el campo Ubicación del encabezado de respuesta. Esta dirección URL debe comprobarse periódicamente hasta que los datos de respuesta o la información de error estén disponibles. El tamaño máximo de una matriz para esta API es 700 (el número de orígenes multiplicado por el número de destinos). Teniendo en cuenta esa restricción, algunos ejemplos de posibles dimensiones de matriz son: 50x10, 10x10, 28x25. 10x70 (no es necesario que sea cuadrado).
El cálculo de una matriz de rutas se considera una operación de larga duración. Una operación de larga duración implica que después de que se acepte la solicitud inicial (HTTP 202), se sondeará el resultado final hasta que esté disponible. Cada solicitud de sondeo reinicia el tiempo de espera del abortador, si se especificó uno.
Usa post Route Matrix API: https://docs.microsoft.com/rest/api/maps/route/postroutematrixpreview
function calculateRouteMatrix(aborter: Aborter, body: CalculateRouteMatrixRequestBody, options?: CalculateRouteMatrixOptions): Promise<CalculateRouteMatrixResponse>Parámetros
- aborter
- Aborter
Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.
Matriz de coordenadas de origen y destino para calcular la distancia de ruta, el tiempo de desplazamiento y otro resumen de cada celda de la matriz en función de los parámetros de entrada. El número mínimo y máximo de celdas admitidos son 1 y 700 respectivamente. Por ejemplo, puede ser 35 orígenes y 20 destinos o 25 orígenes y 25 destinos.
- options
- CalculateRouteMatrixOptions
Devoluciones
Promise<CalculateRouteMatrixResponse>
calculateRouteRange(Aborter, GeoJSON.Position, CalculateRouteRangeOptions)
Calcule un conjunto de ubicaciones a las que se puede llegar desde el punto de origen en función del presupuesto de combustible, energía o tiempo especificado. Se devuelve un límite de polígono (o Isochrone) en una orientación en sentido contrario a las agujas del reloj, así como el centro de polígono preciso que fue el resultado del punto de origen. El polígono devuelto se puede usar para su posterior procesamiento, como Búsqueda Inside Geometry para buscar POIs en el Isochrone proporcionado.
Usa Get Route Range API: https://docs.microsoft.com/rest/api/maps/route/getrouterange
function calculateRouteRange(aborter: Aborter, center: GeoJSON.Position, options?: CalculateRouteRangeOptions): Promise<CalculateRouteRangeResponse>Parámetros
- aborter
- Aborter
Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.
- center
- GeoJSON.Position
Coordenada desde la que se debe iniciar el cálculo del intervalo.
- options
- CalculateRouteRangeOptions
Devoluciones
Promise<CalculateRouteRangeResponse>
Detalles de los métodos heredados
newPipeline(Credential, INewPipelineOptions)
Método estático que se usa para crear un nuevo objeto Pipeline con Credential proporcionado.
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): PipelineParámetros
- credential
- Credential
Por ejemplo, SubscriptionKeyCredential, TokenCredential y MapControlCredential.
- pipelineOptions
- INewPipelineOptions
Devoluciones
Nuevo objeto Pipeline.
Heredado deMapsURL.newPipeline