Describes a legend for a Diagram. More...

import"Legend.idl";

Inheritance diagram for Legend:

Included Services
service	::com::sun::star::drawing::FillProperties

service	::com::sun::star::drawing::LineProperties

service	::com::sun::star::beans::PropertySet

Exported Interfaces
interface	::com::sun::star::chart2::XLegend
	The interface for registering and removing legend entries. More...

Exported Interfaces inherited from PropertySet
interface	com::sun::star::beans::XPropertySet

interface	com::sun::star::beans::XFastPropertySet

interface	com::sun::star::beans::XMultiPropertySet

interface	com::sun::star::beans::XPropertyAccess

interface	com::sun::star::beans::XPropertyState

Public Attributes
LegendPosition	AnchorPosition
	Provides an automated position. More...

::com::sun::star::chart::ChartLegendExpansion	Expansion
	Determines how the aspect ratio of the legend should roughly be. More...

boolean	Show
	Determines, whether the legend should be rendered by the view. More...

boolean	Overlay
	Determines, whether the legend should overlay the chart. More...

com::sun::star::awt::Size	ReferencePageSize
	contains the size of the page at the time when properties were set (e.g. More...

::com::sun::star::chart2::RelativePosition	RelativePosition
	The position is as a relative position on the page. More...

Public Attributes inherited from FillProperties
FillStyle	FillStyle
	This enumeration selects the style the area will be filled with. More...

com::sun::star::util::Color	FillColor
	If the property FillStyle is set to FillStyle::SOLID, this is the color used. More...

short	FillTransparence
	This is the transparence of the filled area. More...

string	FillTransparenceGradientName
	If a gradient is used for transparency, this is the name of the used transparence gradient style or it is empty. More...

com::sun::star::awt::Gradient	FillTransparenceGradient
	This describes the transparency of the fill area as a gradient. More...

string	FillGradientName
	If the property FillStyle is set to FillStyle::GRADIENT, this is the name of the used fill gradient style. More...

com::sun::star::awt::Gradient	FillGradient
	If the property FillStyle is set to FillStyle::GRADIENT, this describes the gradient used. More...

string	FillHatchName
	If the property FillStyle is set to FillStyle::HATCH, this is the name of the used fill hatch style. More...

Hatch	FillHatch
	If the property FillStyle is set to FillStyle::HATCH, this describes the hatch used. More...

boolean	FillBackground
	if this is `TRUE`, the transparent background of a hatch filled area is drawn in the current background color. More...

string	FillBitmapName
	If the property FillStyle is set to FillStyle::BITMAP, this is the name of the used fill bitmap style. More...

com::sun::star::awt::XBitmap	FillBitmap
	If the property FillStyle is set to FillStyle::BITMAP, this is the bitmap used. More...

string	FillBitmapURL
	If the property FillStyle is set to FillStyle::BITMAP, this is a URL to the bitmap used. More...

short	FillBitmapPositionOffsetX
	This is the horizontal offset where the tile starts. More...

short	FillBitmapPositionOffsetY
	This is the vertical offset where the tile starts. More...

short	FillBitmapOffsetX
	Every second line of tiles is moved the given percent of the width of the bitmap. More...

short	FillBitmapOffsetY
	Every second row of tiles is moved the given percent of the height of the bitmap. More...

RectanglePoint	FillBitmapRectanglePoint
	The RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering. More...

boolean	FillBitmapLogicalSize
	specifies if the size is given in percentage or as an absolute value. More...

long	FillBitmapSizeX
	This is the width of the tile for filling. More...

long	FillBitmapSizeY
	This is the height of the tile for filling. More...

BitmapMode	FillBitmapMode
	this enum selects how an area is filled with a single bitmap. More...

boolean	FillBitmapStretch
	if set, the fill bitmap is stretched to fill the area of the shape. More...

boolean	FillBitmapTile
	if set, the fill bitmap is repeated to fill the area of the shape. More...

com::sun::star::text::GraphicCrop	GraphicCrop
	contains the cropping of the object. More...

boolean	FillUseSlideBackground
	If this is `TRUE`, and FillStyle is FillStyle::NONE: The area displays the slide background. More...

Public Attributes inherited from LineProperties
com::sun::star::drawing::LineStyle	LineStyle
	This property contains the type of the line. More...

com::sun::star::drawing::LineDash	LineDash
	This property contains the dash of the line. More...

string	LineDashName
	This property contains the name of the dash of the line. More...

com::sun::star::util::Color	LineColor
	This property contains the line color. More...

short	LineTransparence
	This property contains the extent of transparency. More...

long	LineWidth
	This property contains the width of the line in 1/100th mm. More...

com::sun::star::drawing::LineJoint	LineJoint
	This property defines the rendering of joints between thick lines. More...

com::sun::star::drawing::LineCap	LineCap
	This property defines the rendering of ends of thick lines. More...

string	LineStartName
	This property contains the name of the line start poly polygon Bezier. More...

string	LineEndName
	This property contains the name of the line end poly polygon Bezier. More...

com::sun::star::drawing::PolyPolygonBezierCoords	LineStart
	This property contains the line start in the form of a poly polygon Bezier. More...

com::sun::star::drawing::PolyPolygonBezierCoords	LineEnd
	This property contains the line end in the form of a poly polygon Bezier. More...

boolean	LineStartCenter
	If this property is `TRUE`, the line will start from the center of the polygon. More...

long	LineStartWidth
	This property contains the width of the line start polygon. More...

boolean	LineEndCenter
	If this property is `TRUE`, the line will end in the center of the polygon. More...

long	LineEndWidth
	This property contains the width of the line end polygon. More...

Additional Inherited Members
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 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...

Protected Member Functions inherited from XFastPropertySet
void	setFastPropertyValue ([in] long nHandle, [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 to the property with the specified name. More...

any	getFastPropertyValue ([in] long nHandle) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )

Protected Member Functions inherited from XMultiPropertySet
com::sun::star::beans::XPropertySetInfo	getPropertySetInfo ()

void	setPropertyValues ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the values to the properties with the specified names. More...

sequence< any >	getPropertyValues ([in] sequence< string > aPropertyNames)

void	addPropertiesChangeListener ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
	adds an XPropertiesChangeListener to the specified property with the specified names. More...

void	removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener)
	removes an XPropertiesChangeListener from the listener list. More...

void	firePropertiesChangeEvent ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
	fires a sequence of PropertyChangeEvents to the specified listener. More...

Protected Member Functions inherited from XPropertyAccess
sequence< com::sun::star::beans::PropertyValue >	getPropertyValues ()

void	setPropertyValues ([in] sequence< com::sun::star::beans::PropertyValue > aProps) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
	sets the values of given properties. More...

Protected Member Functions inherited from XPropertyState
com::sun::star::beans::PropertyState	getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )

