Represents a RoutingParameters.
Package
@googlemaps/placesConstructors
(constructor)(properties)
constructor(properties?: google.maps.places.v1.IRoutingParameters);Constructs a new RoutingParameters.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRoutingParameters
Properties to set |
Properties
origin
public origin?: (google.type.ILatLng|null);RoutingParameters origin.
routeModifiers
public routeModifiers?: (google.maps.places.v1.IRouteModifiers|null);RoutingParameters routeModifiers.
routingPreference
public routingPreference: (google.maps.places.v1.RoutingPreference|keyof typeof google.maps.places.v1.RoutingPreference);RoutingParameters routingPreference.
travelMode
public travelMode: (google.maps.places.v1.TravelMode|keyof typeof google.maps.places.v1.TravelMode);RoutingParameters travelMode.
Methods
create(properties)
public static create(properties?: google.maps.places.v1.IRoutingParameters): google.maps.places.v1.RoutingParameters;Creates a new RoutingParameters instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRoutingParameters
Properties to set |
| Returns | |
|---|---|
| Type | Description |
RoutingParameters |
RoutingParameters instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.places.v1.RoutingParameters;Decodes a RoutingParameters message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
RoutingParameters |
RoutingParameters |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.places.v1.RoutingParameters;Decodes a RoutingParameters message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
RoutingParameters |
RoutingParameters |
encode(message, writer)
public static encode(message: google.maps.places.v1.IRoutingParameters, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RoutingParameters message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRoutingParameters
RoutingParameters message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.maps.places.v1.IRoutingParameters, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RoutingParameters message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRoutingParameters
RoutingParameters message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.maps.places.v1.RoutingParameters;Creates a RoutingParameters message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
RoutingParameters |
RoutingParameters |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for RoutingParameters
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this RoutingParameters to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.maps.places.v1.RoutingParameters, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a RoutingParameters message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
RoutingParameters
RoutingParameters |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a RoutingParameters message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|