Source code for highcharts_core.options.series.heatmap

from typing import Optional, List

from highcharts_core.options.series.base import SeriesBase
from highcharts_core.options.series.data.cartesian import CartesianValueData, CartesianValueDataCollection
from highcharts_core.options.plot_options.heatmap import HeatmapOptions, TilemapOptions
from highcharts_core.utility_functions import mro__to_untrimmed_dict, is_ndarray


[docs]class HeatmapSeries(SeriesBase, HeatmapOptions): """Options to configure to a Heatmap series. A heatmap is a graphical representation of data where the individual values contained in a matrix are represented as colors. .. warning:: Heatmaps require that ``modules/heatmap`` is loaded client-side. .. figure:: ../../../_static/heatmap-example.png :alt: Heatmap Example Chart :align: center """ def __init__(self, **kwargs): super().__init__(**kwargs) @classmethod def _data_collection_class(cls): """Returns the class object used for the data collection. :rtype: :class:`DataPointCollection <highcharts_core.options.series.data.collections.DataPointCollection>` descendent """ return CartesianValueDataCollection @classmethod def _data_point_class(cls): """Returns the class object used for individual data points. :rtype: :class:`DataBase <highcharts_core.options.series.data.base.DataBase>` descendent """ return CartesianValueData @property def data(self) -> Optional[List[CartesianValueData] | CartesianValueDataCollection]: """Collection of data that represents the series. Defaults to :obj:`None <python:None>`. While the series type returns a collection of :class:`CartesianValueData` instances, it accepts as input three different types of data: .. tabs:: .. tab:: 2D Collection .. code-block:: series = HeatmapSeries() series.data = [ [0, 2], [5, 1], [3, 7], [5, 1] ] A two-dimensional collection of numerical values, where the dimensions correspond to the ``y`` and ``value`` values, respectively. This structure automatically infers the ``x`` value, such that if :meth:`HeatmapSeries.point_start` is :obj:`None <python:None>`, ``x`` values will begin at ``0``. Otherwise, they will start at ``point_start``. If :meth:`HeatmapSeries.point_interval` is :obj:`None <python:None>`, ``x`` values will be incremented by ``1``. Otherwise, they will be incremented by the value of ``point_interval``. .. tab:: 3D Collection .. code-block:: series = HeatmapSeries() # Category X-axis series.data = [ ['Category A', 0, 2], ['Category B', 5, 1], ['Category C', 3, 7], ['Category D', 5, 1] ] # Numerical X-axis series.data = [ [9, 0, 2], [1, 5, 1], [2, 3, 7], [7, 5, 1] ] A three-dimensional collection of values. Each member of the collection will be interpreted as an ``x``, ``y``, and ``value`` value respectively. The ``x`` value can be a :class:`str <python:str>`, :class:`date <python:datetime.date>`, :class:`datetime <python:datetime.datetime>`, or numeric value. .. note:: If the ``x`` value is a :class:`str <python:str>`, it will be interpreted as the name of the data point. .. tab:: Object Collection A one-dimensional collection of :class:`CartesianValueData` objects. :rtype: :class:`list <python:list>` of :class:`CartesianValueData` or :class:`CartesianValueDataCollection` or :obj:`None <python:None>` """ return self._data @data.setter def data(self, value): if not is_ndarray(value) and not value: self._data = None else: self._data = CartesianValueData.from_array(value) @classmethod def _get_kwargs_from_dict(cls, as_dict): kwargs = { 'accessibility': as_dict.get('accessibility', None), 'allow_point_select': as_dict.get('allowPointSelect', None), 'animation': as_dict.get('animation', None), 'class_name': as_dict.get('className', None), 'clip': as_dict.get('clip', None), 'color': as_dict.get('color', None), 'cursor': as_dict.get('cursor', None), 'custom': as_dict.get('custom', None), 'dash_style': as_dict.get('dashStyle', None), 'data_labels': as_dict.get('dataLabels', None), 'description': as_dict.get('description', None), 'enable_mouse_tracking': as_dict.get('enableMouseTracking', None), 'events': as_dict.get('events', None), 'include_in_data_export': as_dict.get('includeInDataExport', None), 'keys': as_dict.get('keys', None), 'label': as_dict.get('label', None), 'legend_symbol': as_dict.get('legendSymbol', None), 'linked_to': as_dict.get('linkedTo', None), 'marker': as_dict.get('marker', None), 'on_point': as_dict.get('onPoint', None), 'opacity': as_dict.get('opacity', None), 'point': as_dict.get('point', None), 'point_description_formatter': as_dict.get('pointDescriptionFormatter', None), 'selected': as_dict.get('selected', None), 'show_checkbox': as_dict.get('showCheckbox', None), 'show_in_legend': as_dict.get('showInLegend', None), 'skip_keyboard_navigation': as_dict.get('skipKeyboardNavigation', None), 'sonification': as_dict.get('sonification', None), 'states': as_dict.get('states', None), 'sticky_tracking': as_dict.get('stickyTracking', None), 'threshold': as_dict.get('threshold', None), 'tooltip': as_dict.get('tooltip', None), 'turbo_threshold': as_dict.get('turboThreshold', None), 'visible': as_dict.get('visible', None), 'animation_limit': as_dict.get('animationLimit', None), 'boost_blending': as_dict.get('boostBlending', None), 'boost_threshold': as_dict.get('boostThreshold', None), 'color_axis': as_dict.get('colorAxis', None), 'color_index': as_dict.get('colorIndex', None), 'color_key': as_dict.get('colorKey', None), 'connect_ends': as_dict.get('connectEnds', None), 'connect_nulls': as_dict.get('connectNulls', None), 'crisp': as_dict.get('crisp', None), 'crop_threshold': as_dict.get('cropThreshold', None), 'data_sorting': as_dict.get('dataSorting', None), 'drag_drop': as_dict.get('dragDrop', None), 'find_nearest_point_by': as_dict.get('findNearestPointBy', None), 'get_extremes_from_all': as_dict.get('getExtremesFromAll', None), 'inactive_other_points': as_dict.get('inactiveOtherPoints', None), 'linecap': as_dict.get('linecap', None), 'line_width': as_dict.get('lineWidth', None), 'negative_color': as_dict.get('negativeColor', None), 'point_description_format': as_dict.get('pointDescriptionFormat', None), 'point_interval': as_dict.get('pointInterval', None), 'point_interval_unit': as_dict.get('pointIntervalUnit', None), 'point_placement': as_dict.get('pointPlacement', None), 'point_start': as_dict.get('pointStart', None), 'relative_x_value': as_dict.get('relativeXValue', None), 'shadow': as_dict.get('shadow', None), 'soft_threshold': as_dict.get('softThreshold', None), 'stacking': as_dict.get('stacking', None), 'step': as_dict.get('step', None), 'zone_axis': as_dict.get('zoneAxis', None), 'zones': as_dict.get('zones', None), 'data': as_dict.get('data', None), 'id': as_dict.get('id', None), 'index': as_dict.get('index', None), 'legend_index': as_dict.get('legendIndex', None), 'name': as_dict.get('name', None), 'stack': as_dict.get('stack', None), 'x_axis': as_dict.get('xAxis', None), 'y_axis': as_dict.get('yAxis', None), 'z_index': as_dict.get('zIndex', None), 'border_radius': as_dict.get('borderRadius', None), 'colsize': as_dict.get('colsize', None), 'interpolation': as_dict.get('interpolation', None), 'null_color': as_dict.get('nullColor', None), 'point_padding': as_dict.get('pointPadding', None), 'rowsize': as_dict.get('rowsize', None), } return kwargs def _to_untrimmed_dict(self, in_cls = None) -> dict: untrimmed = mro__to_untrimmed_dict(self, in_cls = in_cls) return untrimmed
[docs]class TilemapSeries(HeatmapSeries, TilemapOptions): """General options to apply to all Tilemap series types. A tilemap series is a type of heatmap where the tile shapes are configurable. .. tabs:: .. tab:: Honeycomb Tilemap .. figure:: ../../../_static/tilemap-example.png :alt: Honeycomb Tilemap Example Chart :align: center .. tab:: Circle Tilemap .. figure:: ../../../_static/tilemap-example-circle.png :alt: Tilemap Example Chart :align: center .. tab:: Diamond Tilemap .. figure:: ../../../_static/tilemap-example-diamond.png :alt: Tilemap Example Chart :align: center """ def __init__(self, **kwargs): super().__init__(**kwargs) @classmethod def _get_kwargs_from_dict(cls, as_dict): kwargs = { 'accessibility': as_dict.get('accessibility', None), 'allow_point_select': as_dict.get('allowPointSelect', None), 'animation': as_dict.get('animation', None), 'class_name': as_dict.get('className', None), 'clip': as_dict.get('clip', None), 'color': as_dict.get('color', None), 'cursor': as_dict.get('cursor', None), 'custom': as_dict.get('custom', None), 'dash_style': as_dict.get('dashStyle', None), 'data_labels': as_dict.get('dataLabels', None), 'description': as_dict.get('description', None), 'enable_mouse_tracking': as_dict.get('enableMouseTracking', None), 'events': as_dict.get('events', None), 'include_in_data_export': as_dict.get('includeInDataExport', None), 'keys': as_dict.get('keys', None), 'label': as_dict.get('label', None), 'legend_symbol': as_dict.get('legendSymbol', None), 'linked_to': as_dict.get('linkedTo', None), 'marker': as_dict.get('marker', None), 'on_point': as_dict.get('onPoint', None), 'opacity': as_dict.get('opacity', None), 'point': as_dict.get('point', None), 'point_description_formatter': as_dict.get('pointDescriptionFormatter', None), 'selected': as_dict.get('selected', None), 'show_checkbox': as_dict.get('showCheckbox', None), 'show_in_legend': as_dict.get('showInLegend', None), 'skip_keyboard_navigation': as_dict.get('skipKeyboardNavigation', None), 'sonification': as_dict.get('sonification', None), 'states': as_dict.get('states', None), 'sticky_tracking': as_dict.get('stickyTracking', None), 'threshold': as_dict.get('threshold', None), 'tooltip': as_dict.get('tooltip', None), 'turbo_threshold': as_dict.get('turboThreshold', None), 'visible': as_dict.get('visible', None), 'animation_limit': as_dict.get('animationLimit', None), 'boost_blending': as_dict.get('boostBlending', None), 'boost_threshold': as_dict.get('boostThreshold', None), 'color_axis': as_dict.get('colorAxis', None), 'color_index': as_dict.get('colorIndex', None), 'color_key': as_dict.get('colorKey', None), 'connect_ends': as_dict.get('connectEnds', None), 'connect_nulls': as_dict.get('connectNulls', None), 'crisp': as_dict.get('crisp', None), 'crop_threshold': as_dict.get('cropThreshold', None), 'data_sorting': as_dict.get('dataSorting', None), 'drag_drop': as_dict.get('dragDrop', None), 'find_nearest_point_by': as_dict.get('findNearestPointBy', None), 'get_extremes_from_all': as_dict.get('getExtremesFromAll', None), 'inactive_other_points': as_dict.get('inactiveOtherPoints', None), 'linecap': as_dict.get('linecap', None), 'line_width': as_dict.get('lineWidth', None), 'negative_color': as_dict.get('negativeColor', None), 'point_description_format': as_dict.get('pointDescriptionFormat', None), 'point_interval': as_dict.get('pointInterval', None), 'point_interval_unit': as_dict.get('pointIntervalUnit', None), 'point_placement': as_dict.get('pointPlacement', None), 'point_start': as_dict.get('pointStart', None), 'relative_x_value': as_dict.get('relativeXValue', None), 'shadow': as_dict.get('shadow', None), 'soft_threshold': as_dict.get('softThreshold', None), 'stacking': as_dict.get('stacking', None), 'step': as_dict.get('step', None), 'zone_axis': as_dict.get('zoneAxis', None), 'zones': as_dict.get('zones', None), 'data': as_dict.get('data', None), 'id': as_dict.get('id', None), 'index': as_dict.get('index', None), 'legend_index': as_dict.get('legendIndex', None), 'name': as_dict.get('name', None), 'stack': as_dict.get('stack', None), 'x_axis': as_dict.get('xAxis', None), 'y_axis': as_dict.get('yAxis', None), 'z_index': as_dict.get('zIndex', None), 'border_radius': as_dict.get('borderRadius', None), 'colsize': as_dict.get('colsize', None), 'interpolation': as_dict.get('interpolation', None), 'null_color': as_dict.get('nullColor', None), 'point_padding': as_dict.get('pointPadding', None), 'rowsize': as_dict.get('rowsize', None), 'tile_shape': as_dict.get('tileShape', None), } return kwargs def _to_untrimmed_dict(self, in_cls = None) -> dict: untrimmed = mro__to_untrimmed_dict(self, in_cls = in_cls) return untrimmed