sequence< com::sun::star::beans::PropertyState >	getPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException )

void	setPropertyToDefault ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
	Sets the property to default value. More...

any	getPropertyDefault ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )

Detailed Description

Describes a legend for a Diagram.

Exported Interfaces

◆ ::com::sun::star::beans::PropertySet

service ::com::sun::star::beans::PropertySet

◆ ::com::sun::star::drawing::FillProperties

service ::com::sun::star::drawing::FillProperties

◆ ::com::sun::star::drawing::LineProperties

service ::com::sun::star::drawing::LineProperties

Exported Interfaces

◆ ::com::sun::star::chart2::XLegend

interface ::com::sun::star::chart2::XLegend

The interface for registering and removing legend entries.

Member Data Documentation

◆ AnchorPosition

LegendPosition AnchorPosition

property

Provides an automated position.

◆ Expansion

::com::sun::star::chart::ChartLegendExpansion Expansion

property

Determines how the aspect ratio of the legend should roughly be.

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

◆ Overlay

boolean Overlay

property

Determines, whether the legend should overlay the chart.

Since: LibreOffice 7.0

◆ ReferencePageSize

com::sun::star::awt::Size ReferencePageSize

propertymaybevoid

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

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

propertymaybevoid

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.

◆ Show

boolean Show

property

Determines, whether the legend should be rendered by the view.

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

com/sun/star/chart2/Legend.idl

Included Services

Exported Interfaces

Public Attributes

Additional Inherited Members

Detailed Description

Exported Interfaces

◆ ::com::sun::star::beans::PropertySet

◆ ::com::sun::star::drawing::FillProperties

◆ ::com::sun::star::drawing::LineProperties

Exported Interfaces

◆ ::com::sun::star::chart2::XLegend

Member Data Documentation

◆ AnchorPosition

◆ Expansion

◆ Overlay

◆ ReferencePageSize

◆ RelativePosition

◆ Show