Skip to content

ChartObjectHoverChangedEventArgs.IsObjectHovered

property · ChartObjectHoverChangedEventArgs · cAlgo.API

DesktopCLICloud

Defines if the mouse is hovered over the chart object.

Environment behaviour

CLI — not supported. Never raised in the CLI: the events that pass it never fire there (ChartArea.ObjectHoverChanged).

Cloud — not supported. Never raised in the cloud: the events that pass it never fire there (ChartArea.ObjectHoverChanged).

Definition

public bool IsObjectHovered {get;}

chartObjectHoverChangedEventArgs.IsObjectHovered: bool

Returns bool

Examples

protected override void OnStart()
{
    Chart.ObjectHoverChanged += OnChartObjectHoverChanged;
}

private void OnChartObjectHoverChanged(ChartObjectHoverChangedEventArgs args)
{
    var state = args.IsObjectHovered ? "entered" : "left";
    Print("Mouse {0} object {1}", state, args.ChartObject.Name);
}

def on_start(self):
    api.Chart.ObjectHoverChanged += self.on_chart_object_hover_changed

def on_chart_object_hover_changed(self, args):
    state = "entered" if args.IsObjectHovered else "left"
    api.Print(f"Mouse {state} object {args.ChartObject.Name}")