.defs

---

class: MarkerDefinition

class MarkerDefinition(dict=None, /, **kwargs)

Special dict class used to construct a JavaScript object literal map. Each key represents a key or node within that map, while the value for that key is an ASTNode.

Keys are validated to be valid variable names, while each value is validated to be an ASTNode.

Class Inheritance

digraph inheritance9952869fe4 { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "UserDict" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "abc.MutableMapping" -> "UserDict" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.Collection" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "abc.Sized" -> "abc.Collection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.Iterable" -> "abc.Collection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.Container" -> "abc.Collection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.Container" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "abc.Iterable" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "abc.Mapping" [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 Mapping is a generic container for associating key/value"]; "abc.Collection" -> "abc.Mapping" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.MutableMapping" [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 MutableMapping is a generic container for associating"]; "abc.Mapping" -> "abc.MutableMapping" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.Sized" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "metaclasses.JavaScriptDict" [URL="../internals.html#highcharts_stock.metaclasses.JavaScriptDict",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="Special :class:`dict <python:dict>` class which constructs a JavaScript"]; "UserDict" -> "metaclasses.JavaScriptDict" [arrowsize=0.5,style="setlinewidth(0.5)"]; "options.defs.MarkerDefinition" [URL="#highcharts_stock.options.defs.MarkerDefinition",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="Special :class:`dict <python:dict>` class used to construct a JavaScript object"]; "utility_classes.ast.ASTMap" -> "options.defs.MarkerDefinition" [arrowsize=0.5,style="setlinewidth(0.5)"]; "utility_classes.ast.ASTMap" [URL="../utility_classes/ast.html#highcharts_stock.utility_classes.ast.ASTMap",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="Special :class:`dict <python:dict>` class used to construct a JavaScript object"]; "metaclasses.JavaScriptDict" -> "utility_classes.ast.ASTMap" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

clear() → None.  Remove all items from D.

classmethod from_dict(as_dict)

Construct an instance of the class from a dict object.

Parameters:

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

Returns:

A Python object representation of as_dict.

Return type:

JavaScriptDict

classmethod from_json(as_json)

Construct an instance of the class from a JSON string.

Parameters:

as_json (str or bytes) – The JSON string for the object.

Returns:

A Python objcet representation of as_json.

Return type:

HighchartsMeta

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.

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 key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

to_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') → 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 'utf8'.

Returns:

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

Return type:

str or bytes

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

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

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

---

class: MarkerASTNode

class MarkerASTNode(**kwargs)

ASTNode that enforces a Marker Attribute set..

Class Inheritance

digraph inheritanced3909e57e5 { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "metaclasses.HighchartsMeta" [URL="../internals.html#highcharts_stock.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"]; "options.defs.MarkerASTNode" [URL="#highcharts_stock.options.defs.MarkerASTNode",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=":class:`ASTNode` that enforces a Marker Attribute set.."]; "utility_classes.ast.ASTNode" -> "options.defs.MarkerASTNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; "utility_classes.ast.ASTNode" [URL="../utility_classes/ast.html#highcharts_stock.utility_classes.ast.ASTNode",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="Generic representation of an AST node."]; "metaclasses.HighchartsMeta" -> "utility_classes.ast.ASTNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

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

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') → 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

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

property attributes: MarkerAttributeObject | None

Map of attributes that are used to describe the node.

Basically corresponds to a dict, where keys have to generally conform to standard variable-naming conventions and values are basic literals (string, array, numer, boolean, dict, etc.)

Return type:

MarkerAttributeObject or None

property children: List[ASTNode] | None

Collection of ASTNode instances that should be considered children of this node.

Return type:

list of ASTNode objects

property tag_name: str | None

The name given to the SVG tag.

Return type:

str or None

property text_content: str | None

Text content that populates the tag, if applicable.

Return type:

str or None

---

class: MarkerAttributeObject

class MarkerAttributeObject(*args, **kwargs)

Special subclass of the SVGAttributeMap which provides properties for annotation markers.

While this class also is a special subclass of dict, it also propagates values from certain named properties to corresponding key entries in the underling dict’s data map.

Class Inheritance

digraph inheritance37411d7a76 { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "UserDict" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "abc.MutableMapping" -> "UserDict" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.Collection" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "abc.Sized" -> "abc.Collection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.Iterable" -> "abc.Collection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.Container" -> "abc.Collection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.Container" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "abc.Iterable" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "abc.Mapping" [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 Mapping is a generic container for associating key/value"]; "abc.Collection" -> "abc.Mapping" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.MutableMapping" [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 MutableMapping is a generic container for associating"]; "abc.Mapping" -> "abc.MutableMapping" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.Sized" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "metaclasses.JavaScriptDict" [URL="../internals.html#highcharts_stock.metaclasses.JavaScriptDict",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="Special :class:`dict <python:dict>` class which constructs a JavaScript"]; "UserDict" -> "metaclasses.JavaScriptDict" [arrowsize=0.5,style="setlinewidth(0.5)"]; "options.defs.MarkerAttributeObject" [URL="#highcharts_stock.options.defs.MarkerAttributeObject",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="Special subclass of the :class:`SVGAttributeMap` which provides properties for"]; "utility_classes.ast.AttributeObject" -> "options.defs.MarkerAttributeObject" [arrowsize=0.5,style="setlinewidth(0.5)"]; "utility_classes.ast.AttributeObject" [URL="../utility_classes/ast.html#highcharts_stock.utility_classes.ast.AttributeObject",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="Special :class:`dict <python:dict>` class used to construct an arbitrary set of"]; "metaclasses.JavaScriptDict" -> "utility_classes.ast.AttributeObject" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

clear() → None.  Remove all items from D.

classmethod from_dict(as_dict)

Construct an instance of the class from a dict object.

Parameters:

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

Returns:

A Python object representation of as_dict.

Return type:

JavaScriptDict

classmethod from_json(as_json)

Construct an instance of the class from a JSON string.

Parameters:

as_json (str or bytes) – The JSON string for the object.

Returns:

A Python objcet representation of as_json.

Return type:

HighchartsMeta

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.

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 key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D

to_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') → 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 'utf8'.

Returns:

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

Return type:

str or bytes

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

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

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

property id: str | None

The identifier applied to the marker.

Return type:

str or None

property marker_height: int | None

The height of the marker, expressed in pixels.

Return type:

str or None

property marker_width: int | None

The width of the marker, expressed in pixels.

Return type:

str or None

property ref_x: int | None

TBD

Todo

Determine what purpose the refX and refY properties serve.

Return type:

str or None

property ref_y: int | None

TBD

Todo

Determine what purpose the refX and refY properties serve.

Return type:

str or None