Module FusionChartsHelper
In: lib/fusion_charts_helper.rb

Include this module wherever you want to use render_chart, render_chart_html and other functions Version 1.5 (August 2010) - Added other parameters as options hash. Added function enable_FC_print_manager_js to enable PrintManager. Version 1.4 (2010) - Added other parameters to the render_chart and render_chart_html methods. ( w_mode, color, scale_mode, lang, detect_flash_version,auto_install_redirect etc) Version 1.3 (March 2009) - debug_mode changes Version 1.2 (February 2009) - Compatible with rails 2.2 and above - removed the second parameter in concat. Version 1.1 (January 2009) - Added get_UTF8_BOM function

Methods

Public Instance methods

This function can be used when time needs to be added to the URL. This will help avoiding cache of the page rendered by the URL. Can be used for dataURL method.

Inserts the javascript code to enable the FC Print Manager. New feature since v3.2

This function returns the BOM for UTF8. BOM needs to be placed as first few bytes in the xml before providing to the chart. This can be used in the XML provider views.

Renders a chart from the swf file passed as parameter either making use of setChartDataURL method or setChartData method. The width and height of chart are passed as parameters to this function. If the chart is not rendered, the errors can be detected by setting debugging mode to true while calling this function. The chart can be registered with javascript by setting registerWithJS to true while calling this function.

  • parameter chart_swf : pass swf file that renders the chart.
  • parameter str_url : pass URL path to the xml file.
  • parameter str_data : pass xml content.
  • parameter chart_id : Id for the chart, using which it will be recognized in the HTML page. Each chart on the page needs to have a unique Id. Datatype: String
  • parameter chart_width : pass value as integer as the width of the chart.
  • parameter chart_height : pass value as integer as the height of the chart.
  • parameter debug_mode : By default, false. pass value as true ( a boolean ) for debugging errors, if any, while rendering the chart.
  • parameter register_with_js :By default, false. pass value as true ( a boolean ) for chart to be registered with javascript.
  • parameter options={} : Hash containing other options to render the chart. The options can be
    • data_format : "xml" or "json".
    • renderer : "flash" or "javascript".
    • w_mode : Window Mode - expected values ’’, ‘window’,’transparent’ or ‘opaque’.
    • color : Background color of the flash movie (here chart).
    • scale_mode : ‘noScale’,’exactFit’,’noBorder’,’showAll’.
    • lang : Application Message Language - 2-letter code. Currently, only "EN" is supported.
    • detect_flash_version : If set on, the user would be redirected to Adobe site if Flash player 8 is not installed.
    • auto_install_redirect : Checks the Flash Player version and if version is less than 8 and autoInstallRedirect is set on then asks the user to install Flash Player from Adobe site.

Can be called from html block in the view where the chart needs to be embedded.

Deprecated from rails 2.2.2. Uses render_component. Renders a chart using the swf file passed as parameter by calling an action to get the xml for the setDataXML method. The width and height of chart are passed as parameters to this function. If the chart is not rendered, the errors can be detected by setting debugging mode to true while calling this function.

  • parameter chart_swf : SWF file that renders the chart.
  • parameter controller_name : The complete name of the controller containing the action.
  • parameter action_name : The name of the action which will provide the xml.
  • parameter params : The parameters that have to be passed to the action as an array.
  • parameter chart_id : String for identifying chart.
  • parameter chart_width : Integer for the width of the chart.
  • parameter chart_height : Integer for the height of the chart.
  • parameter debug_mode : True ( a boolean ) for debugging errors, if any, while rendering the chart.
  • parameter options={} : Hash containing other options to render the chart.

Can be called from html block in the view where the chart needs to be embedded.

Renders a chart from the swf file passed as parameter either making use of setChartDataURL method or setChartData method. The width and height of chart are passed as parameters to this function. If the chart is not rendered, the errors can be detected by setting debug mode to true while calling this function.

  • parameter chart_swf : SWF file that renders the chart.
  • parameter str_url : URL path to the xml file.
  • parameter str_data : XML content.
  • parameter chart_id : String for identifying chart.
  • parameter chart_width : Integer for the width of the chart.
  • parameter chart_height : Integer for the height of the chart.
  • parameter debug_mode : By default, false. true ( a boolean ) for debugging errors, if any, while rendering the chart.
  • parameter register_with_js :By default, false. pass value as true ( a boolean ) for chart to be registered with javascript.
  • parameter options={} : Hash containing other options to render the chart. The options can be
  • w_mode : Window Mode - expected values ’’, ‘window’,’transparent’ or ‘opaque’.
  • color : Background color of the flash movie (here chart).
  • scale_mode : ‘noScale’,’exactFit’,’noBorder’,’showAll’.
  • lang : Application Message Language - 2-letter code. Currently, only "EN" is supported.

Can be called from html block in the view where the chart needs to be embedded.

[Validate]