Source code for highcharts_core.options.plot_options.bubble

from typing import Optional
from decimal import Decimal

from validator_collection import validators

from highcharts_core import errors
from highcharts_core.decorators import class_sensitive
from highcharts_core.options.plot_options.series import SeriesOptions
from highcharts_core.utility_classes.jitter import Jitter


[docs]class BubbleOptions(SeriesOptions): """General options to apply to all Bubble series types. A bubble series is a three dimensional series type where each point renders an X, Y, and Z value. Each points is drawn as a bubble where the position along the X and Y axes mark the X and Y values, and the size of the bubble relates to the Z value. .. figure:: ../../../_static/bubble-example.png :alt: Bubble Example Chart :align: center """ def __init__(self, **kwargs): self._display_negative = True self._jitter = None self._max_size = None self._min_size = None self._size_by = None self._size_by_absolute_value = False self._z_max = None self._z_min = None self._z_threshold = None self.display_negative = kwargs.get('display_negative', None) self.jitter = kwargs.get('jitter', None) self.max_size = kwargs.get('max_size', None) self.min_size = kwargs.get('min_size', None) self.size_by = kwargs.get('size_by', None) self.size_by_absolute_value = kwargs.get('size_by_absolute_value', None) self.z_max = kwargs.get('z_max', None) self.z_min = kwargs.get('z_min', None) self.z_threshold = kwargs.get('z_threshold', None) super().__init__(**kwargs) @property def display_negative(self) -> Optional[bool]: """If ``True``, display negative sized bubbles. The threshold is given by the :meth:`z_threshold <BubbleOptions.z_threshold>` setting, and negative bubbles can be visualized by setting :meth:`negative_color <BubbleOptions.negative_color>`. :rtype: :class:`bool <python:bool>` or :obj:`None <python:None>` """ return self._display_negative @display_negative.setter def display_negative(self, value): if value is None: self._display_negative = None else: self._display_negative = bool(value) @property def jitter(self) -> Optional[Jitter]: """Apply a jitter effect for the rendered markers. When plotting discrete values, a little random noise may help telling the points apart. The jitter setting applies a random displacement of up to n axis units in either direction. So for example on a horizontal X axis, setting the ``jitter.x`` to ``0.24`` will render the point in a random position between 0.24 units to the left and 0.24 units to the right of the true axis position. On a category axis, setting it to ``0.5`` will fill up the bin and make the data appear continuous. When rendered on top of a box plot or a column series, a jitter value of 0.24 will correspond to the underlying series' default ``group_padding`` and ``point_padding`` settings. :rtype: :class:`Jitter` or :obj:`None <python:None>` """ return self._jitter @jitter.setter @class_sensitive(Jitter) def jitter(self, value): self._jitter = value @property def max_size(self) -> Optional[str | int | float | Decimal]: """Maximum bubble size. Defaults to ``'20%'``. If :obj:`None <python:None>`, bubbles will automatically size between the :meth:`min_size <BubbleOptions.min_size>` and ``max_size``, to reflect the z value of each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width and height. :rtype: numeric or :obj:`None <python:None>` """ return self._max_size @max_size.setter def max_size(self, value): if value is None: self._max_size = None else: try: value = validators.string(value) if '%' not in value: raise errors.HighchartsValueError('max_size expects either a number ' 'or a % string. No "%" found.') except TypeError: self._max_size = validators.numeric(value, allow_empty = True, minimum = 0) @property def min_size(self) -> Optional[str | int | float | Decimal]: """Minimum bubble size. Defaults to ``8``. If :obj:`None <python:None>`, bubbles will automatically size between the :meth:`max_size <BubbleOptions.max_size>` and ``min_size``, to reflect the z value of each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width and height. :rtype: numeric or :obj:`None <python:None>` """ return self._min_size @min_size.setter def min_size(self, value): if value is None: self._min_size = None else: try: value = validators.string(value) if '%' not in value: raise errors.HighchartsValueError('min_size expects either a number ' 'or a % string. No "%" found.') except TypeError: self._min_size = validators.numeric(value, allow_empty = True, minimum = 0) @property def size_by(self) -> Optional[str]: """Whether the bubble's value should be represented by the ``'area'`` or the ``'width'`` of the bubble. The default, ``'area'``, corresponds best to the human perception of the size of each bubble. :rtype: :class:`str <python:str>` or :obj:`None <python:None>` """ return self._size_by @size_by.setter def size_by(self, value): if not value: self._size_by = None else: value = validators.string(value) value = value.lower() if value not in ['area', 'width']: raise errors.HighchartsValueError(f'size_by expects either "area", ' f'or "width". Received: {value}') self._size_by = value @property def size_by_absolute_value(self) -> Optional[bool]: """If ``True``, the absolute value of z determines the size of the bubble. This means that with the default :meth:`z_threshold <BubbleOptions.z_threshold>` of ``0``, a bubble of value ``-1`` will have the same size as a bubble of value ``1``, while a bubble of value ``0`` will have a smaller size according to :meth:`min_size <BubbleOptions.min_size>`. Defaults to ``False``. :rtype: :class:`bool <python:bool>` or :obj:`None <python:None>` """ return self._size_by_absolute_value @size_by_absolute_value.setter def size_by_absolute_value(self, value): if value is None: self._size_by_absolute_value = None else: self._size_by_absolute_value = bool(value) @property def z_max(self) -> Optional[int | float | Decimal]: """The maximum for the Z value range. When :obj:`None <python:None>`, defaults to the highest Z value in the data. Defaults to :obj:`None <python:None>`. :rtype: numeric or :obj:`None <python:None>` """ return self._z_max @z_max.setter def z_max(self, value): self._z_max = validators.numeric(value, allow_empty = True) @property def z_min(self) -> Optional[int | float | Decimal]: """The minimum for the Z value range. When :obj:`None <python:None>`, defaults to the lowest Z value in the data. Defaults to :obj:`None <python:None>`. :rtype: numeric or :obj:`None <python:None>` """ return self._z_min @z_min.setter def z_min(self, value): self._z_min = validators.numeric(value, allow_empty = True) @property def z_threshold(self) -> Optional[int | float | Decimal]: """When :meth:`display_negative <BubbleOptions.display_negative>` is ``False``, then bubbles with a Z value lower than ``z_threshold`` are not rendered. When :meth:`display_negative <BubbleOptions.display_negative>` is ``True`` and :meth:`negative_color <BubbleOptions.negative_color>` is set, then points with a Z value lower than ``z_threshold`` are rendered with the negative coloring. Defaults to ``0``. :rtype: numeric or :obj:`None <python:None>` """ return self._z_threshold @z_threshold.setter def z_threshold(self, value): self._z_threshold = validators.numeric(value, allow_empty = True) @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), '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), '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), 'linecap': as_dict.get('linecap', None), 'line_width': as_dict.get('lineWidth', None), 'negative_color': as_dict.get('negativeColor', 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), 'display_negative': as_dict.get('displayNegative', None), 'jitter': as_dict.get('jitter', None), 'max_size': as_dict.get('maxSize', None), 'min_size': as_dict.get('minSize', None), 'size_by': as_dict.get('sizeBy', None), 'size_by_absolute_value': as_dict.get('sizeByAbsoluteValue', None), 'z_max': as_dict.get('zMax', None), 'z_min': as_dict.get('zMin', None), 'z_threshold': as_dict.get('zThreshold', None), } return kwargs def _to_untrimmed_dict(self, in_cls = None) -> dict: untrimmed = { 'displayNegative': self.display_negative, 'jitter': self.jitter, 'maxSize': self.max_size, 'minSize': self.min_size, 'sizeBy': self.size_by, 'sizeByAbsoluteValue': self.size_by_absolute_value, 'zMax': self.z_max, 'zMin': self.z_min, 'zThreshold': self.z_threshold } parent_as_dict = super()._to_untrimmed_dict(in_cls = in_cls) for key in parent_as_dict: untrimmed[key] = parent_as_dict[key] return untrimmed