Get Started

API Reference

Class

ChartBuilder

Edit on GitHub
Namespace OfficeIMO.Excel.Fluent
Assembly OfficeIMO.Excel
Source OfficeIMO.Excel/Fluent/ChartBuilder.cs:27
Modifiers sealed

Fluent builder for creating charts from an A1 range or table.

Inheritance

  • Object
  • ChartBuilder

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Methods

public ChartBuilder Area() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:80
Returns: ChartBuilder

Uses an area chart.

public ChartBuilder Area3D() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:89
Returns: ChartBuilder

Uses a 3-D area chart.

public ChartBuilder Area3DStacked() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:92
Returns: ChartBuilder

Uses a 3-D stacked area chart.

public ChartBuilder Area3DStacked100() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:95
Returns: ChartBuilder

Uses a 3-D 100% stacked area chart.

public ChartBuilder AreaStacked() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:83
Returns: ChartBuilder

Uses a stacked area chart.

public ChartBuilder AreaStacked100() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:86
Returns: ChartBuilder

Uses a 100% stacked area chart.

public ExcelChart At(Int32 row, Int32 column) #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:198
Returns: ExcelChart

Creates the chart at the given worksheet coordinates.

Parameters

row System.Int32 requiredposition: 0
column System.Int32 requiredposition: 1
public ChartBuilder Bar3DClustered() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:59
Returns: ChartBuilder

Uses a 3-D clustered bar chart.

public ChartBuilder Bar3DStacked() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:62
Returns: ChartBuilder

Uses a 3-D stacked bar chart.

public ChartBuilder Bar3DStacked100() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:65
Returns: ChartBuilder

Uses a 3-D 100% stacked bar chart.

public ChartBuilder BarClustered() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:50
Returns: ChartBuilder

Uses a clustered bar chart.

public ChartBuilder BarOfPie() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:107
Returns: ChartBuilder

Uses a bar-of-pie chart.

public ChartBuilder BarStacked() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:53
Returns: ChartBuilder

Uses a stacked bar chart.

public ChartBuilder BarStacked100() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:56
Returns: ChartBuilder

Uses a 100% stacked bar chart.

public ChartBuilder CachedData(Boolean includeCachedData = true) #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:182
Returns: ChartBuilder

Controls whether cached chart data is written.

Parameters

includeCachedData System.Boolean = true optionalposition: 0
public ChartBuilder Column3DClustered() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:41
Returns: ChartBuilder

Uses a 3-D clustered column chart.

public ChartBuilder Column3DStacked() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:44
Returns: ChartBuilder

Uses a 3-D stacked column chart.

public ChartBuilder Column3DStacked100() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:47
Returns: ChartBuilder

Uses a 3-D 100% stacked column chart.

public ChartBuilder ColumnClustered() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:32
Returns: ChartBuilder

Uses a clustered column chart.

public ChartBuilder ColumnStacked() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:35
Returns: ChartBuilder

Uses a stacked column chart.

public ChartBuilder ColumnStacked100() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:38
Returns: ChartBuilder

Uses a 100% stacked column chart.

public ChartBuilder Contribution(String title = "Contribution", Int32 widthPixels = 520, Int32 heightPixels = 320) #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:160
Returns: ChartBuilder

Uses doughnut-chart defaults suitable for contribution and mix analysis.

Parameters

title System.String = "Contribution" optionalposition: 0
widthPixels System.Int32 = 520 optionalposition: 1
heightPixels System.Int32 = 320 optionalposition: 2
public ChartBuilder Doughnut() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:110
Returns: ChartBuilder

Uses a doughnut chart.

public ChartBuilder Headers(Boolean hasHeaders = true) #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:176
Returns: ChartBuilder

Controls whether the first row of a range contains headers.

Parameters

hasHeaders System.Boolean = true optionalposition: 0
public ChartBuilder KpiScorecard(String title = "KPI Scorecard", Int32 widthPixels = 520, Int32 heightPixels = 300) #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:155
Returns: ChartBuilder

Uses compact column-chart defaults suitable for a KPI scorecard.

Parameters

title System.String = "KPI Scorecard" optionalposition: 0
widthPixels System.Int32 = 520 optionalposition: 1
heightPixels System.Int32 = 300 optionalposition: 2
public ChartBuilder Line() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:68
Returns: ChartBuilder

Uses a line chart.

