LibreOffice
LibreOffice 24.2 SDK API Reference
|
This is a service for bar and column diagrams. More...
import"BarDiagram.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::ChartAxisZSupplier |
service | com::sun::star::chart::Dim3DDiagram |
service | com::sun::star::chart::StackableDiagram |
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. More... | |
Included Services inherited from ChartTwoAxisYSupplier | |
service | com::sun::star::chart::ChartAxisYSupplier |
Public Attributes | |
boolean | Vertical |
Determines if the bars of a chart are drawn vertically or horizontally. More... | |
boolean | Deep |
If TRUE , determines that in a three-dimensional bar chart the bars of each series are arranged behind each other in the z-direction. More... | |
boolean | StackedBarsConnected |
determines if, in a stacked chart, there are connecting lines between corresponding bars. More... | |
boolean | GroupBarsPerAxis |
If bars of a bar or column chart are attached to different axis, this property determines how to display those. More... | |
long | NumberOfLines |
Determines how many data rows are displayed as lines rather than bars. More... | |
Public Attributes inherited from Diagram | |
boolean | AutomaticPosition |
If this property is TRUE the position is calculated by the application automatically. More... | |
boolean | AutomaticSize |
If this property is TRUE the size is calculated by the application automatically. More... | |
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. More... | |
long | DataCaption |
specifies how the caption of data points is displayed. More... | |
long | MissingValueTreatment |
specifies how empty or invalid cells in the provided data should be handled when displayed More... | |
Public Attributes inherited from ChartStatistics | |
double | ConstantErrorLow |
specifies the lower limit of the error range of a data row. More... | |
double | ConstantErrorHigh |
specifies the upper limit of the error range of a data row. More... | |
boolean | MeanValue |
determines if the mean value for a data row is displayed as a line. More... | |
com::sun::star::chart::ChartErrorCategory | ErrorCategory |
determines the type of error to indicate. More... | |
long | ErrorBarStyle |
determines the style of the error bars. More... | |
double | PercentageError |
specifies the percentage that is used to display error bars. More... | |
double | ErrorMargin |
specifies the percentage for the margin of errors. More... | |
com::sun::star::chart::ChartErrorIndicatorType | ErrorIndicator |
determines how the error is indicated. More... | |
com::sun::star::chart::ChartRegressionCurveType | RegressionCurves |
determines a type of regression for the data row values. More... | |
string | ErrorBarRangePositive |
contains a cell range string for positive error bars. More... | |
string | ErrorBarRangeNegative |
contains a cell range string for negative error bars. More... | |
Public Attributes inherited from ChartAxisXSupplier | |
boolean | HasXAxis |
This property determines if the x-axis is shown or hidden. More... | |
boolean | HasXAxisDescription |
Determines if the description of the x-axis is shown or hidden. More... | |
boolean | HasXAxisGrid |
Determines if the major grid of the x-axis is shown or hidden. More... | |
boolean | HasXAxisHelpGrid |
Determines if the minor grid of the x-axis is shown or hidden. More... | |
boolean | HasXAxisTitle |
Determines if the title of the x-axis is shown or hidden. More... | |
Public Attributes inherited from ChartTwoAxisYSupplier | |
boolean | HasSecondaryYAxis |
determines if the secondary y-axis is shown or hidden. More... | |
boolean | HasSecondaryYAxisDescription |
determines for the secondary y-axis if the labels at the tick marks are shown or hidden. More... | |
boolean | HasSecondaryYAxisTitle |
determines if the title of the secondary y-axis is shown or hidden. More... | |
Public Attributes inherited from ChartAxisYSupplier | |
boolean | HasYAxis |
Determines if the y-axis is shown or hidden. More... | |
boolean | HasYAxisDescription |
Determines if the description of the y-axis is shown or hidden. More... | |
boolean | HasYAxisGrid |
Determines if the major grid of the y-axis is shown or hidden. More... | |
boolean | HasYAxisHelpGrid |
Determines if the minor grid of the y-axis is shown or hidden. More... | |
boolean | HasYAxisTitle |
Determines if the title of the y-axis is shown or hidden. More... | |
Public Attributes inherited from ChartAxisZSupplier | |
boolean | HasZAxis |
Determines if the z-axis is shown or hidden. More... | |
boolean | HasZAxisDescription |
Determines if the description of the z-axis is shown or hidden. More... | |
boolean | HasZAxisGrid |
Determines if the major grid of the z-axis is shown or hidden. More... | |
boolean | HasZAxisHelpGrid |
Determines if the minor grid of the z-axis is shown or hidden. More... | |
boolean | HasZAxisTitle |
Determines if the title of the z-axis is shown or hidden. More... | |
Public Attributes inherited from Dim3DDiagram | |
boolean | Dim3D |
If set to TRUE , the chart becomes a three-dimensional chart. More... | |
long | Perspective |
Perspective of 3D charts ( [0,100] ). More... | |
long | RotationHorizontal |
Horizontal rotation of 3D charts in degrees ( ]-180,180] ). More... | |
long | RotationVertical |
Vertical rotation of 3D charts in degrees ( ]-180,180] ). More... | |
Public Attributes inherited from StackableDiagram | |
boolean | Percent |
If TRUE , the series of the diagram are stacked and each category sums up to 100%. More... | |
boolean | Stacked |
If TRUE , the series of the diagram are stacked. More... | |
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. More... | |
interface | com::sun::star::chart::XSecondAxisTitleSupplier |
Provides access to the titles of the secondary X axis and Y axis. More... | |
interface | com::sun::star::chart::XDiagramPositioning |
More... | |
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 More... | |
Exported Interfaces inherited from ChartTwoAxisYSupplier | |
interface | com::sun::star::chart::XTwoAxisYSupplier |
offers access to the axis object More... | |
Exported Interfaces inherited from ChartAxisYSupplier | |
interface | com::sun::star::chart::XAxisYSupplier |
offers access to the axis object, the title, and the grids More... | |
Exported Interfaces inherited from ChartAxisZSupplier | |
interface | com::sun::star::chart::XAxisZSupplier |
offers access to the axis object, the title, and the grids More... | |
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. More... | |
interface | ::com::sun::star::chart::X3DDefaultSetter |
makes it easy to set suitable defaults for illumination and rotation for 3D charts More... | |
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. More... | |
void | setPosition ([in] com::sun::star::awt::Point aPosition) |
sets the current position of this object More... | |
com::sun::star::awt::Size | getSize () |
gets the size of this object. More... | |
void | setSize ([in] com::sun::star::awt::Size aSize) raises ( com::sun::star::beans::PropertyVetoException ) |
sets the size of this object. More... | |
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. More... | |
void | acquire () |
increases the reference counter by one. More... | |
void | release () |
decreases the reference counter by one. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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 () |
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 More... | |
boolean | isAutomaticDiagramPositioning () |
void | setDiagramPositionExcludingAxes ([in] com::sun::star::awt::Rectangle PositionRect) |
place the inner diagram part excluding any axes, labels and titles More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
Protected Member Functions inherited from X3DDefaultSetter | |
void | set3DSettingsToDefault () |
The result may depend on the current chart type and the current shade mode. More... | |
void | setDefaultRotation () |
sets a suitable default for the rotation of the current 3D chart. More... | |
void | setDefaultIllumination () |
set suitable defaults for the illumination of the current 3D chart. More... | |
Protected Attributes inherited from UserDefinedAttributesSupplier | |
::com::sun::star::container::XNameContainer | UserDefinedAttributes |
This container holds the AttributeData elements that represent uninterpreted XML attributes. More... | |
This is a service for bar and column diagrams.
service com::sun::star::chart::Diagram |
|
optionalproperty |
If TRUE
, determines that in a three-dimensional bar chart the bars of each series are arranged behind each other in the z-direction.
If FALSE
the arrangement of bars is like in two-dimensional bar charts.
|
optionalproperty |
If bars of a bar or column chart are attached to different axis, this property determines how to display those.
If TRUE
, the bars are grouped together in one block for each axis, thus they are painted one group over the other.
If FALSE
, the bars are displayed side-by-side, as if they were all attached to the same axis.
If all data series of a bar or column chart are attached to only one axis, this property has no effect.
|
property |
Determines how many data rows are displayed as lines rather than bars.
If this property differs from zero the last BarDiagram::NumberOfLines data rows are shown as lines. It is currently supported by two dimensional vertical bar charts only.
|
optionalproperty |
determines if, in a stacked chart, there are connecting lines between corresponding bars.
Currently, bar charts with horizontal bars do not support this property.
|
property |
Determines if the bars of a chart are drawn vertically or horizontally.
Default is vertical.
If Vertical is FALSE
you get a column chart rather than a bar chart.