include/SugarCharts/SugarChart.php

Show:

inherited

Classes
- \SugarChart

Table of Contents

\SugarChart
jump to top

Package: SugarCRM

Generic chart

Children: \JsChart
Api

Properties


                 $base_url= 'array()'

Default valuearray()Details

Type: n/a


                 $chart_properties= 'array()'

Default valuearray()Details

Type: n/a


                 $chart_yAxis= 'array()'

Default valuearray()Details

Type: n/a


                 $colors_list= 'array()'

Default valuearray()Details

Type: n/a


                 $currency_symbol= ''

Details

Type: n/a


                 $data_set= 'array()'

Default valuearray()Details

Type: n/a


                 $db= ''

Details

Type: n/a


                 $display_data= 'array()'

Default valuearray()Details

Type: n/a


                 $forceHideDataGroupLink= 'false'

Default valuefalseDetails

Type: n/a


                 $group_by= 'array()'

Default valuearray()Details

Type: n/a


                 $image_export_type= '""'

Default value""Details

Type: n/a


                 $is_currency= ''

Details

Type: n/a


                 $print_html_legend_pdf= 'false'

Default valuefalseDetails

Type: n/a


                 $ss= ''

Details

Type: n/a


                 $super_set= 'array()'

Default valuearray()Details

Type: n/a


                 $supports_image_export= 'false'

Default valuefalseDetails

Type: n/a


                 $thousands_symbol= ''

Details

Type: n/a


                 $url_params= 'array()'

Default valuearray()Details

Type: n/a

Methods

__construct(
          
          )
        
        :
          void

calculateGroupByTotal(
           $dataset
          )
        
        :
          void

Parameters

Name	Type	Description
$dataset

calculateSingleBarMax(
           $dataset
          )
        
        :
          void

Parameters

Name	Type	Description
$dataset

calculateTotal(
          \group $group_by
          )
        
        :
          int

returns the total amount value for the group by field

Parameters

Name	Type	Description
$group_by	\group	by field

Returns

Type	Description
int	$total total value

chartArray(
          array $chartsArray
          )
        
        :
          array

wrapper function to return chart array after any additional processing

Parameters

Name	Type	Description
$chartsArray	array	array of chart config items that need processing

Returns

Type	Description
array	$chartArray after it has been process

checkYAxis(
          \value $value
          )
        
        :
          \yAxis

returns correct yAxis min/max

Parameters

Name	Type	Description
$value	\value	to check

Returns

Type	Description
\yAxis	min and max

constructBaseURL(
          
          )
        
        :
          void

constructURL(
          
          )
        
        :
          void

convertCurrency(
           $to_convert
          )
        
        :
          void

Parameters

Name	Type	Description
$to_convert

display(
          string $name,  $xmlFile,  $width
              =
              '320',  $height
              =
              '480',  $resize
              =
              false
          )
        
        :
          string

wrapper function to return the html code containing the chart in a div

Parameters

Name	Type	Description
$name	string	name of the div string $xmlFile location of the XML file string $style optional additional styles for the div
$xmlFile
$width
$height
$resize

Returns

Type	Description
string	returns the html code through smarty

