GraffitiSuite Docs
Docs
Route
Loading document parsing libraries...
# Route Class ## Compatibility ### Framework API Version | 1.0 | 2.0 | | :---: | :---: | | True | True | ### Web | 32-Bit | 64-Bit | | :---: | :---: | | True | True | ## Enumerations | Name | Value | Description | | --- | :---: | --- | | TravelModes | Driving <br> Bicycling <br> Transit <br> Walking <br> TwoWheeler | Supported modes of travel. | | UnitSystems | Imperial <br> Metric | Supported distance measurement systems. | ## Methods | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | Close | (None) | (None) | | | Constructor | origin as GraffitiMap.Point <br> destination as GraffitiMap.Point | (None) | Creates a new instance of the class. | | Attributes | Hidden | toJavaScript | | | Attributes | Hidden | toJSON | | | Update | (None) | (None) | Notifies that changes have been made. | ## Properties | Name | Type | Default Value | Description | | --- | :---: | :---: | --- | | Attributes | APIKey | String | | | Attributes | mDestination | GraffitiMap.Point | | | Attributes | mDistanceText | String | | | Attributes | mDistanceValue | Integer | | | Attributes | mID | String | | | Attributes | mOrigin | GraffitiMap.Point | | | Attributes | mParent | GraffitiUpdateInterface | | | Attributes | ID | Nil | | | AutoFocus | Boolean | False | When True, the map should focus on this route. | | AvoidFerries | Boolean | Nil | | | AvoidHighways | Boolean | Nil | | | AvoidTolls | Boolean | Nil | | | Destination | GraffitiMap.Point | Nil | | | DistanceText | String | Nil | | | DistanceValue | Integer | Nil | | | Editable | Boolean | Nil | | | Origin | GraffitiMap.Point | Nil | | | ProvideAlternatives | Boolean | Nil | | | ResolveNames | Boolean | False | When True, locations should be resolved to world coordinate points. | | ShowStepsInSidebar | Boolean | True | When True, route steps should be displayed as directions in the map’s sidebar. | | StrokeColor | Color | Nil | | | StrokeWeight | Integer | Nil | | | Tag | Variant | Nil | Developer storage. | | TravelMode | TravelModes | Nil | | | UnitSystem | UnitSystems | Nil | Used measurement system. | | waypoints() | GraffitiMap.Directions.Waypoint | Nil | Points along the route path. | ## Examples ### Sample Route ``` var directionsToNY as new GraffitiMap.Directions.Route( johnsonCity.Position, new GraffitiMap.Point( "New York, NY" ) ) directionsToNY.Editable = True me.Directions = directionsToNY ```