ApiChart

class ApiChart

Description

Class representing a chart.

Instance Methods

GetClassType(): chart

Returns a type of the ApiChart class.

GetChartType(): ChartType

Returns a type of the chart object.

SetTitle(sTitle, nFontSize, bIsBold)

Specifies the chart title.

SetHorAxisTitle(sTitle, nFontSize, bIsBold)

Specifies the chart horizontal axis title.

SetVerAxisTitle(sTitle, nFontSize, bIsBold)

Specifies the chart vertical axis title.

SetVerAxisOrientation(bIsMinMax)

Specifies the vertical axis orientation.

SetHorAxisOrientation(bIsMinMax)

Specifies the horizontal axis orientation.

SetLegendPos(sLegendPos)

Specifies the chart legend position.

SetLegendFontSize(nFontSize)

Specifies the legend font size.

SetShowDataLabels(bShowSerName, bShowCatName, bShowVal, bShowPercent)

Specifies which chart data labels are shown for the chart.

SetShowPointDataLabel(nSeriesIndex, nPointIndex, bShowSerName, bShowCatName, bShowVal, bShowPercent)

Spicifies the show options for data labels.

SetVertAxisTickLabelPosition(sTickLabelPosition)

Spicifies tick labels position for the vertical axis.

SetHorAxisTickLabelPosition(sTickLabelPosition)

Spicifies tick labels position for the horizontal axis.

SetHorAxisMajorTickMark(sTickMark)

Specifies major tick mark for the horizontal axis.

SetHorAxisMinorTickMark(sTickMark)

Specifies minor tick mark for the horizontal axis.

SetVertAxisMajorTickMark(sTickMark)

Specifies major tick mark for the vertical axis.

SetVertAxisMinorTickMark(sTickMark)

Specifies minor tick mark for the vertical axis.

SetMajorVerticalGridlines(oStroke)

Specifies major vertical gridline visual properties.

SetMinorVerticalGridlines(oStroke)

Specifies minor vertical gridline visual properties.

SetMajorHorizontalGridlines(oStroke)

Specifies major horizontal gridline visual properties.

SetMinorHorizontalGridlines(oStroke)

Specifies minor horizontal gridline visual properties.

SetHorAxisLablesFontSize(nFontSize)

Specifies font size for labels of the horizontal axis.

SetVertAxisLablesFontSize(nFontSize)

Specifies font size for labels of the vertical axis.

GetNextChart(): ApiChart | "null"

Returns the next inline chart if exists.

GetPrevChart(): ApiChart | "null"

Returns the previous inline chart if exists.

RemoveSeria(nSeria): boolean

Removes the specified series from the current chart.

SetSeriaValues(aValues, nSeria): boolean

Sets values to the specified chart series.

SetXValues(aValues): boolean

Sets the x-axis values to all chart series.

SetSeriaName(sName, nSeria): boolean

Sets a name to the specified chart series.

SetCategoryName(sName, nCategory): boolean

Sets a name to the specified chart category.

ApplyChartStyle(nStyleId): boolean

Sets a style to the current chart by style ID.

SetPlotAreaFill(oFill): boolean

Sets the fill to the chart plot area.

SetPlotAreaOutLine(oStroke): boolean

Sets the outline to the chart plot area.

SetSeriesFill(oFill, nSeries, bAll): boolean

Sets the fill to the specified chart series.

SetSeriesOutLine(oStroke, nSeries, bAll): boolean

Sets the outline to the specified chart series.

SetDataPointFill(oFill, nSeries, nDataPoint, bAllSeries): boolean

Sets the fill to the data point in the specified chart series.

SetDataPointOutLine(oStroke, nSeries, nDataPoint, bAllSeries): boolean

Sets the outline to the data point in the specified chart series.

SetMarkerFill(oFill, nSeries, nMarker, bAllMarkers): boolean

Sets the fill to the marker in the specified chart series.

SetMarkerOutLine(oStroke, nSeries, nMarker, bAllMarkers): boolean

Sets the outline to the marker in the specified chart series.

SetTitleFill(oFill): boolean

Sets the fill to the chart title.

SetTitleOutLine(oStroke): boolean

Sets the outline to the chart title.

SetLegendFill(oFill): boolean

Sets the fill to the chart legend.

SetLegendOutLine(oStroke): boolean

Sets the outline to the chart legend.

SetAxieNumFormat(sFormat, sAxiePos): boolean

Sets the specified numeric format to the axis values.

SetSeriaNumFormat(sFormat, nSeria): boolean

Sets the specified numeric format to the chart series.

SetDataPointNumFormat(sFormat, nSeria, nDataPoint, bAllSeries): boolean

Sets the specified numeric format to the chart data point.

GetAllSeries(): ApiChartSeries[]

Returns all series from the chart space.

GetSeries(nIdx): ApiChartSeries

Returns the series with specific index.

Get Help

  • If you have any questions about ONLYOFFICE Docs, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).