Clase RouteMatrix
clase
google.maps.routes.RouteMatrix
biblioteca "routes"
Es una matriz de rutas calculadas para un conjunto de pares de origen y destino por RouteMatrix.computeRouteMatrix.
const {RouteMatrix} = await google.maps.importLibrary("routes");
Métodos estáticos | |
|---|---|
computeRouteMatrix |
computeRouteMatrix(request)Parámetros:
Valor de retorno:
Promise<{matrix:RouteMatrix}>Toma una lista de orígenes y destinos, y devuelve una matriz que contiene información de la ruta para cada combinación de origen y destino. Nota: Este método requiere que especifiques una máscara de campo de respuesta en la solicitud configurando la propiedad ComputeRouteMatrixRequest.fields. El valor es una lista de rutas de acceso de campos. Por ejemplo:
No se recomienda usar la máscara de campo de respuesta comodín fields: ['*'] por los siguientes motivos:
|
Propiedades | |
|---|---|
rows
readonly |
Tipo:
Array<RouteMatrixRow>Son las filas de la matriz. Cada fila corresponde a un origen y contiene un array de RouteMatrixItem, cada uno de los cuales representa una ruta a un destino. |
Métodos | |
|---|---|
Heredado:
toJSON
|
Clase RouteMatrixRow
clase
google.maps.routes.RouteMatrixRow
biblioteca "routes"
Corresponde a un origen que se pasa a RouteMatrix.computeRouteMatrix. Contiene una lista de RouteMatrixItem, en la que cada elemento representa una ruta a un destino.
const {RouteMatrixRow} = await google.maps.importLibrary("routes");
Propiedades | |
|---|---|
items
readonly |
Tipo:
Array<RouteMatrixItem>La información de la ruta para cada destino. |
Métodos | |
|---|---|
Heredado:
toJSON
|
Clase RouteMatrixItem
clase
google.maps.routes.RouteMatrixItem
biblioteca "routes"
Contiene información de la ruta calculada para un par de origen y destino que se pasa a RouteMatrix.computeRouteMatrix.
const {RouteMatrixItem} = await google.maps.importLibrary("routes");
Propiedades | |
|---|---|
condition
readonly |
Tipo:
RouteMatrixItemCondition optionalIndica si se encontró la ruta o no. |
distanceMeters
readonly |
Tipo:
number optionalEs la distancia de viaje de la ruta en metros. |
durationMillis
readonly |
Tipo:
number optionalEs el tiempo necesario para recorrer la ruta, expresado en milisegundos. Si estableces ComputeRouteMatrixRequest.routingPreference en TRAFFIC_UNAWARE, este valor será el mismo que RouteMatrixItem.staticDurationMillis. Si configuras ComputeRouteMatrixRequest.routingPreference como TRAFFIC_AWARE o TRAFFIC_AWARE_OPTIMAL, este valor se calcula teniendo en cuenta las condiciones de tráfico. Nota: Si la duración supera los 2^53 milisegundos, este valor es Number.POSITIVE_INFINITY. |
error
readonly |
Tipo:
RouteMatrixItemError optionalEs el error que se produjo durante el cálculo de la ruta. |
fallbackInfo
readonly |
Tipo:
FallbackInfo optionalEn algunos casos, cuando el servidor no puede calcular la ruta con las preferencias dadas para este par de origen y destino en particular, puede recurrir a un modo de cálculo diferente. Cuando se usa un resguardo, este campo contiene información detallada sobre la respuesta de resguardo. De lo contrario, este campo no se configura. |
localizedValues
readonly |
Tipo:
RouteMatrixItemLocalizedValues optionalSon representaciones de texto de las propiedades de RouteMatrixItem. |
staticDurationMillis
readonly |
Tipo:
number optionalEs la duración del viaje por la ruta sin tener en cuenta las condiciones de tráfico. Nota: Si la duración supera los 2^53 milisegundos, este valor es Number.POSITIVE_INFINITY. |
travelAdvisory
readonly |
Tipo:
RouteTravelAdvisory optionalInformación adicional sobre la ruta. |
Interfaz ComputeRouteMatrixRequest
interfaz
google.maps.routes.ComputeRouteMatrixRequest
Es una solicitud de una matriz de rutas.
Propiedades | |
|---|---|
destinations |
Tipo:
Iterable<string|LatLng|LatLngLiteral|LatLngAltitudeLiteral|DirectionalLocationLiteral|Place|Waypoint>Es un array de destinos que determina las columnas de la matriz de respuesta. Un valor que se pasa como una cadena puede ser una dirección, un Plus Code o un nombre de recurso de Place. No se tienen en cuenta los valores de altitud. |
fields |
Tipo:
Iterable<string>Es la colección de campos que se recuperarán. Especifica ["*"] para todos los campos. |
origins |
Tipo:
Iterable<string|LatLng|LatLngLiteral|LatLngAltitudeLiteral|DirectionalLocationLiteral|Place|RouteMatrixOrigin|Waypoint>Es un array de orígenes que determina las filas de la matriz de respuesta. Un valor que se pasa como una cadena puede ser una dirección, un Plus Code o un nombre de recurso de Place. No se tienen en cuenta los valores de altitud. Se aplican varias restricciones de tamaño a la cardinalidad de los orígenes y destinos:
|
arrivalTime
opcional |
Tipo:
Date optionalLa hora de llegada. Nota: Solo se puede configurar cuando ComputeRouteMatrixRequest.travelMode se establece en TRANSIT. Puedes especificar ComputeRouteMatrixRequest.departureTime o ComputeRouteMatrixRequest.arrivalTime, pero no ambos. Los viajes en transporte público están disponibles hasta 7 días en el pasado o 100 días en el futuro. |
departureTime
opcional |
Tipo:
Date optionalLa hora de salida. Si no estableces este valor, se establecerá de forma predeterminada en la hora en que realizaste la solicitud. Nota: Solo puedes especificar una hora en el pasado cuando ComputeRouteMatrixRequest.travelMode se establece en TRANSIT. Los viajes en transporte público están disponibles hasta 7 días en el pasado o 100 días en el futuro. |
extraComputations
opcional |
Tipo:
Iterable<ComputeRouteMatrixExtraComputation> optionalEs una lista de cálculos adicionales que se pueden usar para completar la solicitud. Nota: Estos cálculos adicionales pueden devolver campos adicionales en la respuesta. Estos campos adicionales también se deben especificar en ComputeRouteMatrixRequest.fields para que se devuelvan en la respuesta. |
internalUsageAttributionIds
opcional |
Tipo:
Iterable<string> optionalSon identificadores que se usan para atribuir llamadas a paquetes específicos o bibliotecas de OSS. |
language
opcional |
Tipo:
string optionalEl código de idioma BCP-47, como "en-US" o "sr-Latn". Para obtener más información, consulta Identificador de configuración regional de Unicode. Consulta Idiomas admitidos para obtener la lista de idiomas compatibles. Si no proporcionas este valor, el idioma se infiere de la configuración de localización de la API de Maps JavaScript de Google Maps. De lo contrario, el idioma se infiere de la ubicación del primer origen. |
region
opcional |
Tipo:
string optionalEs el código de región, especificado como un valor ccTLD ("dominio de nivel superior") de dos caracteres. Para obtener más información, consulta Dominios de nivel superior con código de país. Si no proporcionas este valor, la región se infiere de la configuración de localización de la API de Google Maps JavaScript. De lo contrario, la región se infiere de la ubicación del primer origen. |
routingPreference
opcional |
Tipo:
RoutingPreference optionalEspecifica cómo calcular la matriz de rutas. El servidor intenta usar la preferencia de ruta seleccionada para calcular la matriz de rutas. Si la preferencia de enrutamiento genera un error o una latencia muy larga, se devuelve un error. Puedes especificar esta opción solo cuando ComputeRouteMatrixRequest.travelMode es DRIVING o TWO_WHEELER; de lo contrario, la solicitud falla. |
trafficModel
opcional |
Tipo:
TrafficModel optionalEspecifica las suposiciones que se usarán para calcular el tiempo en el tráfico. Este parámetro de configuración afecta el valor que se muestra en RouteMatrixItem.durationMillis, que contiene el tiempo previsto en el tráfico según los promedios históricos. ComputeRouteMatrixRequest.trafficModel solo está disponible para las solicitudes que establecieron ComputeRouteMatrixRequest.routingPreference en TRAFFIC_AWARE_OPTIMAL y ComputeRouteMatrixRequest.travelMode en DRIVING. La configuración predeterminada es BEST_GUESS. |
transitPreference
opcional |
Tipo:
TransitPreference optionalEspecifica las preferencias que influyen en la ruta que se devuelve para las rutas TRANSIT. Nota: Solo se puede especificar cuando ComputeRouteMatrixRequest.travelMode se establece en TRANSIT. |
travelMode
opcional |
Tipo:
TravelMode optionalEspecifica el medio de transporte. |
units
opcional |
Tipo:
UnitSystem optionalEspecifica las unidades de medida de los campos de visualización. Si no proporcionas este valor, las unidades de visualización se infieren de la ubicación del primer origen. |
Constantes de ComputeRouteMatrixExtraComputation
constantes
google.maps.routes.ComputeRouteMatrixExtraComputation
biblioteca "routes"
Son los cálculos adicionales que se deben realizar mientras se completa la solicitud. Consulta la documentación del servicio web para obtener más información.
Estas constantes también se pueden usar como cadenas. En TypeScript, los literales de cadena se definen con el tipo ComputeRouteMatrixExtraComputationString.
const {ComputeRouteMatrixExtraComputation} = await google.maps.importLibrary("routes");
Constantes | |
|---|---|
TOLLS |
Es la información de peaje de los elementos de la matriz. Consulta la documentación del servicio web para obtener más información. |
Constantes de RouteMatrixItemCondition
constantes
google.maps.routes.RouteMatrixItemCondition
biblioteca "routes"
Es la condición de la ruta que se devuelve. Consulta la documentación del servicio web para obtener más información.
Estas constantes también se pueden usar como cadenas. En TypeScript, los literales de cadena se definen con el tipo RouteMatrixItemConditionString.
const {RouteMatrixItemCondition} = await google.maps.importLibrary("routes");
Constantes | |
|---|---|
ROUTE_EXISTS |
Se encontró una ruta y se completó la información correspondiente para el elemento. Consulta la documentación del servicio web para obtener más información. |
ROUTE_NOT_FOUND |
No se encontró ninguna ruta. Consulta la documentación del servicio web para obtener más información. |
Clase RouteMatrixItemError
class
google.maps.routes.RouteMatrixItemError
extends Error
library "routes"
Es un error que se produjo durante RouteMatrix.computeRouteMatrix para un par de origen y destino específico.
const {RouteMatrixItemError} = await google.maps.importLibrary("routes");
Métodos | |
|---|---|
Heredado:
toJSON
|
Clase RouteMatrixItemLocalizedValues
clase
google.maps.routes.RouteMatrixItemLocalizedValues
biblioteca "routes"
Son representaciones de texto de la RouteMatrixItem.
const {RouteMatrixItemLocalizedValues} = await google.maps.importLibrary("routes");
Propiedades | |
|---|---|
distance
readonly |
Tipo:
string optionalEs la distancia de viaje del elemento de la matriz de rutas en formato de texto. |
distanceLanguage
readonly |
Tipo:
string optionalEs el código de idioma según la norma BCP-47 del texto de la distancia, como "en-US" o "sr-Latn". Para obtener más información, consulta http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. |
duration
readonly |
Tipo:
string optionalEs la duración, representada en formato de texto y localizada según la región de la consulta. Toma en cuenta las condiciones de tráfico. Nota: Si no solicitaste información sobre el tráfico, este valor es el mismo que RouteMatrixItemLocalizedValues.staticDuration. |
durationLanguage
readonly |
Tipo:
string optionalEs el código de idioma según la norma BCP-47 del texto de duración, como "en-US" o "sr-Latn". Para obtener más información, consulta http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. |
staticDuration
readonly |
Tipo:
string optionalEs la duración sin tener en cuenta las condiciones de tráfico, representada en formato de texto. |
staticDurationLanguage
readonly |
Tipo:
string optionalEs el código de idioma según la norma BCP-47 del texto de duración estática, como "en-US" o "sr-Latn". |
transitFare
readonly |
Tipo:
string optionalEs la tarifa de transporte público, representada en formato de texto. |
transitFareLanguage
readonly |
Tipo:
string optionalEs el código de idioma según la norma BCP-47 del texto de la tarifa de transporte público, como "en-US" o "sr-Latn". Para obtener más información, consulta http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. |
Métodos | |
|---|---|
Heredado:
toJSON
|
Interfaz RouteMatrixOrigin
interfaz
google.maps.routes.RouteMatrixOrigin
Un solo origen para un ComputeRouteMatrixRequest.
Propiedades | |
|---|---|
waypoint |
La ubicación del origen. Un valor que se pasa como una cadena puede ser una dirección o un código plus. No se tienen en cuenta los valores de altitud. |
routeModifiers
opcional |
Tipo:
RouteModifiers optionalModificadores para cada ruta que toma este elemento como origen. |