# Interface: LayoutItem

# Hierarchy

# Properties

# bottom

bottom: number

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

# Defined in

types/layout.d.ts:41


# fullSize

fullSize: boolean

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

# Defined in

types/layout.d.ts:17


# height

height: number

Height of item. Must be valid after update()

# Defined in

types/layout.d.ts:25


# left

left: number

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

# Defined in

types/layout.d.ts:29


# position

position: LayoutPosition

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

# Defined in

types/layout.d.ts:9


right: number

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

# Defined in

types/layout.d.ts:37


# top

top: number

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

# Defined in

types/layout.d.ts:33


# weight

weight: number

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

# Defined in

types/layout.d.ts:13


# width

width: number

Width of item. Must be valid after update()

# Defined in

types/layout.d.ts:21

# Methods

# beforeLayout

Optional beforeLayout(): void

Called before the layout process starts

# Returns

void

# Defined in

types/layout.d.ts:46


# draw

draw(chartArea): void

Draws the element

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Defined in

types/layout.d.ts:50


# getPadding

Optional getPadding(): ChartArea

Returns an object with padding on the edges

# Returns

ChartArea

# Defined in

types/layout.d.ts:54


# isHorizontal

isHorizontal(): boolean

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

# Returns

boolean

# Defined in

types/layout.d.ts:58


# update

update(width, height, margins?): void

Takes two parameters: width and height.

# Parameters

Name Type
width number
height number
margins? ChartArea

# Returns

void

# Defined in

types/layout.d.ts:64