LibreOffice: com::sun::star::chart Module Reference

LibreOffice LibreOffice 5.1 SDK API Reference

Modules | Classes | Typedefs | Enumerations
com::sun::star::chart Module Reference

Charting diagram interfaces. More...

## Constant Groups
constants | ChartAxisAssign
| These values specify to which y-axis a data row is assigned.
constants | ChartAxisMarks
| With these constants you can specify how the tick-marks of an axis are displayed.
constants | ChartAxisType
constants | ChartDataCaption
| These values specify how the captions of data points are displayed.
constants | ChartSolidType
| These values specify the type of solid shapes for data points of 3D bar charts.
constants | ChartSymbolType
| These values specify the type of the symbol used for data points.
constants | DataLabelPlacement
| These values specify where the captions/labels of data points are displayed.
constants | ErrorBarStyle
| specifies the style of error indicators.
constants | MissingValueTreatment
| This specifies how empty or invalid cells in the provided data should be handled when plotted.
constants | TimeUnit
| Specifies a unit for intervals on a date-time axis.

## Classes
service | AccessibleChartDocumentView
| The AccessibleChartDocumentView service is supported by a Component that represents the view of a Chart document to provide an entry point to the document tree for accessibility. More...
service | AccessibleChartElement
| This service is supported by all components that are contained in the view of a chart document that are controlled by the chart. More...
service | AreaDiagram
| This is a service for area diagrams. More...
service | BarDiagram
| This is a service for bar and column diagrams. More...
service | BubbleDiagram
| a service for bubble diagrams. More...
service | Chart3DBarProperties
| Specifies all the properties for the graphic object of a data point in a three-dimensional bar diagram. More...
service | ChartArea
| Specifies the area elements of a chart, e.g. More...
service | ChartAxis
| Specifies the axes in a diagram. More...
service | ChartAxisXSupplier
| has to be supported by charts providing the capabilities of a horizontal axis, i.e., an x-axis. More...
service | ChartAxisYSupplier
| A helper service for the y-axis. More...
service | ChartAxisZSupplier
| A helper service for chart documents which supply a z-axis. More...
service | ChartData
| must be supported by every component that wants to provide data for a chart More...
service | ChartDataArray
| must be supported by each data source for charts, where you want to access the values directly. More...
struct | ChartDataChangeEvent
| describes a change that was applied to the data. More...
service | ChartDataPointProperties
| specifies all the properties for the graphic object of a data point (e.g., a single bar in a bar chart). More...
struct | ChartDataRow
| describes a single data row, specified by its name and a sequence of data points. More...
service | ChartDataRowProperties
| specifies the properties for a group of graphic elements which belong to a data row (also known as data series). More...
struct | ChartDataValue
| describes a single data value, including the error More...
service | ChartDocument
| is the service for a chart document. More...
service | ChartGrid
| specifies the grid of the diagram in a chart. More...
service | ChartLegend
| specifies the legend of a chart. More...
service | ChartLine
| specifies line elements in a chart (regression lines, etc.). More...
service | ChartPieSegmentProperties
| specifies all the properties for the graphic object of a pie segment. More...
struct | ChartSeriesAddress
| This structure describes a single data row, specified by its name and a sequence of data points. More...
service | ChartStatistics
| offers statistical properties for the data in the chart. More...
service | ChartTableAddressSupplier
| This is a helper service for access to table Address to cell ranges of the container document of a chart. More...
service | ChartTitle
| specifies titles in a chart. More...
service | ChartTwoAxisXSupplier
| a helper service for chart documents which supply primary and secondary x-axes. More...
service | ChartTwoAxisYSupplier
| a helper service for chart documents which supply primary and secondary y-axes. More...
service | Diagram
| the base service for the diagram of the chart document. More...
service | Dim3DDiagram
| is a service for diagrams that support the capability to render themselves as three-dimensional diagrams as well as two-dimensional ones. More...
service | DonutDiagram
| a service for donut diagrams. More...
service | FilledNetDiagram
| specifies filled net diagrams. More...
service | LineDiagram
| specifies line, spline and symbol diagrams. More...
service | NetDiagram
| specifies net diagrams. More...
service | PieDiagram
| a service for pie diagrams. More...
service | StackableDiagram
| a helper service for stackable chart types (e.g., charts in which the data rows may be displayed stacked on each other or in percent relation). More...
service | StockDiagram
| specifies a diagram which can be used for presenting stock quotes. More...
struct | TimeIncrement
| A TimeIncrement describes how tickmarks are positioned on the scale of a date-time axis. More...
struct | TimeInterval
| Describes an interval on a date-axis. More...
interface | X3DDefaultSetter
| makes it easy to set suitable defaults for illumination and rotation for 3D charts More...
interface | X3DDisplay
| gives access to 3D elements of a three-dimensional chart. More...
interface | XAxis
| Allows easier access to the different subelements of an axis. More...
interface | XAxisSupplier
| Easier access to the different axes within a chart. More...
interface | XAxisXSupplier
| gives access to the x-axis of a chart. More...
interface | XAxisYSupplier
| gives access to the y-axis of a chart. More...
interface | XAxisZSupplier
| gives access to the z-axis of a chart. More...
interface | XChartData
| manages the data of the chart. More...
interface | XChartDataArray
| gives access to data represented as an array of rows. More...
interface | XChartDataChangeEventListener
| makes it possible to receive events when chart data changes. More...
interface | XChartDocument
| manages the chart document. More...
interface | XComplexDescriptionAccess
| Offers access to complex column and row descriptions. More...
interface | XDateCategories
| Allows to set date values as categories. More...
interface | XDiagram
| manages the diagram of the chart document. More...
interface | XDiagramPositioning
| allow for different positioning options for a diagram More...
interface | XSecondAxisTitleSupplier
interface | XStatisticDisplay
| gives access to statistical elements for the chart. More...
interface | XTwoAxisXSupplier
| gives access to both the primary and the secondary x-axis of a chart. More...
interface | XTwoAxisYSupplier
| gives access to both the primary and the secondary y-axis of a diagram. More...
service | XYDiagram
| a service for X/Y diagrams (Also known as scatter charts). More...

