Interface: LegendElement

• LayoutItem

  ↳ LegendElement

• active: boolean

Inherited from: Element.active

Defined in:

bottom

• bottom: number

Bottom edge of the item. Set by layout system and cannot be used in update

Inherited from: .bottom

Defined in:

fullSize

• fullSize: boolean

if true, and the item is horizontal, then push vertical boxes down

Inherited from: .fullSize

Defined in:

height

• height: number

Height of item. Must be valid after update()

Inherited from: .height

Defined in:

left

• left: number

Left edge of the item. Set by layout system and cannot be used in update

Inherited from: .left

Defined in:

options

• Readonly options: object

Type declaration:

Inherited from: Element.options

Defined in: element.d.ts:7 (opens new window)

position

• position: LayoutPosition

The position of the item in the chart layout. Possible values are

Inherited from: .position

Defined in:

• right: number

Right edge of the item. Set by layout system and cannot be used in update

Inherited from: LayoutItem.

Defined in: layout.d.ts:37 (opens new window)

top

• top: number

Top edge of the item. Set by layout system and cannot be used in update

Inherited from: LayoutItem.

weight

• weight: number

The weight used to sort the item. Higher weights are further away from the chart area

Inherited from: .weight

Defined in:

width

• width: number

Width of item. Must be valid after update()

Inherited from: .width

Defined in:

x

• Readonly x: number

Inherited from: Element.x

Defined in:

y

• Readonly y: number

Inherited from: Element.y

Defined in:

beforeLayout

▸ OptionalbeforeLayout(): void

Called before the layout process starts

Returns: void

Inherited from:

Defined in: layout.d.ts:46 (opens new window)

▸ draw(chartArea: ): void

Draws the element

Parameters:

Returns: void

Inherited from:

Defined in: layout.d.ts:50 (opens new window)

getPadding

▸ OptionalgetPadding(): ChartArea

Returns an object with padding on the edges

Returns:

Inherited from: LayoutItem

Defined in:

getProps

▸ getProps<P>(props: [P], final?: boolean): Pick<{}, P>

Type parameters:

Parameters:

Returns: Pick<{}, P>

Inherited from: Element.getProps

Defined in:

▸ getProps<P, P2>(props: [P, P2], final?: boolean): Pick<{}, P | P2>

Type parameters:

Parameters:

Returns: Pick<{}, P | P2>

Defined in: element.d.ts:12 (opens new window)

▸ getProps<P, P2, P3>(props: [P, P2, P3], final?: boolean): Pick<{}, P | P2 | P3>

Type parameters:

Parameters:

Returns: Pick<{}, P | P2 | P3>

Inherited from: Element.getProps

Defined in:

▸ getProps<P, P2, P3, P4>(props: [P, P2, P3, P4], final?: boolean): Pick<{}, P | P2 | P3 | P4>

Type parameters:

Parameters:

Returns: Pick<{}, P | P2 | P3 | P4>

Inherited from: Element.getProps

Defined in: element.d.ts:17 (opens new window)

▸ getProps<P, P2, P3, P4, P5>(props: [P, P2, P3, P4, P5], final?: boolean): Pick<{}, P | P2 | P3 | P4 | P5>

Type parameters:

Parameters:

Returns: Pick<{}, P | P2 | P3 | P4 | P5>

Inherited from: Element.getProps

Defined in:

▸ getProps(props: never[], final?: boolean): object

Parameters:

Returns: object

Inherited from: Element.getProps

Defined in:

hasValue

▸ hasValue(): boolean

Returns: boolean

Inherited from: Element.hasValue

Defined in:

isHorizontal

▸ isHorizontal(): boolean

returns true if the layout item is horizontal (ie. top or bottom)

Returns: boolean

Inherited from:

Defined in: layout.d.ts:58 (opens new window)

tooltipPosition

▸ tooltipPosition(useFinalPosition?: boolean): Point

Parameters:

Returns: Point

Inherited from: Element.tooltipPosition

Defined in:

update

▸ update(width: number, height: number, margins?: ): void

Takes two parameters: width and height.

Parameters:

Returns: void

Inherited from: LayoutItem

Defined in: