ApiChart

ApiChart is a subclass of ApiDrawing.

Methods

Method	Returns	Description
AddBreak	boolean	Inserts a break at the specified location in the main document.
ApplyChartStyle	boolean	Sets a style to the current chart by style ID.
Copy	ApiChart	Copies the current chart.
Delete	boolean	Deletes the current graphic object.
Fill	boolean	Sets the fill formatting properties to the current graphic object.
GetAllSeries	ApiChartSeries[]	Returns all series from the chart space.
GetChartType	ChartType	Returns a type of the chart object.
GetClassType	"chart"	Returns a type of the ApiChart class.
GetContent	ApiDocumentContent	Returns the drawing inner contents where a paragraph or text runs can be inserted if it exists.
GetFlipH	boolean | null	Get horizontal flip of current drawing.
GetFlipV	boolean | null	Get vertical flip of current drawing.
GetHeight	EMU	Returns the height of the current drawing.
GetLockValue	boolean	Returns the lock value for the specified lock type of the current drawing.
GetName	string	Returns the name of the current drawing.
GetNextChart	ApiChart | null	Returns the next inline chart if exists.
GetNextDrawing	ApiDrawing | null	Returns the next inline drawing object if exists.
GetParentContentControl	ApiBlockLvlSdt | null	Returns a parent content control that contains the graphic object.
GetParentParagraph	ApiParagraph | null	Returns a parent paragraph that contains the graphic object.
GetParentTable	ApiTable | null	Returns a parent table that contains the graphic object.
GetParentTableCell	ApiTableCell | null	Returns a parent table cell that contains the graphic object.
GetPrevChart	ApiChart | null	Returns the previous inline chart if exists.
GetPrevDrawing	ApiDrawing | null	Returns the previous inline drawing object if exists.
GetRotation	number	Returns the rotation angle of the current drawing object.
GetSeries	ApiChartSeries	Returns the series with a specific index.
GetTitle	string | null	Returns the chart title text.
GetWidth	EMU	Returns the width of the current drawing.
InsertInContentControl	ApiDrawing | ApiBlockLvlSdt	Wraps the graphic object with a rich text content control.
InsertParagraph	ApiParagraph | ApiDrawing	Inserts a paragraph at the specified position.
RemoveSeria	boolean	Removes the specified series from the current chart.
ScaleHeight	boolean	Scales the height of the figure using the specified coefficient.
ScaleWidth	boolean	Scales the width of the figure using the specified coefficient.
Select	boolean	Selects the current graphic object.
SetAxieNumFormat	boolean	Sets the specified numeric format to the axis values.
SetCategoryName	boolean	Sets a name to the specified chart category.
SetDataPointFill	boolean	Sets the fill to the data point in the specified chart series.
SetDataPointNumFormat	boolean	Sets the specified numeric format to the chart data point.
SetDataPointOutLine	boolean	Sets the outline to the data point in the specified chart series.
SetDistances	boolean	Specifies the minimum distance which will be maintained between the edges of the current drawing object and any
SetDrawingPrFromDrawing	boolean	Sets the properties from another drawing to the current drawing.
SetFlipH	boolean	Sets the horizontal flip of the current drawing.
SetFlipV	boolean	Sets the vertical flip of the current drawing.
SetHorAlign	boolean	Specifies how the floating object will be horizontally aligned.
SetHorAxisLabelsFontSize	boolean	Specifies font size for labels of the horizontal axis.
SetHorAxisMajorTickMark	boolean	Specifies major tick mark for the horizontal axis.
SetHorAxisMinorTickMark	boolean	Specifies minor tick mark for the horizontal axis.
SetHorAxisOrientation	boolean	Specifies the horizontal axis orientation.
SetHorAxisTickLabelPosition	boolean	Spicifies tick labels position for the horizontal axis.
SetHorAxisTitle	boolean	Specifies the chart horizontal axis title.
SetHorFlip	boolean	Flips the current drawing horizontally.
SetHorPosition	boolean	Sets the absolute measurement for the horizontal positioning of the floating object.
SetLegendFill	boolean	Sets the fill to the chart legend.
SetLegendFontSize	boolean	Specifies the legend font size.
SetLegendOutLine	boolean	Sets the outline to the chart legend.
SetLegendPos	boolean	Specifies the chart legend position.
SetLockValue	boolean	Sets the lock value to the specified lock type of the current drawing.
SetMajorHorizontalGridlines	boolean	Specifies major horizontal gridline visual properties.
SetMajorVerticalGridlines	boolean	Specifies major vertical gridline visual properties.
SetMarkerFill	boolean	Sets the fill to the marker in the specified chart series.
SetMarkerOutLine	boolean	Sets the outline to the marker in the specified chart series.
SetMinorHorizontalGridlines	boolean	Specifies minor horizontal gridline visual properties.
SetMinorVerticalGridlines	boolean	Specifies minor vertical gridline visual properties.
SetName	boolean	Sets the name of the current drawing.
SetOutLine	boolean	Sets the outline properties to the specified graphic object.
SetPlotAreaFill	boolean	Sets the fill to the chart plot area.
SetPlotAreaOutLine	boolean	Sets the outline to the chart plot area.
SetRelativeHeight	boolean	Sets the relative height of the object (image, shape, chart) bounding box.
SetRelativeWidth	boolean	Sets the relative width of the object (image, shape, chart) bounding box.
SetRotation	boolean	Sets the rotation angle to the current drawing object.
SetSeriaName	boolean	Sets a name to the specified chart series.
SetSeriaNumFormat	boolean	Sets the specified numeric format to the chart series.
SetSeriaValues	boolean	Sets values to the specified chart series.
SetSeriesFill	boolean	Sets the fill to the specified chart series.
SetSeriesOutLine	boolean	Sets the outline to the specified chart series.
SetShowDataLabels	boolean	Specifies which chart data labels are shown for the chart.
SetShowPointDataLabel	boolean	Spicifies the show options for data labels.
SetSize	boolean	Sets the size of the object (image, shape, chart) bounding box.
SetTitle	boolean	Specifies the chart title.
SetTitleFill	boolean	Sets the fill to the chart title.
SetTitleOutLine	boolean	Sets the outline to the chart title.
SetVerAlign	boolean	Specifies how the floating object will be vertically aligned.
SetVerAxisOrientation	boolean	Specifies the vertical axis orientation.
SetVerAxisTitle	boolean	Specifies the chart vertical axis title.
SetVerPosition	boolean	Sets the absolute measurement for the vertical positioning of the floating object.
SetVertAxisLabelsFontSize	boolean	Specifies font size for labels of the vertical axis.
SetVertAxisMajorTickMark	boolean	Specifies major tick mark for the vertical axis.
SetVertAxisMinorTickMark	boolean	Specifies minor tick mark for the vertical axis.
SetVertAxisTickLabelPosition	boolean	Spicifies tick labels position for the vertical axis.
SetVertFlip	boolean	Flips the current drawing vertically.
SetWrappingStyle	boolean	Sets the wrapping type of the current object (image, shape, chart). One of the following wrapping style types can be set:
SetXValues	boolean	Sets the x-axis values to all chart series. It is used with the scatter charts only.
ToJSON	JSON	Converts the ApiDrawing object into the JSON object.
Unselect	boolean	Removes the current graphic object from the selection.