.nodes

---

class: NodeOptions

class NodeOptions(**kwargs)

Configuration of options for nodes in an Arc Diagram that are associated with a specific ArcDiagramSeries by the ArcDiagramSeries.id().

Class Inheritance

digraph inheritanceaa04c85180 { 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"]; "utility_classes.nodes.NodeOptions" [URL="#highcharts_stock.utility_classes.nodes.NodeOptions",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="Configuration of options for nodes in an Arc Diagram that are associated with a"]; "metaclasses.HighchartsMeta" -> "utility_classes.nodes.NodeOptions" [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 color: str | Gradient | Pattern | None

The color of the auto-generated node. Defaults to None.

Return type:

None, Gradient, Pattern, or str

property color_index: int | None

When operating in styled mode, a specific color index to use for the auto-generated node. Defaults to None.

Return type:

int or None

property data_labels: DataLabel | None

Options for the node’s data label.

Return type:

DataLabel, list of DataLabel, or None

property id: str | None

The id of the auto-generated node, refering to the from or to setting of the link. Defaults to None.

Return type:

str or None

property name: str | None

The name to display for the node in data labels and tooltips. Defaults to None.

Hint

Use this when the name is different from the NodeOptions.id(). Where the id must be unique for each node, this is not necessary for the name.

Return type:

str or None

property offset_horizontal: str | int | float | Decimal | None

The horizontal offset of a node, expressed in either pixels or as a percentage of the node size. Defaults to None.

Hint

Positive values shift the node right, negative shift it left.

Return type:

numeric or str or None

property offset_vertical: str | int | float | Decimal | None

The vertical offset of a node, expressed in either pixels or as a percentage of the node size. Defaults to None.

Hint

Positive values shift the node down, negative shift it up.

Return type:

numeric or str or None

---

class: DependencyWheelNodeOptions

class DependencyWheelNodeOptions(**kwargs)

Variant of NodeOptions for use in DependencyWheelSeries.

Class Inheritance

digraph inheritance719b01dcf1 { 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"]; "utility_classes.nodes.DependencyWheelNodeOptions" [URL="#highcharts_stock.utility_classes.nodes.DependencyWheelNodeOptions",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="Variant of :class:`NodeOptions` for use in :class:`DependencyWheelSeries`."]; "utility_classes.nodes.NodeOptions" -> "utility_classes.nodes.DependencyWheelNodeOptions" [arrowsize=0.5,style="setlinewidth(0.5)"]; "utility_classes.nodes.NodeOptions" [URL="#highcharts_stock.utility_classes.nodes.NodeOptions",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="Configuration of options for nodes in an Arc Diagram that are associated with a"]; "metaclasses.HighchartsMeta" -> "utility_classes.nodes.NodeOptions" [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 color: str | Gradient | Pattern | None

The color of the auto-generated node. Defaults to None.

Return type:

None, Gradient, Pattern, or str

property color_index: int | None

When operating in styled mode, a specific color index to use for the auto-generated node. Defaults to None.

Return type:

int or None

property column: int | None

An optional column index of where to place the node. Defaults to None, which places it next to the preceding node.

Warning

This option name is counter-intuitive in inverted charts, like for example an organization chart rendered top-down. In this case the “columns” are rendered horizontally, more like “rows”.

Return type:

int or None

property data_labels: NodeDataLabel | None

Options for the node’s data label.

Return type:

NodeDataLabel or None

property id: str | None

The id of the auto-generated node, refering to the from or to setting of the link. Defaults to None.

Return type:

str or None

property level: int | None

An optional level index of where to place the node. Defaults to None, which places it next to the preceding node.

Return type:

int or None

property name: str | None

The name to display for the node in data labels and tooltips. Defaults to None.

Hint

Use this when the name is different from the NodeOptions.id(). Where the id must be unique for each node, this is not necessary for the name.

Return type:

str or None

property offset_horizontal: str | int | float | Decimal | None

The horizontal offset of a node, expressed in either pixels or as a percentage of the node size. Defaults to None.

Hint

Positive values shift the node right, negative shift it left.

Return type:

numeric or str or None

property offset_vertical: str | int | float | Decimal | None

The vertical offset of a node, expressed in either pixels or as a percentage of the node size. Defaults to None.

Hint

Positive values shift the node down, negative shift it up.

Return type:

numeric or str or None

---

class: OrganizationNodeOptions

class OrganizationNodeOptions(**kwargs)

Variant of NodeOptions for use in OrganizationSeries.

Class Inheritance

digraph inheritance23441cc22f { 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"]; "utility_classes.nodes.DependencyWheelNodeOptions" [URL="#highcharts_stock.utility_classes.nodes.DependencyWheelNodeOptions",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="Variant of :class:`NodeOptions` for use in :class:`DependencyWheelSeries`."]; "utility_classes.nodes.NodeOptions" -> "utility_classes.nodes.DependencyWheelNodeOptions" [arrowsize=0.5,style="setlinewidth(0.5)"]; "utility_classes.nodes.NodeOptions" [URL="#highcharts_stock.utility_classes.nodes.NodeOptions",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="Configuration of options for nodes in an Arc Diagram that are associated with a"]; "metaclasses.HighchartsMeta" -> "utility_classes.nodes.NodeOptions" [arrowsize=0.5,style="setlinewidth(0.5)"]; "utility_classes.nodes.OrganizationNodeOptions" [URL="#highcharts_stock.utility_classes.nodes.OrganizationNodeOptions",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="Variant of :class:`NodeOptions` for use in :class:`OrganizationSeries`."]; "utility_classes.nodes.DependencyWheelNodeOptions" -> "utility_classes.nodes.OrganizationNodeOptions" [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 color: str | Gradient | Pattern | None

The color of the auto-generated node. Defaults to None.

Return type:

None, Gradient, Pattern, or str

property color_index: int | None

When operating in styled mode, a specific color index to use for the auto-generated node. Defaults to None.

Return type:

int or None

property column: int | None

An optional column index of where to place the node. Defaults to None, which places it next to the preceding node.

Warning

This option name is counter-intuitive in inverted charts, like for example an organization chart rendered top-down. In this case the “columns” are rendered horizontally, more like “rows”.

Return type:

int or None

property data_labels: NodeDataLabel | None

Options for the node’s data label.

Return type:

NodeDataLabel or None

property id: str | None

The id of the auto-generated node, refering to the from or to setting of the link. Defaults to None.

Return type:

str or None

property image: str | None

The URL of an image for the node card, which will be inserted by the default DataLabel.node_formatter(). Defaults to None.

Return type:

str or None

property layout: str | None

The layout for the node’s children. Defaults to None, which behaves as 'normal'.

Accepts:

• 'normal' - renders children spaced evenly below the node

• 'hanging' - renders children condensed in a vertical hanging fashion below the node, allowing for tighter packing of nodes in the resulting diagram

Note

Unless explicitly overridden, nodes whose parent use a 'hanging' layout will also apply a 'hanging' layout.

Return type:

str or None

property level: int | None

An optional level index of where to place the node. Defaults to None, which places it next to the preceding node.

Return type:

int or None

property name: str | None

The name to display for the node in data labels and tooltips. Defaults to None.

Hint

Use this when the name is different from the NodeOptions.id(). Where the id must be unique for each node, this is not necessary for the name.

Return type:

str or None

property offset_horizontal: str | int | float | Decimal | None

The horizontal offset of a node, expressed in either pixels or as a percentage of the node size. Defaults to None.

Hint

Positive values shift the node right, negative shift it left.

Return type:

numeric or str or None

property offset_vertical: str | int | float | Decimal | None

The vertical offset of a node, expressed in either pixels or as a percentage of the node size. Defaults to None.

Hint

Positive values shift the node down, negative shift it up.

Return type:

numeric or str or None

property title: str | None

The job title for the node card. Defaults to None.

Note

Will be inserted by the default DataLabel.node_formatter().

Return type:

str or None