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) | (None) | | Constructor | origin as GraffitiMap.Point <br> destination as GraffitiMap.Point | (None) | Creates a new instance of the class. | | Update | (None) | (None) | Notifies that changes have been made. | ## Properties | Name | Type | Default Value | Description | | --- | :---: | :---: | --- | | Attributes | APIKey | String | (None) | | Attributes | mDestination | GraffitiMap.Point | (None) | | Attributes | mDistanceText | String | (None) | | Attributes | mDistanceValue | Integer | (None) | | Attributes | mID | String | (None) | | Attributes | mOrigin | GraffitiMap.Point | (None) | | Attributes | mParent | GraffitiUpdateInterface | (None) | | Attributes | ID | (None) | (None) | | AutoFocus | Boolean | False | When True, the map should focus on this route. | | AvoidFerries | Boolean | (None) | (None) | | AvoidHighways | Boolean | (None) | (None) | | AvoidTolls | Boolean | (None) | (None) | | Destination | GraffitiMap.Point | (None) | (None) | | DistanceText | String | (None) | (None) | | DistanceValue | Integer | (None) | (None) | | Editable | Boolean | (None) | (None) | | Origin | GraffitiMap.Point | (None) | (None) | | ProvideAlternatives | Boolean | (None) | (None) | | 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 | (None) | (None) | | StrokeWeight | Integer | (None) | (None) | | Tag | Variant | (None) | Developer storage. | | TravelMode | TravelModes | (None) | (None) | | UnitSystem | UnitSystems | (None) | Used measurement system. | | waypoints() | GraffitiMap.Directions.Waypoint | (None) | 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 ```