c3js-PHP
Chart Class Reference

Public Member Functions

 addRegion (Region $region)
 
 bindTo ($selector)
 
 getRendering ($var= 'chart', $pretty=false)
 
 onResize (Callback $callback)
 
 onResized (Callback $callback)
 
 render ($var= 'chart', $pretty=false)
 
 setArea (Charts\Area $area)
 
 setAxis (Axis $axis)
 
 setBar (Charts\Bar $bar)
 
 setColorPattern ($pattern)
 
 setData (Data $data)
 
 setDonut (Charts\Donut $donut)
 
 setGauge (Charts\Gauge $gauge)
 
 setGrid (Grid $grid)
 
 setInteractionEnabled ($interaction=true)
 
 setLegend (Legend $legend)
 
 setLine (Charts\Line $line)
 
 setOnInit (Callback $callback)
 
 setOnMouseOut (Callback $callback)
 
 setOnMouseOver (Callback $callback)
 
 setOnRendered (Callback $callback)
 
 setPaddingBottom ($padding)
 
 setPaddingLeft ($padding)
 
 setPaddingRight ($padding)
 
 setPaddingTop ($padding)
 
 setPie (Charts\Pie $pie)
 
 setPoint (Point $point)
 
 setRegions ($regions)
 
 setSizeHeight ($height)
 
 setSizeWidth ($width)
 
 setSubChart (Subchart $subchart)
 
 setTooltip (Tooltip $tooltip)
 
 setTransitionDuration ($duration=350)
 
 setZoom (Zoom $zoom)
 

Member Function Documentation

addRegion ( Region  $region)

Attach a Region object to the Chart

Parameters
Region$region
Returns
Chart
See also
setRegions()
bindTo (   $selector)

The CSS selector or the element which the chart will be set to

Parameters
string$selector
Returns
Chart

http://c3js.org/reference.html#bindto

getRendering (   $var = 'chart',
  $pretty = false 
)

Get the rendered JavaScript

Parameters
string$var(optional) Returning javascript variable name
bool$pretty(optional) Render prettyfied javascript
Returns
string
onResize ( Callback  $callback)

Set a callback to execute when user resizes the screen

Parameters
Callback$callback
Returns
Chart

http://c3js.org/reference.html#onresize

onResized ( Callback  $callback)

Set a callback to execute when screen resize finished

Parameters
Callback$callback
Returns
Chart

http://c3js.org/reference.html#onresized

render (   $var = 'chart',
  $pretty = false 
)

Renders the JavaScript directly onto the HTML document

Parameters
string$var(optional) Returning javascript variable name
bool$pretty(optional) Render prettyfied javascript
setArea ( Charts\Area  $area)

Attach a Area object to the Chart

Parameters
Charts\Area$area
Returns
Chart
setAxis ( Axis  $axis)

Attach a Axis object to the Chart

Parameters
Axis$axis
Returns
Chart
setBar ( Charts\Bar  $bar)

Attach a Bar object to the Chart

Parameters
Charts\Bar$bar
Returns
Chart
setColorPattern (   $pattern)

Set custom color pattern

Parameters
string[]$pattern CSS hex colors
Returns
Chart

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

setData ( Data  $data)

Attach a Data object to the Chart

Parameters
Data$data
Returns
Chart
setDonut ( Charts\Donut  $donut)

Attach a Donut object to the Chart

Parameters
Charts\Donut$donut
Returns
Chart
setGauge ( Charts\Gauge  $gauge)

Attach a Gauge object to the Chart

Parameters
Charts\Gauge$gauge
Returns
Chart
setGrid ( Grid  $grid)

Attach a Grid object to the Chart

Parameters
Grid$grid
Returns
Chart
setInteractionEnabled (   $interaction = true)

Indicate if the chart should have interactions

Parameters
bool$interaction
Returns
Chart

http://c3js.org/reference.html#interaction-enabled

setLegend ( Legend  $legend)

Attach a Legend object to the Chart

Parameters
Legend$legend
Returns
Chart
setLine ( Charts\Line  $line)

Attach a Line object to the Chart

Parameters
Charts\Line$line
Returns
Chart
setOnInit ( Callback  $callback)

Set a callback to execute when the chart is initialized

Parameters
Callback$callback
Returns
Chart

http://c3js.org/reference.html#oninit

setOnMouseOut ( Callback  $callback)

Set a callback to execute when mouse leaves the chart

Parameters
Callback$callback
Returns
Chart

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

setOnMouseOver ( Callback  $callback)

Set a callback to execute when mouse enters the chart

Parameters
Callback$callback
Returns
Chart

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

setOnRendered ( Callback  $callback)

Set a callback which is executed when the chart is rendered

Parameters
Callback$callback
Returns
Chart

http://c3js.org/reference.html#onrendered

setPaddingBottom (   $padding)

Set the padding on the bottom of the chart

Parameters
int$padding
Returns
Chart

http://c3js.org/reference.html#padding-bottom

setPaddingLeft (   $padding)

Set the padding on the left of the chart

Parameters
int$padding
Returns
Chart

http://c3js.org/reference.html#padding-left

setPaddingRight (   $padding)

Set the padding on the right of the chart

Parameters
int$padding
Returns
Chart

http://c3js.org/reference.html#padding-right

setPaddingTop (   $padding)

Set the padding on the top of the chart

Parameters
int$padding
Returns
Chart

http://c3js.org/reference.html#padding-top

setPie ( Charts\Pie  $pie)

Attach a Pie object to the Chart

Parameters
Charts\Pie$pie
Returns
Chart
setPoint ( Point  $point)

Attach a Point object to the Chart

Parameters
Point$point
Returns
Chart
setRegions (   $regions)

Set Chart Regions

Parameters
Region[]$regions
Returns
Chart
See also
addRegion()
setSizeHeight (   $height)

The desired height of the chart element

Parameters
int$height
Returns
Chart

http://c3js.org/reference.html#size-height

setSizeWidth (   $width)

The desired width of the chart element

Parameters
int$width
Returns
Chart

http://c3js.org/reference.html#size-width

setSubChart ( Subchart  $subchart)

Attach a Subchart object to the Chart

Parameters
Subchart$subchart
Returns
Chart
setTooltip ( Tooltip  $tooltip)

Attach a Tooltip object to the Chart

Parameters
Tooltip$tooltip
Returns
Chart
setTransitionDuration (   $duration = 350)

Set duration of transition for chart animation

Parameters
int$durationDuration of transition in milliseconds
Returns
Chart

http://c3js.org/reference.html#transition-duration

setZoom ( Zoom  $zoom)

Attach a Zoom object to the Chart

Parameters
Zoom$zoom
Returns
Chart