## Typedefs
typedef sequence< ChartDataValue > | ChartDataPoint

## Enumerations
enum | ChartAxisArrangeOrderType { AUTO, SIDE_BY_SIDE, STAGGER_EVEN, STAGGER_ODD }
| Values specify the arrangement of the axes descriptions. More...
enum | ChartAxisLabelPosition { NEAR_AXIS, NEAR_AXIS_OTHER_SIDE, OUTSIDE_START, OUTSIDE_END }
| Specifies the position of the axis labels with respect to the axis on the scale of the crossing axis. More...
enum | ChartAxisMarkPosition { AT_LABELS, AT_AXIS, AT_LABELS_AND_AXIS }
| Specifies the position of the axis interval marks. More...
enum | ChartAxisPosition { ZERO, START, END, VALUE }
| Specifies the position of the axis on the scale of the crossing axis. More...
enum | ChartDataChangeType { ALL, DATA_RANGE, COLUMN_INSERTED, ROW_INSERTED, COLUMN_DELETED, ROW_DELETED }
| specifies the type of change that was applied to the data. More...
enum | ChartDataRowSource { ROWS, COLUMNS }
| specifies if the data rows (aka data series) displayed in the chart, take their values from the row or the column in the underlying data source (ChartDataArray). More...
enum | ChartErrorCategory { NONE, VARIANCE, STANDARD_DEVIATION, PERCENT, ERROR_MARGIN, CONSTANT_VALUE }
| specifies the category of error indicators. More...
enum | ChartErrorIndicatorType { NONE, TOP_AND_BOTTOM, UPPER, LOWER }
| specifies how the error is indicated. More...
enum | ChartLegendExpansion { WIDE, HIGH, BALANCED, CUSTOM }
| Specifies sizing aspects of the legend. More...
enum | ChartLegendPosition { NONE, LEFT, TOP, RIGHT, BOTTOM }
| specifies one of the default positions of the legend in relation to the diagram. More...
enum | ChartRegressionCurveType { NONE, LINEAR, LOGARITHM, EXPONENTIAL, POLYNOMIAL, POWER }
| specifies the type of the regression curve to be displayed. More...

