LibreOffice: HistogramDiagram Service Reference

LibreOffice LibreOffice 26.8 SDK API Reference

Loading...
Searching...
No Matches
HistogramDiagram Service Reference

This is a service for histogram diagrams. More...

`import "HistogramDiagram.idl";`

Inheritance diagram for HistogramDiagram:

## 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
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

## Public Attributes
double | BinWidth
| Specifies the width of each bin in the histogram.
long | BinCount
| Specifies the number of bins in the histogram.
long | FrequencyType
| Specifies the type of frequency representation (count or density).
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.

## 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
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 ()
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 Attributes inherited from UserDefinedAttributesSupplier
::com::sun::star::container::XNameContainer | UserDefinedAttributes
| This container holds the AttributeData elements that represent uninterpreted XML attributes.

## Detailed Description

This is a service for histogram diagrams.

## Exported Interfaces

## ◆ com::sun::star::chart::ChartAxisXSupplier

service com::sun::star::chart::ChartAxisXSupplier

## ◆ com::sun::star::chart::ChartStatistics

service com::sun::star::chart::ChartStatistics

## ◆ com::sun::star::chart::ChartTwoAxisYSupplier

service com::sun::star::chart::ChartTwoAxisYSupplier

## ◆ com::sun::star::chart::Diagram

service com::sun::star::chart::Diagram

## Member Data Documentation

## ◆ BinCount

long BinCount
| property

Specifies the number of bins in the histogram.

## ◆ BinWidth

double BinWidth
| property

Specifies the width of each bin in the histogram.

## ◆ FrequencyType

long FrequencyType
| property

Specifies the type of frequency representation (count or density).

The documentation for this service was generated from the following file:

- com/sun/star/chart/HistogramDiagram.idl