include/SugarCharts/Jit/JitReports.php

Show:

inherited

Classes
- \JitReports

Table of Contents

\JitReports
jump to top

Package:

Generic chart

Parent(s): \Jit < \JsChart < \SugarChart

Properties


                 $base_url= 'array()'

inheritedInherited from: \SugarChart::$$base_url \JsChart::$$base_url \Jit::$$base_url

Default valuearray()Details

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


                 $chartId= ''

inheritedInherited from: \JsChart::$$chartId \Jit::$$chartId

Details

Type: n/a
Inherited_from: \JsChart::$$chartId
Inherited_from: \Jit::$$chartId


                 $chartType= ''

inheritedInherited from: \JsChart::$$chartType \Jit::$$chartType

Details

Type: n/a
Inherited_from: \JsChart::$$chartType
Inherited_from: \Jit::$$chartType


                 $chart_properties= 'array()'

inheritedInherited from: \SugarChart::$$chart_properties \JsChart::$$chart_properties \Jit::$$chart_properties

Default valuearray()Details

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


                 $chart_yAxis= 'array()'

inheritedInherited from: \SugarChart::$$chart_yAxis \JsChart::$$chart_yAxis \Jit::$$chart_yAxis

Default valuearray()Details

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


                 $colors_list= 'array()'

inheritedInherited from: \SugarChart::$$colors_list \JsChart::$$colors_list \Jit::$$colors_list

Default valuearray()Details

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


                 $currency_symbol= ''

inheritedInherited from: \SugarChart::$$currency_symbol \JsChart::$$currency_symbol \Jit::$$currency_symbol

Details

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


                 $data_set= 'array()'

inheritedInherited from: \SugarChart::$$data_set \JsChart::$$data_set \Jit::$$data_set

Default valuearray()Details

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


                 $db= ''

inheritedInherited from: \SugarChart::$$db \JsChart::$$db \Jit::$$db

Details

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


                 $display_data= 'array()'

inheritedInherited from: \SugarChart::$$display_data \JsChart::$$display_data \Jit::$$display_data

Default valuearray()Details

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


                 $forceHideDataGroupLink= 'false'

inheritedInherited from: \SugarChart::$$forceHideDataGroupLink \JsChart::$$forceHideDataGroupLink \Jit::$$forceHideDataGroupLink

Default valuefalseDetails

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


                 $group_by= 'array()'

inheritedInherited from: \SugarChart::$$group_by \JsChart::$$group_by \Jit::$$group_by

Default valuearray()Details

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


                 $height= ''

inheritedInherited from: \JsChart::$$height \Jit::$$height

Details

Type: n/a
Inherited_from: \JsChart::$$height
Inherited_from: \Jit::$$height


                 $image_export_type= '""'

inheritedInherited from: \SugarChart::$$image_export_type \JsChart::$$image_export_type \Jit::$$image_export_type

Default value""Details

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


                 $is_currency= ''

inheritedInherited from: \SugarChart::$$is_currency \JsChart::$$is_currency \Jit::$$is_currency

Details

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


                 $jsonFilename= ''

inheritedInherited from: \JsChart::$$jsonFilename \Jit::$$jsonFilename

Details

Type: n/a
Inherited_from: \JsChart::$$jsonFilename
Inherited_from: \Jit::$$jsonFilename


                 $print_html_legend_pdf= 'true'

inheritedInherited from: \Jit::$$print_html_legend_pdf

Default valuetrueDetails

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


                 $processed_report_keys= 'array()'

Default valuearray()Details

Type: n/a


                 $ss= ''

inheritedInherited from: \JsChart::$$ss \Jit::$$ss

Details

Type: n/a
Inherited_from: \JsChart::$$ss
Inherited_from: \Jit::$$ss


                 $super_set= 'array()'

inheritedInherited from: \SugarChart::$$super_set \JsChart::$$super_set \Jit::$$super_set

Default valuearray()Details

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


                 $supports_image_export= 'true'

inheritedInherited from: \Jit::$$supports_image_export

Default valuetrueDetails

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


                 $thousands_symbol= ''

inheritedInherited from: \SugarChart::$$thousands_symbol \JsChart::$$thousands_symbol \Jit::$$thousands_symbol

