bencher.results.holoview_results.line_result
============================================

.. py:module:: bencher.results.holoview_results.line_result


Classes
-------

.. autoapisummary::

   bencher.results.holoview_results.line_result.LineResult


Module Contents
---------------

.. py:class:: LineResult(bench_cfg: bencher.bench_cfg.BenchCfg)

   Bases: :py:obj:`bencher.results.holoview_results.holoview_result.HoloviewResult`


   A class for creating line plot visualizations from benchmark results.

   Line plots are effective for visualizing trends in data over a continuous variable.
   This class provides methods to generate interactive line plots from benchmark data,
   with options for adding interactive tap functionality to display detailed information
   about specific data points.


   .. py:method:: to_plot(**kwargs) -> panel.panel | None

      Generates a line plot. See ``to_line`` for parameters.



   .. py:method:: to_line(result_var: param.Parameter | None = None, tap_var=None, tap_container: panel.pane.panel = None, target_dimension=2, override: bool = True, use_tap: bool = _USE_TAP, **kwargs) -> panel.panel | None

      Generates a line plot from benchmark data.

      :param result_var: The result variable to plot.
      :type result_var: Parameter, optional
      :param tap_var: Variables to display when tapping on line plot points.
      :param tap_container: Container to hold tapped information.
      :type tap_container: pn.pane.panel, optional
      :param target_dimension: Target dimensionality for the plot. Defaults to 2.
      :type target_dimension: int, optional
      :param override: Whether to override filter restrictions. Defaults to True.
      :type override: bool, optional
      :param use_tap: Whether to enable tap functionality.
      :type use_tap: bool, optional
      :param \*\*kwargs: Additional keyword arguments passed to the plot rendering.

      :returns: A panel containing the line plot, or filter match results.
      :rtype: pn.panel | None



   .. py:method:: to_line_ds(dataset: xarray.Dataset, result_var: param.Parameter, **kwargs)

      Creates a basic line plot from the provided dataset.

      When over_time is active with multiple time points, creates an hv.HoloMap
      with a slider.

      :param dataset: The dataset containing benchmark results.
      :type dataset: xr.Dataset
      :param result_var: The result variable to plot.
      :type result_var: Parameter
      :param \*\*kwargs: Additional keyword arguments passed to the line plot options.

      :returns: A line plot visualization.
      :rtype: hvplot.element.Curve | pn.Column



   .. py:method:: _to_line_tap_ds(dataset: xarray.Dataset, result_var: param.Parameter, result_var_plots: list[param.Parameter] | None = None, container: panel.pane.panel = pn.pane.panel, **kwargs) -> panel.Row

      Creates an interactive line plot with tap functionality.

      :param dataset: The dataset containing benchmark results.
      :type dataset: xr.Dataset
      :param result_var: The primary result variable to plot.
      :type result_var: Parameter
      :param result_var_plots: Additional result variables
                               to display when a point is tapped.
      :type result_var_plots: list[Parameter], optional
      :param container: Container to display tapped information.
      :type container: pn.pane.panel, optional
      :param \*\*kwargs: Additional keyword arguments passed to the line plot options.

      :returns: A panel row containing the interactive line plot and tap info.
      :rtype: pn.Row