Legend Class Reference

Inherits JsonSerializable.

Public Member Functions
	JsonSerialize ()
	setHidden ($hidden=false)
	setInsetAnchor ($anchor=self::INSET_TOP_LEFT)
	setInsetStep ($step)
	setInsetX ($x=10)
	setInsetY ($y=0)
	setItemOnClick (Callback $callback)
	setItemOnMouseOut (Callback $callback)
	setItemOnMouseOver (Callback $callback)
	setPosition ($position=self::POSITION_BOTTOM)
	setVisibility ($visibility=true)

Data Fields
const	INSET_BOTTOM_LEFT = 'bottom-left'
const	INSET_BOTTOM_RIGHT = 'bottom-right'
const	INSET_TOP_LEFT = 'top-left'
const	INSET_TOP_RIGHT = 'top-right'
const	POSITION_BOTTOM = 'bottom'
const	POSITION_INSET = 'inset'
const	POSITION_RIGHT = 'right'

Member Function Documentation

JsonSerialize

(

)

Returns

array

setHidden

(

$hidden = false

)

Hide legend

Parameters

bool | string | array

$hidden

http://c3js.org/reference.html#legend-hide

setInsetAnchor

(

$anchor = self::INSET_TOP_LEFT

)

Change inset legend anchor

Parameters

INSET_TOP_LEFT | INSET_TOP_RIGHT | INSET_BOTTOM_LEFT | INSET_BOTTOM_RIGHT

$anchor

setInsetX() setInsetY() setInsetStep()

setInsetStep

(

$step

)

Change inset legend step

Parameters

int

$step

setInsetAnchor() setInsetX() setInsetY()

setInsetX

(

$x = 10

)

Change inset legend x

Parameters

int

$x

setInsetAnchor() setInsetY() setInsetStep()

setInsetY

(

$y = 0

)

Change inset legend y

Parameters

int

$y

setInsetAnchor() setInsetX() setInsetStep()

setItemOnClick

(

Callback

$callback

)

Set click event handler to the legend item

Parameters

Callback

$callback

http://c3js.org/reference.html#legend-item-onclick

setItemOnMouseOut

(

Callback

$callback

)

Set mouseout event handler to the legend item

Parameters

Callback

$callback

http://c3js.org/reference.html#legend-item-onmouseout

setItemOnMouseOver

(

Callback

$callback

)

Set mouseover event handler to the legend item

Parameters

Callback

$callback

http://c3js.org/reference.html#legend-item-onmouseover

setPosition

(

$position = self::POSITION_BOTTOM

)

Change the position of legend

Parameters

POSITION_BOTTOM | POSITION_RIGHT | POSITION_INSET

$position

http://c3js.org/reference.html#legend-position

setVisibility

(

$visibility = true

)

Show or hide legend

Parameters

bool

$visibility

http://c3js.org/reference.html#legend-show

Field Documentation

const INSET_BOTTOM_LEFT = 'bottom-left'

const INSET_BOTTOM_RIGHT = 'bottom-right'

const INSET_TOP_LEFT = 'top-left'

const INSET_TOP_RIGHT = 'top-right'

const POSITION_BOTTOM = 'bottom'

const POSITION_INSET = 'inset'

const POSITION_RIGHT = 'right'