Details

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


                 $url_params= 'array()'

inheritedInherited from: \SugarChart::$$url_params \JsChart::$$url_params \Jit::$$url_params

Default valuearray()Details

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


                 $width= ''

inheritedInherited from: \JsChart::$$width \Jit::$$width

Details

Type: n/a
Inherited_from: \JsChart::$$width
Inherited_from: \Jit::$$width


                 $xmlFile= ''

inheritedInherited from: \JsChart::$$xmlFile \Jit::$$xmlFile

Details

Type: n/a
Inherited_from: \JsChart::$$xmlFile
Inherited_from: \Jit::$$xmlFile

Methods

__construct(
          
          )
        
        :
          void

buildChartColors(
          
          )
        
        :
          void

inherited

Inherited from: \JsChart::buildChartColors()\Jit::buildChartColors()

buildDataBarChart(
           $xmlstr
          )
        
        :
          void

inherited

Inherited from: \JsChart::buildDataBarChart()\Jit::buildDataBarChart()

Parameters

Name	Type	Description
$xmlstr

buildDataBarChartGrouped(
           $xmlstr
          )
        
        :
          void

inherited

Inherited from: \JsChart::buildDataBarChartGrouped()\Jit::buildDataBarChartGrouped()

Parameters

Name	Type	Description
$xmlstr

buildDataBarChartStacked(
           $xmlstr
          )
        
        :
          void

inherited

Inherited from: \JsChart::buildDataBarChartStacked()\Jit::buildDataBarChartStacked()

Parameters

Name	Type	Description
$xmlstr

buildDataGaugeChart(
           $xmlstr
          )
        
        :
          void

inherited

Inherited from: \JsChart::buildDataGaugeChart()\Jit::buildDataGaugeChart()

Parameters

Name	Type	Description
$xmlstr

buildDataPieChart(
           $xmlstr
          )
        
        :
          void

inherited

Inherited from: \JsChart::buildDataPieChart()\Jit::buildDataPieChart()

Parameters

Name	Type	Description
$xmlstr

buildHTMLLegend(
           $xmlFile
          )
        
        :
          void

inherited

Inherited from: \JsChart::buildHTMLLegend()\Jit::buildHTMLLegend()

Parameters

Name	Type	Description
$xmlFile

buildJson(
           $xmlstr
          )
        
        :
          void

inherited

Inherited from: \JsChart::buildJson()\Jit::buildJson()

Parameters

Name	Type	Description
$xmlstr

buildLabelsBarChart(
           $xmlstr
          )
        
        :
          void

inherited

Inherited from: \JsChart::buildLabelsBarChart()\Jit::buildLabelsBarChart()

Parameters

Name	Type	Description
$xmlstr

buildLabelsBarChartStacked(
           $xmlstr
          )
        
        :
          void

inherited

Inherited from: \JsChart::buildLabelsBarChartStacked()\Jit::buildLabelsBarChartStacked()

Parameters

Name	Type	Description
$xmlstr

buildLabelsGaugeChart(
           $xmlstr
          )
        
        :
          void

inherited

Inherited from: \JsChart::buildLabelsGaugeChart()\Jit::buildLabelsGaugeChart()

Parameters

Name	Type	Description
$xmlstr

buildLabelsPieChart(
           $xmlstr
          )
        
        :
          void

inherited

Inherited from: \JsChart::buildLabelsPieChart()\Jit::buildLabelsPieChart()

Parameters

Name	Type	Description
$xmlstr

buildProperties(
           $xmlstr
          )
        
        :
          void

inherited

Inherited from: \JsChart::buildProperties()\Jit::buildProperties()

Parameters

Name	Type	Description
$xmlstr

calculateGroupByTotal(
           $dataset
          )
        
        :
          void

inherited

Inherited from: \SugarChart::calculateGroupByTotal()\JsChart::calculateGroupByTotal()\Jit::calculateGroupByTotal()

Parameters

Name	Type	Description
$dataset

calculateReportGroupTotal(
           $dataset
          )
        
        :
          void

Parameters

Name	Type	Description
$dataset

