from typing import Optional
from decimal import Decimal
from validator_collection import validators
from highcharts_core.decorators import class_sensitive
from highcharts_core.metaclasses import HighchartsMeta
from highcharts_stock.options.plot_options.indicators import ParameterBase, ComparableIndicatorOptions
from highcharts_stock.utility_classes.line_styles import LineStylesColorWidth
[docs]class PriceEnvelopesParameters(ParameterBase):
def __init__(self, **kwargs):
self._bottom_band = None
self._top_band = None
self.bottom_band = kwargs.get('bottom_band', None)
self.top_band = kwargs.get('top_band', None)
super().__init__(**kwargs)
@property
def bottom_band(self) -> Optional[int | float | Decimal]:
"""Percentage below the moving average that should be displayed, relative to the
calculated value. Defaults to ``0.1``, which means 90%.
:rtype: numeric or :obj:`None <python:None>`
"""
return self._bottom_band
@bottom_band.setter
def bottom_band(self, value):
self._bottom_band = validators.numeric(value, allow_empty = True)
@property
def top_band(self) -> Optional[int | float | Decimal]:
"""Percentage above the moving average that should be displayed, relative to the
calculated value. Defaults to ``0.1``, which means 110%.
:rtype: numeric or :obj:`None <python:None>`
"""
return self._top_band
@top_band.setter
def top_band(self, value):
self._top_band = validators.numeric(value, allow_empty = True)
@classmethod
def _get_kwargs_from_dict(cls, as_dict):
kwargs = {
'index': as_dict.get('index', None),
'period': as_dict.get('period', None),
'bottom_band': as_dict.get('bottomBand', None),
'top_band': as_dict.get('topBand', None),
}
return kwargs
def _to_untrimmed_dict(self, in_cls = None) -> dict:
untrimmed = {
'index': self.index,
'period': self.period,
'bottomBand': self.bottom_band,
'topBand': self.top_band,
}
return untrimmed
[docs]class PriceEnvelopesStyleOptions(HighchartsMeta):
"""Styles for the PriceEnvelopes lines."""
def __init__(self, **kwargs):
self._styles = None
self.styles = kwargs.get('styles', None)
@property
def styles(self) -> Optional[LineStylesColorWidth]:
"""Styles for the bottom line.
:rtype: :class:`LineStylesColorWidth` or :obj:`None <python:None>`
"""
return self._styles
@styles.setter
@class_sensitive(LineStylesColorWidth)
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 PriceEnvelopesOptions(ComparableIndicatorOptions):
"""Configuration for :term:`Price Envelopes`, a :term:`technical indicator` based on
simple moving averages.
.. figure:: ../../../_static/price-envelopes-example.png
:alt: Price Envelopes Example Chart
:align: center
"""
def __init__(self, **kwargs):
self._bottom_line = None
self._top_line = None
self.bottom_line = kwargs.get('bottom_line', None)
self.top_line = kwargs.get('top_line', None)
super().__init__(**kwargs)
@property
def bottom_line(self) -> Optional[PriceEnvelopesStyleOptions]:
"""Styles for the bottom line.
:rtype: :class:`AbandsStyleOptions` or :obj:`None <python:None>`
"""
return self._bottom_line
@bottom_line.setter
@class_sensitive(PriceEnvelopesStyleOptions)
def bottom_line(self, value):
self._bottom_line = value
@property
def params(self) -> Optional[PriceEnvelopesParameters]:
"""Parameters used in calculating the indicator's data points.
:rtype: :class:`PriceEnvelopesParameters` or :obj:`None <python:None>`
"""
return self._params
@params.setter
@class_sensitive(PriceEnvelopesParameters)
def params(self, value):
self._params = value
@property
def top_line(self) -> Optional[PriceEnvelopesStyleOptions]:
"""Styles for the top line.
:rtype: :class:`PriceEnvelopesStyleOptions` or :obj:`None <python:None>`
"""
return self._top_line
@top_line.setter
@class_sensitive(PriceEnvelopesStyleOptions)
def top_line(self, value):
self._top_line = 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),
'bottom_line': as_dict.get('bottomLine', None),
'top_line': as_dict.get('topLine', None),
}
return kwargs
def _to_untrimmed_dict(self, in_cls = None) -> dict:
untrimmed = {
'bottomLine': self.bottom_line,
'topLine': self.top_line,
}
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