Class GSRouteInstruction

Represents a single directions instruction within a set of instructions.

Class Summary
Constructor Attributes	Constructor Name and Description
	GSRouteInstruction(leg, feature) Creates a new `GSRouteInstruction` object.

Method Summary
Method Attributes	Method Name and Description
	getCoordinate() Get the coordinate of where this instruction takes place on the map
	getHTML() Get the HTML for this driving instruction
	getName() Get the name of this instruction.

Class Detail

GSRouteInstruction(leg, feature)

Creates a new GSRouteInstruction object.

You should not need to instantiate GSRouteInstruction objects yourself - GSRouteLeg will instantiate GSRouteInstruction objects for you automatically. See GSRouteLeg#getInstructions

Parameters:
{GSRouteLeg} leg: the route leg object that this instruction belongs to
{Object} feature: a GeoJSON feature defining the instruction

Method Detail

{GSPoint} getCoordinate()

Get the coordinate of where this instruction takes place on the map

Returns:: {GSPoint} the coordinate of where the instruction takes place on the map

{String} getHTML()

Get the HTML for this driving instruction

Returns:: {String} the HTML for this driving instruction

{String} getName()

Get the name of this instruction. Only applies for the 'start' and 'stop' instructions at the beginning and end of each route leg.

Returns:: {String} the name of this instruction