Sugar Developer Guide Version 5.1

Creating Custom Chart Dashlets

Creating a custom chart dashlet is very similar to how we created the MyAccountsDashlet above. The main difference is that you will need to override the display() method in your class to build the chart, using the SugarChart library included with SugarCRM. Below is an example display() method as used in the Outcome by Month dashlet.

public function display()

{

$currency_symbol = $GLOBALS['sugar_config']['default_currency_symbol'];

if ($GLOBALS['current_user']->getPreference('currency')){

require_once('modules/Currencies/Currency.php');

$currency = new Currency();

$currency->retrieve($GLOBALS['current_user']->getPreference('currency'));

$currency_symbol = $currency->symbol;

}

 

require("modules/Charts/chartdefs.php");

$chartDef = $chartDefs['outcome_by_month'];

require_once('include/SugarCharts/SugarChart.php');

$sugarChart = new SugarChart();

$sugarChart->setProperties('',

translate('LBL_OPP_SIZE', 'Charts') . ' ' . $currency_symbol . '1' .translate('LBL_OPP_THOUSANDS', 'Charts'),

$chartDef['chartType']);

$sugarChart->base_url = $chartDef['base_url'];

$sugarChart->group_by = $chartDef['groupBy'];

$sugarChart->url_params = array();

$sugarChart->getData($this->constructQuery());

$xmlFile = $sugarChart->getXMLFileName($this->id);

$sugarChart->saveXMLFile($xmlFile, $sugarChart->generateXML());

return $this->getTitle('<div align="center"></div>') .

'<div align="center">' . $sugarChart->display($this->id, $xmlFile, '100%', '480', false) . '</div><br />';

}

 

protected function constructQuery()

{

$query = "SELECT sales_stage,".

db_convert('opportunities.date_closed','date_format',array("'%Y-%m'"),array("'YYYY-MM'"))." as m, ".

"sum(amount_usdollar/1000) as total, count(*) as opp_count FROM opportunities ";

$query .= " WHERE opportunities.date_closed >= ".db_convert("'".$this->obm_date_start."'",'datetime') .

" AND opportunities.date_closed <= ".db_convert("'".$this->obm_date_end."'",'datetime') .

" AND opportunities.deleted=0";

if (count($this->obm_ids) > 0)

$query .= " AND opportunities.assigned_user_id IN ('" . implode("','",$this->obm_ids) . "')";

$query .= " GROUP BY sales_stage,".

db_convert('opportunities.date_closed','date_format',array("'%Y-%m'"),array("'YYYY-MM'")) . " ORDER BY m";

return $query;

}