from lightningchart_trader.drawing_tools import DrawingToolBase
[docs]
class ParallelChannel(DrawingToolBase):
def __init__(self, trader, startX, startY, endX=None, endY=None, channelHeight=None):
super().__init__(trader)
self.instance.send(
self.id,
'addParallelChannel',
{
'traderID': trader.id,
'startX': startX,
'startY': startY,
'endX': endX,
'endY': endY,
'channelHeight': channelHeight,
},
)
[docs]
def set_area_color(self, color: str):
"""Sets the color of the channel area.
Args:
color (str): New area color as string, should be in HEX format e.g. #FFFFFF.
"""
self.instance.send(self.id, 'setAreaColor', {'color': color})
return self
[docs]
def set_extend_lines(self, enabled: bool):
"""Sets whether the two lines extend to the edge of the chart.
Args:
enabled (bool): Set true to extend the lines.
"""
self.instance.send(self.id, 'setExtendLines', {'extendLines': enabled})
return self
[docs]
def set_fill_enabled(self, fillEnabled: bool):
"""Sets whether the channel area is colored or not.
Args:
fillEnabled (bool): Set true to enable colored fill.
"""
self.instance.send(self.id, 'setFillEnabled', {'fillEnabled': fillEnabled})
return self
[docs]
def set_line_color(self, color: str):
"""Sets the color of the lines.
Args:
color (str): New line color as string, should be in HEX format e.g. #FFFFFF.
"""
self.instance.send(self.id, 'setLineColor', {'color': color})
return self
[docs]
def set_line_width(self, width: int | float):
"""Sets the width of the lines.
Args:
width (int | float): New line width.
"""
self.instance.send(self.id, 'setLineWidth', {'width': width})
return self
[docs]
def set_magnetic(self, is_magnetic: bool):
"""Sets whether the drawing tool should automatically snap to OHLC data points.
Args:
is_magnetic (bool): Set true to enable snapping to data points.
"""
self.instance.send(self.id, 'setMagnetic', {'isMagnetic': is_magnetic})
return self
[docs]
def update_position(
self,
startX: int | float,
endX: int | float,
upperStartY: int | float,
upperEndY: int | float,
priceRange: int | float,
):
"""Updates the drawing tool based on the control points' locations.
Args:
startX (int | float): Channel's starting X-location.
endX (int | float): Channel's ending X-location.
upperStartY (int | float): Y-location for the starting point of the first line.
upperEndY (int | float): Y-location for the ending point of the first line.
priceRange (int | float): Price value range between the two channel lines.
"""
self.instance.send(
self.id,
'updateParallelChannelPosition',
{
'startX': startX,
'endX': endX,
'upperStartY': upperStartY,
'upperEndY': upperEndY,
'priceRange': priceRange,
},
)
return self