.. index:: pair: class; EE::UI::Charts::LineSeries
.. _doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series:

class EE::UI::Charts::LineSeries
================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

One model-owned line. :ref:`More...<details-class_e_e_1_1_u_i_1_1_charts_1_1_line_series>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <uichart.hpp>
	
	class LineSeries {
	public:
		// methods
	
		const :ref:`String<doxid-class_e_e_1_1_string>`& :target:`name<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1afd1650eefd5d2b3b27b311128bcf7a3a>`() const;
		:ref:`ChartAxis<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_chart_axis>`& :target:`xAxis<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a07490c9b26d15ecc58fd0f2d9f8763f0>`() const;
		:ref:`ChartAxis<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_chart_axis>`& :target:`yAxis<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a2ba9144a8d26f969e52adf99a551365e>`() const;
		void :ref:`setXAxis<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1aa762bbceace6ff7f9b973b845981b008>`(:ref:`ChartAxis<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_chart_axis>`& axis);
		void :ref:`setYAxis<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a7764d8d4029c379b1d669bb40fb563cd>`(:ref:`ChartAxis<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_chart_axis>`& axis);
		void :target:`setVisible<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1ad1c866bc626e7365577b792cb6e1587f>`(bool visible);
		bool :target:`visible<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a108f9e287b7ddcd93c3c937119e2a842>`() const;
		void :ref:`setColor<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1af8e66a28ba76a80961b994c1d42a00ed>`(:ref:`Color<doxid-class_e_e_1_1_system_1_1_color>` color);
		:ref:`Color<doxid-class_e_e_1_1_system_1_1_color>` :target:`color<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a171d26f196cb7a8283de91ee968c29ad>`() const;
		bool :target:`hasCustomColor<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1ad94d8f657811a0e2a7e7e1c9d675e9c3>`() const;
		void :ref:`setFilled<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a7e6fce465958c8c2279adb649f4899a9>`(bool filled);
		bool :target:`filled<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a29a53f87f399f54ef6a5083fa30de635>`() const;
		void :ref:`setFillColor<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1aad5bd4ef5ac1e8ec2ec4591c894aaafa>`(std::optional<:ref:`Color<doxid-class_e_e_1_1_system_1_1_color>`> color);
		const std::optional<:ref:`Color<doxid-class_e_e_1_1_system_1_1_color>`>& :target:`fillColor<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1ab2d2c19cd1ecd37d1619f18a08fa245e>`() const;
		void :ref:`setWidth<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a938296c6954305ca74549884b8ae8db8>`(:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` width);
		:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :target:`width<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a02e304a3018f44914c3cea1aa0183966>`() const;
		void :target:`setJoin<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a0fdf96ef9393f71ed96589d58a5cae21>`(:ref:`LineJoin<doxid-namespace_e_e_1_1_u_i_1_1_charts_1a0dd4414cc521827263f61f8d55f99833>` join);
		:ref:`LineJoin<doxid-namespace_e_e_1_1_u_i_1_1_charts_1a0dd4414cc521827263f61f8d55f99833>` :target:`join<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a8d0761c13e3745bdab74ebb2fad56f23>`() const;
		void :target:`setCap<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1adc888e20bb840fe9cb61195499ae6e2f>`(:ref:`LineCap<doxid-namespace_e_e_1_1_u_i_1_1_charts_1a465c708c042710abd8395b3339829cc4>` cap);
		:ref:`LineCap<doxid-namespace_e_e_1_1_u_i_1_1_charts_1a465c708c042710abd8395b3339829cc4>` :target:`cap<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a8dd7577736942866162308ed38a0cea5>`() const;
		void :ref:`setInterpolation<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a27814836334a56c7efcc538c66ffe3f2>`(:ref:`LineInterpolation<doxid-namespace_e_e_1_1_u_i_1_1_charts_1a27a0650d0652420e7cb891c4b8828a96>` interpolation);
		:ref:`LineInterpolation<doxid-namespace_e_e_1_1_u_i_1_1_charts_1a27a0650d0652420e7cb891c4b8828a96>` :target:`interpolation<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a9c07e23a11dfc4c547382c05073407fa>`() const;
		void :ref:`setMiterLimit<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a15ec8e77fca397b1f706226186dff88b>`(:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` limit);
		:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :target:`miterLimit<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a650049d777d68f525a6bdeb36c49c4ac>`() const;
		:ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` :target:`geometryRevision<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a73e73e3b33eb1a54ee9183daeddfcf15>`() const;
		void :ref:`setPoints<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1af5411446f12c2baf918cb0e06cc19d55>`(std::vector<:ref:`ChartPoint<doxid-struct_e_e_1_1_u_i_1_1_charts_1_1_chart_point>`> points);
		void :ref:`setPoints<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a67cd01d431cbcb74336773e28b15ac02>`(std::span<const double> xs, std::span<const double> ys);
		void :ref:`setValues<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a7efc2e5a2577e729c61237dff94b82a7>`(std::span<const double> ys, double start = 0.0, double step = 1.0);
		void :ref:`setDataSource<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a3ee6f7844acc168e1ab119177f8fabcb>`(std::shared_ptr<:ref:`XYDataSource<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_x_y_data_source>`> source);
		std::shared_ptr<:ref:`XYDataSource<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_x_y_data_source>`> :target:`dataSource<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a3454e5eeefb7b2cce942ef3fe8df1e6c>`() const;
		void :ref:`setTooltipProvider<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a27ea8bc93415549e7e3bd8476751844e>`(:ref:`PointTooltipProvider<doxid-namespace_e_e_1_1_u_i_1_1_charts_1aa4c3a4047bdb61547d05ad7ddcc056c4>` provider);
		const :ref:`PointTooltipProvider<doxid-namespace_e_e_1_1_u_i_1_1_charts_1aa4c3a4047bdb61547d05ad7ddcc056c4>`& :target:`tooltipProvider<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1ac00e75c049639c368e6ea5d09a3707f4>`() const;
	};
