README

轻松地将Highcharts、Highstock和Highmaps图表添加到您的Yii2应用程序中。

关于

Highcharts

为您的Web项目轻松创建交互式图表。Highcharts被成千上万的开发者使用，其中59家是世界上最顶尖的100家公司之一，它是市场上最简单但最灵活的图表API。

Highstock

Highstock允许您使用纯JavaScript创建股票或通用时间线图表。包括复杂的导航选项，如小型导航系列、预设日期范围、日期选择器、滚动和缩放。

Highmaps

构建交互式地图以显示销售、选举结果或与地理相关的任何其他信息。非常适合独立使用或在仪表板中使用，与Highcharts相结合！

安装

安装此扩展的首选方法是通过composer。

运行以下命令：

php composer.phar require sankaest/yii2-highcharts-widget

或者

"sankaest/yii2-highcharts-widget": "^8.0"

将以下内容添加到您的composer.json文件的require部分。

使用方法

首选方法（使用PHP数组）

要使用此小部件，将以下代码插入到视图文件中

use sankaest\highcharts\Highcharts;

echo Highcharts::widget([
   'options' => [
      'title' => ['text' => 'Fruit Consumption'],
      'xAxis' => [
         'categories' => ['Apples', 'Bananas', 'Oranges']
      ],
      'yAxis' => [
         'title' => ['text' => 'Fruit eaten']
      ],
      'series' => [
         ['name' => 'Jane', 'data' => [1, 0, 4]],
         ['name' => 'John', 'data' => [5, 7, 3]]
      ]
   ]
]);

通过配置options属性，您可以指定需要传递给Highcharts JavaScript对象的选项。请参阅Highcharts网站上的示例画廊和文档以获取可能的选项。

有关更多使用示例，请参阅/doc/examples。

备选方法（使用JSON字符串）

或者，您可以使用有效的JSON字符串（使用双引号）代替关联数组来指定选项

use sankaest\highcharts\Highcharts;

echo Highcharts::widget([
   'options'=>'{
      "title": { "text": "Fruit Consumption" },
      "xAxis": {
         "categories": ["Apples", "Bananas", "Oranges"]
      },
      "yAxis": {
         "title": { "text": "Fruit eaten" }
      },
      "series": [
         { "name": "Jane", "data": [1, 0, 4] },
         { "name": "John", "data": [5, 7,3] }
      ]
   }'
]);

注意：在使用第二种选项时，您必须提供一个有效的JSON字符串。您可以使用JSONLint在线快速验证您的JSON字符串。

仅包含资产

如果您只想在视图中包含Highcharts/Highstock/Highmaps JavaScript库，可以跳过小部件并直接访问资产包

use sankaest\highcharts\HighchartsAsset;

HighchartsAsset::register($this)->withScripts(['modules/stock', 'modules/exporting', 'modules/drilldown']);

在这种情况下，您需要编写并包含自己的JavaScript来显示图表，就像在Highcharts演示、Highstock演示和Highmaps演示页面上所展示的那样。

提示

此扩展使用Bower来加载所需的Highcharts资产，因此不需要在您的composer.json文件中更改版本号，直到下一个主要版本。
如果您需要在任何配置选项中使用JavaScript，请使用Yii的[[JsExpression]]对象。例如
```
...
'tooltip' => [
   'formatter' => new JsExpression('function(){ return this.series.name; }')
],
...
```
注意，这目前仅在使用PHP关联数组（首选方法）进行配置时才可行。
Highcharts默认在图表的右下角显示一个小型版权标签。您可以使用以下顶级选项来删除它。
```
...
'credits' => ['enabled' => false],
...
```

必须通过顶级'scripts'选项启用所有适配器、模块、主题和补充图表类型。

...
'scripts' => [
   'highcharts-more',   // enables supplementary chart types (gauge, arearange, columnrange, etc.)
   'modules/exporting', // adds Exporting button/menu to chart
   'themes/grid'        // applies global 'grid' theme to all charts
],
...

有关可用脚本的列表，请参阅vendor/bower/highcharts/的内容。

您可以从另一个脚本中以这种方式访问JavaScript图表对象
```
var chart = $('#my-chart-id').highcharts();
```
其中 my-chart-id 通过顶层 id 配置选项设置。只需确保在组件声明之后注册您的脚本，以便它有机会初始化。
顶层 'callback' 选项允许您在 AJAX 请求或其他预处理之后初始化图表。请参阅包含的 Highstock 组件示例了解用法。

sankaest / yii2-highcharts

维护者

详细信息