Region class

Represents a physical region, the middle precision level for this library

In JSON format, the instance for Badakhshan might look like:

{
  "id": 3901,
  "name": "Badakhshan",
  "state_code": "BDS",
  "latitude": 36.73477250,
  "longitude": 70.81199530,
  "type": null,
  "cities": [
    // ...
    {
      "id": 68,
      "name": "Fayzabad",
      "latitude": 37.11664000,
      "longitude": 70.58002000
    },
    // ...
  ]
}
Inheritance
Available extensions
Annotations
  • @immutable
  • @JsonSerializable.new()

Constructors

Region({required int id, required int parentId, required String name, required String? type, required String stateCode, required List<City> cities, required double longitude, required double latitude})
const
Region.fromJson(Map<String, dynamic> json)
Creates a new Region from JSON.
factory

Properties

cities → List<City>
A list of City instances located in this Region
final
country → Country

Available on Region, provided by the RegionExtensions extension

The Country parenting this Region instance.
no setter
emoji → String?

Available on GeoLocationNode, provided by the GeoLocationNodeExtensions extension

The flag emoji for this node. This will walk the nodes to Country for the Country.emoji flag. If the node is a custom node that can't be walked, this returns null.
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → int
The unique identifier for this data, like 1
finalinherited
latitude → double
The longitude coordinate for this data, like 65.00000000
finalinherited
longitude → double
The longitude coordinate for this data, like 33.00000000
finalinherited
name → String
The human name of this data, like Afghanistan
finalinherited
nameQualified → String

Available on GeoLocationNode, provided by the GeoLocationNodeExtensions extension

The qualified name (including parent names), separated by ,
no setter
parentId → int
finalinherited
props → List<Object?>
The list of properties that will be used to determine whether two instances are equal.
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stateCode → String
The short code for this state, often used in mailing addresses, like BDS for Badakhshan
final
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited
type → String?
If set, the type of region, otherwise null. When set, the value might look like: province, municipality, autonomous region, etc.
final

Methods

distanceTo(T location) → double

Available on T, provided by the GeoCoordsExtensions extension

findClosestCity(GeoCoords target) → City?

Available on Region, provided by the RegionExtensions extension

Finds the City in this Region nearest to the target.
metersTo(T location) → double

Available on T, provided by the GeoCoordsExtensions extension

Measures the distance between this instance and the provided location
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited

Available on Region, provided by the RegionExtensions extension

Finds the City instances with a name containing the value
toJson() → Map<String, dynamic>
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited