OELegendLayoutOptions

class OELegendLayoutOptions

This class represents the OELegendLayoutOptions class that encapsulates properties that determine how an legend layout is depicted.

The OELegendLayoutOptions class stores the following properties:

Property	Get method	Set method	Corresponding namespace / class / type
legend layout style	`GetLayoutStyle`	(set by the constructor)	`OELegendLayoutStyle` namespace
legend color style	`GetColorStyle`	(set by the constructor)	`OELegendColorStyle` namespace
legend interactive style	`GetInteractiveStyle`	(set by the constructor)	`OELegendInteractiveStyle` namespace
button label font	`GetButtonFont`	`SetButtonFont`	OEFont
button pen(s)	`GetButtonPen`	`SetButtonPen`	OEPen
button height scale	`GetButtonHeightScale`	`SetButtonHeightScale`	positive floating point number in the range of \([0.5, 3.0]\)
button width scale	`GetButtonWidthScale`	`SetButtonWidthScale`	positive floating point number in the range of \([0.5, 5.0]\)
legend box pen	`GetLegendBoxPen`	`SetLegendBoxPen`	OEPen
layout margins	`GetMargin`	`SetMargin` / `SetMargins`	positive floating point number in the range of \([0.0, 90.0]\)

See also

OELegendLayout class

Constructors

OELegendLayoutOptions(layout: int, color: int, inter: int) -> OELegendLayoutOptions

See also

OELegendLayoutOptions(arg2: OELegendLayoutOptions) -> OELegendLayoutOptions

Copy constructor.

GetButtonFont

GetButtonFont() -> OEFont

See also

OEFont class
OELegendLayoutOptions.SetButtonFont method

GetButtonHeightScale

GetButtonHeightScale() -> float

See also

OELegendLayoutOptions.SetButtonHeightScale method

GetButtonPen

GetButtonPen(on: bool) -> OEPen

See also

OEPen class
OELegendLayoutOptions.SetButtonPen method

GetButtonWidthScale

GetButtonWidthScale() -> float

See also

OELegendLayoutOptions.SetButtonWidthScale method

GetColorStyle

GetColorStyle() -> int

See also

OELegendColorStyle namespace

GetInteractiveStyle

GetInteractiveStyle() -> int

See also

OELegendInteractiveStyle namespace

GetLayoutStyle

GetLayoutStyle() -> int

See also

OELegendLayoutStyle namespace

GetLegendBoxPen

GetLegendBoxPen() -> OEPen

See also

OEPen class
OELegendLayoutOptions.SetLegendBoxPen method

GetMargin

GetMargin(percent: int) -> float

Returns the ratio of a specific margin of the legend layout.

margin: This value has to be from the OEMargin namespace.

See also

OELegendLayoutOptions.SetMargin method
OELegendLayoutOptions.SetMargins method

SetButtonFont

SetButtonFont(font: OEFont) -> None

See also

OEFont class
OELegendLayoutOptions.GetButtonFont method

SetButtonHeightScale

SetButtonHeightScale(s: float) -> None

See also

OELegendLayoutOptions.GetButtonHeightScale method

SetButtonPen

SetButtonPen(pen: OEPen, on: bool) -> None

See also

OEPen class
OELegendLayoutOptions.GetButtonPen method

SetButtonWidthScale

SetButtonWidthScale(s: float) -> None

See also

OELegendLayoutOptions.GetButtonWidthScale method

SetLegendBoxPen

SetLegendBoxPen(pen: OEPen) -> None

See also

OEPen class
OELegendLayoutOptions.GetLegendBoxPen method

SetMargin

SetMargin(margin: int, percent: float) -> bool

Sets the size of a specific margin of the legend layout.

marginloc: This value has to be from the OEMargin namespace.
margin: This number is considered as a percentage of either the width or the height of image on which the legend layout will be drawn and has to be in the range of \([0.0, 90.0]\). For example, 10.0% means, that the left and right margin are 10% of the total width of the image, and the top and bottom margins are 10% of the total height of the image.

See also

OELegendLayoutOptions.GetMargin method
OELegendLayoutOptions.SetMargins method

SetMargins

SetMargins(percent: float) -> bool

Sets the size of all margins of the legend layout.

margin: This number is considered as a percentage of either the width or the height of image on which the legend layout will be drawn and has to be in the range of \([0.0, 90.0]\). For example, 10.0% means, that the left and right margin are 10% of the total width of the image, and the top and bottom margins are 10% of the total height of the image.

See also

OELegendLayoutOptions.GetMargin method
OELegendLayoutOptions.SetMargin method