Class protos.google.maps.routing.v2.RouteLegStep (0.2.1)

Represents a RouteLegStep.

Package

@googlemaps/routing

Constructors

(constructor)(properties)

constructor(properties?: google.maps.routing.v2.IRouteLegStep);

Constructs a new RouteLegStep.

Parameter
NameDescription
properties IRouteLegStep

Properties to set

Properties

distanceMeters

public distanceMeters: number;

RouteLegStep distanceMeters.

endLocation

public endLocation?: (google.maps.routing.v2.ILocation|null);

RouteLegStep endLocation.

navigationInstruction

public navigationInstruction?: (google.maps.routing.v2.INavigationInstruction|null);

RouteLegStep navigationInstruction.

polyline

public polyline?: (google.maps.routing.v2.IPolyline|null);

RouteLegStep polyline.

startLocation

public startLocation?: (google.maps.routing.v2.ILocation|null);

RouteLegStep startLocation.

staticDuration

public staticDuration?: (google.protobuf.IDuration|null);

RouteLegStep staticDuration.

travelAdvisory

public travelAdvisory?: (google.maps.routing.v2.IRouteLegStepTravelAdvisory|null);

RouteLegStep travelAdvisory.

Methods

create(properties)

public static create(properties?: google.maps.routing.v2.IRouteLegStep): google.maps.routing.v2.RouteLegStep;

Creates a new RouteLegStep instance using the specified properties.

Parameter
NameDescription
properties IRouteLegStep

Properties to set

Returns
TypeDescription
google.maps.routing.v2.RouteLegStep

RouteLegStep instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.routing.v2.RouteLegStep;

Decodes a RouteLegStep message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.maps.routing.v2.RouteLegStep

RouteLegStep

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.routing.v2.RouteLegStep;

Decodes a RouteLegStep message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.maps.routing.v2.RouteLegStep

RouteLegStep

encode(message, writer)

public static encode(message: google.maps.routing.v2.IRouteLegStep, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified RouteLegStep message. Does not implicitly messages.

Parameters
NameDescription
message IRouteLegStep

RouteLegStep message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.maps.routing.v2.IRouteLegStep, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified RouteLegStep message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IRouteLegStep

RouteLegStep message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.maps.routing.v2.RouteLegStep;

Creates a RouteLegStep message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.maps.routing.v2.RouteLegStep

RouteLegStep

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for RouteLegStep

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this RouteLegStep to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.maps.routing.v2.RouteLegStep, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a RouteLegStep message. Also converts values to other types if specified.

Parameters
NameDescription
message google.maps.routing.v2.RouteLegStep

RouteLegStep

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a RouteLegStep message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not