Skip to content

khotim/yii2-highcharts

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

yii2-highcharts

Yii2 wrapper for Highcharts library. It supports rendering Highcharts, Highstock, and Highmaps.

Latest Stable Version License

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist khotim/yii2-highcharts "*"

or add

"khotim/yii2-highcharts": "*"

to the require section of your composer.json file.

Usage

Insert the following code into a view file (using this sample).

<?= \khotim\highcharts\Highcharts::widget([
    'chartType' => \khotim\highcharts\Highcharts::TYPE_HIGHCHARTS,
    'options' => [
        'id' => 'myChart'
    ],
   'clientOptions' => [
        'chart' => [
            'type' => 'bar'
        ],
        'title' => [
            'text' => 'Fruit Consumption'
        ],
        'xAxis' => [
            'categories' => ['Apples', 'Bananas', 'Oranges']
        ],
        'yAxis' => [
            'title' => [
                'text' => 'Fruit eaten'
            ]
        ],
        'series' => [
            [
                'name' => 'Jane',
                'data' => [1, 0, 4]
            ],
            [
                'name' =>'Production',
                'data' => [5, 7, 3]
            ]
        ]
    ]
]) ?>

Constants

Constant   Value   Description
TYPE_HIGHCHARTS   1   Chart type Highcharts.
TYPE_HIGHSTOCK   2   Chart type Highstock.
TYPE_HIGHMAPS   3   Chart type Highmaps.

Public Properties

Property   Type   Description
$chartType   integer   Specifies type of chart to be rendered. Defaults to self::TYPE_HIGHCHARTS.
$options   array   The HTML attributes for the widget container tag. The "tag" element specifies the tag name of the container element and defaults to "div".
$clientOptions   array   The options for the underlying Highcharts library. Refers to this page for more information.