src/cm/media/js/lib/yui/yui_3.10.3/docs/charts/charts-legend.html
author Yves-Marie Haussonne <ymh.work+github@gmail.com>
Fri, 09 May 2014 18:35:26 +0200
changeset 656 a84519031134
parent 525 89ef5ed3c48b
permissions -rw-r--r--
add link to "privacy policy" in the header test

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>Example: Create Chart with a Legend</title>
    <link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,700,400italic,700italic">
    <link rel="stylesheet" href="../../build/cssgrids/cssgrids-min.css">
    <link rel="stylesheet" href="../assets/css/main.css">
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
    <link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
    <script src="../../build/yui/yui-min.js"></script>
    
</head>
<body>
<!--
<a href="https://github.com/yui/yui3"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a>
-->
<div id="doc">
    <div id="hd">
        <h1><img src="http://yuilibrary.com/img/yui-logo.png"></h1>
    </div>
    

            <h1>Example: Create Chart with a Legend</h1>
    <div class="yui3-g">
        <div class="yui3-u-3-4">
            <div id="main">
                <div class="content"><style scoped>
#mychart {
    margin:10px 10px 10px 10px;
    width:90%;
    max-width: 800px;
    height:400px;
}
</style>
<div class="intro">
<p>This example shows how to add a legend to a <code>Chart</code>.</p>
</div>
<div class="example">
<div id="mychart"></div>
<script type="text/javascript">
(function() {
    YUI().use('charts-legend', function (Y) 
    { 
        var myDataValues = [ 
            {date:"5/1/2010", miscellaneous:2000, expenses:3700, revenue:2200}, 
            {date:"5/2/2010", miscellaneous:50, expenses:9100, revenue:100}, 
            {date:"5/3/2010", miscellaneous:400, expenses:1100, revenue:1500}, 
            {date:"5/4/2010", miscellaneous:200, expenses:1900, revenue:2800}, 
            {date:"5/5/2010", miscellaneous:5000, expenses:5000, revenue:2650}
        ];
    
        var myChart = new Y.Chart({
                            legend: {
                                position: "right",
                                width: 300,
                                height: 300,
                                styles: {
                                    hAlign: "center",
                                    hSpacing: 4
                                }
                            },
                            axes: {
                                category: {
                                    keys: ["date"],
                                    type: "category",
                                    styles: {
                                        label: {
                                            rotation: -90
                                        }
                                    }
                                }
                            },
                            categoryKey: "date",
                            dataProvider:myDataValues, 
                            horizontalGridlines: true,
                            verticalGridlines: true,
                            render:"#mychart"
                        });
        
    });
})();
</script>

</div>
<h3>Adding a legend to a <code>Chart</code> instance</h3>

<p>When a chart has multiple series, a legend can allow the user to identify each series more easily. The <code>charts</code> module includes a <code>charts-legend</code> submodule. Specifying
<code>charts-legend</code> in you use statement allows you to add a legend to a <code>Chart</code> instance. A legend is added to a chart through the <code>legend</code> attribute. This attribute is an
object containing value pairs for the attributes of a legend. All available attributes for the <code>legend</code> are outlined <a href="index.html#usinglegend">here</a>. In the 
example below, we will add a legend to a chart instance.</p>

<h4>CSS</h4>
<pre class="code prettyprint">#mychart {
    margin:10px 10px 10px 10px;
    width:90%;
    max-width: 800px;
    height:400px;
}</pre>


<h4>HTML</h4>
<pre class="code prettyprint">&lt;div id=&quot;mychart&quot;&gt;&lt;&#x2F;div&gt;</pre>


