GrapeCity.Documents.Excel.Drawing.IChart

Interface IChart

Namespace

GrapeCity.Documents.Excel.Drawing

Assembly

GcDocs.Excel.dll

Represents a chart object in a worksheet.

public interface IChart

Properties

Area3DGroup

Returns the IChartGroup object that represents the area chart group on a 3-D chart.

IChartGroup Area3DGroup { get; }

Property Value

IChartGroup

AreaGroups

Returns an object that represents a collection of the area chart groups IChartGroups, on a 2D chart.

IChartGroups AreaGroups { get; }

Property Value

IChartGroups

AutoScaling

Gets or sets the scaling (True to scale a 3-D chart so that it's closer in size to the equivalent 2-D chart. The RightAngleAxes property must be True).

bool AutoScaling { get; set; }

Property Value

bool

Axes

Returns an object that represents a collection of the axes on the chart.

IAxes Axes { get; }

Property Value

IAxes

BackWall

Returns the IWall object that allows the user to individually format the back wall of a 3-D chart.

IWall BackWall { get; }

Property Value

IWall

Bar3DGroup

Returns the IChartGroup object that represents the bar chart group on a 3-D chart.

IChartGroup Bar3DGroup { get; }

Property Value

IChartGroup

BarGroups

Returns an object that represents a collection of the bar chart groups IChartGroups, on a 2D chart.

IChartGroups BarGroups { get; }

Property Value

IChartGroups

BarShape

Returns or sets the shape used with the 3-D bar or column chart.

BarShape BarShape { get; set; }

Property Value

BarShape

ChartArea

Returns the IChartArea object that represents the complete chart area for the chart.

IChartArea ChartArea { get; }

Property Value

IChartArea

ChartGroups

Returns an object that represents a collection of all the chart groups in the chart IChartGroups. The returned collection includes every type of group.

IChartGroups ChartGroups { get; }

Property Value

IChartGroups

ChartTitle

Returns the IChartTitle object that represents the title of the specified chart.

IChartTitle ChartTitle { get; }

Property Value

IChartTitle

ChartType

Returns or sets the chart type.

ChartType ChartType { get; set; }

Property Value

ChartType

Column3DGroup

Returns the IChartGroup object that represents the column chart group on a 3-D chart.

IChartGroup Column3DGroup { get; }

Property Value

IChartGroup

ColumnGroups

Returns an object that represents a collection of the column chart groups IChartGroups, on a 2D chart.

IChartGroups ColumnGroups { get; }

Property Value

IChartGroups

DataTable

Returns the IDataTable object that represents the chart data table.

IDataTable DataTable { get; }

Property Value

IDataTable

DepthPercent

Returns or sets the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).

int DepthPercent { get; set; }

Property Value

int

DisplayBlanksAs

Returns or sets the way that blank cells are plotted on a chart. Can be one of the following: DisplayBlanksAs constants: NotPlotted, Interpolated, or Zero.

DisplayBlanksAs DisplayBlanksAs { get; set; }

Property Value

DisplayBlanksAs

DisplayNaAsBlank

specifies whether to treat cells containing #N/A as if they were blank cells.

bool DisplayNaAsBlank { get; set; }

Property Value

bool

DoughnutGroups

Returns an object that represents a collection of the doughnut chart groups IChartGroups, on a 2D chart.

IChartGroups DoughnutGroups { get; }

Property Value

IChartGroups

Elevation

Returns or sets the elevation of the 3-D chart view in degrees.

double Elevation { get; set; }

Property Value

double

Floor

Returns the IFloor object that represents the floor of the 3-D chart.

IFloor Floor { get; }

Property Value

IFloor

GapDepth

Returns or sets the distance between the data series in a 3-D chart as a percentage of the marker width. The value of this property must be between 0 and 500.

int GapDepth { get; set; }

Property Value

int

HasDataTable

Gets or sets a value indicating whether the chart displays a data table.

bool HasDataTable { get; set; }

Property Value

bool

HasLegend

Gets or sets whether the chart has a legend.

bool HasLegend { get; set; }

Property Value

bool

HasTitle

Gets or sets whether the axis or chart has a visible title.

bool HasTitle { get; set; }

Property Value

bool

HeightPercent

Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent).

int HeightPercent { get; set; }

Property Value

int

Legend

Returns the ILegend object that represents the legend for the chart.

ILegend Legend { get; }

Property Value

ILegend

Line3DGroup

Returns the IChartGroup object that represents the line chart group on a 3-D chart.

IChartGroup Line3DGroup { get; }

Property Value

IChartGroup

LineGroups

Returns an object that represents a collection of the line chart groups IChartGroups, on a 2D chart.

IChartGroups LineGroups { get; }

Property Value

IChartGroups

Name

Returns the name of the object.

string Name { get; }

Property Value

string

Parent

Returns the parent IShape of the chart.

IShape Parent { get; }

Property Value

IShape

Perspective

Returns or sets the perspective for the 3-D chart view. Must be between 0 and 100. This property is ignored if the RightAngleAxes property is True.

int Perspective { get; set; }

Property Value

int

Pie3DGroup

Returns the IChartGroup object that represents the pie chart group on a 3-D chart.

IChartGroup Pie3DGroup { get; }

Property Value

IChartGroup

PieGroups

Returns an object that represents a collection of the pie chart groups IChartGroups, on a 2D chart.

IChartGroups PieGroups { get; }

Property Value

IChartGroups

PivotOptions

Returns a IPivotOptions object that represents the options whether to display pivot chart buttons.

IPivotOptions PivotOptions { get; }

Property Value

IPivotOptions

PivotTable

Returns a IPivotTable object that represents the PivotTable report containing the upper-left corner of the specified range, or the PivotTable report associated with the PivotChart report.

IPivotTable PivotTable { get; }

Property Value

IPivotTable

PlotArea

Returns the IPlotArea object that represents the plot area of a chart.

IPlotArea PlotArea { get; }

Property Value

IPlotArea

PlotVisibleOnly

Gets or sets whether visible cells are plotted. True if only visible cells are plotted. False if both visible and hidden cells are plotted.

bool PlotVisibleOnly { get; set; }

Property Value

bool

RadarGroups

Returns an object that represents a collection of the radar chart groups IChartGroups, on a 2D chart.

IChartGroups RadarGroups { get; }

Property Value

IChartGroups

RightAngleAxes

Gets or sets whether the chart axes are at right angles, independent of chart rotation or elevation. Applies only to 3-D line, column, and bar charts.

bool RightAngleAxes { get; set; }

Property Value

bool

Rotation

Returns or sets the rotation of the 3-D chart view (the rotation of the plot area around the z-axis in degrees). The value of this property must be from 0 to 360, except for 3-D bar charts, where the value must be from 0 to 44. The default value is 20. Applies only to 3-D charts.

double Rotation { get; set; }

Property Value

double

SeriesCollection

Returns an object that represents a collection of all the series in the chart.

ISeriesCollection SeriesCollection { get; }

Property Value

ISeriesCollection

Shapes

Returns all drawing shapes in this chart.

IEnumerable<IShape> Shapes { get; }

Property Value

System.Collections.Generic.IEnumerable<T><IShape>

ShowDataLabelsOverMaximum

Gets or sets whether to show the data labels when the value is greater than the maximum value on the value axis.

bool ShowDataLabelsOverMaximum { get; set; }

Property Value

bool

SideWall

Returns the IWall object that allows the user to individually format the side wall of a 3-D chart.

IWall SideWall { get; }

Property Value

IWall

SurfaceGroup

Returns the IChartGroup object that represents the surface chart group of a 3-D chart.

IChartGroup SurfaceGroup { get; }

Property Value

IChartGroup

Walls

Returns the IWall object that represents the walls of the 3-D chart.

IWall Walls { get; }

Property Value

IWall

XYGroups

Returns an object that represents a collection of the scatter chart groups IChartGroups, on a 2D chart.

IChartGroups XYGroups { get; }

Property Value

IChartGroups

Methods

AddChart(ChartType, double, double, double, double)

Creates a chart at the specified location on the chart.

IShape AddChart(ChartType chartType, double left, double top, double width, double height)

Parameters

chartType ChartType

The chart type

left double

The distance from the left edge of the chart to the left edge of the chart area, in points.

top double

The distance from the top edge of the chart to the top edge of the chart area, in points.

width double

The width of the chart, in points.

height double

The height of the chart, in points.

Returns

IShape

The IShape object.

AddChartInPixel(ChartType, double, double, double, double)

Creates a chart at the specified location on the active sheet.

IShape AddChartInPixel(ChartType chartType, double left, double top, double width, double height)

Parameters

chartType ChartType

The chart type

left double

The distance from the left edge of the chart to the left edge of the chart area, in pixels.

top double

The distance from the top edge of the chart to the top edge of the chart area, in pixels.

width double

The width of the chart, in pixels.

height double

The height of the chart, in pixels.

Returns

IShape

The IShape object.

AddConnector(ConnectorType, double, double, double, double)

Creates a connector. Returns the IShape object that represents the new connector.

IShape AddConnector(ConnectorType type, double beginX, double beginY, double endX, double endY)

Parameters

type ConnectorType

The connector type to add.

beginX double

The horizontal position of the connector's starting point relative to the upper-left corner of the chart area, in points.

beginY double

The vertical position of the connector's starting point relative to the upper-left corner of the chart area, in points.

endX double

The horizontal position of the connector's end point relative to the upper-left corner of the chart area, in points.

endY double

The veritcal position of the connector's end point relative to the upper-left corner of the chart area, in points.

