XlsBaseChart Class

Implements common functionality in an ExcelChart interface for xls or xlsx charts.

Syntax

Namespace: FlexCel.XlsAdapter

public abstract class XlsBaseChart: ExcelChart

Fields

Name	Description
Workbook	Workbook holding the chart.
CurrentSheet	Identifier of the current sheet.
FDefaultFont	Default font.
FDefaultLabelFont	Default font for labels.
FDefaultAxisFont	Default font for Axis.
FDefaultTitleFont	Default font for the chart title.
FDefaultAxis​Title​Font	Default font for the chart axis title.
FVerticalFontScaling	Vertical font scaling.
FHorizontalFont​Scaling	Horizontal font scaling.

Methods

Name	Description
DoAfterConstruction	This method will be called after the chart has been created.
CheckConnected	Checks if the chart is already loaded.
CheckRange	Checks if a parameter is in the range.
CheckRangeObjPath	Checks if an ObjPath is in the range.
CheckRangeObj​Path​OrImage​Index	Checks that a range or path are between bounds. Internal use.
GetImageProperties	Returns image position and size.
HasImageAlternate	Returns true if the image has an alternate representation. This currently happens only with SVG images, which have a PNG base and an SVG alternate. If the image has an alternate, you can get the data with ExcelChart.​Get​Image​Alternate
AddImage	Adds an image to the active sheet. Note that for SVG images, xlsx files store both a PNG and SVG image. To enter an SVG image, use ExcelChart.​Add​Image​Alternate
AddImageAlternate	Adds an image to the active sheet. Currently this method is only needed for SVG images, since SVG images are stored as both PNG and SVG inside the xlsx file. This method allows you to supply both images.
DeleteImage	Deletes the image at position imageIndex. Note that if the image is grouped, this will remove the full group. To remove a particular image inside a group, use ExcelChart.​Delete​Object(​​Int32, String).
ClearImage	Clears the image at position imageIndex, leaving an empty white box.
AddAutoShape	Adds an autoshape to an existing embedded chart. Note that the coordinates for the shape are in chart coords, meaning that only row1, row2, col1 and col2 are used, and they represent the percentage in 1/4000 of the coordinate. So 0 means the top and left of the parent chart, and 4000 means the bottom and right of the parent chart.
SetShapeLinkedCell	Links the shape or image to a cell, if the shape can be linked. To unlink the cell, make linkedCell null. Note that this method applies to shapes like a rectangle or a circle, or an image, not to the link of a forms object like a combobox or a radiobutton.
GetShapeLinkedCell	Returns the cell that is linked to the shape or image. If the object isn't linked, this method will return null. Note that when you change the value in the cell linked to this object, the value of the object will change. Also note that this method applies to shapes like a rectangle or circle, or an image. Objects like a combobox won't be reported by this method.
ImageIndexTo​Object​Path	Returns the absolute object path for an image, given an image index. Note that this method can be slow if there are many objects in the file. Whenever possible, prefer the methods that take directly an imageIndex instead of converting the imageIndex to an objectPath.

Properties

Name	Description
DefaultFont	Returns the default font for all text in the chart that does not have a font defined.
DefaultLabelFont	Returns the default font for all labels in the chart that do not have a font defined.
DefaultAxisFont	Returns the default font for the Axis in the chart that do not have a font defined.
DefaultAxisTitleFont	Returns the default font for the Axis title in the chart that do not have a font defined.
DefaultTitleFont	Returns the default font for the Title in the chart that do not have a font defined.
ImageCount	The number of images in the chart.