<h4>JavaScript</h4>
<pre class="code prettyprint">YUI().use(&#x27;charts-legend&#x27;, function (Y) 
{ 
    var myDataValues = [ 
        {date:&quot;5&#x2F;1&#x2F;2010&quot;, miscellaneous:2000, expenses:3700, revenue:2200}, 
        {date:&quot;5&#x2F;2&#x2F;2010&quot;, miscellaneous:50, expenses:9100, revenue:100}, 
        {date:&quot;5&#x2F;3&#x2F;2010&quot;, miscellaneous:400, expenses:1100, revenue:1500}, 
        {date:&quot;5&#x2F;4&#x2F;2010&quot;, miscellaneous:200, expenses:1900, revenue:2800}, 
        {date:&quot;5&#x2F;5&#x2F;2010&quot;, miscellaneous:5000, expenses:5000, revenue:2650}
    ];

    var myChart = new Y.Chart({
                        legend: {
                            position: &quot;right&quot;,
                            width: 300,
                            height: 300,
                            styles: {
                                hAlign: &quot;center&quot;,
                                hSpacing: 4
                            }
                        },
                        axes: {
                            category: {
                                keys: [&quot;date&quot;],
                                type: &quot;category&quot;,
                                styles: {
                                    label: {
                                        rotation: -90
                                    }
                                }
                            }
                        },
                        categoryKey: &quot;date&quot;,
                        dataProvider:myDataValues, 
                        horizontalGridlines: true,
                        verticalGridlines: true,
                        render:&quot;#mychart&quot;
                    });
    
});</pre>

</div>
            </div>
        </div>

        <div class="yui3-u-1-4">
            <div class="sidebar">
                

                
                    <div class="sidebox">
                        <div class="hd">
                            <h2 class="no-toc">Examples</h2>
                        </div>

                        <div class="bd">
                            <ul class="examples">
                                
                                    
                                        <li data-description="Shows how to use Charts to create a basic chart.">
                                            <a href="charts-simple.html">Basic Charts Implementation</a>
                                        </li>
                                    
                                
                                    
                                        <li data-description="Shows how to create a chart with multiple series.">
                                            <a href="charts-multiseries.html">Chart with Multiple Series</a>
                                        </li>
                                    
                                
                                    
                                        <li data-description="Shows how to create a column chart with multiple series.">
                                            <a href="charts-column.html">Specify Chart Type</a>
                                        </li>
                                    
                                
                                    
                                        <li data-description="Shows how to create a column chart with a stacked numeric axis.">
                                            <a href="charts-stackedcolumn.html">Create Stacked Chart</a>
                                        </li>
                                    
                                
                                    
                                        <li data-description="Shows how to create a chart with a time axis.">
                                            <a href="charts-timeaxis.html">Create a Chart with a Time Axis</a>
                                        </li>
                                    
                                
                                    
                                        <li data-description="Shows how to add gridlines to a chart.">
                                            <a href="charts-gridlines.html">Add Gridlines to a Chart</a>
                                        </li>
                                    
                                
                                    
                                        <li data-description="Shows how to create a chart with planar based events.">
                                            <a href="charts-stackedarea.html">Create a Stacked Area Chart with Planar Based Events</a>
                                        </li>
                                    
                                
                                    
                                        <li data-description="Shows how to use a chart&#x27;s styles attribute to customize a chart.">
                                            <a href="charts-globalstyles.html">Customize a Chart</a>
                                        </li>
                                    
                                
                                    
                                        <li data-description="Shows how to customize the default tooltip of a chart.">
                                            <a href="charts-customizedtooltip.html">Customize a Chart&#x27;s Tooltip</a>
                                        </li>
                                    
                                
                                    
                                        <li data-description="Shows how to explicitly define the axes and series for a chart.">
                                            <a href="charts-objectstyles.html">Define a Chart&#x27;s Axes and Series</a>
                                        </li>
                                    
                                
                                    
                                        <li data-description="Shows how to use charts to create a pie chart.">
                                            <a href="charts-pie.html">Pie Chart</a>
                                        </li>
                                    
                                
                                    
                                        <li data-description="Shows how to create a chart with multiple value axes.">
                                            <a href="charts-dualaxes.html">Dual Axes Chart</a>
                                        </li>
                                    
                                
                                    
                                        <li data-description="Shows how to access a chart instance&#x27;s value axis after the chart has rendered.">
                                            <a href="charts-axisupdate.html">Update Chart Axis</a>
                                        </li>
                                    
                                
                                    
                                        <li data-description="Shows how to access a chart instance&#x27;s seriesCollection after the chart has rendered.">
                                            <a href="charts-seriesupdate.html">Update Chart Series</a>
                                        </li>
                                    
                                
                                    
                                        <li data-description="Shows how to add a legend to a chart.">
                                            <a href="charts-legend.html">Create Chart with a Legend</a>
                                        </li>
                                    
                                
                                    
                                        <li data-description="Shows how to render multiple data points in a singe marker.">
                                            <a href="charts-groupmarkers.html">Group Marker Chart</a>
                                        </li>
                                    
                                
                            </ul>
                        </div>
                    </div>
                

                
            </div>
        </div>
    </div>
</div>

<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>

<script>
YUI.Env.Tests = {
    examples: [],
    project: '../assets',
    assets: '../assets/charts',
    name: 'charts-legend',
    title: 'Create Chart with a Legend',
    newWindow: '',
    auto:  false 
};
YUI.Env.Tests.examples.push('charts-simple');
YUI.Env.Tests.examples.push('charts-multiseries');
YUI.Env.Tests.examples.push('charts-column');
YUI.Env.Tests.examples.push('charts-stackedcolumn');
YUI.Env.Tests.examples.push('charts-timeaxis');
YUI.Env.Tests.examples.push('charts-gridlines');
YUI.Env.Tests.examples.push('charts-stackedarea');
YUI.Env.Tests.examples.push('charts-globalstyles');
YUI.Env.Tests.examples.push('charts-customizedtooltip');
YUI.Env.Tests.examples.push('charts-objectstyles');
YUI.Env.Tests.examples.push('charts-pie');
YUI.Env.Tests.examples.push('charts-dualaxes');
YUI.Env.Tests.examples.push('charts-axisupdate');
YUI.Env.Tests.examples.push('charts-seriesupdate');
YUI.Env.Tests.examples.push('charts-legend');
YUI.Env.Tests.examples.push('charts-groupmarkers');

</script>
<script src="../assets/yui/test-runner.js"></script>



</body>
</html>