Data Class Reference

Inherits JsonSerializable.

Public Member Functions
	enableDraggableSeletion ($draggable=false)
	enableGroupedSelection ($grouped=false)
	enableMultipleSelection ($multiple=false)
	enableSelection ($selection=false)
	hide ($hide=false)
	JsonSerialize ()
	setAxes ($axes)
	setClasses ($classes)
	setColor ($color)
	setColors ($colors)
	setColumns ($data)
	setEmptyLabelText ($text= '')
	setGroups ($groups)
	setIsSelectable (Callback $callback)
	setJson ($data)
	setKeysValue ($fields)
	setKeysX ($field)
	setLabelsFormat ($format)
	setMimeType ($mime=self::MIMETYPE_JSON)
	setNames ($names)
	setOnClick (Callback $callback)
	setOnMouseOut (Callback $callback)
	setOnMouseOver (Callback $callback)
	setOrder ($order=self::ORDER_DESC)
	setRegions ($regions)
	setRows ($data)
	setType ($type=self::TYPE_LINE)
	setTypes ($types)
	setUrl ($url)
	setX ($x)
	setXFormat ($format= '%Y-%m-%d')
	setXs ($xs)
	showLabels ($labels=false)

Data Fields
const	MIMETYPE_JSON = 'json'
const	ORDER_ASC = 'asc'
const	ORDER_DESC = 'desc'
const	TYPE_AREA = 'area'
const	TYPE_AREA_SPLINE = 'area-spline'
const	TYPE_AREA_STEP = 'area-step'
const	TYPE_BAR = 'bar'
const	TYPE_DONUT = 'donut'
const	TYPE_GAUGE = 'gauge'
const	TYPE_LINE = 'line'
const	TYPE_PIE = 'pie'
const	TYPE_SCATTER = 'scatter'
const	TYPE_SPLINE = 'spline'
const	TYPE_STEP = 'step'

Member Function Documentation

enableDraggableSeletion

(

$draggable = false

)

Enable to select data points by dragging

Parameters

bool

$draggable

Returns

Data

http://c3js.org/reference.html#data-selection-draggable

enableGroupedSelection

(

$grouped = false

)

Set grouped selection enabled

Parameters

bool

$grouped

Returns

Data

http://c3js.org/reference.html#data-selection-grouped

enableMultipleSelection

(

$multiple = false

)

Set multiple data points selection enabled

Parameters

bool

$multiple

Returns

Data

http://c3js.org/reference.html#data-selection-multiple

enableSelection

(

$selection = false

)

Set data selection enabled

Parameters

bool

$selection

Returns

Data

http://c3js.org/reference.html#data-selection-enabled

hide

(

$hide = false

)

Hide each data when the chart appears

Parameters

bool | array

$hide

Returns

Data

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

JsonSerialize

(

)

Returns

array

setAxes

(

$axes

)

Set y axis the data related to. y and y2 can be used

Parameters

array

$axes

Returns

Data

http://c3js.org/reference.html#data-axes

setClasses

(

$classes

)

Set custom data class

Parameters

array

$classes

Returns

Data

http://c3js.org/reference.html#data-classes

setColor

(

$color

)

Set color converter function

Parameters

string

$color

Returns

Data

http://c3js.org/reference.html#data-color

setColors

(

$colors

)

Set color for each data

Parameters

array

$colors

Returns

Data

http://c3js.org/reference.html#data-colors

setColumns

(

$data

)

Set chart data as columns

Parameters

array

$data

Returns

Data

http://c3js.org/reference.html#data-columns

setEmptyLabelText

(

$text = ''

)

Set text displayed when empty data

Parameters

string

$text

Returns

Data

http://c3js.org/reference.html#data-empty-label-text

setGroups

(

$groups

)

Set groups for the data for stacking

Parameters

array

$groups

Returns

Data

http://c3js.org/reference.html#data-groups

setIsSelectable

(

Callback

$callback

)

Set a callback for each data point to determine if it's selectable or not

Parameters

Callback

$callback

Returns

Data

http://c3js.org/reference.html#data-selection-isselectable

setJson

(

$data

)

Set chart data from JSON

Parameters

array

$data

Returns

Data

http://c3js.org/reference.html#data-json

setKeysValue

(

$fields

)

Set which JSON object keys correspond to which data

Parameters

array

$fields

Returns

Data

http://c3js.org/reference.html#data-keys

setKeysX

(

$field

)

Set keys for x axis when axis x is on category type

Parameters

string

$field

Returns

Data

http://c3js.org/reference.html#data-keys

setLabelsFormat

(

$format

)

Set formatter function for data labels

Parameters

string

$format

Returns

Data

http://c3js.org/reference.html#data-labels-format

setMimeType

(

$mime = self::MIMETYPE_JSON

)

Set data URL MIME type

Parameters

string

$mime

Data URL mime type

Returns

Data

setUrl()

setNames

(

$names

)

Set custom data name

Parameters

array

$names

Returns

Data

http://c3js.org/reference.html#data-names

setOnClick

(

Callback

$callback

)

Set a callback for click event on each data point

Parameters

Callback

$callback

Returns

Data

http://c3js.org/reference.html#data-onclick

setOnMouseOut

(

Callback

$callback

)

Set a callback for mouseout event on each data point

Parameters

Callback

$callback

Returns

Data

http://c3js.org/reference.html#data-onmouseout

setOnMouseOver

(

Callback

$callback

)

Set a callback for mouseover event on each data point

Parameters

Callback

$callback

Returns

Data

http://c3js.org/reference.html#data-onmouseover

setOrder

(

$order = self::ORDER_DESC

)

Define the order of the data

Parameters

ORDER_DESC | ORDER_ASC | string | null

$order

Returns

Data

http://c3js.org/reference.html#data-order

setRegions

(

$regions

)

Define regions for each data

Parameters

array

$regions

Returns

Data

http://c3js.org/reference.html#data-regions

setRows

(

$data

)

Set chart data as rows

Parameters

array

$data

Returns

Data

http://c3js.org/reference.html#data-rows

setType

(

$type = self::TYPE_LINE

)

Set chart type at once

Parameters

TYPE_LINE | TYPE_SPLINE | TYPE_STEP | TYPE_AREA | TYPE_AREA_SPLINE | TYPE_AREA_STEP | TYPE_BAR | TYPE_SCATTER | TYPE_PIE | TYPE_DONUT | TYPE_GAUGE

$type

Returns

Data

setTypes()

setTypes

(

$types

)

Set chart type for each data

Parameters

array

$types

Returns

Data

setType()

setUrl

(

$url

)

Set chart data from a JSON or CSV file

Parameters

string

$url

Returns

Data

setMimeType()

setX

(

$x

)

Set key of x values in data

Parameters

string

$x

Returns

Data

setXs()

setXFormat

(

$format = '%Y-%m-%d'

)

Set a format to parse string specifed as x

Parameters

string

$format

Returns

Data

http://c3js.org/reference.html#data-xFormat

setXs

(

$xs

)

Specify the keys of the x values for each data

Parameters

array

$xs

Returns

Data

setX()

showLabels

(

$labels = false

)

Show labels on each data points

Parameters

bool

$labels

Returns

Data

See also

http://c3js.org/reference.html#data-labels

Field Documentation

const MIMETYPE_JSON = 'json'

const ORDER_ASC = 'asc'

const ORDER_DESC = 'desc'

const TYPE_AREA = 'area'

const TYPE_AREA_SPLINE = 'area-spline'

const TYPE_AREA_STEP = 'area-step'

const TYPE_BAR = 'bar'

const TYPE_DONUT = 'donut'

const TYPE_GAUGE = 'gauge'

const TYPE_LINE = 'line'

const TYPE_PIE = 'pie'

const TYPE_SCATTER = 'scatter'

const TYPE_SPLINE = 'spline'

const TYPE_STEP = 'step'