README

Google Charts 的 Yii 2.0 方法

yii2-gcharts 是一个用于在 Yii 2.0 PHP 框架中渲染选定的 Google Charts 的工具包，就像使用 GridView 一样。

目前，yii2-gcharts 包含以下小部件

• AreaChart
• BarChart
• BubbleChart
• ColumnChart
• GeoChart
• LineChart
• PieChart
• ScatterChart

Yii2-gcharts 的一个演示在这里 here。

安装

使用 Composer 安装 yii2-gcharts。您可以将以下内容添加到您的 composer.json 文件的 require 部分

"sjaakp/yii2-gcharts": "*"

或者运行

composer require sjaakp/yii2-gcharts "*"

您可以通过 下载 ZIP 格式的源代码 来手动安装 yii2-gcharts。

使用 yii2-gcharts

就像使用 GridView 一样使用 yii2 charts 小部件。例如，在控制器中您可能看到如下代码

<?php
// ...
public function actionPie()	{
	$dataProvider = new ActiveDataProvider([
		'query' => Country::find(),
	    'pagination' => false
	]);
	
	return $this->render('pie', [
		'dataProvider' => $dataProvider
	]);
}
// ...
?>

在视图中渲染 PieChart，我们可以使用

<?php
use sjaakp\gcharts\PieChart;
?>
...
<?= PieChart::widget([
    'height' => '400px',
    'dataProvider' => $dataProvider,
    'columns' => [
        'name:string',
        'population'
    ],
    'options' => [
        'title' => 'Countries by Population'
    ],
]) ?>
...

每种图表类型在列解释上略有不同，并有一组自己的选项。请参阅 Google Charts 文档。

选项

所有 yii2-gcharts 小部件都共享相同的选项

dataProvider

图表的数据提供者。此属性是必需的。在大多数情况下，它将是 ActiveDataProvider 或 ArrayDataProvider。

columns

图表列配置数组。每个数组元素配置一个图表列。每个列配置都是一个 array 或一个 string 快捷方式。

一个 array 列配置可以有以下成员（所有都是可选的，但至少必须提供一个）

• attribute 与此列相关联的属性名称。当未指定 value 时，将从每个数据模型中检索属性的值。

• formatted 数据的 Google Charts 格式化版本。可以是一个形式为 function($model, $attribute, $index, $widget) 的可调用函数。

• label 分配给数据的标签。如果没有提供，它将是从模型中检索到的，或者是从 attribute 推导出来的。

• pattern Google Charts 的 模式。

• role Google Charts 的 角色。可以是以下之一

  • "annotation"
  • "annotationText"
  • "certainty"
  • "emphasis"
  • "interval"
  • "scope"
  • "style"
  • "tooltip"

• type Google Charts 的 数据类型。可以是以下之一

  • "number" (默认)
  • "string"
  • "boolean"
  • "date"
  • "datetime"
  • timeofday

• 值 数据值。这可以是一个形式为 function($model, $attribute, $index, $widget) 的可调用对象。如果没有提供，则使用模型的 attribute 的值。

使用 string 快捷配置指定属性、类型和标签，格式为 "attribute:type:label"。类型和标签都是可选的；如果省略，则使用默认值。

模式

string 这决定了绘制图表的哪个变体。必须是以下之一

• "classic" (默认) 绘制图表的 '普通' 版本，
• "material" 如果可用，绘制新的 Material 版本的图表，
• "transition" 如果可用，绘制 Material 版本的图表，并应用 convertOptions() 到选项上

注意 目前只有少数图表在 Material 版本中可用，并且它们处于早期测试阶段，缺少许多 'classic' 选项。

注意 目前，Material 选项尚未记录文档，因此与 Material 图表一起工作的唯一实际方法是使用 "transition" 模式。

版本

string 使用的 gcharts 库的版本。必须是以下之一

• "current" (默认)，
• "upcoming",
• 数字

更多信息。

mapsApiKey

string 仅适用于 GeoChart。建议向 GeoChart 提供一个 API密钥。