.. _details-class_e_e_1_1_u_i_1_1_charts_1_1_line_series:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

One model-owned line. Its axes are borrowed from the same :ref:`ChartModel <doxid-class_e_e_1_1_u_i_1_1_charts_1_1_chart_model>`; neither this object nor a :ref:`UIChart <doxid-class_e_e_1_1_u_i_1_1_charts_1_1_u_i_chart>` owns them separately. A series can share its data source with other series.

Methods
-------

.. index:: pair: function; setXAxis
.. _doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1aa762bbceace6ff7f9b973b845981b008:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setXAxis(:ref:`ChartAxis<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_chart_axis>`& axis)

The axis must belong to this series' model and outlive the series.

.. index:: pair: function; setYAxis
.. _doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a7764d8d4029c379b1d669bb40fb563cd:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setYAxis(:ref:`ChartAxis<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_chart_axis>`& axis)

The axis must belong to this series' model and outlive the series.

.. index:: pair: function; setColor
.. _doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1af8e66a28ba76a80961b994c1d42a00ed:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setColor(:ref:`Color<doxid-class_e_e_1_1_system_1_1_color>` color)

Overrides the theme's default series color.

.. index:: pair: function; setFilled
.. _doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a7e6fce465958c8c2279adb649f4899a9:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setFilled(bool filled)

Fill the area between the line and the plot's bottom edge. Disabled by default.

.. index:: pair: function; setFillColor
.. _doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1aad5bd4ef5ac1e8ec2ec4591c894aaafa:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setFillColor(std::optional<:ref:`Color<doxid-class_e_e_1_1_system_1_1_color>`> color)

Overrides the translucent line color used by the fill; null restores the default.

.. index:: pair: function; setWidth
.. _doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a938296c6954305ca74549884b8ae8db8:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setWidth(:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` width)

Stroke width in device-independent pixels.

.. index:: pair: function; setInterpolation
.. _doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a27814836334a56c7efcc538c66ffe3f2:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setInterpolation(:ref:`LineInterpolation<doxid-namespace_e_e_1_1_u_i_1_1_charts_1a27a0650d0652420e7cb891c4b8828a96>` interpolation)

Changes line geometry; defaults to Linear.

.. index:: pair: function; setMiterLimit
.. _doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a15ec8e77fca397b1f706226186dff88b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setMiterLimit(:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` limit)

Maximum miter extension as a multiple of half the line width.

.. index:: pair: function; setPoints
.. _doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1af5411446f12c2baf918cb0e06cc19d55:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setPoints(std::vector<:ref:`ChartPoint<doxid-struct_e_e_1_1_u_i_1_1_charts_1_1_chart_point>`> points)

Replaces the samples with an owned data source, moving the vector when possible.

.. index:: pair: function; setPoints
.. _doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a67cd01d431cbcb74336773e28b15ac02:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setPoints(std::span<const double> xs, std::span<const double> ys)

Copies paired X/Y samples into an owned data source.

.. index:: pair: function; setValues
.. _doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a7efc2e5a2577e729c61237dff94b82a7:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setValues(std::span<const double> ys, double start = 0.0, double step = 1.0)

Copies Y samples with generated X values: start + index \* step.

.. index:: pair: function; setDataSource
.. _doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a3ee6f7844acc168e1ab119177f8fabcb:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setDataSource(std::shared_ptr<:ref:`XYDataSource<doxid-class_e_e_1_1_u_i_1_1_charts_1_1_x_y_data_source>`> source)

Shares ownership of the source; it may be updated independently of the :ref:`UIChart <doxid-class_e_e_1_1_u_i_1_1_charts_1_1_u_i_chart>`.

.. index:: pair: function; setTooltipProvider
.. _doxid-class_e_e_1_1_u_i_1_1_charts_1_1_line_series_1a27ea8bc93415549e7e3bd8476751844e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setTooltipProvider(:ref:`PointTooltipProvider<doxid-namespace_e_e_1_1_u_i_1_1_charts_1aa4c3a4047bdb61547d05ad7ddcc056c4>` provider)

Replaces the optional callback used for hover text.