`.gantt`

class: `GanttData`

class GanttData(**kwargs)[source]

Data point used in a GanttSeries.

Class Inheritance

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_array(value)[source]

Creates a collection of data point instances, parsing the contents of value as an array (iterable). This method is specifically used to parse data that is input to Highcharts for Python without property names, in an array-organized structure as described in the Highcharts JS documentation.

See also

The specific structure of the expected array is highly dependent on the type of data point that the series needs, which itself is dependent on the series type itself.

Please review the detailed series documentation for series type-specific details of relevant array structures.

Note

An example of how this works for a simple LineSeries (which uses CartesianData data points) would be:

my_series = LineSeries()

# A simple array of numerical values which correspond to the Y value of the
# data point
my_series.data = [0, 5, 3, 5]

# An array containing 2-member arrays (corresponding to the X and Y values
# of the data point)
my_series.data = [
    [0, 0],
    [1, 5],
    [2, 3],
    [3, 5]
]

# An array of dict with named values
my_series.data = [
  {
      'x': 0,
      'y': 0,
      'name': 'Point1',
      'color': '#00FF00'
  },
  {
      'x': 1,
      'y': 5,
      'name': 'Point2',
      'color': '#CCC'
  },
  {
      'x': 2,
      'y': 3,
      'name': 'Point3',
      'color': '#999'
  },
  {
      'x': 3,
      'y': 5,
      'name': 'Point4',
      'color': '#000'
  }
]

Parameters:

value (iterable) –

The value that should contain the data which will be converted into data point instances.

Note

If value is not an iterable, it will be converted into an iterable to be further de-serialized correctly.

Returns:

Collection of data point instances (descended from DataBase)

Return type:

list of DataBase descendant instances

classmethod from_asana(task, use_html_description=True, connection_callback=None, connection_kwargs=None)[source]

Create a GanttData instance from an Asana task dict representation.

Parameters:

task (dict) – An Asana task object.
use_html_description (bool) – If True, will use the Asana task’s HTML notes in the data point’s .description field. If False, will use the non-HTML notes. Defaults to True.
connection_callback (Callable or None) –
A custom Python function or method which accepts two keyword arguments: connection_target (which expects the dependency dict object from the Asana task), and task (which expects the originating Asana task dict object). The function should return a DataConnection instance. Defaults to None

Tip

The connection_callback argument is useful if you want to customize the connection styling based on properties included in the Asana task.
connection_kwargs (dict or None) – Set of keyword arugments to supply to the DataConnection constructor, besides the .to property which is derived from the task. Defaults to None

Returns:

A GanttData instance

Return type:

GanttData

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_jira(issue, connection_kwargs=None, connection_callback=None)[source]

Create a GanttData instance from a JIRA Issue representation.

Parameters:

issue (Issue) – A JIRA Issue instance
connection_callback (Callable or None) –
A custom Python function or method which accepts two keyword arguments: connection_target (which expects the dependency Issue instance), and issue (which expects the originating Issue object). The function should return a DataConnection instance. Defaults to None

Tip

The connection_callback argument is useful if you want to customize the connection styling based on properties included in the Monday.com task.
connection_kwargs (dict or None) – Set of keyword arugments to supply to the DataConnection constructor, besides the .to property which is derived from the task. Defaults to None

Returns:

A GanttData instance

Return type:

GanttData

Raises:

HighchartsValueError – if both template and property_column_map are None or connection_callback is not callable
MondayTemplateError – if template is not None, but is not supported

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

classmethod from_monday(task, template=None, property_column_map=None, connection_kwargs=None, connection_callback=None)[source]

Create a GanttData instance from a Monday.com task dict representation.

Parameters:

task (dict) – A Monday.com task object.
connection_callback (Callable or None) –
A custom Python function or method which accepts two keyword arguments: connection_target (which expects the dependency dict object from the Monday.com task), and task (which expects the originating Monday.com task dict object). The function should return a DataConnection instance. Defaults to None

Tip

The connection_callback argument is useful if you want to customize the connection styling based on properties included in the Monday.com task.
connection_kwargs (dict or None) – Set of keyword arugments to supply to the DataConnection constructor, besides the .to property which is derived from the task. Defaults to None

Returns:

