CartographicBoundary

data class CartographicBoundary(val id: Long = 0, val administrativeUnitName: AdministrativeUnitName, val regions: List<Region>, val boundingBox: BoundingBox, val zIndex: Float, val administrativeLevel: AdministrativeLevel)

Represents a cartographic boundary on a map, typically the outline of an administrative unit.

Constructors

Link copied to clipboard
constructor(id: Long = 0, administrativeUnitName: AdministrativeUnitName, regions: List<Region>, boundingBox: BoundingBox, zIndex: Float, administrativeLevel: AdministrativeLevel)

Properties

Link copied to clipboard

The administrative level of this unit (e.g., state, county, city).

Link copied to clipboard

The name of the administrative unit associated with this boundary. Refer to AdministrativeUnitName for details on how the name is constructed based on the administrative level (e.g., city, county, state) for flexibility with different regional structures.

Link copied to clipboard

The BoundingBox object encompassing the entire cartographic boundary (including all regions).

Link copied to clipboard
val id: Long = 0

The database ID of the cartographic boundary (defaults to 0).

Link copied to clipboard

A list of Region objects that define the outline of the boundary. Some administrative units may have disconnected territories, hence the list.

Link copied to clipboard

The layer order on the map where the boundary should be drawn (higher zIndex means drawn on top of others).

Functions

Link copied to clipboard

Returns a list of all active regions that are completely within the specified bounding box.

Link copied to clipboard

Creates a new cartographic boundary with all regions deactivated except the one with the largest polygon (based on the number of geoLocations). Deactivated regions will be excluded from the final map visualization.

Link copied to clipboard

Creates a new cartographic boundary with the region at the specified index switched off (deactivated). Deactivated regions will be excluded from the final map visualization.

Link copied to clipboard

Converts the CartographicBoundary model into the view object CartographicBoundaryViewData used to represent cartographic boundaries in the UI.

Link copied to clipboard
open override fun toString(): String