Skip to main content

ApiChart

ApiChart is a subclass of ApiDrawing.

Methods

MethodReturnsDescription
AddSeriaNoneAdds a new series to the current chart.
ApplyChartStylebooleanSets a style to the current chart by style ID.
FillbooleanSets the fill formatting properties to the current graphic object.
GetAllSeriesApiChartSeries[]Returns all series from the chart space.
GetChartTypeChartTypeReturns a type of the chart object.
GetClassType"chart"Returns a type of the ApiChart class.
GetFlipHboolean | nullGet horizontal flip of current drawing.
GetFlipVboolean | nullGet vertical flip of current drawing.
GetHeightEMUReturns the height of the current drawing.
GetLockValuebooleanReturns the lock value for the specified lock type of the current drawing.
GetNamestringReturns the name of the current drawing.
GetParentSheetApiWorksheetReturns the parent sheet of the current drawing.
GetRotationnumberReturns the rotation angle of the current drawing object.
GetSeriesApiChartSeriesReturns the series with a specific index.
GetTitlestring | nullReturns the chart title text.
GetWidthEMUReturns the width of the current drawing.
RemoveSeriabooleanRemoves the specified series from the current chart.
SelectNoneSelects the current graphic object.
SetAxieNumFormatbooleanSets the specified numeric format to the axis values.
SetCatFormulaNoneSets a range with the category values to the current chart.
SetDataPointFillbooleanSets the fill to the data point in the specified chart series.
SetDataPointOutLinebooleanSets the outline to the data point in the specified chart series.
SetFlipHbooleanSets the horizontal flip of the current drawing.
SetFlipVbooleanSets the vertical flip of the current drawing.
SetHorAxisLabelsFontSizebooleanSpecifies font size for labels of the horizontal axis.
SetHorAxisMajorTickMarkbooleanSpecifies major tick mark for the horizontal axis.
SetHorAxisMinorTickMarkbooleanSpecifies minor tick mark for the horizontal axis.
SetHorAxisOrientationbooleanSpecifies the horizontal axis orientation.
SetHorAxisTickLabelPositionbooleanSpicifies tick labels position for the horizontal axis.
SetHorAxisTitlebooleanSpecifies the chart horizontal axis title.
SetLegendFillbooleanSets the fill to the chart legend.
SetLegendFontSizebooleanSpecifies the legend font size.
SetLegendOutLinebooleanSets the outline to the chart legend.
SetLegendPosbooleanSpecifies the chart legend position.
SetLockValuebooleanSets the lock value to the specified lock type of the current drawing.
SetMajorHorizontalGridlinesbooleanSpecifies major horizontal gridline visual properties.
SetMajorVerticalGridlinesbooleanSpecifies major vertical gridline visual properties.
SetMarkerFillbooleanSets the fill to the marker in the specified chart series.
SetMarkerOutLinebooleanSets the outline to the marker in the specified chart series.
SetMinorHorizontalGridlinesbooleanSpecifies minor horizontal gridline visual properties.
SetMinorVerticalGridlinesbooleanSpecifies minor vertical gridline visual properties.
SetNamebooleanSets the name of the current drawing. If another drawing with the same name already exists, that drawing's name will be reset to a default auto-generated name.
SetOutLinebooleanSets the outline properties to the specified graphic object.
SetPlotAreaFillbooleanSets the fill to the chart plot area.
SetPlotAreaOutLinebooleanSets the outline to the chart plot area.
SetPositionNoneChanges the position for the drawing object. 💡 Please note that the horizontal and vertical offsets are calculated within the limits of the specified column and row cells only. If this value exceeds the cell width or height, another vertical/horizontal position will be set.
SetRotationbooleanSets the rotation angle to the current drawing object.
SetSeriaNamebooleanSets a name to the specified series.
SetSeriaValuesbooleanSets values from the specified range to the specified series.
SetSeriaXValuesbooleanSets the x-axis values from the specified range to the specified series. It is used with the scatter charts only.
SetSeriesFillbooleanSets the fill to the specified chart series.
SetSeriesOutLinebooleanSets the outline to the specified chart series.
SetShowDataLabelsbooleanSpecifies which chart data labels are shown for the chart.
SetShowPointDataLabelbooleanSpicifies the show options for data labels.
SetSizeNoneSets a size of the object (image, shape, chart) bounding box.
SetTitlebooleanSpecifies the chart title.
SetTitleFillbooleanSets the fill to the chart title.
SetTitleOutLinebooleanSets the outline to the chart title.
SetVerAxisOrientationbooleanSpecifies the vertical axis orientation.
SetVerAxisTitlebooleanSpecifies the chart vertical axis title.
SetVertAxisLabelsFontSizebooleanSpecifies font size for labels of the vertical axis.
SetVertAxisMajorTickMarkbooleanSpecifies major tick mark for the vertical axis.
SetVertAxisMinorTickMarkbooleanSpecifies minor tick mark for the vertical axis.
SetVertAxisTickLabelPositionbooleanSpicifies tick labels position for the vertical axis.
UnselectbooleanRemoves the current drawing from the selection.