## Detailed Description

Charting diagram interfaces.

## Typedef Documentation

## § ChartDataPoint

typedef sequence<ChartDataValue> ChartDataPoint
| published

Deprecated:

## Enumeration Type Documentation

## § ChartAxisArrangeOrderType

enum ChartAxisArrangeOrderType
| published

Values specify the arrangement of the axes descriptions.

Enumerator
AUTO | The descriptions are arranged automatically. If there is enough space to put them side by side, this arrangement is preferred. If the descriptions would overlap when arranged side by side, they are staggered.
SIDE_BY_SIDE | The descriptions are arranged side by side.
STAGGER_EVEN | The descriptions are alternately put on two lines with the even values out of the normal line.
STAGGER_ODD | The descriptions are alternately put on two lines with the odd values out of the normal line.

## § ChartAxisLabelPosition

enum ChartAxisLabelPosition
| published

Specifies the position of the axis labels with respect to the axis on the scale of the crossing axis.

Enumerator
NEAR_AXIS | The labels are placed adjacent to the axis. When the axis itself is placed at the minimum or maximum of the scale ( that is when the property CrossoverPosition equals ChartAxisPosition_MINIMUM or ChartAxisPosition_MAXIMUM) the labels are placed outside the coordinate system. Otherwise the labels are placed adjacent to the axis on that side that belongs to the lower values on the crossing axis. E.g. when the ChartAxisLabelPosition is set to NEAR_AXIS for an y axis the labels are placed adjacent to the y axis on that side that belongs to the lower x values.
NEAR_AXIS_OTHER_SIDE | The labels are placed adjacent to the axis on the opposite side as for NEAR_AXIS.
OUTSIDE_START | The labels are placed outside the coordinate region on that side where the crossing axis has its minimum value. E.g. when this is set for an y axis the labels are placed outside the diagram on that side where to the x axis has its minimum value.
OUTSIDE_END | The labels are placed outside the coordinate region on that side where the crossing axis has its maximum value. E.g. when this is set for an y axis the labels are placed outside the diagram on that side where to the x axis has its maximum value.

## § ChartAxisMarkPosition

enum ChartAxisMarkPosition
| published

Specifies the position of the axis interval marks.

Enumerator
AT_LABELS | The interval marks are drawn besides the axis labels.
AT_AXIS | The interval marks are drawn at the axis line. This makes a difference to "AT_LABELS" only when the labels are not placed near the axis ( See also ChartAxisLabelPosition).
AT_LABELS_AND_AXIS | Interval marks are drawn at the axis line and also besides the axis labels. This makes a difference to "AT_LABELS" only when the labels are not placed near the axis ( See also ChartAxisLabelPosition).

## § ChartAxisPosition

enum ChartAxisPosition
| published

Specifies the position of the axis on the scale of the crossing axis.

When the property is set at a x-axis it indicates a position on the scale of the primary y-axis. When the property is set at a y-axis it indicates a position on the scale of the primary x-axis.

Enumerator
ZERO | Cross the other axes at zero. If zero is not contained in the current scale the value is used which is nearest to zero.
START | Cross the other axes at their minimum scale value.
END | Cross the other axes at their maximum scale value.
VALUE | Cross the other axes at the value specified in the property CrossoverValue.

## § ChartDataChangeType

enum ChartDataChangeType
| published

specifies the type of change that was applied to the data.

Enumerator
ALL | Major changes were applied to the data.
DATA_RANGE | The range of columns and rows, given in the ChartDataChangeEvent, has changed.
COLUMN_INSERTED | The column given in the ChartDataChangeEvent, was inserted.
ROW_INSERTED | The row given in the ChartDataChangeEvent, was inserted.
COLUMN_DELETED | The column given in the ChartDataChangeEvent, was deleted.
ROW_DELETED | The row given in the ChartDataChangeEvent, was deleted.