calculateSingleBarMax(
           $dataset
          )
        
        :
          void

inherited

Inherited from: \SugarChart::calculateSingleBarMax()\JsChart::calculateSingleBarMax()\Jit::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()\JsChart::calculateTotal()\Jit::calculateTotal()

Parameters

Name	Type	Description
$group_by	\group	by field

Returns

Type	Description
int	$total total value

chartArray(
          array $chartsArray
          )
        
        :
          array

inherited

wrapper function to return chart array after any additional processing

Inherited from: \JsChart::chartArray()\Jit::chartArray()

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

inherited

Inherited from: \JsChart::checkData()\Jit::checkData()

Parameters

Name	Type	Description
$xmlstr

checkYAxis(
          \value $value
          )
        
        :
          \yAxis

inherited

returns correct yAxis min/max

Inherited from: \SugarChart::checkYAxis()\JsChart::checkYAxis()\Jit::checkYAxis()

Parameters

Name	Type	Description
$value	\value	to check

Returns

Type	Description
\yAxis	min and max

constructBaseURL(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::constructBaseURL()\JsChart::constructBaseURL()\Jit::constructBaseURL()

constructURL(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::constructURL()\JsChart::constructURL()\Jit::constructURL()

convertCurrency(
           $to_convert
          )
        
        :
          void

inherited

Inherited from: \SugarChart::convertCurrency()\JsChart::convertCurrency()\Jit::convertCurrency()

Parameters

Name	Type	Description
$to_convert

display(
          string $name,  $xmlFile,  $width
              =
              '320',  $height
              =
              '480',  $reportChartDivStyle,  $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
$reportChartDivStyle
$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()\JsChart::formatNumber()\Jit::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()\JsChart::generateChartStrings()\Jit::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()\JsChart::generateXML()\Jit::generateXML()

Parameters

Name	Type	Description
$xmlDataName		none

Returns

Type	Description
string	$xmlContents with xml information

getChartConfigParams(
           $xmlStr
          )
        
        :
          void

inherited

Inherited from: \JsChart::getChartConfigParams()\Jit::getChartConfigParams()

Parameters

Name	Type	Description
$xmlStr

getChartDimensions(
           $xmlStr
          )
        
        :
          void

inherited

Inherited from: \JsChart::getChartDimensions()\Jit::getChartDimensions()

Parameters

Name	Type	Description
$xmlStr

getChartResources(
          
          )
        
        :
          void

inherited

Inherited from: \Jit::getChartResources()

getConfigProperties(
          
          )
        
        :
          void

inherited

Inherited from: \JsChart::getConfigProperties()\Jit::getConfigProperties()

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

inherited

Inherited from: \Jit::getDashletScript()

Parameters

Name	Type	Description
$id
$xmlFile

getData(
           $query
          )
        
        :
          void

inherited

Inherited from: \SugarChart::getData()\JsChart::getData()\Jit::getData()

Parameters

Name	Type	Description
$query

getMySugarChartResources(
          
          )
        
        :
          void

inherited

Inherited from: \Jit::getMySugarChartResources()

getNumNodes(
           $xmlstr
          )
        
        :
          void

inherited

Inherited from: \JsChart::getNumNodes()\Jit::getNumNodes()

Parameters

Name	Type	Description
$xmlstr

getTotal(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::getTotal()\JsChart::getTotal()\Jit::getTotal()

getXMLChartProperties(
           $xmlStr
          )
        
        :
          void

inherited

Inherited from: \JsChart::getXMLChartProperties()\Jit::getXMLChartProperties()

Parameters

Name	Type	Description
$xmlStr

getXMLFileName(
          string $file_id
          )
        
        :
          void

staticinherited

returns a name for the XML File

Inherited from: \SugarChart::getXMLFileName()\JsChart::getXMLFileName()\Jit::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

inherited

Inherited from: \JsChart::get_image_cache_file_name()\Jit::get_image_cache_file_name()

Parameters

Name	Type	Description
$xmlFile
$ext

isCurrencyReportGroupTotal(
          array $dataset
          )
        
        :
          bool

Method checks is our dataset from currency field or not

Parameters

Name	Type	Description
$dataset	array	of chart

Returns

Type	Description
bool	is currency

isSupported(
           $chartType
          )
        
        :
          void

inherited

Inherited from: \JsChart::isSupported()\Jit::isSupported()

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()\JsChart::nullGroup()\Jit::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()\JsChart::processData()\Jit::processData()

Returns

Type	Description
string	with xml data format

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

inherited

Inherited from: \SugarChart::processDataGroup()\JsChart::processDataGroup()\Jit::processDataGroup()

Parameters

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

processReportData(
           $dataset,  $level
              =
              1,  $first
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$dataset
$level
$first

processReportGroup(
           $dataset
          )
        
        :
          void

Parameters

Name	Type	Description
$dataset

processSpecialChars(
           $str
          )
        
        :
          void

inherited

Inherited from: \JsChart::processSpecialChars()\Jit::processSpecialChars()

Parameters

Name	Type	Description
$str

processXML(
           $xmlFile
          )
        
        :
          void

inherited

Inherited from: \JsChart::processXML()\Jit::processXML()

Parameters

Name	Type	Description
$xmlFile

processXmlData(
          
          )
        
        :
          void

saveJsonFile(
           $jsonContents
          )
        
        :
          void

inherited

Inherited from: \JsChart::saveJsonFile()\Jit::saveJsonFile()

Parameters

Name	Type	Description
$jsonContents

saveXMLFile(
          string $xmlFilename,  $xmlContents
          )
        
        :
          string

inherited

function to save XML contents into a file

Inherited from: \SugarChart::saveXMLFile()\JsChart::saveXMLFile()\Jit::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()\JsChart::setColors()\Jit::setColors()

Parameters

Name	Type	Description
$colors

setData(
           $dataSet
          )
        
        :
          void

inherited

Inherited from: \SugarChart::setData()\JsChart::setData()\Jit::setData()

Parameters

Name	Type	Description
$dataSet

setDisplayProperty(
           $property,  $value
          )
        
        :
          void

inherited

Inherited from: \SugarChart::setDisplayProperty()\JsChart::setDisplayProperty()\Jit::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()\JsChart::setProperties()\Jit::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()\JsChart::sortData()\Jit::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

inherited

returns text with tabs appended before it

Inherited from: \JsChart::tab()\Jit::tab()

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()\JsChart::tabValue()\Jit::tabValue()

Parameters

Name	Type	Description
$tag
$value
$depth

Returns

Type	Description
string	with tabs appended before it

xmlData(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::xmlData()\JsChart::xmlData()\Jit::xmlData()

xmlDataBarChart(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::xmlDataBarChart()\JsChart::xmlDataBarChart()\Jit::xmlDataBarChart()

xmlDataForGaugeChart(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::xmlDataForGaugeChart()\JsChart::xmlDataForGaugeChart()\Jit::xmlDataForGaugeChart()

xmlDataForGroupByChart(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::xmlDataForGroupByChart()\JsChart::xmlDataForGroupByChart()\Jit::xmlDataForGroupByChart()

xmlDataGenericChart(
          
          )
        
        :
          void

inherited

Inherited from: \SugarChart::xmlDataGenericChart()\JsChart::xmlDataGenericChart()\Jit::xmlDataGenericChart()

xmlDataReportChart(
          
          )
        
        :
          void

xmlDataReportSingleValue(
          
          )
        
        :
          void

xmlFooter(
          
          )
        
        :
          string

inherited

returns the footer for the constructed xml file for sugarcharts

Inherited from: \SugarChart::xmlFooter()\JsChart::xmlFooter()\Jit::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()\JsChart::xmlHeader()\Jit::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()\JsChart::xmlProperties()\Jit::xmlProperties()

Returns

Type	Description
string	$properties XML properties tag

xmlYAxis(
          
          )
        
        :
          string

inherited

returns the y-axis values for the chart

Inherited from: \SugarChart::xmlYAxis()\JsChart::xmlYAxis()\Jit::xmlYAxis()

Returns

Type	Description
string	$yAxis XML yAxis tag

include/SugarCharts/Jit/JitReports.php

\JitReportsjump to top

Properties

Methods

\JitReports
jump to top