Source code for highcharts_stock.options.plot_options.momentum.supertrend

from typing import Optional

from validator_collection import validators

from highcharts_core.decorators import class_sensitive
from highcharts_core.metaclasses import HighchartsMeta
from highcharts_core.utility_classes.gradients import Gradient
from highcharts_core.utility_classes.patterns import Pattern
from highcharts_core.utility_functions import validate_color

from highcharts_stock.options.plot_options.indicators import ComparableIndicatorOptions
from highcharts_stock.options.plot_options.oscillators import WilliamsRParameters as ParameterBase
from highcharts_stock.utility_classes.line_styles import LineStylesColorWidthDash


[docs]class SupertrendParameters(ParameterBase): def __init__(self, **kwargs): self._multiplier = None self.multiplier = kwargs.get('multiplier', None) super().__init__(**kwargs) @property def index(self): """Does not apply, so raises an :exc:`AttributeError <python:AttributeError>`.""" raise AttributeError(f"{self.__class__.__name__} has no attribute 'index'") @index.setter def index(self, value): raise AttributeError(f"{self.__class__.__name__} has no attribute 'index'") @property def multiplier(self) -> Optional[int]: """The multiplier applied to the indicator calculation. Defaults to ``3``. :rtype: :class:`int <python:int>` or :obj:`None <python:None>` """ return self._multiplier @multiplier.setter def multiplier(self, value): self._multiplier = validators.integer(value, allow_empty = True, minimum = 0) @classmethod def _get_kwargs_from_dict(cls, as_dict): kwargs = { 'period': as_dict.get('period', None), 'multiplier': as_dict.get('multiplier', None), } return kwargs def _to_untrimmed_dict(self, in_cls = None) -> dict: untrimmed = { 'multiplier': self.multiplier, 'period': self.period, } return untrimmed
[docs]class SupertrendLineOptions(HighchartsMeta): """Options for styling MACD lines.""" def __init__(self, **kwargs): self._styles = None self._zones = None self.styles = kwargs.get('styles', None) self.zones = kwargs.get('zones', None) @property def styles(self) -> Optional[LineStylesColorWidthDash]: """Styles to apply to the line itself. :rtype: :class:`LineStylesColorWidthDash <highcharts_stock.utility_classes.line_styles.LineStylesColorWidthDash>` or :obj:`None <python:None>` """ return self._styles @styles.setter @class_sensitive(LineStylesColorWidthDash) def styles(self, value): self._styles = value @classmethod def _get_kwargs_from_dict(cls, as_dict): kwargs = { 'styles': as_dict.get('styles', None), } return kwargs def _to_untrimmed_dict(self, in_cls = None) -> dict: untrimmed = { 'styles': self.styles, } return untrimmed
[docs]class SupertrendOptions(ComparableIndicatorOptions): """Options to configure a Supertrend, a momentum :term:`indicator <techincal indicator>` used to help identify buy/sell signals. .. figure:: ../../../../_static/supertrend-example.png :alt: Supertrend Example Chart :align: center """ def __init__(self, **kwargs): self._change_trend_line = None self._falling_trend_color = None self._rising_trend_color = None self.change_trend_line = kwargs.get('change_trend_line', None) self.falling_trend_color = kwargs.get('falling_trend_color', None) self.rising_trend_color = kwargs.get('rising_trend_color', None) super().__init__(**kwargs) @property def change_trend_line(self) -> Optional[SupertrendLineOptions]: """Styles for configuring the MACD line. :rtype: :class:`SupertrendLineOptions` or :obj:`None <python:None>` """ return self._change_trend_line @change_trend_line.setter @class_sensitive(SupertrendLineOptions) def change_trend_line(self, value): self._change_trend_line = value @property def falling_trend_color(self) -> Optional[str | Gradient | Pattern]: """Color of the Supertrend series line that is above the main series. Defaults to ``'#f21313'``. :rtype: :class:`str <python:str>`, :class:`Gradient`, :class:`Pattern``, or :obj:`None <python:None>` """ return self._falling_trend_color @falling_trend_color.setter def falling_trend_color(self, value): self._falling_trend_color = validate_color(value) @property def params(self) -> Optional[SupertrendParameters]: """Parameters used in calculating the indicator's data points. :rtype: :class:`SupertrendParameters` or :obj:`None <python:None>` """ return self._params @params.setter @class_sensitive(SupertrendParameters) def params(self, value): self._params = value @property def rising_trend_color(self) -> Optional[str | Gradient | Pattern]: """Color of the Supertrend series line that is beneath the main series. Defaults to ``'#06b535'``. :rtype: :class:`str <python:str>`, :class:`Gradient`, :class:`Pattern``, or :obj:`None <python:None>` """ return self._rising_trend_color @rising_trend_color.setter def rising_trend_color(self, value): self._rising_trend_color = validate_color(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), '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_index': as_dict.get('colorIndex', None), 'color_key': as_dict.get('colorKey', 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), '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), 'relative_x_value': as_dict.get('relativeXValue', None), 'shadow': as_dict.get('shadow', None), 'soft_threshold': as_dict.get('softThreshold', None), 'step': as_dict.get('step', None), 'zone_axis': as_dict.get('zoneAxis', None), 'zones': as_dict.get('zones', None), 'color_axis': as_dict.get('colorAxis', None), 'connect_ends': as_dict.get('connectEnds', None), 'drag_drop': as_dict.get('dragDrop', 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), 'stacking': as_dict.get('stacking', None), 'compare_start': as_dict.get('compareStart', None), 'compare_to_main': as_dict.get('compareToMain', None), 'cumulative': as_dict.get('cumulative', None), 'data_as_columns': as_dict.get('dataAsColumns', None), 'data_grouping': as_dict.get('dataGrouping', None), 'gap_size': as_dict.get('gapSize', None), 'gap_unit': as_dict.get('gapUnit', None), 'last_price': as_dict.get('lastPrice', None), 'last_visible_price': as_dict.get('lastVisiblePrice', None), 'name': as_dict.get('name', None), 'params': as_dict.get('params', None), 'compare': as_dict.get('compare', None), 'compare_base': as_dict.get('compareBase', None), 'change_trend_line': as_dict.get('changeTrendLine', None), 'falling_trend_color': as_dict.get('fallingTrendColor', None), 'rising_trend_color': as_dict.get('risingTrendColor', None), } return kwargs def _to_untrimmed_dict(self, in_cls = None) -> dict: untrimmed = { 'changeTrendLine': self.change_trend_line, 'fallingTrendColor': self.falling_trend_color, 'risingTrendColor': self.rising_trend_color, } 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