|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /home/queenjbs/www/FusionChart/Code/RoR/SampleApp/doc/app/classes/ |
Upload File : |
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Module: FusionChartsHelper</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Module</strong></td>
<td class="class-name-in-header">FusionChartsHelper</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/fusion_charts_helper_rb.html">
lib/fusion_charts_helper.rb
</a>
<br />
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
Include this module wherever you want to use <a
href="FusionChartsHelper.html#M000110">render_chart</a>, <a
href="FusionChartsHelper.html#M000111">render_chart_html</a> and other
functions Version 1.5 (August 2010) - Added other parameters as options
hash. Added function <a
href="FusionChartsHelper.html#M000113">enable_FC_print_manager_js</a> to
enable PrintManager. Version 1.4 (2010) - Added other parameters to the <a
href="FusionChartsHelper.html#M000110">render_chart</a> and <a
href="FusionChartsHelper.html#M000111">render_chart_html</a> 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 <a
href="FusionChartsHelper.html#M000115">get_UTF8_BOM</a> function
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000114">add_cache_to_data_url</a>
<a href="#M000113">enable_FC_print_manager_js</a>
<a href="#M000115">get_UTF8_BOM</a>
<a href="#M000110">render_chart</a>
<a href="#M000112">render_chart_get_xml_from_action</a>
<a href="#M000111">render_chart_html</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000114" class="method-detail">
<a name="M000114"></a>
<div class="method-heading">
<a href="FusionChartsHelper.src/M000114.html" target="Code" class="method-signature"
onclick="popupCode('FusionChartsHelper.src/M000114.html');return false;">
<span class="method-name">add_cache_to_data_url</span><span class="method-args">(str_data_url)</span>
</a>
</div>
<div class="method-description">
<p>
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.
</p>
</div>
</div>
<div id="method-M000113" class="method-detail">
<a name="M000113"></a>
<div class="method-heading">
<a href="FusionChartsHelper.src/M000113.html" target="Code" class="method-signature"
onclick="popupCode('FusionChartsHelper.src/M000113.html');return false;">
<span class="method-name">enable_FC_print_manager_js</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Inserts the javascript code to enable the FC Print Manager. New feature
since v3.2
</p>
</div>
</div>
<div id="method-M000115" class="method-detail">
<a name="M000115"></a>
<div class="method-heading">
<a href="FusionChartsHelper.src/M000115.html" target="Code" class="method-signature"
onclick="popupCode('FusionChartsHelper.src/M000115.html');return false;">
<span class="method-name">get_UTF8_BOM</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
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.
</p>
</div>
</div>
<div id="method-M000110" class="method-detail">
<a name="M000110"></a>
<div class="method-heading">
<a href="FusionChartsHelper.src/M000110.html" target="Code" class="method-signature"
onclick="popupCode('FusionChartsHelper.src/M000110.html');return false;">
<span class="method-name">render_chart</span><span class="method-args">(chart_swf,str_url,str_data,chart_id,chart_width,chart_height,debug_mode=false,register_with_js=false,options={})</span>
</a>
</div>
<div class="method-description">
<p>
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.
</p>
<ul>
<li>parameter chart_swf : pass swf file that renders the chart.
</li>
<li>parameter str_url : pass URL path to the xml file.
</li>
<li>parameter str_data : pass xml content.
</li>
<li>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
</li>
<li>parameter chart_width : pass value as integer as the width of the chart.
</li>
<li>parameter chart_height : pass value as integer as the height of the chart.
</li>
<li>parameter debug_mode : By default, false. pass value as true ( a boolean )
for debugging errors, if any, while rendering the chart.
</li>
<li>parameter register_with_js :By default, false. pass value as true ( a
boolean ) for chart to be registered with javascript.
</li>
<li>parameter options={} : Hash containing other options to render the chart.
The options can be
<ul>
<li>data_format : "xml" or "json".
</li>
<li>renderer : "flash" or "javascript".
</li>
<li>w_mode : Window Mode - expected values ’’,
‘window’,’transparent’ or ‘opaque’.
</li>
<li>color : Background color of the flash movie (here chart).
</li>
<li>scale_mode :
‘noScale’,’exactFit’,’noBorder’,’showAll’.
</li>
<li>lang : Application Message Language - 2-letter code. Currently, only
"EN" is supported.
</li>
<li>detect_flash_version : If set on, the user would be redirected to Adobe
site if Flash player 8 is not installed.
</li>
<li>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.
</li>
</ul>
</li>
</ul>
<p>
Can be called from html block in the view where the chart needs to be
embedded.
</p>
</div>
</div>
<div id="method-M000112" class="method-detail">
<a name="M000112"></a>
<div class="method-heading">
<a href="FusionChartsHelper.src/M000112.html" target="Code" class="method-signature"
onclick="popupCode('FusionChartsHelper.src/M000112.html');return false;">
<span class="method-name">render_chart_get_xml_from_action</span><span class="method-args">(chart_swf,controller_name,action_name,params,chart_id,chart_width,chart_height,debug_mode=false,register_with_js=false,options={})</span>
</a>
</div>
<div class="method-description">
<p>
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.
</p>
<ul>
<li>parameter chart_swf : SWF file that renders the chart.
</li>
<li>parameter controller_name : The complete name of the controller containing
the action.
</li>
<li>parameter action_name : The name of the action which will provide the xml.
</li>
<li>parameter params : The parameters that have to be passed to the action as
an array.
</li>
<li>parameter chart_id : String for identifying chart.
</li>
<li>parameter chart_width : Integer for the width of the chart.
</li>
<li>parameter chart_height : Integer for the height of the chart.
</li>
<li>parameter debug_mode : True ( a boolean ) for debugging errors, if any,
while rendering the chart.
</li>
<li>parameter options={} : Hash containing other options to render the chart.
</li>
</ul>
<p>
Can be called from html block in the view where the chart needs to be
embedded.
</p>
</div>
</div>
<div id="method-M000111" class="method-detail">
<a name="M000111"></a>
<div class="method-heading">
<a href="FusionChartsHelper.src/M000111.html" target="Code" class="method-signature"
onclick="popupCode('FusionChartsHelper.src/M000111.html');return false;">
<span class="method-name">render_chart_html</span><span class="method-args">(chart_swf,str_url,str_data,chart_id,chart_width,chart_height,debug_mode=false,register_with_js=false)</span>
</a>
</div>
<div class="method-description">
<p>
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.
</p>
<ul>
<li>parameter chart_swf : SWF file that renders the chart.
</li>
<li>parameter str_url : URL path to the xml file.
</li>
<li>parameter str_data : XML content.
</li>
<li>parameter chart_id : String for identifying chart.
</li>
<li>parameter chart_width : Integer for the width of the chart.
</li>
<li>parameter chart_height : Integer for the height of the chart.
</li>
<li>parameter debug_mode : By default, false. true ( a boolean ) for debugging
errors, if any, while rendering the chart.
</li>
<li>parameter register_with_js :By default, false. pass value as true ( a
boolean ) for chart to be registered with javascript.
</li>
<li>parameter options={} : Hash containing other options to render the chart.
The options can be
</li>
<li>w_mode : Window Mode - expected values ’’,
‘window’,’transparent’ or ‘opaque’.
</li>
<li>color : Background color of the flash movie (here chart).
</li>
<li>scale_mode :
‘noScale’,’exactFit’,’noBorder’,’showAll’.
</li>
<li>lang : Application Message Language - 2-letter code. Currently, only
"EN" is supported.
</li>
</ul>
<p>
Can be called from html block in the view where the chart needs to be
embedded.
</p>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>