.insets

class: Inset

class Inset(**kwargs)[source]

Configuration of a specific map inset.

Class Inheritance
Inheritance diagram of Inset

copy(other=None, overwrite=True, **kwargs)

Copy the configuration settings from this instance to the other instance.

Parameters:

  • other (HighchartsMeta) – The target instance to which the properties of this instance should be copied. If None, will create a new instance and populate it with properties copied from self. Defaults to None.

  • overwrite (bool) – if True, properties in other that are already set will be overwritten by their counterparts in self. Defaults to True.

  • kwargs – Additional keyword arguments. Some special descendents of HighchartsMeta may have special implementations of this method which rely on additional keyword arguments.

Returns:

A mutated version of other with new property values

classmethod from_dict(as_dict: dict, allow_snake_case: bool = True)

Construct an instance of the class from a dict object.

Parameters:

  • as_dict (dict) – A dict representation of the object.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

Returns:

A Python object representation of as_dict.

Return type:

HighchartsMeta

classmethod from_js_literal(as_str_or_file, allow_snake_case: bool = True, _break_loop_on_failure: bool = False)

Return a Python object representation of a Highcharts JavaScript object literal.

Parameters:

  • as_str_or_file (str) – The JavaScript object literal, represented either as a str or as a filename which contains the JS object literal.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

  • _break_loop_on_failure (bool) – If True, will break any looping operations in the event of a failure. Otherwise, will attempt to repair the failure. Defaults to False.

Returns:

A Python object representation of the Highcharts JavaScript object literal.

Return type:

HighchartsMeta

classmethod from_json(as_json_or_file, allow_snake_case: bool = True)

Construct an instance of the class from a JSON string.

Parameters:

  • as_json_or_file – The JSON string for the object or the filename of a file that contains the JSON string.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

Returns:

A Python objcet representation of as_json.

Return type:

HighchartsMeta

get_required_modules(include_extension=False) → List[str]

Return the list of URLs from which the Highcharts JavaScript modules needed to render the chart can be retrieved.

Parameters:

include_extension (bool) – if True, will return script names with the '.js' extension included. Defaults to False.

Return type:

list of str

to_dict() → dict

Generate a dict representation of the object compatible with the Highcharts JavaScript library.

Note

The dict representation has a property structure and naming convention that is intentionally consistent with the Highcharts JavaScript library. This is not Pythonic, but it makes managing the interplay between the two languages much, much simpler.

Returns:

A dict representation of the object.

Return type:

dict

to_js_literal(filename=None, encoding='utf-8', careful_validation=False) → str | None

Return the object represented as a str containing the JavaScript object literal.

Parameters:

  • filename (Path-like) – The name of a file to which the JavaScript object literal should be persisted. Defaults to None

  • encoding (str) – The character encoding to apply to the resulting object. Defaults to 'utf-8'.

  • careful_validation – if True, will carefully validate JavaScript values

along the way using the esprima-python library. Defaults to False.

Warning

Setting this value to True will significantly degrade serialization performance, though it may prove useful for debugging purposes.

Return type:

str or None

to_json(filename=None, encoding='utf-8')

Generate a JSON string/byte string representation of the object compatible with the Highcharts JavaScript library.

Note

This method will either return a standard str or a bytes object depending on the JSON serialization library you are using. For example, if your environment has orjson, the result will be a bytes representation of the string.

Parameters:

  • filename (Path-like) – The name of a file to which the JSON string should be persisted. Defaults to None

  • encoding (str) – The character encoding to apply to the resulting object. Defaults to 'utf-8'.

Returns:

A JSON representation of the object compatible with the Highcharts library.

Return type:

str or bytes

static trim_dict(untrimmed: dict, to_json: bool = False, context: str = None) → dict

Remove keys from untrimmed whose values are None and convert values that have .to_dict() methods.

Parameters:

  • untrimmed (dict) – The dict whose values may still be None or Python objects.

  • to_json (bool) – If True, will remove all keys from untrimmed that are not serializable to JSON. Defaults to False.

  • context (str or None) – If provided, will inform the method of the context in which it is being run which may inform special handling cases (e.g. where empty strings may be important / allowable). Defaults to None.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False, context: str = None)

Convert any EnforcedNullType values in untrimmed to 'null'.

