Click or drag to resize

IChartTrendLine Interface

Represents ChartTrendLine interface.

Namespace: Spire.Xls.Core
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
Copy 
public interface IChartTrendLine

The IChartTrendLine type exposes the following members.

Properties
Name Description
Public property Code example Backward
Represents number of periods that the trendline extends backward.
Examples
The following code illustrates how to set backward forecast value for IChartTrendLine object:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>Chart chart = worksheet.Charts.Add(ExcelChartType.ScatterMarkers);</para><para>//Add serie and set serie Y and X Values</para><para>IChartSerie serie = chart.Series.Add();</para><para>serie.Values = worksheet.Range["A2:C2"];</para><para>serie.CategoryLabels = worksheet.Range["A1:C1"];</para><para>//Set X axis minimum and maximum values</para><para>chart.PrimaryCategoryAxis.MinValue = -2;</para><para>chart.PrimaryCategoryAxis.MaxValue = 2;</para><para>//Get chart trendlines collection and Add trendline</para><para>IChartTrendLines trendLines = serie.TrendLines;</para><para>IChartTrendLine trendline = trendLines.Add();</para><para>//Set backward forecast value</para><para>trendline.Backward = 3;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example Border
Represents border object. Read only.
Examples
The following code illustrates how to access and format the IChartBorder for IChartTrendLine:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>IChart chart = worksheet.Charts.Add();</para><para>//Add serie and set serie Y and X Values</para><para>IChartSerie serie = chart.Series.Add();</para><para>serie.Values = worksheet.Range["A2:C2"];</para><para>serie.CategoryLabels = worksheet.Range["A1:C1"];</para><para>//Get chart trendlines collection</para><para>IChartTrendLines trendLines = serie.TrendLines;</para><para>//Add trendline</para><para>IChartTrendLine trendline = trendLines.Add();</para><para>//Set trendline broder properties</para><para>trendline.Border.Color = Color.Red;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Chart3DOptions
Gets the IThreeDFormat object. Read-only.[Deprecated]
Public property Code example DataLabel
Returns data label. Read only.
Examples
The following code illustrates how to enable and set IChartTextArea text for IChartTrendLine object:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and Get chart serie</para><para>Chart chart = worksheet.Charts.Add(ExcelChartType.ColumnClustered);</para><para>chart.DataRange = worksheet.Range["A1:C3"];</para><para>IChartSerie serie = chart.Series[0];</para><para>//Get chart trendlines collection and Add trendline</para><para>IChartTrendLines trendLines = serie.TrendLines;</para><para>IChartTrendLine trendline = trendLines.Add();</para><para>//Enable trendline data label by DisplayRSquared</para><para>trendline.DisplayRSquared = true;</para><para>//Set data label text</para><para>trendline.DataLabel.Text = "y=10*x";</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example DisplayEquation
True if the equation for the trendline is displayed on the chart.
Examples
The following code illustrates how to display equation for IChartTrendLine object:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and Get chart serie</para><para>Chart chart = worksheet.Charts.Add(ExcelChartType.ColumnClustered);</para><para>chart.DataRange = worksheet.Range["A1:C3"];</para><para>IChartSerie serie = chart.Series[0];</para><para>//Get chart trendlines collection and Add trendline</para><para>IChartTrendLines trendLines = serie.TrendLines;</para><para>IChartTrendLine trendline = trendLines.Add();</para><para>//Set equation in trendline</para><para>trendline.DisplayEquation = true;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example DisplayRSquared
True if the R-squared value of the trendline is displayed on the chart.
Examples
The following code illustrates how to display RSquared for IChartTrendLine object:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and Get chart serie</para><para>Chart chart = worksheet.Charts.Add(ExcelChartType.ColumnClustered);</para><para>chart.DataRange = worksheet.Range["A1:C3"];</para><para>IChartSerie serie = chart.Series[0];</para><para>//Get chart trendlines collection and Add trendline</para><para>IChartTrendLines trendLines = serie.TrendLines;</para><para>IChartTrendLine trendline = trendLines.Add();</para><para>//Set RSquared value for trendline</para><para>trendline.DisplayRSquared = true;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Formula
Return trendline formula. Read only.
Public property Code example Forward
Represents number of periods that the trendline extends forward.
Examples
The following code illustrates how to set Forward forecast value for IChartTrendLine object:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>Chart chart = worksheet.Charts.Add(ExcelChartType.ScatterMarkers);</para><para>//Add serie and set serie Y and X Values</para><para>IChartSerie serie = chart.Series.Add();</para><para>serie.Values = worksheet.Range["A2:C2"];</para><para>serie.CategoryLabels = worksheet.Range["A1:C1"];</para><para>//Set X axis minimum and maximum values</para><para>chart.PrimaryCategoryAxis.MinValue = -2;</para><para>chart.PrimaryCategoryAxis.MaxValue = 2;</para><para>//Get chart trendlines collection and Add trendline</para><para>IChartTrendLines trendLines = serie.TrendLines;</para><para>IChartTrendLine trendline = trendLines.Add();</para><para>//Set backward forecast value</para><para>trendline.Forward = 3;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example Intercept
Represents point where the trendline crosses the value axis.
Examples
The following code illustrates how to set intercept value for IChartTrendLine object:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>Chart chart = worksheet.Charts.Add(ExcelChartType.ScatterMarkers);</para><para>//Add serie and set serie Y and X Values</para><para>IChartSerie serie = chart.Series.Add();</para><para>serie.Values = worksheet.Range["A2:C2"];</para><para>serie.CategoryLabels = worksheet.Range["A1:C1"];</para><para>//Get chart trendlines collection and Add trendline</para><para>IChartTrendLines trendLines = serie.TrendLines;</para><para>IChartTrendLine trendline = trendLines.Add();</para><para>//Set intercept value</para><para>trendline.Intercept = 10;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example InterceptIsAuto
True if the point where the trendline crosses the value axis is automatically determined by the regression.
Examples
The following code illustrates how to check whether the IChartTrendLine object intercept value is automatic or not:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>Chart chart = worksheet.Charts.Add(ExcelChartType.ScatterMarkers);</para><para>//Add serie and set serie Y and X Values</para><para>IChartSerie serie = chart.Series.Add();</para><para>serie.Values = worksheet.Range["A2:C2"];</para><para>serie.CategoryLabels = worksheet.Range["A1:C1"];</para><para>//Get chart trendlines collection and Add trendline</para><para>IChartTrendLines trendLines = serie.TrendLines;</para><para>IChartTrendLine trendline = trendLines.Add();</para><para>//Set intercept value</para><para>trendline.Intercept = 10;</para><para>//Check trendline intercept is automatic</para><para>Console.WriteLine("Is Trendline Intercept value is automatic:" + trendline.InterceptIsAuto.ToString());</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example Name
Represents trendline name.
Examples
The following code illustrates how to access name from IChartTrendLine object:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and Get chart serie</para><para>Chart chart = worksheet.Charts.Add(ExcelChartType.ColumnClustered);</para><para>chart.DataRange = worksheet.Range["A1:C3"];</para><para>IChartSerie serie = chart.Series[0];</para><para>//Get chart trendlines collection and Add trendline</para><para>IChartTrendLines trendLines = serie.TrendLines;</para><para>IChartTrendLine trendline = trendLines.Add(TrendLineType.Logarithmic);</para><para>//Get trendline Name</para><para>Console.WriteLine(trendline.Name);</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example NameIsAuto
Indicates if name is default.
Examples
The following code illustrates how to check whether the IChartTrendLine object name is default or not:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and Get chart serie</para><para>Chart chart = worksheet.Charts.Add(ExcelChartType.ColumnClustered);</para><para>chart.DataRange = worksheet.Range["A1:C3"];</para><para>IChartSerie serie = chart.Series[0];</para><para>//Get chart trendlines collection and Add trendline</para><para>IChartTrendLines trendLines = serie.TrendLines;</para><para>IChartTrendLine trendline = trendLines.Add(TrendLineType.Logarithmic);</para><para>//Set trendline name</para><para>trendline.Name = "Trendline 1";</para><para>//Check trendline name is automatic</para><para>Console.WriteLine(trendline.NameIsAuto);</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example Order
Represents for Moving Averange and Polynomial trend line type order value.
Examples
The following code illustrates how to set order value for IChartTrendLine object:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>Chart chart = worksheet.Charts.Add(ExcelChartType.ColumnClustered);</para><para>//Add serie and set serie Y and X Values</para><para>IChartSerie serie = chart.Series.Add();</para><para>serie.Values = worksheet.Range["A2:C2"];</para><para>serie.CategoryLabels = worksheet.Range["A1:C1"];</para><para>//Get chart trendlines collection and Add trendline</para><para>IChartTrendLines trendLines = serie.TrendLines;</para><para>IChartTrendLine trendline = trendLines.Add();</para><para>//Set trendline type</para><para>trendline.Type = TrendLineType.Polynomial;</para><para>//Set trendline order</para><para>trendline.Order = 6;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example Shadow
Gets the shadow.Read-only.
Examples
The following code illustrates how to access and format the IShadow for IChartTrendLine:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart</para><para>Chart chart = worksheet.Charts.Add(ExcelChartType.ScatterMarkers);</para><para>//Add serie and set serie Y and X Values</para><para>IChartSerie serie = chart.Series.Add();</para><para>serie.Values = worksheet.Range["A2:C2"];</para><para>serie.CategoryLabels = worksheet.Range["A1:C1"];</para><para>//Get chart trendlines collection and Add trendline</para><para>IChartTrendLines trendLines = serie.TrendLines;</para><para>IChartTrendLine trendline = trendLines.Add();</para><para>//Set trendline shadow color</para><para>trendline.Shadow.Color = Color.Red;</para><para>//Set trendline shadow outer presets</para><para>trendline.Shadow.ShadowOuterType = XLSXChartShadowOuterType.OffsetDiagonalTopRight;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Public property Code example Type
Represents trend line type.
Examples
The following code illustrates how to set TrendLineType for IChartTrendLine object:
Copy 
<para>//Create worksheet</para><para>Workbook workbook = new Workbook();</para><para>workbook.LoadFromFile("Sample.xlsx");</para><para>Worksheet worksheet = workbook.Worksheets[0];</para><para>//Create chart and Get chart serie</para><para>Chart chart = worksheet.Charts.Add(ExcelChartType.ColumnClustered);</para><para>chart.DataRange = worksheet.Range["A1:C3"];</para><para>IChartSerie serie = chart.Series[0];</para><para>//Get chart trendlines collection and Add trendline</para><para>IChartTrendLines trendLines = serie.TrendLines;</para><para>IChartTrendLine trendline = trendLines.Add();</para><para>//Set trendline type</para><para>trendline.Type = TrendLineType.Polynomial;</para><para>//Save to file</para><para>workbook.SaveToFile("Chart.xlsx");</para>
Top
Methods
Name Description
Public method ClearFormats
Clears current trend line.
Top
See Also