include/SugarCharts/JsChart.php

Show:

inherited

Classes
- \JsChart

Table of Contents

\JsChart
jump to top

Package:

Generic chart

Parent(s): \SugarChart
Children: \Jit

Properties


                 $base_url= 'array()'

inheritedInherited from: \SugarChart::$$base_url

Default valuearray()Details

Type: n/a
Inherited_from: \SugarChart::$$base_url


                 $chartId= ''

Details

Type: n/a


                 $chartType= ''

Details

Type: n/a


                 $chart_properties= 'array()'

inheritedInherited from: \SugarChart::$$chart_properties

Default valuearray()Details

Type: n/a
Inherited_from: \SugarChart::$$chart_properties


                 $chart_yAxis= 'array()'

inheritedInherited from: \SugarChart::$$chart_yAxis

Default valuearray()Details

Type: n/a
Inherited_from: \SugarChart::$$chart_yAxis


                 $colors_list= 'array()'

inheritedInherited from: \SugarChart::$$colors_list

Default valuearray()Details

Type: n/a
Inherited_from: \SugarChart::$$colors_list


                 $currency_symbol= ''

inheritedInherited from: \SugarChart::$$currency_symbol

Details

Type: n/a
Inherited_from: \SugarChart::$$currency_symbol


                 $data_set= 'array()'

inheritedInherited from: \SugarChart::$$data_set

Default valuearray()Details

Type: n/a
Inherited_from: \SugarChart::$$data_set


                 $db= ''

inheritedInherited from: \SugarChart::$$db

Details

Type: n/a
Inherited_from: \SugarChart::$$db


                 $display_data= 'array()'

inheritedInherited from: \SugarChart::$$display_data

Default valuearray()Details

Type: n/a
Inherited_from: \SugarChart::$$display_data


                 $forceHideDataGroupLink= 'false'

inheritedInherited from: \SugarChart::$$forceHideDataGroupLink

Default valuefalseDetails

Type: n/a
Inherited_from: \SugarChart::$$forceHideDataGroupLink


                 $group_by= 'array()'

inheritedInherited from: \SugarChart::$$group_by

Default valuearray()Details

Type: n/a
Inherited_from: \SugarChart::$$group_by


                 $height= ''

Details

Type: n/a


                 $image_export_type= '""'

inheritedInherited from: \SugarChart::$$image_export_type

Default value""Details

Type: n/a
Inherited_from: \SugarChart::$$image_export_type


                 $is_currency= ''

inheritedInherited from: \SugarChart::$$is_currency

Details

Type: n/a
Inherited_from: \SugarChart::$$is_currency


                 $jsonFilename= ''

Details

Type: n/a


                 $print_html_legend_pdf= 'false'

inheritedInherited from: \SugarChart::$$print_html_legend_pdf

Default valuefalseDetails

Type: n/a
Inherited_from: \SugarChart::$$print_html_legend_pdf


                 $ss= ''

Details

Type: n/a


                 $super_set= 'array()'

inheritedInherited from: \SugarChart::$$super_set

Default valuearray()Details

Type: n/a
Inherited_from: \SugarChart::$$super_set


                 $supports_image_export= 'false'

inheritedInherited from: \SugarChart::$$supports_image_export

Default valuefalseDetails

Type: n/a
Inherited_from: \SugarChart::$$supports_image_export


                 $thousands_symbol= ''

inheritedInherited from: \SugarChart::$$thousands_symbol

Details

Type: n/a
Inherited_from: \SugarChart::$$thousands_symbol


                 $url_params= 'array()'

inheritedInherited from: \SugarChart::$$url_params

Default valuearray()Details

Type: n/a
Inherited_from: \SugarChart::$$url_params


                 $width= ''

Details

Type: n/a


                 $xmlFile= ''

Details

Type: n/a

Methods

__construct(
          
          )
        
        :
          void

buildChartColors(
          
          )
        
        :
          void

