DualChartCard
Overview #
DualChartCard
is another special type of card in which there are graphs to show below the main value. The full class name of DualChartCard is \koolreport\amazing\DualChartCard
. Different of ChartCard which has only one chart, DualChartCard
has two charts. The additional charts may help if you want to show two indication chart at the same time, for example, one chart showing sale amount and other showing the number of orders.
Sample Code #
<?php
\koolreport\amazing\DualChartCard::create(array(
"title"=>"SALE",
"infoText"=>"December 2018",
"value"=>7000,
"baseValue"=>8000,
"format"=>array(
"value"=>array(
"prefix"=>"$"
)
),
"preset"=>"info",
"chart"=>array(
"dataSource"=>$this->dataStore("sale"),
"columns"=>array(
"month",
"amount"=>array(
"prefix"=>"$",
)
)
),
"secondChart"=>array(
"dataSource"=>$this->dataStore("sale"),
"columns"=>array(
"month",
"number"
)
),
"cssClass"=>array(
"icon"=>"fa fa-dollars"
),
));
?>
Properties #
Name | type | default | description |
---|---|---|---|
title | string | The title of the card | |
value | number | The value that you need to show | |
infoText | string | Text under title | |
format | array | Contain settings for formatting the value | |
preset | string | "primary" | The preset appearance for card, accept "primary" , "info" , "warning" , "danger" |
cssClass | array | Contain settings for css class | |
cssStyle | array | Contain settings for css style | |
chart | array | Settings for chart | |
secondChart | array | Settings for secondChart | |
indicator | array | Settings for indicator | |
href | string/function | Set an url or an action for card when it is clicked |
Format #
There are number of settings to format the value
of card:
\koolreport\amazing\DualChartCard::create(array(
...
"format"=>array(
"value"=>array(
"decimals"=>2, // Number of decimals to show
"decimalPoint"=>".", // Decimal point character
"thounsandSeparator"=>",", // Thousand separator
"prefix"=>"$", // Prefix
"suffix"=>"USD" // Suffix
)
)
))
cssClass #
There are number of sub settings for cssClass:
Name | type | default | description |
---|---|---|---|
card | string | Set extra css class for card | |
title | string | Set css class for title | |
value | string | Set css class for value | |
icon | string | Set css class for icon |
Example:
\koolreport\amazing\DualChartCard::create(array(
"cssClass"=>array(
"card"=>"my-own-card-class",
"tittle"=>"font-bold",
"value"=>"big-font",
"icon"=>"fa fa-dollar"
)
));
Notice: The "icon"
property can be used to set the icon using font-awesome or simpleline icon.
cssStyle #
Alternative to set the cssClass
, you may directly set the css style to the card element:
Name | type | default | description |
---|---|---|---|
card | string | Css style for card | |
title | string | Css style for card title | |
value | string | Css style for card value | |
icon | string | Css style for card icon |
Example:
\koolreport\amazing\DualChartCard::create(array(
"cssStyle"=>array(
"card"=>"background-color:yellow",
"title"=>"font-weight:bold",
"value"=>"font-style:italic",
"icon"=>"font-size:24px;color:#333"
)
));
Indicator #
Name | type | default | description |
---|---|---|---|
method | string/function | The method to used to calculate indicator, it accept string and anonymous function. Allow values are "percentChange" , "percentComplete" , "different" or custom function function($value,$baseValue){} . Inside custom function, you should return the calculated value of indicator | |
title | string | "Compared to {baseValue}" | Title of the indicator |
threshold | number | 0 | The positive indicator will be active if indicator value is greater than threshold |
Chart settings #
The "chart"
property holds important settings for the chart such as dataSource
or type
of chart.
Name | type | default | description |
---|---|---|---|
dataSource | DataSource/array/function | Set extra css class for card | |
type | string | "area" | Type of chart, support "area" , "line" and "column" |
columns | array | List of columns for chart and their settings |
Examples #
\koolreport\amazing\DualChartCard::create(array(
"chart"=>array(
"type"=>"area",
"dataSource"=>$this->dataStore("orders"),
"columns"=>array(
"date",
"amount"=>array(
"type"=>"number"
"decimals"=>2, // Number of decimals to show
"decimalPoint"=>".", // Decimal point character
"thounsandSeparator"=>",", // Thousand separator
"prefix"=>"$", // Prefix
"suffix"=>"USD" // Suffix
)
)
)
));
Note:
- If you omit the
"columns"
settings, then two first columns in datasource will be used to draw charts. - Your
dataSource
is like dataSource settings in any other widgets which you can enter array, dataStore, function, process. Please refer to here
Second Chart Settings #
The "secondChart"
holds the settings for the second chart. The setting of secondChart
is the same as chart
settings.
href #
Set a url link #
The same as you set href
in an <a>
element in html, you may set "href"
property for the DualChartCard
so that users will be directed to new url location when they click the card. This is extremely useful when you want to show details of data to user after view the summarization on card.
DualChartCard::create(array(
"href"=>"http://example.com/defails"
));
Set a javascript function #
DualChartCard::create(array(
"href"=>"function(){
alert('click on card');
}"
));
Get started with KoolReport
KoolReport will help you to construct good php data report by gathering your data from multiple sources, transforming them into valuable insights, and finally visualizing them in stunning charts and graphs.