A GanttData instance

Return type:

GanttData

Raises:

HighchartsValueError – if both template and property_column_map are None or connection_callback is not callable
MondayTemplateError – if template is not None, but is not supported

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 accessibility: DataPointAccessibility | None

Accessibility options for a data point.

Return type:: DataPointAccessibility or None

property class_name: str | None

The additional CSS class name to apply to the data point’s graphical elements.

Return type:: str or None

property collapsed: bool | None

If True, collapses the grid node belonging to this data point. Defaults to False.

Note

Respected in axes of type 'treegrid'.

Return type:: bool or None

property color: str | Gradient | Pattern | None

The color of the individual data point. 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 point, so its graphic representations are given the class name highcharts-color-{n}. Defaults to None.

Return type:: int or None

property completed: int | float | Decimal | ProgressIndicator | None

Configuration of a progress indicator for the data point. Accepts either a numeric value between 0 (no progress) to 1 (fully complete) or a ProgressIndicator object. Defaults to None.

Note

If supplied as a number, will fill in the completed portion with a darkened version of the main color.

Return type:: numeric or ProgressIndicator or None

property custom: JavaScriptDict | None

A reserved subspace to store options and values for customized functionality.

Here you can add additional data for your own event callbacks and formatter callbacks.

Return type:: dict or None

property dependency: DataConnection | str | List[DataConnection | str] | None

Indicates data points that this data point depends on.

Accepts either a str which corresponds to the ID of a different data point, a DataConnection object configuring the connection, an array of either, or None. Defaults to None

Return type:: str or DataConnection or an iterable of str or DataConnection or None

property description: str | None

A description of the data point to add to the screen reader information about the data point.

Return type:: str

property end: datetime | None

The end time of the data point (task).

Note

While Highcharts Gantt for Python represents this value as a datetime, it actually represents a POSIX timestamp (number of milliseconds since January 1, 1970). If you supply a numerical value, it will be converted to a datetime, and when serialized back to JavaScript object literal notation it will be converted back to a numerical value.

Return type:: datetime or None

property events: PointEvents | None

Event handlers for individual data points.

Return type:: PointEvents or None

property id: str | None

The id of the data point. Defaults to None.

Note

This can be used (in JavaScript) after render time to get a pointer to the point object through chart.get().

Return type:: str or None

property label_rank: int | float | Decimal | None

The rank for this point’s data label in the case of collision. Defaults to None.

Note

If two data labels are about to overlap, the data label for the point with the highest label_rank will be shown.

Return type:: numeric or None

property milestone: bool | None

If True, indicates that this task (data point) is a milestone, which means that only the .start property is taken into consideration and the .end property is ignored. Defaults to None, which behaves as False.

Return type:: bool or None

property name: str | None

The name to display for the point in data labels, tooltips, in legends, etc. Defaults to None.

Return type:: str or None

property parent: str | None

The ID of the parent task (data point) in the Gantt series. Defaults to None.

Return type:: str or None

property selected: bool | None

If True, indicates that the data point is initially selected. Defaults to None, which behaves as False.

Return type:: bool or None

property start: datetime | None

The start time of the data point (task).

Note

While Highcharts Gantt for Python represents this value as a datetime, it actually represents a POSIX timestamp (number of milliseconds since January 1, 1970). If you supply a numerical value, it will be converted to a datetime, and when serialized back to JavaScript object literal notation it will be converted back to a numerical value.

Return type:: datetime or None

property y: int | float | Decimal | None

The Y-axis value of the task (data point).

Return type:: numerical or None

class: `ProgressIndicator`

class ProgressIndicator(**kwargs)[source]

Object representing the progress completed within a data point.

Class Inheritance

Inheritance diagram of ProgressIndicator

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 amount: int | float | Decimal | None

The amount completed in the progress indicator, ranging from 0 (not started) to 1 (completed). Defaults to None, which behaves as 0.

Return type:: numeric or None

property fill: str | Gradient | Pattern | None

Fill color to apply to the completion portion. Defaults to None, which will apply a darkened variant of the data point’s color.

Return type:: None, Gradient, or Pattern

.gantt

class: GanttData

class: ProgressIndicator

`.gantt`

class: `GanttData`

class: `ProgressIndicator`