Skip to content

Latest commit

 

History

History
122 lines (91 loc) · 2.95 KB

README.md

File metadata and controls

122 lines (91 loc) · 2.95 KB
Raw

WinnersPodiumChart

Current Version: 0.5-beta-2

WinnersPodiumChart is a tiny JavaScript library to display highscore statistics in a fun way. It can be used to display the winners for the first, second, and third place.

Uses jquery 3.x and anime.js

Features

Usage

First, specify a div container:

<!-- This is where the chart will appended to -->
<div id="container" style="height: 300px;"></div>

Define height and width of the chart by setting the css height and width properties of the outer div with id container. The chart will take 60% of space of the div container.

Second, pass the selection of the container the the constructor of the graph:

var data = [
    {
        name: "Alice",
        value: 100
    },
    {
        name: "Bob",
        value: 30
    },
    {
        name: "Carl",
        value: 50
    }
];

var myChart = new winnerStepPlot($('#container'));
myChart.data(data);
myChart.draw();

Data format

    var data = [
        {
            name: "Anna",
            value: 100
        },
        {
            name: "Bob",
            value: 30
        },
        {
            name: "Carl",
            value: 50
        }
    ];

Examples

See the example in testPage.html

Customize

You can change the base style with the css classes. All changes related to css classes and properties are referring to the stylesheet winnersPodiumChart.css.

Font

Edit font-family property of css class .wpc-chart

Change colours

You can supply an array of colour values to the chart class with

myChart.colours(["#425BAB", "#3FAB59", "#8A48AB"]);

The colours will be recycled if less than three colours are specified. Up to three colours are supported, more colours will not be used. They are applied in the following way (from left to right): second place, first place, third place.

Change medal icon

Modify the background-image property of the css class .wpc-footer > .names

API

Data

see section data format for the data format.

data(_) supply argument to set new data. If no argument is passed to the method, the current data set is returned.

Change animation duration

Redraw

Reset the animation. Useful if the chart is supplied with new data. Set new data and call animate:

myChart.data(newData);
myChart.reAnimate();

Resources

The following resources were used:

Websites using the winnersPodiumChart

( feel free to send me your website using this component! :) )