Represents a RouteLeg.
Package
@googlemaps/routingConstructors
(constructor)(properties)
constructor(properties?: google.maps.routing.v2.IRouteLeg);Constructs a new RouteLeg.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRouteLeg
Properties to set |
Properties
distanceMeters
public distanceMeters: number;RouteLeg distanceMeters.
duration
public duration?: (google.protobuf.IDuration|null);RouteLeg duration.
endLocation
public endLocation?: (google.maps.routing.v2.ILocation|null);RouteLeg endLocation.
localizedValues
public localizedValues?: (google.maps.routing.v2.RouteLeg.IRouteLegLocalizedValues|null);RouteLeg localizedValues.
polyline
public polyline?: (google.maps.routing.v2.IPolyline|null);RouteLeg polyline.
startLocation
public startLocation?: (google.maps.routing.v2.ILocation|null);RouteLeg startLocation.
staticDuration
public staticDuration?: (google.protobuf.IDuration|null);RouteLeg staticDuration.
steps
public steps: google.maps.routing.v2.IRouteLegStep[];RouteLeg steps.
stepsOverview
public stepsOverview?: (google.maps.routing.v2.RouteLeg.IStepsOverview|null);RouteLeg stepsOverview.
travelAdvisory
public travelAdvisory?: (google.maps.routing.v2.IRouteLegTravelAdvisory|null);RouteLeg travelAdvisory.
Methods
create(properties)
public static create(properties?: google.maps.routing.v2.IRouteLeg): google.maps.routing.v2.RouteLeg;Creates a new RouteLeg instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRouteLeg
Properties to set |
| Returns | |
|---|---|
| Type | Description |
RouteLeg |
RouteLeg instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.routing.v2.RouteLeg;Decodes a RouteLeg 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 |
RouteLeg |
RouteLeg |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.routing.v2.RouteLeg;Decodes a RouteLeg message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
RouteLeg |
RouteLeg |
encode(message, writer)
public static encode(message: google.maps.routing.v2.IRouteLeg, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RouteLeg message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRouteLeg
RouteLeg 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.routing.v2.IRouteLeg, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RouteLeg message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRouteLeg
RouteLeg 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.routing.v2.RouteLeg;Creates a RouteLeg 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 |
RouteLeg |
RouteLeg |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for RouteLeg
| 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 RouteLeg to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.maps.routing.v2.RouteLeg, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a RouteLeg message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
RouteLeg
RouteLeg |
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 RouteLeg message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|