.geojson

class: Point

class Point(**kwargs)[source]

Represents a GeoJSON Point as a Python object, inheriting from geojson.Point with additional methods to conform to the HighchartsMeta standard interface.

Class Inheritancedigraph inheritancea2febaa40b { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "base.GeoJSON" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A class representing a GeoJSON object."]; "geometry.Geometry" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Represents an abstract base class for a WGS84 geometry."]; "base.GeoJSON" -> "geometry.Geometry" [arrowsize=0.5,style="setlinewidth(0.5)"]; "geometry.Point" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "geometry.Geometry" -> "geometry.Point" [arrowsize=0.5,style="setlinewidth(0.5)"]; "metaclasses.HighchartsMeta" [URL="../internals.html#highcharts_maps.metaclasses.HighchartsMeta",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Metaclass that is used to define the standard interface exposed for serializable"]; "utility_classes.geojson.GeoJSONBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class used to implement standard methods that can be mixed-in to the"]; "metaclasses.HighchartsMeta" -> "utility_classes.geojson.GeoJSONBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "utility_classes.geojson.Point" [URL="#highcharts_maps.utility_classes.geojson.Point",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a GeoJSON ``Point`` as a Python object, inheriting from"]; "utility_classes.geojson.GeoJSONBase" -> "utility_classes.geojson.Point" [arrowsize=0.5,style="setlinewidth(0.5)"]; "geometry.Point" -> "utility_classes.geojson.Point" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

check_list_errors(checkFunc, lst)

Validation helper function.

clear() → None.  Remove all items from D.
copy(other=None, overwrite=True, **kwargs)

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

Parameters:

  • other (GeoJSONBase) – 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

errors()[source]

Return validation errors (if any). Implement in each subclass.

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: str | bytes, 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

classmethod from_topojson(as_topojson)

Convert a Topology instance into a GeoJSONBase instance.

Parameters:

as_topojson (Topology) – The TopoJSON object or collection to convert.

Return type:

GeoJSONBase

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

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

classmethod to_instance(ob, default=None, strict=False)

Encode a GeoJSON dict into an GeoJSONBase object.

Note

Assumes the caller knows that the dict should satisfy a GeoJSON type.

Parameters:

  • cls (dict) – dict containing the elements to be encoded into a GeoJSON object.

  • ob (geojson.base.GeoJSON) – GeoJSON object into which to encode the dict provided in cls.

  • default (geojson.base.GeoJSON) – A default instance to append the content of the dict. Defaults to None.

  • strict (bool) – Raise error if unable to coerce particular keys or attributes to a valid GeoJSON structure. Defaults to False.

Returns:

A GeoJSON object with the dict’s elements as its constituents.

Return type:

geojson.base.GeoJSON

Raises:

  • TypeError – If the input dict contains items that are not valid GeoJSON types.

  • UnicodeEncodeError – If the input dict contains items of a type that contain non-ASCII characters.

  • AttributeError – If the input dict contains items that are not valid GeoJSON types.

to_js_literal(filename=None, encoding='utf-8') → 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'.

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

to_topojson() → Topology

Convert the object into a TopoJSON Topology object.

Return type:

Topology

static trim_dict(untrimmed: dict, to_json: bool = False) → 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.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False)

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.

Return type:

iterable

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values

class: MultiPoint

class MultiPoint(**kwargs)[source]

Represents a GeoJSON MultiPoint as a Python object, inheriting from geojson.MultiPoint with additional methods to conform to the HighchartsMeta standard interface.

Class Inheritancedigraph inheritanceeb9feff241 { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "base.GeoJSON" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A class representing a GeoJSON object."]; "geometry.Geometry" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Represents an abstract base class for a WGS84 geometry."]; "base.GeoJSON" -> "geometry.Geometry" [arrowsize=0.5,style="setlinewidth(0.5)"]; "geometry.MultiPoint" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "geometry.Geometry" -> "geometry.MultiPoint" [arrowsize=0.5,style="setlinewidth(0.5)"]; "metaclasses.HighchartsMeta" [URL="../internals.html#highcharts_maps.metaclasses.HighchartsMeta",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Metaclass that is used to define the standard interface exposed for serializable"]; "utility_classes.geojson.GeoJSONBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class used to implement standard methods that can be mixed-in to the"]; "metaclasses.HighchartsMeta" -> "utility_classes.geojson.GeoJSONBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "utility_classes.geojson.MultiPoint" [URL="#highcharts_maps.utility_classes.geojson.MultiPoint",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a GeoJSON ``MultiPoint`` as a Python object, inheriting from"]; "utility_classes.geojson.GeoJSONBase" -> "utility_classes.geojson.MultiPoint" [arrowsize=0.5,style="setlinewidth(0.5)"]; "geometry.MultiPoint" -> "utility_classes.geojson.MultiPoint" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

check_list_errors(checkFunc, lst)

Validation helper function.

clear() → None.  Remove all items from D.
copy(other=None, overwrite=True, **kwargs)

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

Parameters:

  • other (GeoJSONBase) – 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

errors()[source]

Return validation errors (if any). Implement in each subclass.

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: str | bytes, 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

classmethod from_topojson(as_topojson)

Convert a Topology instance into a GeoJSONBase instance.

Parameters:

as_topojson (Topology) – The TopoJSON object or collection to convert.

Return type:

GeoJSONBase

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

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

classmethod to_instance(ob, default=None, strict=False)

Encode a GeoJSON dict into an GeoJSONBase object.

Note

Assumes the caller knows that the dict should satisfy a GeoJSON type.

Parameters:

  • cls (dict) – dict containing the elements to be encoded into a GeoJSON object.

  • ob (geojson.base.GeoJSON) – GeoJSON object into which to encode the dict provided in cls.

  • default (geojson.base.GeoJSON) – A default instance to append the content of the dict. Defaults to None.

  • strict (bool) – Raise error if unable to coerce particular keys or attributes to a valid GeoJSON structure. Defaults to False.

Returns:

A GeoJSON object with the dict’s elements as its constituents.

Return type:

geojson.base.GeoJSON

Raises:

  • TypeError – If the input dict contains items that are not valid GeoJSON types.

  • UnicodeEncodeError – If the input dict contains items of a type that contain non-ASCII characters.

  • AttributeError – If the input dict contains items that are not valid GeoJSON types.

to_js_literal(filename=None, encoding='utf-8') → 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'.

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

to_topojson() → Topology

Convert the object into a TopoJSON Topology object.

Return type:

Topology

static trim_dict(untrimmed: dict, to_json: bool = False) → 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.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False)

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.

Return type:

iterable

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values

class: LineString

class LineString(**kwargs)[source]

Represents a GeoJSON LineString as a Python object, inheriting from geojson.LineString with additional methods to conform to the HighchartsMeta standard interface.

Class Inheritancedigraph inheritanceb4e6c78eb3 { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "base.GeoJSON" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A class representing a GeoJSON object."]; "geometry.Geometry" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Represents an abstract base class for a WGS84 geometry."]; "base.GeoJSON" -> "geometry.Geometry" [arrowsize=0.5,style="setlinewidth(0.5)"]; "geometry.LineString" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "geometry.MultiPoint" -> "geometry.LineString" [arrowsize=0.5,style="setlinewidth(0.5)"]; "geometry.MultiPoint" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "geometry.Geometry" -> "geometry.MultiPoint" [arrowsize=0.5,style="setlinewidth(0.5)"]; "metaclasses.HighchartsMeta" [URL="../internals.html#highcharts_maps.metaclasses.HighchartsMeta",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Metaclass that is used to define the standard interface exposed for serializable"]; "utility_classes.geojson.GeoJSONBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class used to implement standard methods that can be mixed-in to the"]; "metaclasses.HighchartsMeta" -> "utility_classes.geojson.GeoJSONBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "utility_classes.geojson.LineString" [URL="#highcharts_maps.utility_classes.geojson.LineString",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a GeoJSON ``LineString`` as a Python object, inheriting from"]; "utility_classes.geojson.GeoJSONBase" -> "utility_classes.geojson.LineString" [arrowsize=0.5,style="setlinewidth(0.5)"]; "geometry.LineString" -> "utility_classes.geojson.LineString" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

check_list_errors(checkFunc, lst)

Validation helper function.

clear() → None.  Remove all items from D.
copy(other=None, overwrite=True, **kwargs)

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

Parameters:

  • other (GeoJSONBase) – 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

errors()[source]

Return validation errors (if any). Implement in each subclass.

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: str | bytes, 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

classmethod from_topojson(as_topojson)

Convert a Topology instance into a GeoJSONBase instance.

Parameters:

as_topojson (Topology) – The TopoJSON object or collection to convert.

Return type:

GeoJSONBase

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

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

classmethod to_instance(ob, default=None, strict=False)

Encode a GeoJSON dict into an GeoJSONBase object.

Note

Assumes the caller knows that the dict should satisfy a GeoJSON type.

Parameters:

  • cls (dict) – dict containing the elements to be encoded into a GeoJSON object.

  • ob (geojson.base.GeoJSON) – GeoJSON object into which to encode the dict provided in cls.

  • default (geojson.base.GeoJSON) – A default instance to append the content of the dict. Defaults to None.

  • strict (bool) – Raise error if unable to coerce particular keys or attributes to a valid GeoJSON structure. Defaults to False.

Returns:

A GeoJSON object with the dict’s elements as its constituents.

Return type:

geojson.base.GeoJSON

Raises:

  • TypeError – If the input dict contains items that are not valid GeoJSON types.

  • UnicodeEncodeError – If the input dict contains items of a type that contain non-ASCII characters.

  • AttributeError – If the input dict contains items that are not valid GeoJSON types.

to_js_literal(filename=None, encoding='utf-8') → 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'.

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

to_topojson() → Topology

Convert the object into a TopoJSON Topology object.

Return type:

Topology

static trim_dict(untrimmed: dict, to_json: bool = False) → 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.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False)

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.

Return type:

iterable

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values

class: MultiLineString

class MultiLineString(**kwargs)[source]

Represents a GeoJSON MultiLineString as a Python object, inheriting from geojson.MultiLineString with additional methods to conform to the HighchartsMeta standard interface.

Class Inheritancedigraph inheritancefc5c46d702 { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "base.GeoJSON" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A class representing a GeoJSON object."]; "geometry.Geometry" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Represents an abstract base class for a WGS84 geometry."]; "base.GeoJSON" -> "geometry.Geometry" [arrowsize=0.5,style="setlinewidth(0.5)"]; "geometry.MultiLineString" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "geometry.Geometry" -> "geometry.MultiLineString" [arrowsize=0.5,style="setlinewidth(0.5)"]; "metaclasses.HighchartsMeta" [URL="../internals.html#highcharts_maps.metaclasses.HighchartsMeta",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Metaclass that is used to define the standard interface exposed for serializable"]; "utility_classes.geojson.GeoJSONBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class used to implement standard methods that can be mixed-in to the"]; "metaclasses.HighchartsMeta" -> "utility_classes.geojson.GeoJSONBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "utility_classes.geojson.MultiLineString" [URL="#highcharts_maps.utility_classes.geojson.MultiLineString",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a GeoJSON ``MultiLineString`` as a Python object, inheriting from"]; "utility_classes.geojson.GeoJSONBase" -> "utility_classes.geojson.MultiLineString" [arrowsize=0.5,style="setlinewidth(0.5)"]; "geometry.MultiLineString" -> "utility_classes.geojson.MultiLineString" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

check_list_errors(checkFunc, lst)

Validation helper function.

clear() → None.  Remove all items from D.
copy(other=None, overwrite=True, **kwargs)

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

Parameters:

  • other (GeoJSONBase) – 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

errors()[source]

Return validation errors (if any). Implement in each subclass.

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: str | bytes, 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

classmethod from_topojson(as_topojson)

Convert a Topology instance into a GeoJSONBase instance.

Parameters:

as_topojson (Topology) – The TopoJSON object or collection to convert.

Return type:

GeoJSONBase

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

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

classmethod to_instance(ob, default=None, strict=False)

Encode a GeoJSON dict into an GeoJSONBase object.

Note

Assumes the caller knows that the dict should satisfy a GeoJSON type.

Parameters:

  • cls (dict) – dict containing the elements to be encoded into a GeoJSON object.

  • ob (geojson.base.GeoJSON) – GeoJSON object into which to encode the dict provided in cls.

  • default (geojson.base.GeoJSON) – A default instance to append the content of the dict. Defaults to None.

  • strict (bool) – Raise error if unable to coerce particular keys or attributes to a valid GeoJSON structure. Defaults to False.

Returns:

A GeoJSON object with the dict’s elements as its constituents.

Return type:

geojson.base.GeoJSON

Raises:

  • TypeError – If the input dict contains items that are not valid GeoJSON types.

  • UnicodeEncodeError – If the input dict contains items of a type that contain non-ASCII characters.

  • AttributeError – If the input dict contains items that are not valid GeoJSON types.

to_js_literal(filename=None, encoding='utf-8') → 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'.

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

to_topojson() → Topology

Convert the object into a TopoJSON Topology object.

Return type:

Topology

static trim_dict(untrimmed: dict, to_json: bool = False) → 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.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False)

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.

Return type:

iterable

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values

class: Polygon

class Polygon(**kwargs)[source]

Represents a GeoJSON Polygon as a Python object, inheriting from geojson.Polygon with additional methods to conform to the HighchartsMeta standard interface.

Class Inheritancedigraph inheritance3a3ad24aaa { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "base.GeoJSON" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A class representing a GeoJSON object."]; "geometry.Geometry" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Represents an abstract base class for a WGS84 geometry."]; "base.GeoJSON" -> "geometry.Geometry" [arrowsize=0.5,style="setlinewidth(0.5)"]; "geometry.Polygon" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "geometry.Geometry" -> "geometry.Polygon" [arrowsize=0.5,style="setlinewidth(0.5)"]; "metaclasses.HighchartsMeta" [URL="../internals.html#highcharts_maps.metaclasses.HighchartsMeta",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Metaclass that is used to define the standard interface exposed for serializable"]; "utility_classes.geojson.GeoJSONBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class used to implement standard methods that can be mixed-in to the"]; "metaclasses.HighchartsMeta" -> "utility_classes.geojson.GeoJSONBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "utility_classes.geojson.Polygon" [URL="#highcharts_maps.utility_classes.geojson.Polygon",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a GeoJSON ``Polygon`` as a Python object, inheriting from"]; "utility_classes.geojson.GeoJSONBase" -> "utility_classes.geojson.Polygon" [arrowsize=0.5,style="setlinewidth(0.5)"]; "geometry.Polygon" -> "utility_classes.geojson.Polygon" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

check_list_errors(checkFunc, lst)

Validation helper function.

clear() → None.  Remove all items from D.
copy(other=None, overwrite=True, **kwargs)

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

Parameters:

  • other (GeoJSONBase) – 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

errors()[source]

Return validation errors (if any). Implement in each subclass.

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: str | bytes, 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

classmethod from_topojson(as_topojson)

Convert a Topology instance into a GeoJSONBase instance.

Parameters:

as_topojson (Topology) – The TopoJSON object or collection to convert.

Return type:

GeoJSONBase

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

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

classmethod to_instance(ob, default=None, strict=False)

Encode a GeoJSON dict into an GeoJSONBase object.

Note

Assumes the caller knows that the dict should satisfy a GeoJSON type.

Parameters:

  • cls (dict) – dict containing the elements to be encoded into a GeoJSON object.

  • ob (geojson.base.GeoJSON) – GeoJSON object into which to encode the dict provided in cls.

  • default (geojson.base.GeoJSON) – A default instance to append the content of the dict. Defaults to None.

  • strict (bool) – Raise error if unable to coerce particular keys or attributes to a valid GeoJSON structure. Defaults to False.

Returns:

A GeoJSON object with the dict’s elements as its constituents.

Return type:

geojson.base.GeoJSON

Raises:

  • TypeError – If the input dict contains items that are not valid GeoJSON types.

  • UnicodeEncodeError – If the input dict contains items of a type that contain non-ASCII characters.

  • AttributeError – If the input dict contains items that are not valid GeoJSON types.

to_js_literal(filename=None, encoding='utf-8') → 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'.

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

to_topojson() → Topology

Convert the object into a TopoJSON Topology object.

Return type:

Topology

static trim_dict(untrimmed: dict, to_json: bool = False) → 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.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False)

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.

Return type:

iterable

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values

class: MultiPolygon

class MultiPolygon(**kwargs)[source]

Represents a GeoJSON MultiPolygon as a Python object, inheriting from geojson.MultiPolygon with additional methods to conform to the HighchartsMeta standard interface.

Class Inheritancedigraph inheritance9a17dd9aca { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "base.GeoJSON" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A class representing a GeoJSON object."]; "geometry.Geometry" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Represents an abstract base class for a WGS84 geometry."]; "base.GeoJSON" -> "geometry.Geometry" [arrowsize=0.5,style="setlinewidth(0.5)"]; "geometry.MultiPolygon" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "geometry.Geometry" -> "geometry.MultiPolygon" [arrowsize=0.5,style="setlinewidth(0.5)"]; "metaclasses.HighchartsMeta" [URL="../internals.html#highcharts_maps.metaclasses.HighchartsMeta",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Metaclass that is used to define the standard interface exposed for serializable"]; "utility_classes.geojson.GeoJSONBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class used to implement standard methods that can be mixed-in to the"]; "metaclasses.HighchartsMeta" -> "utility_classes.geojson.GeoJSONBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "utility_classes.geojson.MultiPolygon" [URL="#highcharts_maps.utility_classes.geojson.MultiPolygon",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a GeoJSON ``MultiPolygon`` as a Python object, inheriting from"]; "utility_classes.geojson.GeoJSONBase" -> "utility_classes.geojson.MultiPolygon" [arrowsize=0.5,style="setlinewidth(0.5)"]; "geometry.MultiPolygon" -> "utility_classes.geojson.MultiPolygon" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

check_list_errors(checkFunc, lst)

Validation helper function.

clear() → None.  Remove all items from D.
copy(other=None, overwrite=True, **kwargs)

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

Parameters:

  • other (GeoJSONBase) – 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

errors()[source]

Return validation errors (if any). Implement in each subclass.

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: str | bytes, 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

classmethod from_topojson(as_topojson)

Convert a Topology instance into a GeoJSONBase instance.

Parameters:

as_topojson (Topology) – The TopoJSON object or collection to convert.

Return type:

GeoJSONBase

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

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

classmethod to_instance(ob, default=None, strict=False)

Encode a GeoJSON dict into an GeoJSONBase object.

Note

Assumes the caller knows that the dict should satisfy a GeoJSON type.

Parameters:

  • cls (dict) – dict containing the elements to be encoded into a GeoJSON object.

  • ob (geojson.base.GeoJSON) – GeoJSON object into which to encode the dict provided in cls.

  • default (geojson.base.GeoJSON) – A default instance to append the content of the dict. Defaults to None.

  • strict (bool) – Raise error if unable to coerce particular keys or attributes to a valid GeoJSON structure. Defaults to False.

Returns:

A GeoJSON object with the dict’s elements as its constituents.

Return type:

geojson.base.GeoJSON

Raises:

  • TypeError – If the input dict contains items that are not valid GeoJSON types.

  • UnicodeEncodeError – If the input dict contains items of a type that contain non-ASCII characters.

  • AttributeError – If the input dict contains items that are not valid GeoJSON types.

to_js_literal(filename=None, encoding='utf-8') → 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'.

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

to_topojson() → Topology

Convert the object into a TopoJSON Topology object.

Return type:

Topology

static trim_dict(untrimmed: dict, to_json: bool = False) → 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.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False)

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.

Return type:

iterable

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values

class: GeometryCollection

class GeometryCollection(**kwargs)[source]

Represents a GeoJSON GeometryCollection as a Python object, inheriting from geojson.GeometryCollection with additional methods to conform to the HighchartsMeta standard interface.

Class Inheritancedigraph inheritance1ed43c3b9e { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "base.GeoJSON" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A class representing a GeoJSON object."]; "geometry.GeometryCollection" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Represents an abstract base class for collections of WGS84 geometries."]; "base.GeoJSON" -> "geometry.GeometryCollection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "metaclasses.HighchartsMeta" [URL="../internals.html#highcharts_maps.metaclasses.HighchartsMeta",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Metaclass that is used to define the standard interface exposed for serializable"]; "utility_classes.geojson.GeoJSONBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class used to implement standard methods that can be mixed-in to the"]; "metaclasses.HighchartsMeta" -> "utility_classes.geojson.GeoJSONBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "utility_classes.geojson.GeometryCollection" [URL="#highcharts_maps.utility_classes.geojson.GeometryCollection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a GeoJSON ``GeometryCollection`` as a Python object, inheriting from"]; "utility_classes.geojson.GeoJSONBase" -> "utility_classes.geojson.GeometryCollection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "geometry.GeometryCollection" -> "utility_classes.geojson.GeometryCollection" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

check_list_errors(checkFunc, lst)

Validation helper function.

clear() → None.  Remove all items from D.
copy(other=None, overwrite=True, **kwargs)

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

Parameters:

  • other (GeoJSONBase) – 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

errors()[source]

Return validation errors (if any). Implement in each subclass.

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: str | bytes, 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

classmethod from_topojson(as_topojson)

Convert a Topology instance into a GeoJSONBase instance.

Parameters:

as_topojson (Topology) – The TopoJSON object or collection to convert.

Return type:

GeoJSONBase

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

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

classmethod to_instance(ob, default=None, strict=False)

Encode a GeoJSON dict into an GeoJSONBase object.

Note

Assumes the caller knows that the dict should satisfy a GeoJSON type.

Parameters:

  • cls (dict) – dict containing the elements to be encoded into a GeoJSON object.

  • ob (geojson.base.GeoJSON) – GeoJSON object into which to encode the dict provided in cls.

  • default (geojson.base.GeoJSON) – A default instance to append the content of the dict. Defaults to None.

  • strict (bool) – Raise error if unable to coerce particular keys or attributes to a valid GeoJSON structure. Defaults to False.

Returns:

A GeoJSON object with the dict’s elements as its constituents.

Return type:

geojson.base.GeoJSON

Raises:

  • TypeError – If the input dict contains items that are not valid GeoJSON types.

  • UnicodeEncodeError – If the input dict contains items of a type that contain non-ASCII characters.

  • AttributeError – If the input dict contains items that are not valid GeoJSON types.

to_js_literal(filename=None, encoding='utf-8') → 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'.

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

to_topojson() → Topology

Convert the object into a TopoJSON Topology object.

Return type:

Topology

static trim_dict(untrimmed: dict, to_json: bool = False) → 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.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False)

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.

Return type:

iterable

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values

class: Feature

class Feature(**kwargs)[source]

Represents a GeoJSON Feature as a Python object, inheriting from geojson.Feature with additional methods to conform to the HighchartsMeta standard interface.

Class Inheritancedigraph inheritance81a58794db { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "base.GeoJSON" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A class representing a GeoJSON object."]; "feature.Feature" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Represents a WGS84 GIS feature."]; "base.GeoJSON" -> "feature.Feature" [arrowsize=0.5,style="setlinewidth(0.5)"]; "metaclasses.HighchartsMeta" [URL="../internals.html#highcharts_maps.metaclasses.HighchartsMeta",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Metaclass that is used to define the standard interface exposed for serializable"]; "utility_classes.geojson.Feature" [URL="#highcharts_maps.utility_classes.geojson.Feature",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a GeoJSON ``Feature`` as a Python object, inheriting from"]; "utility_classes.geojson.GeoJSONBase" -> "utility_classes.geojson.Feature" [arrowsize=0.5,style="setlinewidth(0.5)"]; "feature.Feature" -> "utility_classes.geojson.Feature" [arrowsize=0.5,style="setlinewidth(0.5)"]; "utility_classes.geojson.GeoJSONBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class used to implement standard methods that can be mixed-in to the"]; "metaclasses.HighchartsMeta" -> "utility_classes.geojson.GeoJSONBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

check_list_errors(checkFunc, lst)

Validation helper function.

clear() → None.  Remove all items from D.
copy(other=None, overwrite=True, **kwargs)

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

Parameters:

  • other (GeoJSONBase) – 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

errors()[source]

Return validation errors (if any). Implement in each subclass.

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: str | bytes, 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

classmethod from_topojson(as_topojson)

Convert a Topology instance into a GeoJSONBase instance.

Parameters:

as_topojson (Topology) – The TopoJSON object or collection to convert.

Return type:

GeoJSONBase

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

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

classmethod to_instance(ob, default=None, strict=False)

Encode a GeoJSON dict into an GeoJSONBase object.

Note

Assumes the caller knows that the dict should satisfy a GeoJSON type.

Parameters:

  • cls (dict) – dict containing the elements to be encoded into a GeoJSON object.

  • ob (geojson.base.GeoJSON) – GeoJSON object into which to encode the dict provided in cls.

  • default (geojson.base.GeoJSON) – A default instance to append the content of the dict. Defaults to None.

  • strict (bool) – Raise error if unable to coerce particular keys or attributes to a valid GeoJSON structure. Defaults to False.

Returns:

A GeoJSON object with the dict’s elements as its constituents.

Return type:

geojson.base.GeoJSON

Raises:

  • TypeError – If the input dict contains items that are not valid GeoJSON types.

  • UnicodeEncodeError – If the input dict contains items of a type that contain non-ASCII characters.

  • AttributeError – If the input dict contains items that are not valid GeoJSON types.

to_js_literal(filename=None, encoding='utf-8') → 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'.

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

to_topojson() → Topology

Convert the object into a TopoJSON Topology object.

Return type:

Topology

static trim_dict(untrimmed: dict, to_json: bool = False) → 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.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False)

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.

Return type:

iterable

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values

class: FeatureCollection

class FeatureCollection(**kwargs)[source]

Represents a GeoJSON FeatureCollection as a Python object, inheriting from geojson.FeatureCollection with additional methods to conform to the HighchartsMeta standard interface.

Class Inheritancedigraph inheritancee2dd834534 { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "base.GeoJSON" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="A class representing a GeoJSON object."]; "feature.FeatureCollection" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Represents a FeatureCollection, a set of multiple Feature objects."]; "base.GeoJSON" -> "feature.FeatureCollection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "metaclasses.HighchartsMeta" [URL="../internals.html#highcharts_maps.metaclasses.HighchartsMeta",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Metaclass that is used to define the standard interface exposed for serializable"]; "utility_classes.geojson.FeatureCollection" [URL="#highcharts_maps.utility_classes.geojson.FeatureCollection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Represents a GeoJSON ``FeatureCollection`` as a Python object, inheriting from"]; "utility_classes.geojson.GeoJSONBase" -> "utility_classes.geojson.FeatureCollection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "feature.FeatureCollection" -> "utility_classes.geojson.FeatureCollection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "utility_classes.geojson.GeoJSONBase" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class used to implement standard methods that can be mixed-in to the"]; "metaclasses.HighchartsMeta" -> "utility_classes.geojson.GeoJSONBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

check_list_errors(checkFunc, lst)

Validation helper function.

clear() → None.  Remove all items from D.
copy(other=None, overwrite=True, **kwargs)

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

Parameters:

  • other (GeoJSONBase) – 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

errors()[source]

Return validation errors (if any). Implement in each subclass.

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: str | bytes, 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

classmethod from_topojson(as_topojson)

Convert a Topology instance into a GeoJSONBase instance.

Parameters:

as_topojson (Topology) – The TopoJSON object or collection to convert.

Return type:

GeoJSONBase

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

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

classmethod to_instance(ob, default=None, strict=False)

Encode a GeoJSON dict into an GeoJSONBase object.

Note

Assumes the caller knows that the dict should satisfy a GeoJSON type.

Parameters:

  • cls (dict) – dict containing the elements to be encoded into a GeoJSON object.

  • ob (geojson.base.GeoJSON) – GeoJSON object into which to encode the dict provided in cls.

  • default (geojson.base.GeoJSON) – A default instance to append the content of the dict. Defaults to None.

  • strict (bool) – Raise error if unable to coerce particular keys or attributes to a valid GeoJSON structure. Defaults to False.

Returns:

A GeoJSON object with the dict’s elements as its constituents.

Return type:

geojson.base.GeoJSON

Raises:

  • TypeError – If the input dict contains items that are not valid GeoJSON types.

  • UnicodeEncodeError – If the input dict contains items of a type that contain non-ASCII characters.

  • AttributeError – If the input dict contains items that are not valid GeoJSON types.

to_js_literal(filename=None, encoding='utf-8') → 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'.

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

to_topojson() → Topology

Convert the object into a TopoJSON Topology object.

Return type:

Topology

static trim_dict(untrimmed: dict, to_json: bool = False) → 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.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False)

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.

Return type:

iterable

update([E, ]**F) → None.  Update D from dict/iterable E and F.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values