ChartDirector 6.0 (Ruby Edition)

Realtime Chart with Snapshot




The example extends the Simple Realtime Chart example by adding buttons to download the chart in PNG and PDF formats.

When the button is pressed, the URL of the web page will be modified by appending an extra query parameter specifying the download format. On the server side, the charting code will check for this parameter. If the parameter exists, it will send the chart as an attachment. When the browser receives the attachment, instead of displaying it, it should save it as a file. The exact behaviour depends on the browser. Some browsers may immediately save the attachment as a file in a download directory; some browsers may prompt the user for the filename and directory; some browsers that do not support downloading files may ignore the content.

NOTE: This sample script uses "cdjcv.js". When developing your own script using this sample script as a template, please ensure you copy "cdjcv.js" to the proper directory and reference it using the proper path.

Source Code Listing

[Ruby On Rails Version - Controller] app/controllers/realtimesnapshot_controller.rb
require("chartdirector")

class RealtimesnapshotController < ApplicationController

    def getchart()
        #
        # Data to draw the chart. In this demo, the data buffer will be filled by a random data
        # generator. In real life, the data is probably stored in a buffer (eg. a database table, a
        # text file, or some global memory) and updated by other means.
        #

        # We use a data buffer to emulate the last 240 samples.
        sampleSize = 240
        dataSeries1 = Array.new(sampleSize, 0)
        dataSeries2 = Array.new(sampleSize, 0)
        dataSeries3 = Array.new(sampleSize, 0)
        timeStamps = Array.new(sampleSize, 0)

        # Our pseudo random number generator
        firstDate = Time.new - timeStamps.length
        0.upto(timeStamps.length - 1) do |i|
            timeStamps[i] = firstDate + i
            p = timeStamps[i].to_i
            dataSeries1[i] = Math.cos(p * 2.1) * 10 + 1 / (Math.cos(p) * Math.cos(p) + 0.01) + 20
            dataSeries2[i] = 100 * Math.sin(p / 27.7) * Math.sin(p / 10.1) + 150
            dataSeries3[i] = 100 * Math.cos(p / 6.7) * Math.cos(p / 11.9) + 150
        end

        # Create an XYChart object 600 x 320 pixels in size
        c = ChartDirector::XYChart.new(600, 320)

        # Set the plotarea at (55, 60) and of size 520 x 235 pixels with transparent background and
        # border. Enable both horizontal and vertical grids by setting their colors to grey
        # (cccccc). Set clipping mode to clip the data lines to the plot area.
        c.setPlotArea(55, 60, 520, 235, -1, -1, ChartDirector::Transparent, 0xcccccc, 0xcccccc)
        c.setClipping()

        # Add a title to the chart using dark grey (0x333333) 20pt Arial Bold font
        c.addTitle("Realtime Chart with Snapshot", "arialbd.ttf", 20, 0x333333)

        # Add a legend box at the top of the plot area using horizontal layout. Use 10pt Arial Bold
        # font, transparent background and border, and line style legend icon.
        b = c.addLegend(55, 30, false, "arialbd.ttf", 10)
        b.setBackground(ChartDirector::Transparent, ChartDirector::Transparent)
        b.setLineStyleKey()

        # Set the x and y axis stems to transparent and the label font to 10pt Arial
        c.xAxis().setColors(ChartDirector::Transparent)
        c.yAxis().setColors(ChartDirector::Transparent)
        c.xAxis().setLabelStyle("arial.ttf", 10)
        c.yAxis().setLabelStyle("arial.ttf", 10)

        # Add y-axis title using 12pt Arial font
        c.yAxis().setTitle("Y-Axis Title Placeholder", "arial.ttf", 12)

        # For the automatic x and y axis labels, set the minimum spacing to 75 and 30 pixels.
        c.xAxis().setTickDensity(75)
        c.yAxis().setTickDensity(30)

        # Set the x-axis label format
        c.xAxis().setLabelFormat("{value|hh:nn:ss}")

        # Create a line layer to plot the lines
        layer = c.addLineLayer2()

        # The x-coordinates are the timeStamps.
        layer.setXData(timeStamps)

        # The 3 data series are used to draw 3 lines. Here we put the latest data values as part of
        # the data set name, so you can see them updated in the legend box.
        layer.addDataSet(dataSeries1, 0xff0000, c.formatValue(dataSeries1[dataSeries1.length - 1],
            "Alpha: {value|2}"))
        layer.addDataSet(dataSeries2, 0x00cc00, c.formatValue(dataSeries2[dataSeries2.length - 1],
            "Beta: {value|2}"))
        layer.addDataSet(dataSeries3, 0x0000ff, c.formatValue(dataSeries3[dataSeries3.length - 1],
            "Gamma: {value|2}"))

        # Check if is download request
        downloadFormat = params["download"]
        if !((downloadFormat == nil) || (downloadFormat == ""))
            fname = sprintf("demo_%s", c.formatValue(timeStamps[timeStamps.length - 1],
                "yyyymmddhhnnss"))
            if downloadFormat == "pdf"
                # Output in PDF and stream as attachment
                send_data(c.makeChart2(ChartDirector::PDF), :type => "application/pdf",
                    :disposition => "attachment", :filename => fname + ".pdf")
                return
            else
                # Output in PNG and stream as attachment
                send_data(c.makeChart2(ChartDirector::PNG), :type => "image/png",
                    :disposition => "attachment", :filename => fname + ".png")
                return
            end
        end

        # Output the chart
        send_data(c.makeChart2(ChartDirector::PNG), :type => "image/png", :disposition => "inline")

    end

