HighchartsMapViewInsetsOptions class

The individual MapView insets, typically used for non-contiguous areas of a country. Each item inherits from the generic insetOptions.

Some of the TopoJSON files of the Highcharts Map Collection include a property called hc-recommended-mapview, and some of these include insets. In order to override the recommended inset options, an inset option with a matching id can be applied, and it will be merged into the embedded settings.

API Docs: https://api.highcharts.com/highmaps/mapView.insets

Inheritance

Constructors

HighchartsMapViewInsetsOptions.new({dynamic borderPath, dynamic field, dynamic geoBounds, String? id, HighchartsMapViewInsetsProjectionOptions? projection, String? borderColor, double? borderWidth, List? padding, String? relativeTo, String? units})
The individual MapView insets, typically used for non-contiguous areas of a country. Each item inherits from the generic insetOptions.

Properties

borderColor ↔ String?
The border color of the insets.
getter/setter pair
borderPath ↔ dynamic
A geometry object of type MultiLineString defining the border path of the inset in terms of units. If undefined, a border is rendered around the field geometry. It is recommended that the borderPath partly follows the outline of the field in order to make pointer positioning consistent.
getter/setter pair
borderWidth ↔ double?
The pixel border width of the insets.
getter/setter pair
field ↔ dynamic
A geometry object of type Polygon defining where in the chart the inset should be rendered, in terms of units and relative to the relativeTo setting. If a borderPath is omitted, a border is rendered around the field. If undefined, the inset is rendered in the full plot area.
getter/setter pair
geoBounds ↔ dynamic
A geometry object of type Polygon encircling the shapes that should be rendered in the inset, in terms of geographic coordinates. Geometries within this geometry are removed from the default map view and rendered in the inset.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
id ↔ String?
The id of the inset, used for internal reference.
getter/setter pair
padding ↔ List?
The padding of the insets. Can be either a number of pixels, a percentage string, or an array of either. If an array is given, it sets the top, right, bottom, left paddings respectively.
getter/setter pair
projection ↔ HighchartsMapViewInsetsProjectionOptions?
The projection options for the inset.
getter/setter pair
relativeTo ↔ String?
What coordinate system the field and borderPath should relate to. If plotBox, they will be fixed to the plot box and responsively move in relation to the main map. If mapBoundingBox, they will be fixed to the map bounding box, which is constant and centered in different chart sizes and ratios.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
units ↔ String?
What units to use for the field and borderPath geometries. If percent (default), they relate to the box given in relativeTo. If pixels, they are absolute values.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJSON() → String
Serializes the settings to a JSON string.
inherited
toOptionsJSON(StringBuffer buffer) → void
override
toString() → String
A string representation of this object.
inherited

Operators

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