RoadShieldIconProperties constructor
- RouteType routeType,
- String countryCode,
- String stateCode,
- String routeNumberName,
- String shieldText,
Creates a new instance.
routeTypeThe type of route indicating the significance of the road in a range from 0 to 6. A value of 1 stands for the most major route and 6 the most minor, with 0 being of unknown type.countryCodeThe country code in ISO-3166-1 alpha-3 format, which will determine the type of road shield.stateCodeThe state code for the road. It's a 2-letter code in ISO 3166-2 format. For example the ones listed for US on this page https://en.wikipedia.org/wiki/ISO_3166-2:US. The code "AL" is for Alabama. Another example is the code for autonomous communities listed on https://en.wikipedia.org/wiki/ISO_3166-2:ES. Can be empty if not required for the particular country.routeNumberNameA string that is used to additionally determine the road shield's visual representation. In a routing context, the text can be taken from aLocalizedRoadNumber, which is available for eachSpanof aRouteobject. Typically, the string contains the number of a road, such as "E100". Internally, the text is parsed with a RegEx pattern and the results will be used along with other properties such asrouteType,countryCodeandstateCodeto identify the visual representation of a road shield icon.
Note that the actual text which will be displayed on the road shield icon is set with
RoadShieldIconProperties.shieldText. In order to determine the visuals of the icon, countryCode, routeType
and eventually the stateCode is in most cases sufficient to determine the type of road
shield. In this case an empty string should be passed.
Note: Texts that contain a CardinalDirection are currently not supported and may lead
to unexpected results. See LocalizedRoadNumber for more details, it provides texts with
and without a cardinal direction.
shieldTextThe text of the road-shield. This is the text which is displayed on the road-shield in reality. It will be in the output road-shield icon.
Implementation
RoadShieldIconProperties(this.routeType, this.countryCode, this.stateCode, this.routeNumberName, this.shieldText);