end

[Ruby On Rails Version - View] app/views/realtimesnapshot/index.html.erb
<!DOCTYPE html>
<html>
<head>
    <title>Realtime Chart with Snapshot</title>
    <script type="text/javascript" src="/javascripts/cdjcv.js"></script>
</head>
<body style="margin:0px">
<table cellspacing="0" cellpadding="0" style="border:black 1px solid;">
    <tr>
        <td align="right" colspan="2" style="background:#000088; color:#ffff00; padding:0px 4px 2px 0px;">
            <a style="color:#FFFF00; font:italic bold 10pt Arial; text-decoration:none" href="http://www.advsofteng.com/">
                Advanced Software Engineering
            </a>
        </td>
    </tr>
    <tr valign="top">
        <td style="width:130px; background:#c0c0ff; border-right:black 1px solid; border-bottom:black 1px solid;">
            <br />
            <br />
            <div style="font:12px Verdana; padding:10px;">
                <b>Update Period</b><br />
                <select id="UpdatePeriod" style="width:110px">
                    <option value="5">5</option>
                    <option value="10" selected="selected">10</option>
                    <option value="20">20</option>
                    <option value="30">30</option>
                    <option value="60">60</option>
                </select>
                <br /><br /><br />
                <b>Time Remaining</b><br />
                <div style="width:108px; border:#888888 1px inset;">
                    <div style="margin:3px" id="TimeRemaining">0</div>
                </div>
            </div>
            <br />
            <br />
            <br />
            <br />
            <div style="text-align:center">
                <input type="button" value="Download PDF" onclick="download('pdf')" style="width:112px; font:10pt Arial" /><br />
                <input type="button" value="Download PNG" onclick="download('png')" style="width:112px; font:10pt Arial" />
            </div>
        </td>
        <td style="border-left:black 1px solid; padding:5px 0px 0px 5px;" >
            <!-- ****** Here is the image tag for the chart image ****** -->
            <img id="ChartImage1" src="<%= url_for(:action => 'getchart', :chartId => 'demoChart1') %>">
        </td>
    </tr>
</table>
<script type="text/javascript">

//
// Executes once every second to update the countdown display. Updates the chart when the countdown reaches 0.
//
function timerTick()
{
    // Get the update period and the time left
    var updatePeriod = parseInt(document.getElementById("UpdatePeriod").value);
    var timeLeft = Math.min(parseInt(document.getElementById("TimeRemaining").innerHTML), updatePeriod) - 1;

    if (timeLeft == 0)
        // Can update the chart now
        JsChartViewer.get('ChartImage1').streamUpdate();
    else if (timeLeft < 0)
        // Reset the update period
        timeLeft += updatePeriod;

    // Update the countdown display
    document.getElementById("TimeRemaining").innerHTML = timeLeft;
}
window.setInterval("timerTick()", 1000);

//
// Send a request to the server with the query parameter "download=xxx". The server should handle this
// as a download request.
//
function download(format)
{
    var imageURL = document.getElementById("ChartImage1").src;
    imageURL += ((imageURL.indexOf('?') == -1) ? '?' : '&') + "download=" + format;

    // Download as an attachment to the current window
    location.href = imageURL;
}

</script>
</body>
</html>