Parameters:

  • untrimmed (iterable) – The iterable whose members may still be None or Python objects.

  • to_json (bool) – If True, will remove all members from untrimmed that are not serializable to JSON. Defaults to False.

  • context (str or None) – If provided, will inform the method of the context in which it is being run which may inform special handling cases (e.g. where empty strings may be important / allowable). Defaults to None.

Return type:

iterable

property border_color: str | Gradient | Pattern | None

The border color drawn around the inset. Defaults to '#cccccc'.

Returns:

The color of the inset border.

Return type:

str, Gradient, Pattern`, or None

property border_path: MultiLineString | None

A MultiLineString geometry that defines the border path of the inset in units as per .units. Defaults to None.

If None, a border is rendered around the .field geometry.

Tip

Best practice!

It is recommended that the border path partly follows the outline of the field in order to make pointer positioning consistent.

Return type:

MultiLineString or None

property border_width: int | float | Decimal | None

The border width (in pixels) applied to the inset border. Defaults to 1.

Returns:

The border width to apply to the inset border.

Return type:

numeric or None

property field: Polygon | None

A Polygon geometry that defines where in the chart the inset should be rendered in units as per .units. Defaults to None.

If None, the inset is rendered in the full plot area.

Return type:

Polygon or None

property geo_bounds: Polygon | None

A Polygon geometry that encircles the shapes that should be rendered inside the inset. Geometries that are found within this geometry are removed from the default map view and rendered in the inset. Defaults to None.

Return type:

Polygon or None

property id: str | None

The identifier given to the inset. Defaults to None.

Return type:

str or None

property padding: str | int | float | Decimal | List[str | int | float | Decimal] | None

The padding of the insets. Defaults to '10%'.

Accepts:

  • a number, representing pixels

  • a percentage string, relative to the plot area

  • an array of numbers or percentage strings, corresponding to top, right, bottom, and left respectively

Return type:

str, int, 4-member list of str or int, or None

property projection: ProjectionOptions | None

The projection options for the inset. Defaults to None.

Return type:

ProjectionOptions or None

property relative_to: str | None

The coordinate system that the inset’s .field and .border_path should relate to. Defaults to 'mapBoundingBox'.

Accepts either:

  • 'mapBoundingBox' (default)

  • 'plotBox'

Note

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.

Return type:

str or None

property units: str | None

The units to use for the inset’s .field and .border_path settings. Defaults to 'percent'.

Accepts either:

  • 'percent' (default)

  • 'pixels'

Note

If 'percent', they are expressed as a percentage of the item referenced in .relative_to.

If 'pixels', they are expressed in absolute values.

Return type:

str

class: InsetOptions

class InsetOptions(**kwargs)[source]

Generic configuration settings for the placement and appearance of map insets, such as those used for non-contiguous territories.

Class Inheritance
Inheritance diagram of InsetOptions

copy(other=None, overwrite=True, **kwargs)

Copy the configuration settings from this instance to the other instance.

Parameters:

  • other (HighchartsMeta) – The target instance to which the properties of this instance should be copied. If None, will create a new instance and populate it with properties copied from self. Defaults to None.

  • overwrite (bool) – if True, properties in other that are already set will be overwritten by their counterparts in self. Defaults to True.

  • kwargs – Additional keyword arguments. Some special descendents of HighchartsMeta may have special implementations of this method which rely on additional keyword arguments.

Returns:

A mutated version of other with new property values

classmethod from_dict(as_dict: dict, allow_snake_case: bool = True)

Construct an instance of the class from a dict object.

Parameters:

  • as_dict (dict) – A dict representation of the object.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

Returns:

A Python object representation of as_dict.

Return type:

HighchartsMeta

classmethod from_js_literal(as_str_or_file, allow_snake_case: bool = True, _break_loop_on_failure: bool = False)

Return a Python object representation of a Highcharts JavaScript object literal.

Parameters:

  • as_str_or_file (str) – The JavaScript object literal, represented either as a str or as a filename which contains the JS object literal.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

  • _break_loop_on_failure (bool) – If True, will break any looping operations in the event of a failure. Otherwise, will attempt to repair the failure. Defaults to False.

Returns:

A Python object representation of the Highcharts JavaScript object literal.

Return type:

HighchartsMeta

classmethod from_json(as_json_or_file, allow_snake_case: bool = True)

Construct an instance of the class from a JSON string.

Parameters:

  • as_json_or_file – The JSON string for the object or the filename of a file that contains the JSON string.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

Returns:

A Python objcet representation of as_json.

Return type:

HighchartsMeta

get_required_modules(include_extension=False) → List[str]

Return the list of URLs from which the Highcharts JavaScript modules needed to render the chart can be retrieved.

Parameters:

include_extension (bool) – if True, will return script names with the '.js' extension included. Defaults to False.

Return type:

list of str

to_dict() → dict

Generate a dict representation of the object compatible with the Highcharts JavaScript library.

Note

The dict representation has a property structure and naming convention that is intentionally consistent with the Highcharts JavaScript library. This is not Pythonic, but it makes managing the interplay between the two languages much, much simpler.

Returns:

A dict representation of the object.

Return type:

dict

to_js_literal(filename=None, encoding='utf-8', careful_validation=False) → str | None

Return the object represented as a str containing the JavaScript object literal.

Parameters:

  • filename (Path-like) – The name of a file to which the JavaScript object literal should be persisted. Defaults to None

  • encoding (str) – The character encoding to apply to the resulting object. Defaults to 'utf-8'.

  • careful_validation – if True, will carefully validate JavaScript values

along the way using the esprima-python library. Defaults to False.

Warning

Setting this value to True will significantly degrade serialization performance, though it may prove useful for debugging purposes.

Return type:

str or None

to_json(filename=None, encoding='utf-8')

Generate a JSON string/byte string representation of the object compatible with the Highcharts JavaScript library.

Note

This method will either return a standard str or a bytes object depending on the JSON serialization library you are using. For example, if your environment has orjson, the result will be a bytes representation of the string.

Parameters:

  • filename (Path-like) – The name of a file to which the JSON string should be persisted. Defaults to None

  • encoding (str) – The character encoding to apply to the resulting object. Defaults to 'utf-8'.

Returns:

A JSON representation of the object compatible with the Highcharts library.

Return type:

str or bytes

static trim_dict(untrimmed: dict, to_json: bool = False, context: str = None) → dict

Remove keys from untrimmed whose values are None and convert values that have .to_dict() methods.

Parameters:

  • untrimmed (dict) – The dict whose values may still be None or Python objects.

  • to_json (bool) – If True, will remove all keys from untrimmed that are not serializable to JSON. Defaults to False.

  • context (str or None) – If provided, will inform the method of the context in which it is being run which may inform special handling cases (e.g. where empty strings may be important / allowable). Defaults to None.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False, context: str = None)

Convert any EnforcedNullType values in untrimmed to 'null'.

Parameters:

  • untrimmed (iterable) – The iterable whose members may still be None or Python objects.

  • to_json (bool) – If True, will remove all members from untrimmed that are not serializable to JSON. Defaults to False.

  • context (str or None) – If provided, will inform the method of the context in which it is being run which may inform special handling cases (e.g. where empty strings may be important / allowable). Defaults to None.

Return type:

iterable

property border_color: str | Gradient | Pattern | None

The border color drawn around the inset. Defaults to '#cccccc'.

Returns:

The color of the inset border.

Return type:

str, Gradient, Pattern`, or None

property border_width: int | float | Decimal | None

The border width (in pixels) applied to the inset border. Defaults to 1.

Returns:

The border width to apply to the inset border.

Return type:

numeric or None

property padding: str | int | float | Decimal | List[str | int | float | Decimal] | None

The padding of the insets. Defaults to '10%'.

Accepts:

  • a number, representing pixels

  • a percentage string, relative to the plot area

  • an array of numbers or percentage strings, corresponding to top, right, bottom, and left respectively

Return type:

str, int, 4-member list of str or int, or None

property relative_to: str | None

The coordinate system that the inset’s .field and .border_path should relate to. Defaults to 'mapBoundingBox'.

Accepts either:

  • 'mapBoundingBox' (default)

  • 'plotBox'

Note

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.

Return type:

str or None

property units: str | None

The units to use for the inset’s .field and .border_path settings. Defaults to 'percent'.

Accepts either:

  • 'percent' (default)

  • 'pixels'

Note

If 'percent', they are expressed as a percentage of the item referenced in .relative_to.

If 'pixels', they are expressed in absolute values.

Return type:

str

Sub-components

Module

Classes / Functions

.options.map_views.insets

InsetOptions

.options.map_views.insets.insets

InsetOptions Inset