OfficeIMO

API Reference

Class

ExcelChartDataRange

Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Modifiers sealed

Represents the workbook range used for chart data (categories + series values).

Inheritance

  • Object
  • ExcelChartDataRange

Constructors

public ExcelChartDataRange(String sheetName, Int32 startRow, Int32 startColumn, Int32 categoryCount, Int32 seriesCount, Boolean hasHeaderRow = true) #

Creates a chart data range descriptor for categories and series values.

Parameters

sheetName System.String requiredposition: 0
startRow System.Int32 requiredposition: 1
startColumn System.Int32 requiredposition: 2
categoryCount System.Int32 requiredposition: 3
seriesCount System.Int32 requiredposition: 4
hasHeaderRow System.Boolean = true optionalposition: 5

Methods

public String SeriesNameCellA1(Int32 seriesIndex) #
Returns: String

Gets the header cell for the specified series (A1), or empty when no header row is used.

Parameters

seriesIndex System.Int32 requiredposition: 0
public String SeriesValuesRangeA1(Int32 seriesIndex) #
Returns: String

Gets the series values range as an A1 reference for the specified series.

Parameters

seriesIndex System.Int32 requiredposition: 0
public ExcelChartDataRange WithSize(Int32 categoryCount, Int32 seriesCount) #
Returns: ExcelChartDataRange

Returns a new range with updated category and series counts.

Parameters

categoryCount System.Int32 requiredposition: 0
seriesCount System.Int32 requiredposition: 1

Properties

public String SheetName { get; } #

Gets the worksheet name that owns the data range.

public Int32 StartRow { get; } #

Gets the 1-based starting row of the data range.

public Int32 StartColumn { get; } #

Gets the 1-based starting column of the data range.

public Int32 CategoryCount { get; } #

Gets the number of category rows.

public Int32 SeriesCount { get; } #

Gets the number of series columns.

public Boolean HasHeaderRow { get; } #

Gets whether the data range includes a header row.

public Int32 CategoryStartRow { get; } #

Gets the first row index that contains category values.

public Int32 CategoryEndRow { get; } #

Gets the last row index that contains category values.

public Int32 SeriesStartColumn { get; } #

Gets the first column index that contains series values.

public Int32 SeriesEndColumn { get; } #

Gets the last column index that contains series values.

public String DataRangeA1 { get; } #

Gets the data range (headers + categories + values) as an A1 reference.

public String CategoriesRangeA1 { get; } #

Gets the categories range as an A1 reference.