LibreOffice
LibreOffice 6.2 SDK API Reference
Included Services | Public Attributes | List of all members
CandleStickChartType Service Reference

chart type service for candlestick charts. More...

import"CandleStickChartType.idl";

Inheritance diagram for CandleStickChartType:
ChartType XChartType XDataSeriesContainer XPropertySet XInterface XInterface XInterface

Included Services

service ChartType
 The base service describing generic chart types. More...
 

Public Attributes

boolean Japanese
 If this property is TRUE, the candlesticks are shown as Japanese candlesticks. More...
 
com::sun::star::beans::XPropertySet WhiteDay
 If the candlestick chart shows Japanese candlesticks, that is the property Japanese is TRUE, the property set given here contains the formatting attributes of the white boxes, i.e. More...
 
com::sun::star::beans::XPropertySet BlackDay
 If the candlestick chart shows Japanese candlesticks, that is the property Japanese is TRUE, the property set given here contains the formatting attributes of the black boxes, i.e. More...
 
boolean ShowFirst
 If this property is TRUE, the first value (which would be the opening course in a stock chart) is shown in the chart. More...
 
boolean ShowHighLow
 If this property is TRUE, the low and high values are shown in the chart. More...
 

Additional Inherited Members

- Exported Interfaces inherited from ChartType
interface XChartType
 
interface XDataSeriesContainer
 
interface com::sun::star::beans::XPropertySet
 provides chart-type-specific properties More...
 
- Public Member Functions inherited from XChartType
string getChartType ()
 A string representation of the chart type. More...
 
XCoordinateSystem createCoordinateSystem ([in] long DimensionCount) raises ( com::sun::star::lang::IllegalArgumentException )
 Creates a coordinate systems that fits the chart-type with its current settings and for the given dimension. More...
 
sequence< string > getSupportedMandatoryRoles ()
 Returns a sequence of roles that are understood by this chart type. More...
 
sequence< string > getSupportedOptionalRoles ()
 Returns a sequence of roles that are understood in addition to the mandatory roles (see XChartType::getSupportedMandatoryRoles()). More...
 
sequence< string > getSupportedPropertyRoles ()
 Returns a sequence with supported property mapping roles. More...
 
string getRoleOfSequenceForSeriesLabel ()
 Returns the role of the XLabeledDataSequence of which the label will be taken to identify the DataSeries in dialogs or the legend. More...
 
- 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 XDataSeriesContainer
void addDataSeries ([in] XDataSeries aDataSeries) raises ( com::sun::star::lang::IllegalArgumentException )
 add a data series to the data series container More...
 
void removeDataSeries ([in] XDataSeries aDataSeries) raises ( com::sun::star::container::NoSuchElementException )
 removes one data series from the data series container. More...
 
sequence< XDataSeriesgetDataSeries ()
 retrieve all data series More...
 
void setDataSeries ([in] sequence< XDataSeries > aDataSeries) raises ( com::sun::star::lang::IllegalArgumentException )
 set all data series More...
 
- 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...
 

Detailed Description

chart type service for candlestick charts.

Exported Interfaces

service ChartType

The base service describing generic chart types.

Member Data Documentation

com::sun::star::beans::XPropertySet BlackDay
propertymaybevoid

If the candlestick chart shows Japanese candlesticks, that is the property Japanese is TRUE, the property set given here contains the formatting attributes of the black boxes, i.e.

the boxes shown for falling values.

The com::sun::star::beans::XPropertySet given here must support the services com::sun::star::drawing::FillProperties and com::sun::star::drawing::LineProperties.

boolean Japanese
propertymaybedefault

If this property is TRUE, the candlesticks are shown as Japanese candlesticks.

This implies that the property ShowFirst is also TRUE.

Japanese candlesticks show the first and last value as boxes. A rising course (i.e. if the last value is greater than the first one) is shown by a white box. A falling course is shown by a black box.

Default is FALSE.

See also
WhiteDay
BlackDay
boolean ShowFirst
propertymaybedefault

If this property is TRUE, the first value (which would be the opening course in a stock chart) is shown in the chart.

This also makes the role "values-first" mandatory.

This property is only evaluated for non-Japanese candlestick charts, as Japanese candlesticks always require to show the first value.

Default is FALSE.

boolean ShowHighLow
propertymaybedefault

If this property is TRUE, the low and high values are shown in the chart.

This also makes the roles "values-min" and "values-max" mandatory.

Default is TRUE.

com::sun::star::beans::XPropertySet WhiteDay
propertymaybevoid

If the candlestick chart shows Japanese candlesticks, that is the property Japanese is TRUE, the property set given here contains the formatting attributes of the white boxes, i.e.

the boxes shown for rising values.

The com::sun::star::beans::XPropertySet given here must support the services com::sun::star::drawing::FillProperties and com::sun::star::drawing::LineProperties.


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