| LibreOffice
    LibreOffice 25.2 SDK API Reference | 
a service for X/Y diagrams (Also known as scatter charts). More...
import "XYDiagram.idl";
 
  
| Included Services | |
| service | com::sun::star::chart::Diagram | 
| service | com::sun::star::chart::ChartStatistics | 
| service | com::sun::star::chart::ChartAxisXSupplier | 
| service | com::sun::star::chart::ChartTwoAxisYSupplier | 
| service | com::sun::star::chart::LineDiagram | 
| Included Services inherited from Diagram | |
| service | com::sun::star::xml::UserDefinedAttributesSupplier | 
| If a Diagram may be stored as XML file, this service should be supported in order to preserve unparsed XML attributes. | |
| Included Services inherited from ChartTwoAxisYSupplier | |
| service | com::sun::star::chart::ChartAxisYSupplier | 
| Included Services inherited from LineDiagram | |
| service | com::sun::star::chart::Diagram | 
| service | com::sun::star::chart::ChartStatistics | 
| service | com::sun::star::chart::ChartAxisXSupplier | 
| service | com::sun::star::chart::ChartTwoAxisYSupplier | 
| service | com::sun::star::chart::ChartAxisZSupplier | 
| service | com::sun::star::chart::Dim3DDiagram | 
| service | com::sun::star::chart::StackableDiagram | 
| Additional Inherited Members | |
| Exported Interfaces inherited from Diagram | |
| interface | com::sun::star::chart::XDiagram | 
| interface | com::sun::star::chart::XAxisSupplier | 
| Provides easier access to the different axes and their sub elements. | |
| interface | com::sun::star::chart::XSecondAxisTitleSupplier | 
| Provides access to the titles of the secondary X axis and Y axis. | |
| interface | com::sun::star::chart::XDiagramPositioning | 
| interface | com::sun::star::beans::XPropertySet | 
| Exported Interfaces inherited from ChartStatistics | |
| interface | com::sun::star::beans::XPropertySet | 
| Exported Interfaces inherited from ChartAxisXSupplier | |
| interface | com::sun::star::chart::XAxisXSupplier | 
| offers access to the axis object, the title, and the grids | |
| Exported Interfaces inherited from ChartTwoAxisYSupplier | |
| interface | com::sun::star::chart::XTwoAxisYSupplier | 
| offers access to the axis object | |
| Exported Interfaces inherited from ChartAxisYSupplier | |
| interface | com::sun::star::chart::XAxisYSupplier | 
| offers access to the axis object, the title, and the grids | |
| Exported Interfaces inherited from ChartAxisZSupplier | |
| interface | com::sun::star::chart::XAxisZSupplier | 
| offers access to the axis object, the title, and the grids | |
| Exported Interfaces inherited from Dim3DDiagram | |
| interface | com::sun::star::chart::X3DDisplay | 
| gives access to the properties of the wall and floor objects of the three-dimensional cuboid that contains the actual diagram. | |
| interface | ::com::sun::star::chart::X3DDefaultSetter | 
| makes it easy to set suitable defaults for illumination and rotation for 3D charts | |
| Public Member Functions inherited from XDiagram | |
| string | getDiagramType () | 
| com::sun::star::beans::XPropertySet | getDataRowProperties ([in] long nRow) raises ( com::sun::star::lang::IndexOutOfBoundsException ) | 
| com::sun::star::beans::XPropertySet | getDataPointProperties ([in] long nCol, [in] long nRow) raises ( com::sun::star::lang::IndexOutOfBoundsException ) | 
| Public Member Functions inherited from XShape | |
| com::sun::star::awt::Point | getPosition () | 
| gets the current position of this object. | |
| void | setPosition ([in] com::sun::star::awt::Point aPosition) | 
| sets the current position of this object | |
| com::sun::star::awt::Size | getSize () | 
| gets the size of this object. | |
| void | setSize ([in] com::sun::star::awt::Size aSize) raises ( com::sun::star::beans::PropertyVetoException ) | 
| sets the size of this object. | |
| Public Member Functions inherited from XShapeDescriptor | |
| string | getShapeType () | 
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) | 
| queries for a new interface to an existing UNO object. | |
| void | acquire () | 
| increases the reference counter by one. | |
| void | release () | 
| decreases the reference counter by one. | |
| Public Member Functions inherited from XPropertySet | |
| com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () | 
| void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) | 
| sets the value of the property with the specified name. | |
| any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) | 
| void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) | 
| adds an XPropertyChangeListener to the specified property. | |
| void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) | 
| removes an XPropertyChangeListener from the listener list. | |
| void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) | 
| adds an XVetoableChangeListener to the specified property with the name PropertyName. | |
| void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) | 
| removes an XVetoableChangeListener from the listener list. | |
| Public Member Functions inherited from XAxisXSupplier | |
| com::sun::star::drawing::XShape | getXAxisTitle () | 
| com::sun::star::beans::XPropertySet | getXAxis () | 
| com::sun::star::beans::XPropertySet | getXMainGrid () | 
| com::sun::star::beans::XPropertySet | getXHelpGrid () | 
| Public Member Functions inherited from XTwoAxisYSupplier | |
| com::sun::star::beans::XPropertySet | getSecondaryYAxis () | 
| Public Member Functions inherited from XAxisYSupplier | |
| com::sun::star::drawing::XShape | getYAxisTitle () | 
| com::sun::star::beans::XPropertySet | getYAxis () | 
| com::sun::star::beans::XPropertySet | getYHelpGrid () | 
| com::sun::star::beans::XPropertySet | getYMainGrid () | 
| Public Member Functions inherited from XAxisZSupplier | |
| com::sun::star::drawing::XShape | getZAxisTitle () | 
| com::sun::star::beans::XPropertySet | getZMainGrid () | 
| com::sun::star::beans::XPropertySet | getZHelpGrid () | 
| com::sun::star::beans::XPropertySet | getZAxis () | 
| Public Member Functions inherited from X3DDisplay | |
| com::sun::star::beans::XPropertySet | getWall () | 
| com::sun::star::beans::XPropertySet | getFloor () | 
| Public Attributes inherited from Diagram | |
| boolean | AutomaticPosition | 
| If this property is TRUE the position is calculated by the application automatically. | |
| boolean | AutomaticSize | 
| If this property is TRUE the size is calculated by the application automatically. | |
| com::sun::star::chart::ChartDataRowSource | DataRowSource | 
| determines if the data for a data row is contained in the columns or in the rows of the data array. | |
| long | DataCaption | 
| specifies how the caption of data points is displayed. | |
| long | MissingValueTreatment | 
| specifies how empty or invalid cells in the provided data should be handled when displayed | |
| Public Attributes inherited from ChartStatistics | |
| double | ConstantErrorLow | 
| specifies the lower limit of the error range of a data row. | |
| double | ConstantErrorHigh | 
| specifies the upper limit of the error range of a data row. | |
| boolean | MeanValue | 
| determines if the mean value for a data row is displayed as a line. | |
| com::sun::star::chart::ChartErrorCategory | ErrorCategory | 
| determines the type of error to indicate. | |
| long | ErrorBarStyle | 
| determines the style of the error bars. | |
| double | PercentageError | 
| specifies the percentage that is used to display error bars. | |
| double | ErrorMargin | 
| specifies the percentage for the margin of errors. | |
| com::sun::star::chart::ChartErrorIndicatorType | ErrorIndicator | 
| determines how the error is indicated. | |
| com::sun::star::chart::ChartRegressionCurveType | RegressionCurves | 
| determines a type of regression for the data row values. | |
| string | ErrorBarRangePositive | 
| contains a cell range string for positive error bars. | |
| string | ErrorBarRangeNegative | 
| contains a cell range string for negative error bars. | |
| Public Attributes inherited from ChartAxisXSupplier | |
| boolean | HasXAxis | 
| This property determines if the x-axis is shown or hidden. | |
| boolean | HasXAxisDescription | 
| Determines if the description of the x-axis is shown or hidden. | |
| boolean | HasXAxisGrid | 
| Determines if the major grid of the x-axis is shown or hidden. | |
| boolean | HasXAxisHelpGrid | 
| Determines if the minor grid of the x-axis is shown or hidden. | |
| boolean | HasXAxisTitle | 
| Determines if the title of the x-axis is shown or hidden. | |
| Public Attributes inherited from ChartTwoAxisYSupplier | |
| boolean | HasSecondaryYAxis | 
| determines if the secondary y-axis is shown or hidden. | |
| boolean | HasSecondaryYAxisDescription | 
| determines for the secondary y-axis if the labels at the tick marks are shown or hidden. | |
| boolean | HasSecondaryYAxisTitle | 
| determines if the title of the secondary y-axis is shown or hidden. | |
| Public Attributes inherited from ChartAxisYSupplier | |
| boolean | HasYAxis | 
| Determines if the y-axis is shown or hidden. | |
| boolean | HasYAxisDescription | 
| Determines if the description of the y-axis is shown or hidden. | |
| boolean | HasYAxisGrid | 
| Determines if the major grid of the y-axis is shown or hidden. | |
| boolean | HasYAxisHelpGrid | 
| Determines if the minor grid of the y-axis is shown or hidden. | |
| boolean | HasYAxisTitle | 
| Determines if the title of the y-axis is shown or hidden. | |
| Public Attributes inherited from LineDiagram | |
| long | SymbolType | 
| determines which type of symbols are displayed. | |
| com::sun::star::awt::Size | SymbolSize | 
| specifies the size of symbols in 1/100th of a millimeter. | |
| string | SymbolBitmapURL | 
| Set this property to any valid URL that points to a graphic file. | |
| boolean | Lines | 
| determines if the chart type has lines connecting the data points or contains just symbols. | |
| long | SplineType | 
| determines if the chart is a spline-chart type and specifies the type of splines. | |
| long | SplineOrder | 
| specifies the power of the polynomials used for spline calculation | |
| long | SplineResolution | 
| determines the number of sampling points of a spline | |
| com::sun::star::graphic::XGraphic | SymbolBitmap | 
| Set this property to a graphic object which is then used as symbol for all series. | |
| Public Attributes inherited from ChartAxisZSupplier | |
| boolean | HasZAxis | 
| Determines if the z-axis is shown or hidden. | |
| boolean | HasZAxisDescription | 
| Determines if the description of the z-axis is shown or hidden. | |
| boolean | HasZAxisGrid | 
| Determines if the major grid of the z-axis is shown or hidden. | |
| boolean | HasZAxisHelpGrid | 
| Determines if the minor grid of the z-axis is shown or hidden. | |
| boolean | HasZAxisTitle | 
| Determines if the title of the z-axis is shown or hidden. | |
| Public Attributes inherited from Dim3DDiagram | |
| boolean | Dim3D | 
| If set to TRUE, the chart becomes a three-dimensional chart. | |
| long | Perspective | 
| Perspective of 3D charts ( [0,100] ). | |
| long | RotationHorizontal | 
| Horizontal rotation of 3D charts in degrees ( ]-180,180] ). | |
| long | RotationVertical | 
| Vertical rotation of 3D charts in degrees ( ]-180,180] ). | |
| Public Attributes inherited from StackableDiagram | |
| boolean | Percent | 
| If TRUE, the series of the diagram are stacked and each category sums up to 100%. | |
| boolean | Stacked | 
| If TRUE, the series of the diagram are stacked. | |
| Protected Member Functions inherited from XAxisSupplier | |
| com::sun::star::chart::XAxis | getAxis ([in] long nDimensionIndex) | 
| com::sun::star::chart::XAxis | getSecondaryAxis ([in] long nDimensionIndex) | 
| Protected Member Functions inherited from XSecondAxisTitleSupplier | |
| com::sun::star::drawing::XShape | getSecondXAxisTitle () | 
| com::sun::star::drawing::XShape | getSecondYAxisTitle () | 
| Protected Member Functions inherited from XDiagramPositioning | |
| void | setAutomaticDiagramPositioning () | 
| the diagram will be placed automatically | |
| boolean | isAutomaticDiagramPositioning () | 
| void | setDiagramPositionExcludingAxes ([in] com::sun::star::awt::Rectangle PositionRect) | 
| place the inner diagram part excluding any axes, labels and titles | |
| boolean | isExcludingDiagramPositioning () | 
| com::sun::star::awt::Rectangle | calculateDiagramPositionExcludingAxes () | 
| void | setDiagramPositionIncludingAxes ([in] com::sun::star::awt::Rectangle PositionRect) | 
| place the outer diagram part including the axes and axes labels, but excluding the axes titles. | |
| com::sun::star::awt::Rectangle | calculateDiagramPositionIncludingAxes () | 
| void | setDiagramPositionIncludingAxesAndAxisTitles ([in] com::sun::star::awt::Rectangle PositionRect) | 
| place the diagram including the axes, axes labels and axes titles. | |
| com::sun::star::awt::Rectangle | calculateDiagramPositionIncludingAxesAndAxisTitles () | 
| Protected Member Functions inherited from XPropertySet | |
| com::sun::star::beans::XPropertySetInfo | getPropertySetInfo () | 
| void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException ) | 
| sets the value of the property with the specified name. | |
| any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) | 
| void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) | 
| adds an XPropertyChangeListener to the specified property. | |
| void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) | 
| removes an XPropertyChangeListener from the listener list. | |
| void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) | 
| adds an XVetoableChangeListener to the specified property with the name PropertyName. | |
| void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException ) | 
| removes an XVetoableChangeListener from the listener list. | |
| Protected Member Functions inherited from X3DDefaultSetter | |
| void | set3DSettingsToDefault () | 
| The result may depend on the current chart type and the current shade mode. | |
| void | setDefaultRotation () | 
| sets a suitable default for the rotation of the current 3D chart. | |
| void | setDefaultIllumination () | 
| set suitable defaults for the illumination of the current 3D chart. | |
| Protected Attributes inherited from UserDefinedAttributesSupplier | |
| ::com::sun::star::container::XNameContainer | UserDefinedAttributes | 
| This container holds the AttributeData elements that represent uninterpreted XML attributes. | |
a service for X/Y diagrams (Also known as scatter charts).
The special thing about X/Y diagrams is that the first series of data contains x-values. The other series contain y-values. Together both form two-dimensional coordinates, at which data points are placed.
| service com::sun::star::chart::Diagram |