## § ChartDataRowSource

enum ChartDataRowSource
| published

specifies if the data rows (aka data series) displayed in the chart, take their values from the row or the column in the underlying data source (ChartDataArray).

Enumerator
ROWS | values displayed as data rows are taken from the rows of the data source.
COLUMNS | values displayed as data rows are taken from the columns of the data source.

## § ChartErrorCategory

enum ChartErrorCategory
| published

specifies the category of error indicators.

Enumerator
NONE | error indicators are not displayed. displays no regression curve. no chart legend is displayed. displays no error indicators. To disable the legend you should set the property ChartDocument::HasLegend to `FALSE` instead of setting this value.
VARIANCE | displays error indicators for the variance of the data row.
STANDARD_DEVIATION | displays error indicators for the standard deviation (square root of variance) of the data row.
PERCENT | The length of the error indicators is calculated for each data point by taking the percentage given as ChartStatistics::PercentageError of its value. See also ChartStatistics
ERROR_MARGIN | The length of the error indicators for all data points is calculated by taking the percentage given as ChartStatistics::ErrorMargin of the largest data point value. See also ChartStatistics
CONSTANT_VALUE | displays the same lower and upper error indicators for all data points. The values for these are given as absolute numbers in ChartStatistics::ConstantErrorLow and ChartStatistics::ConstantErrorHigh See also ChartStatistics

## § ChartErrorIndicatorType

enum ChartErrorIndicatorType
| published

specifies how the error is indicated.

Enumerator
NONE | error indicators are not displayed. displays no regression curve. no chart legend is displayed. displays no error indicators. To disable the legend you should set the property ChartDocument::HasLegend to `FALSE` instead of setting this value.
TOP_AND_BOTTOM | displays both the upper and lower values.
UPPER | displays only the upper value.
LOWER | displays only the lower value.

## § ChartLegendExpansion

enum ChartLegendExpansion

Specifies sizing aspects of the legend.

Enumerator
WIDE | The legend entries are arranged in a single row if possible. If not enough space is available further rows are added. This is usually used for legends that are displayed at the top or bottom of the page.
HIGH | The legend entries are stacked in a single column if possible. If not enough space is available further columns are added. This is usually used for legends that are displayed on the left or right hand side of the page.
BALANCED | The legend entries are arranged in a way that the aspect ratio of the resulting legend is as near to 1 as possible.
CUSTOM | The size of the legend is given explicitly.

## § ChartLegendPosition

enum ChartLegendPosition
| published

specifies one of the default positions of the legend in relation to the diagram.

Enumerator
NONE | error indicators are not displayed. displays no regression curve. no chart legend is displayed. displays no error indicators. To disable the legend you should set the property ChartDocument::HasLegend to `FALSE` instead of setting this value.
LEFT | displays the chart legend on the left side of the diagram. The second entry in the legend is placed below the first one.
TOP | displays the chart legend above the diagram. The second entry in the legend is placed on the right hand side of the first one.
RIGHT | displays the chart legend on the right side of the diagram. The second entry in the legend is placed below the first one.
BOTTOM | displays the chart legend beneath the diagram. The second entry in the legend is placed on the right hand side of the first one.

## § ChartRegressionCurveType

enum ChartRegressionCurveType
| published

specifies the type of the regression curve to be displayed.

Enumerator
NONE | error indicators are not displayed. displays no regression curve. no chart legend is displayed. displays no error indicators. To disable the legend you should set the property ChartDocument::HasLegend to `FALSE` instead of setting this value.
LINEAR | displays a linear regression curve. The values of the series are approximated using the model y = A⋅x + B.
LOGARITHM | displays a linear logarithmic regression curve. The values of the series are approximated using the model y = A⋅log(x) + B.
EXPONENTIAL | displays an exponential regression curve. The values of the series are approximated using the model y = A⋅eB⋅x.
POLYNOMIAL | displays a polynomial regression curve.
POWER | displays a regression curve using a power function. The values of the series are approximated using the model y = A⋅xB. displays a moving average regression curve.