Class pvc.options.panels.LegendPanel

Extends DockedPanel.

Class Summary
Constructor Attributes	Constructor Name and Description
	LegendPanel The options documentation class of the legend panel.

Field Summary
Field Attributes	Field Name and Description
Layout
	align The alignment side of the panel (the source) that will align to a side of the parent panel (the target).
	itemCountMax The maximum positive number of legend items that can fit in the legend panel.
	itemPadding Half the space between legend items, in pixel units.
	itemSize The fixed size of legend items, in pixel units or as a percentage.
	margins The margins of the panel.
	markerSize The width and height of the marker panel, in pixel units.
	overflow The behavior of the legend panel when an overflow is detected.
	paddings The paddings of the panel.
	position The docking position of the panel.
	size The fixed size of the panel, in pixel units or as a percentage.
	sizeMax The maximum size of the panel, in pixel units or as a percentage.
	textMargin The space between the marker and the associated label, in pixel units.
Style
	extensionPoints The extension points provided by the legend panel.
	font The font of the panel.

Class Detail

pvc.options.panels.LegendPanel

The options documentation class of the legend panel.

Field Detail

{pvc.options.varia.PanelAlignmentSource} align

The alignment side of the panel (the source) that will align to a side of the parent panel (the target).

The alignment side must be orthogonal to the docking side.

The default value is 'middle', if DockedPanel#position is an horizontal side, and 'center', otherwise.

Borrowed from:: DockedPanel

{number} itemCountMax

The maximum positive number of legend items that can fit in the legend panel.

See pvc.options.varia.LegendOverflow for information about the different behaviors of the legend panel when this maximum is exceeded.

{number|string|pvc.options.varia.Sides} itemPadding

Half the space between legend items, in pixel units.

This property should be named "itemMargins", according to the current naming and box model concept, but is as is for historical reasons.

Percentage values are in relation to the legend panel's available client size (i.e. the available size with margins and paddings discounted).

The item margins are only applied between items.

See pvc.options.varia.Sides for information about the different supported data types.

Default Value:: 2.5

{number|string|pvc.options.varia.Size} itemSize

The fixed size of legend items, in pixel units or as a percentage.

The size includes #itemPadding. The items' client size is the size discounted of the item padding.

Percentage values are in relation to the legend panel's available client size (i.e. the available size with margins and paddings discounted).

When unspecified, each item assumes the smallest possible size that fits all content. You can specify only the item's width or height.

The default item height is the biggest of the font height and the #markerSize. The default item width is the #markerSize, plus the #textMargin, plus the width of the item's text at the current font.

See pvc.options.varia.Size for information about the different supported data types.

{number|string|pvc.options.varia.Sides} margins

The margins of the panel.

See pvc.options.varia.Sides for information about the different supported data types.

Default Value:: 0

Borrowed from:: DockedPanel

{number} markerSize

The width and height of the marker panel, in pixel units.

The marker itself will be slightly smaller.

Default Value:: 15

{string|pvc.options.varia.LegendOverflow} overflow

The behavior of the legend panel when an overflow is detected.

See pvc.options.varia.LegendOverflow for information about the different behaviors of the legend panel when an overflow is detected.

Default Value:: 'clip'

{number|string|pvc.options.varia.Sides} paddings

The paddings of the panel.

See pvc.options.varia.Sides for information about the different supported data types.

Default Value:: 5

{pvc.options.varia.PanelPosition} position

The docking position of the panel.

Default Value:: 'bottom'

{number|string|pvc.options.varia.Size} size

The fixed size of the panel, in pixel units or as a percentage.

See pvc.options.varia.Size for information about the different supported data types.

Borrowed from:: Panel

{number|string|pvc.options.varia.Size} sizeMax

The maximum size of the panel, in pixel units or as a percentage.

See pvc.options.varia.Size for information about the different supported data types.

Borrowed from:: Panel

{number} textMargin

The space between the marker and the associated label, in pixel units.

Default Value:: 6

{pvc.options.ext.LegendPanelExtensionPoints} extensionPoints

The extension points provided by the legend panel.

{string} font

The font of the panel.

See the supported font format in http://www.w3.org/TR/CSS2/fonts.html#font-shorthand

Default Value:: '10px sans-serif'

Types By Namespace

cdo

def

pvc

pvc.data

pvc.options

pvc.options.axes

pvc.options.charts

pvc.options.ext

pvc.options.format

pvc.options.marks

pvc.options.panels

pvc.options.plots

pvc.options.varia

pvc.options.visualRoles

pvc.visual

Class pvc.options.panels.LegendPanel