buildDataBarChart(
           $xmlstr
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlstr

buildDataBarChartGrouped(
           $xmlstr
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlstr

buildDataBarChartStacked(
           $xmlstr
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlstr

buildDataGaugeChart(
           $xmlstr
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlstr

buildDataPieChart(
           $xmlstr
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlstr

buildHTMLLegend(
           $xmlFile
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlFile

buildJson(
           $xmlstr
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlstr

buildLabelsBarChart(
           $xmlstr
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlstr

buildLabelsBarChartStacked(
           $xmlstr
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlstr

buildLabelsGaugeChart(
           $xmlstr
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlstr

buildLabelsPieChart(
           $xmlstr
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlstr

buildProperties(
           $xmlstr
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlstr

calculateGroupByTotal(
           $dataset
          )
        
        :
          void

inherited

Inherited from: \SugarChart::calculateGroupByTotal()

Parameters

Name	Type	Description
$dataset

calculateSingleBarMax(
           $dataset
          )
        
        :
          void

inherited

Inherited from: \SugarChart::calculateSingleBarMax()

Parameters

Name	Type	Description
$dataset

calculateTotal(
          \group $group_by
          )
        
        :
          int

inherited

returns the total amount value for the group by field

Inherited from: \SugarChart::calculateTotal()

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

checkData(
           $xmlstr
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlstr

checkYAxis(
          \value $value
          )
        
        :
          \yAxis

inherited

returns correct yAxis min/max

Inherited from: \SugarChart::checkYAxis()

Parameters

Name	Type	Description
$value	\value	to check

Returns

Type	Description
\yAxis	min and max

constructBaseURL(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::constructBaseURL()

constructURL(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::constructURL()

convertCurrency(
           $to_convert
          )
        
        :
          void

inherited

Inherited from: \SugarChart::convertCurrency()

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

inherited

Inherited from: \SugarChart::formatNumber()

Parameters

Name	Type	Description
$number
$decimals
$decimal_point
$thousands_sep

generateChartStrings(
          string $xmlFile
          )
        
        :
          \none

inherited

generates xml file for Flash charts to use for internationalized instances

Inherited from: \SugarChart::generateChartStrings()

Parameters

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

Returns

Type	Description
\none

generateXML(
           $xmlDataName
              =
              false
          )
        
        :
          string

inherited

function to generate XML and return it

Inherited from: \SugarChart::generateXML()

Parameters

Name	Type	Description
$xmlDataName		none

Returns

Type	Description
string	$xmlContents with xml information

getChartConfigParams(
           $xmlStr
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlStr

getChartDimensions(
           $xmlStr
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlStr

getChartResources(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::getChartResources()

getConfigProperties(
          
          )
        
        :
          void

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

Parameters

Name	Type	Description
$id
$xmlFile

getData(
           $query
          )
        
        :
          void

inherited

Inherited from: \SugarChart::getData()

Parameters

Name	Type	Description
$query

getMySugarChartResources(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::getMySugarChartResources()

getNumNodes(
           $xmlstr
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlstr

getTotal(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::getTotal()

getXMLChartProperties(
           $xmlStr
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlStr

getXMLFileName(
          string $file_id
          )
        
        :
          void

staticinherited

returns a name for the XML File

Inherited from: \SugarChart::getXMLFileName()

Parameters

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

get_image_cache_file_name(
           $xmlFile,  $ext
              =
              ".png"
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlFile
$ext

isSupported(
           $chartType
          )
        
        :
          void

Parameters

Name	Type	Description
$chartType

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

inherited

nullGroup This function sets a null group by clause

Inherited from: \SugarChart::nullGroup()

Parameters

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

processData(
          
          )
        
        :
          string

inherited

returns xml data format

Inherited from: \SugarChart::processData()

Returns

Type	Description
string	with xml data format

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

inherited

Inherited from: \SugarChart::processDataGroup()

Parameters

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

processGauge(
           $position,  $target,  $phases
              =
              array()
          )
        
        :
          void

inherited

Inherited from: \SugarChart::processGauge()

Parameters

Name	Type	Description
$position
$target
$phases

processSpecialChars(
           $str
          )
        
        :
          void

Parameters

Name	Type	Description
$str

processXML(
           $xmlFile
          )
        
        :
          void

Parameters

Name	Type	Description
$xmlFile

processXmlData(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::processXmlData()

saveJsonFile(
           $jsonContents
          )
        
        :
          void

Parameters

Name	Type	Description
$jsonContents

saveXMLFile(
          string $xmlFilename,  $xmlContents
          )
        
        :
          string

inherited

function to save XML contents into a file

Inherited from: \SugarChart::saveXMLFile()

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

inherited

Inherited from: \SugarChart::setColors()

Parameters

Name	Type	Description
$colors

setData(
           $dataSet
          )
        
        :
          void

inherited

Inherited from: \SugarChart::setData()

Parameters

Name	Type	Description
$dataSet

setDisplayProperty(
           $property,  $value
          )
        
        :
          void

inherited

Inherited from: \SugarChart::setDisplayProperty()

Parameters

Name	Type	Description
$property
$value

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

inherited

Inherited from: \SugarChart::setProperties()

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

inherited

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.

Inherited from: \SugarChart::sortData()

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

inherited

returns text with tabs appended before it

Inherited from: \SugarChart::tabValue()

Parameters

Name	Type	Description
$tag
$value
$depth

Returns

Type	Description
string	with tabs appended before it

xmlData(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::xmlData()

xmlDataBarChart(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::xmlDataBarChart()

xmlDataForGaugeChart(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::xmlDataForGaugeChart()

xmlDataForGroupByChart(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::xmlDataForGroupByChart()

xmlDataGenericChart(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::xmlDataGenericChart()

xmlFooter(
          
          )
        
        :
          string

inherited

returns the footer for the constructed xml file for sugarcharts

Inherited from: \SugarChart::xmlFooter()

Returns

Type	Description
string	$footer XML footer

xmlHeader(
          
          )
        
        :
          string

inherited

returns the header for the constructed xml file for sugarcharts

Inherited from: \SugarChart::xmlHeader()

Returns

Type	Description
string	$header XML header

xmlProperties(
          
          )
        
        :
          string

inherited

returns the properties tag for the constructed xml file for sugarcharts

Inherited from: \SugarChart::xmlProperties()

Returns

Type	Description
string	$properties XML properties tag

xmlYAxis(
          
          )
        
        :
          string

inherited

returns the y-axis values for the chart

Inherited from: \SugarChart::xmlYAxis()

Returns

Type	Description
string	$yAxis XML yAxis tag

include/SugarCharts/JsChart.php

\JsChartjump to top

Properties

Methods

\JsChart
jump to top