Returns

IShape

The IShape object.

AddConnectorInPixel(ConnectorType, double, double, double, double)

Creates a connector. Returns the IShape object that represents the new connector.

IShape AddConnectorInPixel(ConnectorType type, double beginX, double beginY, double endX, double endY)

Parameters

type ConnectorType

The connector type to add.

beginX double

The horizontal position of the connector's starting point relative to the upper-left corner of the chart area, in pixels.

beginY double

The vertical position of the connector's starting point relative to the upper-left corner of the chart area, in pixels.

endX double

The horizontal position of the connector's end point relative to the upper-left corner of the chart area, in pixels.

endY double

The veritcal position of the connector's end point relative to the upper-left corner of the chart area, in pixels.

Returns

IShape

The IShape object.

AddPicture(Stream, ImageType, double, double, double, double)

Creates a picture from an existing stream. Returns the IShape object that represents the new picture.

IShape AddPicture(Stream stream, ImageType type, double left, double top, double width, double height)

Parameters

stream System.IO.Stream

The stream from which the object is to be created.

type ImageType

Specifies the type of picture to create.

left double

The distance from the left edge of the picture to the left edge of the chart area, in points.

top double

The distance from the top edge of the picture to the top edge of the chart area, in points.

width double

The width of the picture, in points.

height double

The height of the picture, in points.

Returns

IShape

The IShapeThe object.

AddPicture(string, double, double, double, double)

Creates a picture from an existing file. Returns the IShape object that represents the new picture.

IShape AddPicture(string filename, double left, double top, double width, double height)

Parameters

filename string

The file from which the object is to be created

left double

The distance from the left edge of the picture to the left edge of the chart area, in points.

top double

The distance from the top edge of the picture to the top edge of the chart area, in points.

width double

The width of the picture, in points.

height double

The height of the picture, in points.

Returns

IShape

The IShape object.

AddPictureInPixel(Stream, ImageType, double, double, double, double)

Creates a picture from an existing stream. Returns the IShape object that represents the new picture.

IShape AddPictureInPixel(Stream stream, ImageType type, double left, double top, double width, double height)

Parameters

stream System.IO.Stream

The stream from which the object is to be created.

type ImageType

Specifies the type of picture to create.

left double

The distance from the left edge of the picture to the left edge of the chart area, in pixels.

top double

The distance from the top edge of the picture to the top edge of the chart area, in pixels.

width double

The width of the picture, in pixels.

height double

The height of the picture, in pixels.

Returns

IShape

The IShapeThe object.

AddPictureInPixel(string, double, double, double, double)

Creates a picture from an existing file. Returns the IShape object that represents the new picture.

IShape AddPictureInPixel(string filename, double left, double top, double width, double height)

Parameters

filename string

The file from which the object is to be created

left double

The distance from the left edge of the picture to the left edge of the chart area, in pixels.

top double

The distance from the top edge of the picture to the top edge of the chart area, in pixels.

width double

The width of the picture, in pixels.

height double

The height of the picture, in pixels.

Returns

IShape

The IShape object.

AddShape(AutoShapeType, double, double, double, double)

Returns the IShape object that represents the new AutoShape in the chart.

IShape AddShape(AutoShapeType type, double left, double top, double width, double height)

Parameters

type AutoShapeType

Specifies the type of AutoShape to create.

left double

The distance from the left edge of the AutoShape's boundary box to the left edge of the chart area, in points.

top double

The distance from the top edge of the AutoShape's boundary box to the top edge of the chart area, in points.

width double

The width of the AutoShape's boundary box, in points.

height double

The height of the AutoShape's boundary box, in points.

Returns

IShape

The IShape object.

AddShapeInPixel(AutoShapeType, double, double, double, double)

Returns the IShape object that represents the new AutoShape in a worksheet.

IShape AddShapeInPixel(AutoShapeType type, double left, double top, double width, double height)

Parameters

type AutoShapeType

Specifies the type of AutoShape to create.

left double

The distance from the left edge of the AutoShape's boundary box to the left edge of the chart area, in pixels.

top double

The distance from the top edge of the AutoShape's boundary box to the top edge of the chart area, in pixels.

width double

The width of the AutoShape's boundary box, in pixels.

height double

The height of the AutoShape's boundary box, in pixels.

Returns

IShape

The IShape object.

Delete()

Deletes the object.

void Delete()

SetSourceData(IRange, RowCol)

Sets the source data range for the chart.

void SetSourceData(IRange source, RowCol plotBy)

Parameters

source IRange

The range that contains the source data.

plotBy RowCol

Specifies the way the data is to be plotted. Can be either of the following RowCol constants: Columns or Rows.

SetSourceData(IRange)

Sets the source data range for the chart.

void SetSourceData(IRange source)

Parameters

source IRange

The range that contains the source data.