Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

unpublished service Legend
Usage Restrictions
not published
Description
Describes a legend for a Diagram.

Included Services - Summary
::com::sun::star::drawing::FillProperties
(referenced entity's summary:)
This is a set of properties to describe the style for rendering an area.
::com::sun::star::drawing::LineProperties
(referenced entity's summary:)
This is a set of properties to describe the style for rendering a Line.
::com::sun::star::beans::PropertySet
(referenced entity's summary:)
This is a generic service which should be supported by all servies which have properties.
Exported Interfaces - Summary
XLegend

The interface for registering and removing legend entries.

Properties' Summary
LegendPosition
AnchorPosition
Provides an automated position  
::com::sun::star::chart::ChartLegendExpansion
Expansion
Determines how the aspect ratio of the legend should roughly be.  
boolean
Show
Determines, whether the legend should be redered by the view.  
[ maybevoid ] ::com::sun::star::awt::Size
ReferencePageSize
contains the size of the page at the time when properties were set (e.g. the CharHeight).  
[ maybevoid ] RelativePosition
RelativePosition
The position is as a relative position on the page.  
Included Services - Details
::com::sun::star::drawing::FillProperties
(referenced entity's summary:)
This is a set of properties to describe the style for rendering an area.
::com::sun::star::drawing::LineProperties
(referenced entity's summary:)
This is a set of properties to describe the style for rendering a Line.
::com::sun::star::beans::PropertySet
(referenced entity's summary:)
This is a generic service which should be supported by all servies which have properties.
Exported Interfaces - Details
XLegend
Description
The interface for registering and removing legend entries.
Properties' Details
AnchorPosition
LegendPosition AnchorPosition;
Description
Provides an automated position
Expansion
::com::sun::star::chart::ChartLegendExpansion Expansion;
Description
Determines how the aspect ratio of the legend should roughly be.

Set the Expansion to ::::com::sun::star::chart::ChartLegendExpansion::HIGH for a legend that is positioned on the right or left hand side. Use ::LegendExpansion::WIDE for a legend that is positioned on top or the bottom.

Show
boolean Show;
Description
Determines, whether the legend should be redered by the view.
ReferencePageSize
[ maybevoid ] ::com::sun::star::awt::Size ReferencePageSize;
Description
contains the size of the page at the time when properties were set (e.g. the CharHeight).

This way it is possible to resize objects (like text) in the view without modifying the model.

RelativePosition
[ maybevoid ] RelativePosition RelativePosition;
Description
The position is as a relative position on the page.

If a relative position is given the legend is not automatically placed, but instead is placed relative on the page.

If void, the legend position is solely determined by the AnchorPosition.


 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.