 |
PEEL Shopping
Open source ecommerce : PEEL Shopping
|
Public Member Functions | |
| graph () | |
| Constructer for the open_flash_chart_api Sets our default variables. More... | |
| set_unique_id () | |
| Set the unique_id to use for the flash object id. More... | |
| get_unique_id () | |
| Get the flash object ID for the last rendered object. More... | |
| set_js_path ($path) | |
| Set the base path for the swfobject.js. More... | |
| set_swf_path ($path) | |
| Set the base path for the open-flash-chart.swf. More... | |
| set_output_type ($type) | |
| Set the type of output data. More... | |
| next_line () | |
| returns the next line label for multiple lines. More... | |
| esc ($text) | |
| format_output ($function, $values) | |
| Format the text to the type of output. More... | |
| set_title ($title, $style='') | |
| Set the text and style of the title. More... | |
| set_width ($width) | |
| Set the width of the chart. More... | |
| set_height ($height) | |
| Set the height of the chart. More... | |
| set_base ($base='js/') | |
| Set the base path of the swfobject. More... | |
| set_y_format ($val) | |
| set_num_decimals ($val) | |
| set_is_fixed_num_decimals_forced ($val) | |
| set_is_decimal_separator_comma ($val) | |
| set_is_thousand_separator_disabled ($val) | |
| set_data ($a) | |
| Set the data for the chart. More... | |
| set_links ($links) | |
| set_x_offset ($val) | |
| set_tool_tip ($tip) | |
| Set the tooltip to be displayed on each chart item. More... | |
| set_x_labels ($a) | |
| Set the x axis labels. More... | |
| set_x_label_style ($size, $colour='', $orientation=0, $step=-1, $grid_colour='') | |
| Set the look and feel of the x axis labels. More... | |
| set_bg_colour ($colour) | |
| Set the background colour. More... | |
| set_bg_image ($url, $x='center', $y='center') | |
| Set a background image. More... | |
| attach_to_y_right_axis ($data_number) | |
| Attach a set of data (a line, area or bar chart) to the right Y axis. More... | |
| set_inner_background ($col, $col2='', $angle=-1) | |
| Set the background colour of the grid portion of the chart. More... | |
| _set_y_label_style ($size, $colour) | |
| Internal function to build the y label style for y and y2. More... | |
| set_y_label_style ($size, $colour='') | |
| Set the look and feel of the y axis labels. More... | |
| set_y_right_label_style ($size, $colour='') | |
| Set the look and feel of the right y axis labels. More... | |
| set_x_max ($max) | |
| set_x_min ($min) | |
| set_y_max ($max) | |
| Set the maximum value of the y axis. More... | |
| set_y_min ($min) | |
| Set the minimum value of the y axis. More... | |
| set_y_right_max ($max) | |
| Set the maximum value of the right y axis. More... | |
| set_y_right_min ($min) | |
| Set the minimum value of the right y axis. More... | |
| y_label_steps ($val) | |
| Show the y label on every $step label. More... | |
| title ($title, $style='') | |
| set_x_legend ($text, $size=-1, $colour='') | |
| Set the parameters of the x legend. More... | |
| set_x_tick_size ($size) | |
| Set the size of the x label ticks. More... | |
| set_x_axis_steps ($steps) | |
| Set how often you would like to show a tick on the x axis. More... | |
| set_x_axis_3d ($size) | |
| Set the depth in pixels of the 3D X axis slab. More... | |
| _set_y_legend ($text, $size, $colour) | |
| The private method of building the y legend output. More... | |
| set_y_legend ($text, $size=-1, $colour='') | |
| Set the parameters of the y legend. More... | |
| set_y_right_legend ($text, $size=-1, $colour='') | |
| Set the parameters of the right y legend. More... | |
| x_axis_colour ($axis, $grid='') | |
| Set the colour of the x axis line and grid. More... | |
| y_axis_colour ($axis, $grid='') | |
| Set the colour of the y axis line and grid. More... | |
| y_right_axis_colour ($colour) | |
| Set the colour of the right y axis line. More... | |
| line ($width, $colour='', $text='', $size=-1, $circles=-1) | |
| Draw a line without markers on values. More... | |
| line_dot ($width, $dot_size, $colour, $text='', $font_size='') | |
| Draw a line with solid dot markers on values. More... | |
| line_hollow ($width, $dot_size, $colour, $text='', $font_size='') | |
| Draw a line with hollow dot markers on values. More... | |
| area_hollow ($width, $dot_size, $colour, $alpha, $text='', $font_size='', $fill_colour='') | |
| Draw an area chart. More... | |
| bar ($alpha, $colour='', $text='', $size=-1) | |
| Draw a bar chart. More... | |
| bar_filled ($alpha, $colour, $colour_outline, $text='', $size=-1) | |
| Draw a bar chart with an outline. More... | |
| bar_sketch ($alpha, $offset, $colour, $colour_outline, $text='', $size=-1) | |
| bar_3D ($alpha, $colour='', $text='', $size=-1) | |
| Draw a 3D bar chart. More... | |
| bar_glass ($alpha, $colour, $outline_colour, $text='', $size=-1) | |
| Draw a 3D bar chart that looks like glass. More... | |
| bar_fade ($alpha, $colour='', $text='', $size=-1) | |
| Draw a faded bar chart. More... | |
| candle ($data, $alpha, $line_width, $colour, $text='', $size=-1) | |
| hlc ($data, $alpha, $line_width, $colour, $text='', $size=-1) | |
| scatter ($data, $line_width, $colour, $text='', $size=-1) | |
| pie ($alpha, $line_colour, $style, $gradient=true, $border_size=false) | |
| Draw a pie chart. More... | |
| pie_values ($values, $labels=array(), $links=array()) | |
| Set the values of the pie chart. More... | |
| pie_slice_colours ($colours) | |
| Set the pie slice colours. More... | |
| render () | |
| Render the output. More... | |
Definition at line 28 of file open-flash-chart.php.
| _set_y_label_style | ( | $size, | |
| $colour | |||
| ) |
Internal function to build the y label style for y and y2.
Definition at line 444 of file open-flash-chart.php.
| _set_y_legend | ( | $text, | |
| $size, | |||
| $colour | |||
| ) |
The private method of building the y legend output.
Definition at line 610 of file open-flash-chart.php.
| area_hollow | ( | $width, | |
| $dot_size, | |||
| $colour, | |||
| $alpha, | |||
$text = '', |
|||
$font_size = '', |
|||
$fill_colour = '' |
|||
| ) |
Draw an area chart.
| width | an int argument. The width of the line in pixels. |
| dot_size | an int argument. Size in pixels of the dot. |
| colour | a string argument. The hex colour value of the line. |
| alpha | an int argument. The percentage of transparency of the fill colour. |
| text | a string argument. The label of the line. |
| font_size | an int argument. Font size of the label. |
| fill_colour | a string argument. The hex colour value of the fill colour. |
Definition at line 801 of file open-flash-chart.php.
| attach_to_y_right_axis | ( | $data_number | ) |
Attach a set of data (a line, area or bar chart) to the right Y axis.
| data_number | an int argument. The numbered order the data was attached using set_data. |
Definition at line 416 of file open-flash-chart.php.
| bar | ( | $alpha, | |
$colour = '', |
|||
$text = '', |
|||
$size = -1 |
|||
| ) |
Draw a bar chart.
| alpha | an int argument. The percentage of transparency of the bar colour. |
| colour | a string argument. The hex colour value of the line. |
| text | a string argument. The label of the line. |
| font_size | an int argument. Font size of the label. |
Definition at line 828 of file open-flash-chart.php.
| bar_3D | ( | $alpha, | |
$colour = '', |
|||
$text = '', |
|||
$size = -1 |
|||
| ) |
Draw a 3D bar chart.
| alpha | an int argument. The percentage of transparency of the bar colour. |
| colour | a string argument. The hex colour value of the line. |
| text | a string argument. The label of the line. |
| font_size | an int argument. Font size of the label. |
Definition at line 881 of file open-flash-chart.php.
| bar_fade | ( | $alpha, | |
$colour = '', |
|||
$text = '', |
|||
$size = -1 |
|||
| ) |
Draw a faded bar chart.
| alpha | an int argument. The percentage of transparency of the bar colour. |
| colour | a string argument. The hex colour value of the line. |
| text | a string argument. The label of the line. |
| font_size | an int argument. Font size of the label. |
Definition at line 925 of file open-flash-chart.php.
| bar_filled | ( | $alpha, | |
| $colour, | |||
| $colour_outline, | |||
$text = '', |
|||
$size = -1 |
|||
| ) |
Draw a bar chart with an outline.
| alpha | an int argument. The percentage of transparency of the bar colour. |
| colour | a string argument. The hex colour value of the line. |
| colour_outline | a strng argument. The hex colour value of the outline. |
| text | a string argument. The label of the line. |
| font_size | an int argument. Font size of the label. |
Definition at line 851 of file open-flash-chart.php.
| bar_glass | ( | $alpha, | |
| $colour, | |||
| $outline_colour, | |||
$text = '', |
|||
$size = -1 |
|||
| ) |
Draw a 3D bar chart that looks like glass.
| alpha | an int argument. The percentage of transparency of the bar colour. |
| colour | a string argument. The hex colour value of the line. |
| outline_colour | a string argument. The hex colour value of the outline. |
| text | a string argument. The label of the line. |
| font_size | an int argument. Font size of the label. |
Definition at line 904 of file open-flash-chart.php.
| bar_sketch | ( | $alpha, | |
| $offset, | |||
| $colour, | |||
| $colour_outline, | |||
$text = '', |
|||
$size = -1 |
|||
| ) |
Definition at line 860 of file open-flash-chart.php.
| candle | ( | $data, | |
| $alpha, | |||
| $line_width, | |||
| $colour, | |||
$text = '', |
|||
$size = -1 |
|||
| ) |
Definition at line 934 of file open-flash-chart.php.
| esc | ( | $text | ) |
Definition at line 194 of file open-flash-chart.php.
| format_output | ( | $function, | |
| $values | |||
| ) |
Format the text to the type of output.
Definition at line 208 of file open-flash-chart.php.
| get_unique_id | ( | ) |
Get the flash object ID for the last rendered object.
Definition at line 143 of file open-flash-chart.php.
| graph | ( | ) |
Constructer for the open_flash_chart_api Sets our default variables.
Definition at line 34 of file open-flash-chart.php.
| hlc | ( | $data, | |
| $alpha, | |||
| $line_width, | |||
| $colour, | |||
$text = '', |
|||
$size = -1 |
|||
| ) |
Definition at line 949 of file open-flash-chart.php.
| line | ( | $width, | |
$colour = '', |
|||
$text = '', |
|||
$size = -1, |
|||
$circles = -1 |
|||
| ) |
Draw a line without markers on values.
| width | an int argument. The width of the line in pixels. |
| colour | a string argument. The hex colour value of the line. |
| text | a string argument. The label of the line. |
| font_size | an int argument. Font size of the label |
| circles | an int argument Need to find out. |
Definition at line 708 of file open-flash-chart.php.
| line_dot | ( | $width, | |
| $dot_size, | |||
| $colour, | |||
$text = '', |
|||
$font_size = '' |
|||
| ) |
Draw a line with solid dot markers on values.
| width | an int argument. The width of the line in pixels. |
| dot_size | an int argument. Size in pixels of the dot. |
| colour | a string argument. The hex colour value of the line. |
| text | a string argument. The label of the line. |
| font_size | an int argument. Font size of the label. |
Definition at line 745 of file open-flash-chart.php.
| line_hollow | ( | $width, | |
| $dot_size, | |||
| $colour, | |||
$text = '', |
|||
$font_size = '' |
|||
| ) |
Draw a line with hollow dot markers on values.
| width | an int argument. The width of the line in pixels. |
| dot_size | an int argument. Size in pixels of the dot. |
| colour | a string argument. The hex colour value of the line. |
| text | a string argument. The label of the line. |
| font_size | an int argument. Font size of the label. |
Definition at line 771 of file open-flash-chart.php.
| next_line | ( | ) |
returns the next line label for multiple lines.
Definition at line 184 of file open-flash-chart.php.
| pie | ( | $alpha, | |
| $line_colour, | |||
| $style, | |||
$gradient = true, |
|||
$border_size = false |
|||
| ) |
Draw a pie chart.
| alpha | an int argument. The percentage of transparency of the pie colour. |
| $style | a string argument. CSS style string |
| label_colour | a string argument. The hex colour value of the label. |
| gradient | a boolean argument. Use a gradient true or false. |
| border_size | an int argument. Size of the border in pixels. |
Definition at line 997 of file open-flash-chart.php.
| pie_slice_colours | ( | $colours | ) |
Set the pie slice colours.
| colours | an array argument. The hex colour values of the pie pieces. |
Definition at line 1037 of file open-flash-chart.php.
| pie_values | ( | $values, | |
$labels = array(), |
|||
$links = array() |
|||
| ) |
Set the values of the pie chart.
| values | an array argument. An array of the values for the pie chart. |
| labels | an array argument. An array of the labels for the pie pieces. |
| links | an array argument. An array of the links to the pie pieces. |
Definition at line 1024 of file open-flash-chart.php.
| render | ( | ) |
Render the output.
Definition at line 1046 of file open-flash-chart.php.
| scatter | ( | $data, | |
| $line_width, | |||
| $colour, | |||
$text = '', |
|||
$size = -1 |
|||
| ) |
Definition at line 964 of file open-flash-chart.php.
| set_base | ( | $base = 'js/' | ) |
Set the base path of the swfobject.
| base | a string argument. The base path of the swfobject. |
Definition at line 265 of file open-flash-chart.php.
| set_bg_colour | ( | $colour | ) |
Set the background colour.
| colour | a string argument. The hex colour value. |
Definition at line 390 of file open-flash-chart.php.
| set_bg_image | ( | $url, | |
$x = 'center', |
|||
$y = 'center' |
|||
| ) |
Set a background image.
| url | a string argument. The location of the image. |
| x | a string argument. The x location of the image. 'Right', 'Left', 'Center' |
| y | a string argument. The y location of the image. 'Top', 'Bottom', 'Middle' |
Definition at line 404 of file open-flash-chart.php.
| set_data | ( | $a | ) |
Set the data for the chart.
| a | an array argument. An array of the data to add to the chart. |
Definition at line 301 of file open-flash-chart.php.
| set_height | ( | $height | ) |
Set the height of the chart.
| height | an int argument. The height of the chart frame. |
Definition at line 254 of file open-flash-chart.php.
| set_inner_background | ( | $col, | |
$col2 = '', |
|||
$angle = -1 |
|||
| ) |
Set the background colour of the grid portion of the chart.
| col | a string argument. The hex colour value of the background. |
| col2 | a string argument. The hex colour value of the second colour if you want a gradient. |
| angle | an int argument. The angle in degrees to make the gradient. |
Definition at line 430 of file open-flash-chart.php.
| set_is_decimal_separator_comma | ( | $val | ) |
Definition at line 286 of file open-flash-chart.php.
| set_is_fixed_num_decimals_forced | ( | $val | ) |
Definition at line 281 of file open-flash-chart.php.
| set_is_thousand_separator_disabled | ( | $val | ) |
Definition at line 291 of file open-flash-chart.php.
| set_js_path | ( | $path | ) |
Set the base path for the swfobject.js.
| base_path | a string argument. The path to the swfobject.js file |
Definition at line 154 of file open-flash-chart.php.
| set_links | ( | $links | ) |
Definition at line 307 of file open-flash-chart.php.
| set_num_decimals | ( | $val | ) |
Definition at line 276 of file open-flash-chart.php.
| set_output_type | ( | $type | ) |
Set the type of output data.
| type | a string argument. The type of data. Currently only type is js, or nothing. |
Definition at line 176 of file open-flash-chart.php.
| set_swf_path | ( | $path | ) |
Set the base path for the open-flash-chart.swf.
| path | a string argument. The path to the open-flash-chart.swf file |
Definition at line 165 of file open-flash-chart.php.
| set_title | ( | $title, | |
$style = '' |
|||
| ) |
Set the text and style of the title.
| title | a string argument. The text of the title. |
| style | a string. CSS styling of the title. |
Definition at line 230 of file open-flash-chart.php.
| set_tool_tip | ( | $tip | ) |
Set the tooltip to be displayed on each chart item.
Replaceable tokens that can be used in the string include:
#val# - The actual value of whatever the mouse is over.
#key# - The key string.
<br> - New line.
#x_label# - The X label string.
#x_legend# - The X axis legend text.
Default string is: "#x_label#<br>#val#"
| tip | a string argument. A formatted string to show as the tooltip. |
Definition at line 333 of file open-flash-chart.php.
| set_unique_id | ( | ) |
Set the unique_id to use for the flash object id.
Definition at line 135 of file open-flash-chart.php.
| set_width | ( | $width | ) |
Set the width of the chart.
| width | an int argument. The width of the chart frame. |
Definition at line 243 of file open-flash-chart.php.
| set_x_axis_3d | ( | $size | ) |
Set the depth in pixels of the 3D X axis slab.
| size | an int argument. The depth in pixels of the 3D X axis. |
Definition at line 601 of file open-flash-chart.php.
| set_x_axis_steps | ( | $steps | ) |
Set how often you would like to show a tick on the x axis.
| steps | an int argument. Show a tick ever $steps. |
Definition at line 589 of file open-flash-chart.php.
| set_x_label_style | ( | $size, | |
$colour = '', |
|||
$orientation = 0, |
|||
$step = -1, |
|||
$grid_colour = '' |
|||
| ) |
Set the look and feel of the x axis labels.
| font_size | an int argument. The font size. |
| colour | a string argument. The hex colour value. |
| orientation | an int argument. The orientation of the x-axis text. 0 - Horizontal 1 - Vertical 2 - 45 degrees |
| step | an int argument. Show the label on every $step label. |
| grid_colour | a string argument. |
Definition at line 368 of file open-flash-chart.php.
| set_x_labels | ( | $a | ) |
Set the x axis labels.
| a | an array argument. An array of the x axis labels. |
Definition at line 344 of file open-flash-chart.php.
| set_x_legend | ( | $text, | |
$size = -1, |
|||
$colour = '' |
|||
| ) |
Set the parameters of the x legend.
| text | a string argument. The text of the x legend. |
| font_size | an int argument. The font size of the x legend text. |
| colour | a string argument The hex value of the font colour. |
Definition at line 561 of file open-flash-chart.php.
| set_x_max | ( | $max | ) |
Definition at line 479 of file open-flash-chart.php.
| set_x_min | ( | $min | ) |
Definition at line 484 of file open-flash-chart.php.
| set_x_offset | ( | $val | ) |
Definition at line 314 of file open-flash-chart.php.
| set_x_tick_size | ( | $size | ) |
Set the size of the x label ticks.
| size | an int argument. The size of the ticks in pixels. |
Definition at line 577 of file open-flash-chart.php.
| set_y_format | ( | $val | ) |
Definition at line 271 of file open-flash-chart.php.
| set_y_label_style | ( | $size, | |
$colour = '' |
|||
| ) |
Set the look and feel of the y axis labels.
| font_size | an int argument. The font size. |
| colour | a string argument. The hex colour value. |
Definition at line 461 of file open-flash-chart.php.
| set_y_legend | ( | $text, | |
$size = -1, |
|||
$colour = '' |
|||
| ) |
Set the parameters of the y legend.
| text | a string argument. The text of the y legend. |
| font_size | an int argument. The font size of the y legend text. |
| colour | a string argument The hex colour value of the font colour. |
Definition at line 633 of file open-flash-chart.php.
| set_y_max | ( | $max | ) |
Set the maximum value of the y axis.
| max | an float argument. The maximum value. |
Definition at line 495 of file open-flash-chart.php.
| set_y_min | ( | $min | ) |
Set the minimum value of the y axis.
| min | an float argument. The minimum value. |
Definition at line 506 of file open-flash-chart.php.
| set_y_right_label_style | ( | $size, | |
$colour = '' |
|||
| ) |
Set the look and feel of the right y axis labels.
| font_size | an int argument. The font size. |
| colour | a string argument. The hex colour value. |
Definition at line 474 of file open-flash-chart.php.
| set_y_right_legend | ( | $text, | |
$size = -1, |
|||
$colour = '' |
|||
| ) |
Set the parameters of the right y legend.
| text | a string argument. The text of the right y legend. |
| font_size | an int argument. The font size of the right y legend text. |
| colour | a string argument The hex value of the font colour. |
Definition at line 648 of file open-flash-chart.php.
| set_y_right_max | ( | $max | ) |
Set the maximum value of the right y axis.
| max | an float argument. The maximum value. |
Definition at line 517 of file open-flash-chart.php.
| set_y_right_min | ( | $min | ) |
Set the minimum value of the right y axis.
| min | an float argument. The minimum value. |
Definition at line 528 of file open-flash-chart.php.
| title | ( | $title, | |
$style = '' |
|||
| ) |
Definition at line 544 of file open-flash-chart.php.
| x_axis_colour | ( | $axis, | |
$grid = '' |
|||
| ) |
Set the colour of the x axis line and grid.
| axis | a string argument. The hex colour value of the x axis line. |
| grid | a string argument. The hex colour value of the x axis grid. |
Definition at line 661 of file open-flash-chart.php.
| y_axis_colour | ( | $axis, | |
$grid = '' |
|||
| ) |
Set the colour of the y axis line and grid.
| axis | a string argument. The hex colour value of the y axis line. |
| grid | a string argument. The hex colour value of the y axis grid. |
Definition at line 675 of file open-flash-chart.php.
| y_label_steps | ( | $val | ) |
Show the y label on every $step label.
| val | an int argument. Show the label on every $step label. |
Definition at line 539 of file open-flash-chart.php.
| y_right_axis_colour | ( | $colour | ) |
Set the colour of the right y axis line.
| colour | a string argument. The hex colour value of the right y axis line. |
Definition at line 689 of file open-flash-chart.php.
This documentation for Open ecommerce PEEL Shopping and PEEL.fr has been generated by Doxygen on Thu Oct 15 2015 14:41:43 - 
is a product of 
SAS. All rights reserved.