public ChartBuilder Line3D() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:77
Returns: ChartBuilder

Uses a 3-D line chart.

public ChartBuilder LineStacked() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:71
Returns: ChartBuilder

Uses a stacked line chart.

public ChartBuilder LineStacked100() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:74
Returns: ChartBuilder

Uses a 100% stacked line chart.

public ChartBuilder Pie() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:98
Returns: ChartBuilder

Uses a pie chart.

public ChartBuilder Pie3D() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:101
Returns: ChartBuilder

Uses a 3-D pie chart.

public ChartBuilder PieOfPie() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:104
Returns: ChartBuilder

Uses a pie-of-pie chart.

public ChartBuilder Radar() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:116
Returns: ChartBuilder

Uses a radar chart.

public ChartBuilder RevenueTrend(String title = "Revenue Trend", Int32 widthPixels = 720, Int32 heightPixels = 320) #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:135
Returns: ChartBuilder

Uses defaults suitable for a time-series revenue or volume trend.

Parameters

title System.String = "Revenue Trend" optionalposition: 0
widthPixels System.Int32 = 720 optionalposition: 1
heightPixels System.Int32 = 320 optionalposition: 2
public ChartBuilder Scatter() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:113
Returns: ChartBuilder

Uses a scatter chart. Category values must be numeric.

public ChartBuilder Size(Int32 widthPixels, Int32 heightPixels) #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:188
Returns: ChartBuilder

Sets the chart dimensions in pixels.

Parameters

widthPixels System.Int32 requiredposition: 0
heightPixels System.Int32 requiredposition: 1
public ChartBuilder StatusBreakdown(String title = "Status Breakdown", Int32 widthPixels = 520, Int32 heightPixels = 320) #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:140
Returns: ChartBuilder

Uses defaults suitable for a status, category, or allocation breakdown.

Parameters

title System.String = "Status Breakdown" optionalposition: 0
widthPixels System.Int32 = 520 optionalposition: 1
heightPixels System.Int32 = 320 optionalposition: 2
public ChartBuilder Stock() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:119
Returns: ChartBuilder

Uses a stock chart. Provide high-low-close or open-high-low-close series.

public ChartBuilder Surface() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:122
Returns: ChartBuilder

Uses a 3-D surface chart.

public ChartBuilder SurfaceContour() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:128
Returns: ChartBuilder

Uses a contour surface chart.

public ChartBuilder SurfaceContourWireframe() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:131
Returns: ChartBuilder

Uses a wireframe contour surface chart.

public ChartBuilder SurfaceWireframe() #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:125
Returns: ChartBuilder

Uses a wireframe 3-D surface chart.

public ChartBuilder Title(String title) #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:170
Returns: ChartBuilder

Sets the chart title.

Parameters

title System.String requiredposition: 0
public ChartBuilder TopNBar(String title = "Top Items", Int32 widthPixels = 640, Int32 heightPixels = 360) #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:145
Returns: ChartBuilder

Uses defaults suitable for ranking the largest items in a compact dashboard.

Parameters

title System.String = "Top Items" optionalposition: 0
widthPixels System.Int32 = 640 optionalposition: 1
heightPixels System.Int32 = 360 optionalposition: 2
public ChartBuilder Type(ExcelChartType type) #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:27
Returns: ChartBuilder

Uses a specific chart type.

Parameters

type OfficeIMO.Excel.ExcelChartType requiredposition: 0
public ChartBuilder VarianceColumns(String title = "Variance", Int32 widthPixels = 640, Int32 heightPixels = 360) #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:150
Returns: ChartBuilder

Uses defaults suitable for positive/negative variance comparisons.

Parameters

title System.String = "Variance" optionalposition: 0
widthPixels System.Int32 = 640 optionalposition: 1
heightPixels System.Int32 = 360 optionalposition: 2
public ChartBuilder VarianceWaterfall(String title = "Variance Bridge", Int32 widthPixels = 720, Int32 heightPixels = 360) #
OfficeIMO.Excel/Fluent/ChartBuilder.cs:165
Returns: ChartBuilder

Uses stacked-column defaults suitable for variance bridges prepared with helper series.

Parameters

title System.String = "Variance Bridge" optionalposition: 0
widthPixels System.Int32 = 720 optionalposition: 1
heightPixels System.Int32 = 360 optionalposition: 2