The Bakery Everything CakePHP

Public variables

$swf

Path relative to webroot to the swf file

example: $flashChart->swf = 'flash/ofc.swf'; // app/webroot/flash/ofc.swf

$ready

The javascript/flash integration in the vendors include two custom callbacks. This is one and it will be run when the flash is ready.

example: $flashChart->ready = 'alert('ready');';

$loading

The other javascript callback. Called once for each chart.

example: $flashChart->loading = 'alert('loading chart');';

$data

The dataset(s) should be set through the setData method and only handled directly in extreme cases.

$Chart

Contains the Chart vendor object. May (and should only) be used directly to control something that the helper doesn't implement.

Private variable - default values

There are several private variables that define default behavior in the top of the helper. If you wish, you may alter the helper to work by default more close to your specifications. Most of these are styles. At the moment they are set up for the charts to blend into Cake's default style.

Public methods

begin($options = array())

Initializes the helper and embeds the needed javascript libraries. You should start with this method and the only available option key at the moment is 'prototype' (set it to true to be compatible).

setData($data, $numbersPath = '{n}', $labelsPath = false, $datasetName = 'default', $chartId = 'default')

Always call this at least once and do so between begin() and axis(). This method sends the data the helper and, optionally, where in the dataset it can find the values and labels (if any). Also note that
if you wish to use several datasets, use the last parameter to give each set a name that can be used by later methods to distinguish between the sets.

render($width = null, $height = null, $chartId = 'default', $domId = false)

Outputs the embeded flash, rendering the charts. When multiple charts are used use the chartId parameter. If you wish to place the chart somewhere else than where this method is rendered, you may use the $domId parameter to target a specific dom object (place div with this id somewhere in your page).

chart($type = 'bar', $options = array(), $datasetName = 'default')

Renders the javascript with data and customization for one graph chart. To be called last, but may be called multiple times with different datasetNames for different datasets or different type (and options) for different display of the same data in the same chart.

What options are valid vary from chart type to chart type, and the helper is set up in such a way as to pass the options on to the vendor, therefore letting you use an updated vendor without changes to the helper. This also means that the helper doesnt know (or care) what options you send, but if they do not exist in the vendor, you will throw an error. Check http://teethgrinder.co.uk/open-flash-chart-2/ under the type you are using for what options may be set.

chart() aliases

The following methods are aliases for FlashChartHelper::chart(), that implement the custom chart types. They may be called directly, or for consistency, you can only use chart('type').

• barStack($options = array(), $datasetName = 'default')
• scatter($options = array(), $datasetName = 'default')
• sketch($options = array(), $datasetName = 'default')
• radar($options = array(), $datasetName = 'default')
• pie($options = array(), $datasetName = 'default')

setToolTip($tooltip = '', $options = array())

Sets the tool tip for the chart by using a string with replaceable codewords like #val#. Check OFC2 for documentation. Also you can style the tooltips look and behavior using the options parameter.

setTitle($title_text, $style = '')

Sets the title above the chart. You can also style it with css as the second parameter.

setLegend($axis, $title, $style = '')

Set the descriptive texts next to the axies to describe their meaning. You can also style it directly here using CSS.

axis($axis, $options = array())

Use this method to set up the axis' range and labels. There are also a number of options (mostly styling) that can be set up. The two axis have different options, but a full documentation can be found on the links given under. Importantly though, the y has a range option that takes an array with 3 values (minimum value, max value and step size). On the x axis you will often want to use the labels from the dataset and the helper will add those labels if you have defined a proper labels path, either as the third parameter of setDate() or using the setLabelsPat() method. Note, that even if you require no options for the x-axis, you will have to call this method on that axis for it to use those labels. Also you may set the 'vertical' option to true to have the x-axis labels be rendered sideways (vertically).

rightAxis($options = array())

When using multiple charts in one diagram, it may be useful to have a second y-axis for different values. At the moment this feature is not perfectly implemented in the vendor, among other problems, all charts will use the left y-axis' range for displaying their values.

setRadarAxis($options = array(), $labels = array())

Radar charts are circular and this method sets the grid options, more than an axis really. The options it takes in define the "height" and steps of the grid and its colour. You can also set the labels for the y axis (or what you can think of as the radius).

setRadarSpokes($spokes, $colour = null)

Spokes are the labels that name the "radius"-axis of the chart.

setNumbersPath($path, $datasetName = 'default')

Tells the helper where to find the numbers to generate the graph with. This is the same functionality as the 2nd paramter of the setData() method. You do not need to set it both places.

setLabelsPath($path)

Tells the helper where to find the labels for the X axis. This is the same functionality as the third paramter of the setData() method. You do not need to set it both places.

NB!. The path should start with the name of the dataset (ie. $flashChart->setLabelsPath('Default.{n}.User.name');).

setBgColour($colour)

Set the background color for the entire diagram. Optional. Will use the default stored in FlashChart::bg_colour if not used.

setStackColours($colours = array())

For the chart type Bar_stack this method sets the colours of the bars.