formatNumber(
           $number,  $decimals
              =
              null,  $decimal_point
              =
              null,  $thousands_sep
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$number
$decimals
$decimal_point
$thousands_sep

generateChartStrings(
          string $xmlFile
          )
        
        :
          \none

generates xml file for Flash charts to use for internationalized instances

Parameters

Name	Type	Description
$xmlFile	string	location of the XML file to write to

Returns

Type	Description
\none

generateXML(
           $xmlDataName
              =
              false
          )
        
        :
          string

function to generate XML and return it

Parameters

Name	Type	Description
$xmlDataName		none

Returns

Type	Description
string	$xmlContents with xml information

getChartResources(
          
          )
        
        :
          void

getDashletScript(
           $id,  $xmlFile
              =
              ""
          )
        
        :
          void

Parameters

Name	Type	Description
$id
$xmlFile

getData(
           $query
          )
        
        :
          void

Parameters

Name	Type	Description
$query

getMySugarChartResources(
          
          )
        
        :
          void

getTotal(
          
          )
        
        :
          void

getXMLFileName(
          string $file_id
          )
        
        :
          void

static

returns a name for the XML File

Parameters

Name	Type	Description
$file_id	string	unique id to make part of the file name

nullGroup(
          \$sugarSetValue $superSetValue, \$url $url
          )
        
        :
          void

nullGroup This function sets a null group by clause

Parameters

Name	Type	Description
$superSetValue	\$sugarSetValue	Mixed value
$url	\$url	String value of URL for the link

processData(
          
          )
        
        :
          string

returns xml data format

Returns

Type	Description
string	with xml data format

processDataGroup(
           $tablevel,  $title,  $value,  $label,  $link
          )
        
        :
          void

Parameters

Name	Type	Description
$tablevel
$title
$value
$label
$link

processXmlData(
          
          )
        
        :
          void

saveXMLFile(
          string $xmlFilename,  $xmlContents
          )
        
        :
          string

function to save XML contents into a file

Parameters

Name	Type	Description
$xmlFilename	string	location of the xml file string $xmlContents contents of the xml file
$xmlContents

Returns

Type	Description
string	boolean denoting whether save has failed

setColors(
           $colors
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$colors

setData(
           $dataSet
          )
        
        :
          void

Parameters

Name	Type	Description
$dataSet

setDisplayProperty(
           $property,  $value
          )
        
        :
          void

Parameters

Name	Type	Description
$property
$value

setProperties(
           $title,  $subtitle,  $type,  $legend
              =
              'on',  $labels
              =
              'value',  $print
              =
              'on',  $thousands
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$title
$subtitle
$type
$legend
$labels
$print
$thousands

sortData(
          array $data_set,  $keycolname1
              =
              null,  $translate1
              =
              false,  $keycolname2
              =
              null,  $translate2
              =
              false,  $ifsort2
              =
              false
          )
        
        :
          \The

This function is used for localize all the characters in the Chart. And it can also sort all the dom_values by the sequence defined in the dom, but this may produce a lot of extra empty data in the xml file, when the chart is sorted by two key cols.

If the data quantity is large, it maybe a little slow.

Parameters

Name	Type	Description
$data_set	array	The data get from database string $keycolname1 We will sort by this key first bool $translate1 Whether to trabslate the first column string $keycolname1 We will sort by this key secondly, and it can be null, then it will only sort by the first column. bool $translate1 Whether to trabslate the second column bool $ifsort2 Whether to sort by the second column or just translate the second column.
$keycolname1
$translate1
$keycolname2
$translate2
$ifsort2

Returns

Type	Description
\The	sorted and translated data.

tab(
          string $str,  $depth
          )
        
        :
          string

returns text with tabs appended before it

Parameters

Name	Type	Description
$str	string	input string int $depth number of times to tab
$depth

Returns

Type	Description
string	with tabs appended before it

tabValue(
           $tag,  $value,  $depth
          )
        
        :
          string

returns text with tabs appended before it

Parameters

Name	Type	Description
$tag
$value
$depth

Returns

Type	Description
string	with tabs appended before it

xmlData(
          
          )
        
        :
          void

xmlDataBarChart(
          
          )
        
        :
          void

xmlDataForGaugeChart(
          
          )
        
        :
          void

xmlDataForGroupByChart(
          
          )
        
        :
          void

xmlDataGenericChart(
          
          )
        
        :
          void

xmlFooter(
          
          )
        
        :
          string

returns the footer for the constructed xml file for sugarcharts

Returns

Type	Description
string	$footer XML footer

xmlHeader(
          
          )
        
        :
          string

returns the header for the constructed xml file for sugarcharts

Returns

Type	Description
string	$header XML header

xmlProperties(
          
          )
        
        :
          string

returns the properties tag for the constructed xml file for sugarcharts

Returns

Type	Description
string	$properties XML properties tag

xmlYAxis(
          
          )
        
        :
          string

returns the y-axis values for the chart

Returns

Type	Description
string	$yAxis XML yAxis tag

include/SugarCharts/SugarChart.php

\SugarChartjump to top

Properties

Methods

\SugarChart
jump to top