:: com :: sun :: star :: chart2 ::

service CandleStickChartType

Included Services - Summary
ChartType

The base service describing generic chart types.

Properties' Summary
[ maybedefault ] boolean
Japanese
If this property is `TRUE`, the candlesticks are shown as Japanese candlesticks. This implies that the property #ShowFirst is also `TRUE`.  
[ maybevoid ] ::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. the boxes shown for rising values.

 
[ maybevoid ] ::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. the boxes shown for falling values.

 
[ maybedefault ] 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. This also makes the role "values-first" mandatory.  
[ maybedefault ] boolean
ShowHighLow
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.  
Included Services - Details
ChartType
Description
The base service describing generic chart types.
Properties' Details
Japanese
[ maybedefault ] boolean Japanese;
Description
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
WhiteDay
[ maybevoid ] ::com::sun::star::beans::XPropertySet WhiteDay;
Description
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.

BlackDay
[ maybevoid ] ::com::sun::star::beans::XPropertySet BlackDay;
Description
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.

ShowFirst
[ maybedefault ] boolean ShowFirst;
Description
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`.

ShowHighLow
[ maybedefault ] boolean ShowHighLow;
Description
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`.


 
Top of Page