1. Report Designer’s Guide
  2. Visualizations
  3. Bar Reference Object Chart

Bar Reference Object Chart

JSON Data Attribute XML declaration Description / Notes

name

<cell type="text" data-format="text" alignment="left" style="col_header_1" print-width="130" chart-attr-name="seriesName">TotalOperatingCosts</cell>

“seriesName” is a constant attribute name. The value is derived based on the cell type definition.

items

<cell type="expr" data-format="integer" alignment="right" style="header_1" suppress-formatting="true">DBGET("DailyOpsQuery","prepCostTotal")</cell>

This attribute must directly follow the “seriesName” declaration. This is the chart data points/items values. The “suppress-formatting” property must be set to true. The value is derived based on the cell type definition.

groupData

<cell type="column" data-format="text" alignment="left" chart-attr-name="groupData">Group A</cell>

“groupData” is a constant attribute name. The value is derived based on the cell type definition.

stackValue

<cell type="chart_text" data-format="text" alignment="left" chart-attr-name="stackValue">on</cell>

“stackValue” is a constant attribute name. The cell type must be set to “chart_text”. Valid values areon or off.

xAxisTitle

<cell type="text" data-format="text" alignment="left" chart-attr-name="xAxisTitle">Y Axis Title</cell>

“xAxisTitle” is a constant attribute name. The value is derived based on the cell type definition.

xAxisRefObjValue

<cell type="text" data-format="text" alignment="left" chart-attr-name="xAxisRefObjValue">Group A</cell>

“xAxisRefObjValue” is a constant attribute name. The value is derived based on the cell type definition.

xAxisRefObjLegendText

<cell type="text" data-format="text" alignment="left" chart-attr-name="xAxisRefObjLegendText">X Axis Object Reference Text</cell>

“xAxisRefObjLegendText” is a constant attribute name. The value is derived based on the cell type definition.

xAxisRefObjHoverDescValue

<cell type="text" data-format="text" alignment="left" chart-attr-name="xAxisRefObjHoverDescValue">X Axis Sample Reference Line</cell>

“xAxisRefObjHoverDescValue” is a constant attribute name. The value is derived based on the cell type definition.

yAxisTitle

<cell type="text" data-format="text" alignment="left" chart-attr-name="yAxisTitle">Y Axis Title</cell>

“yAxisTitle” is a constant attribute name. The value is derived based on the cell type definition.

yAxisRefObjValue

<cell type="text" data-format="text" alignment="left" chart-attr-name="yAxisRefObjValue">25000</cell>

“yAxisRefObjValue” is a constant attribute name. The value is derived based on the cell type definition.

yAxisRefObjLegendText

<cell type="text" data-format="text" alignment="left" chart-attr-name="yAxisRefObjLegendText">Y Axis Object Reference Text</cell>

“yAxisRefObjLegendText” is a constant attribute name. The value is derived based on the cell type definition.

yAxisRefObjHoverDescValue

<cell type="text" data-format="text" alignment="left" chart-attr-name="yAxisRefObjHoverDescValue">Y Axis Sample Reference Line</cell>

“yAxisRefObjHoverDescValue” is a constant attribute name. The value is derived based on the cell type definition.

hoverSeriesLabel

<cell type="text" data-format="text" alignment="left" chart-attr-name="hoverSeriesLabel">Test Series</cell>

“hoverSeriesLabel” is a constant attribute name. The value is derived based on the cell type definition.

hoverValueLabel

<cell type="text" data-format="text" alignment="left" chart-attr-name="hoverValueLabel">Test Value</cell>

“hoverValueLabel” is a constant attribute name. The value is derived based on the cell type definition.

hoverGroupLabel

<cell type="text" data-format="text" alignment="left" chart-attr-name="hoverGroupLabel">Test Group</cell>

“hoverGroupLabel” is a constant attribute name. The value is derived based on the cell type definition.

dataType

<cell type="chart_text" data-format="text" alignment="left" chart-attr-name="dataType">integer</cell>

“dataType” is a constant attribute name. This applies data formatting to “items” values. The cell type must be set to “chart_text”. The valid value is the same as those that can be defined in cell data-format.

decimalPlaces

<cell type="chart_text" data-format="text" alignment="left" chart-attr-name="decimalPlaces">2</cell>

“decimalPlaces” is a constant attribute name. This set number of decimal places to “items” values. The cell type must be set to “chart_text”. The Value is an integer.

dataTypeSeriesFormat

<cell type="chart_text" data-format="text" alignment="left" chart-attr-name="dataTypeSeriesFormat">percent</cell>

“dataTypeSeriesFormat” is a constant attribute name. This applies data formatting to “seriesName” values. The cell type must be set to “chart_text”. The valid value is the same as those that can be defined in cell data-format.

dataTypeGroupFormat

<cell type="chart_text" data-format="text" alignment="left" chart-attr-name="dataTypeGroupFormat">currency</cell>

“dataTypeGroupFormat” is a constant attribute name. This applies data formatting to “groupData” values. The cell type must be set to “chart_text”. The valid value is the same as those that can be defined in cell data-format.

Example of XML Report Definition to Generate Bar Reference Object JSON Data

<report>

       <frame type="table" query-name="MajorGroupsQuery" name="barRefObjFrame">
            <bands>
       
                <band type="table-body">
                    <cell type="column" data-format="text" alignment="left" print-width="140" indent-level="3" chart-attr-name="seriesName">majorGroupNameMaster</cell>
                    <cell type="column" data-format="currency" alignment="right" suppress-formatting="true" print-width="70">salesTotal</cell> 
					
	      <!-- extra cell to match count in table-column -->
	      <cell type="chart_text" data-format="text" alignment="left"></cell>
	      <cell type="chart_text" data-format="text" alignment="left"></cell>
	      <cell type="chart_text" data-format="text" alignment="left"></cell>
	      <cell type="chart_text" data-format="text" alignment="left"></cell>
	      <cell type="chart_text" data-format="text" alignment="left"></cell>
	      <cell type="chart_text" data-format="text" alignment="left"></cell>
	      <cell type="chart_text" data-format="text" alignment="left"></cell>
	      <cell type="chart_text" data-format="text" alignment="left"></cell>
	      <cell type="chart_text" data-format="text" alignment="left"></cell>
	      <cell type="chart_text" data-format="text" alignment="left"></cell>
	      <cell type="chart_text" data-format="text" alignment="left"></cell>
	  </band>
				
	<band type="table-column-header">
                    <!--  groupData chart attribute  -->
                    <cell type="text" data-format="text" alignment="left" chart-attr-name="groupData">Group A</cell>
					
	     <!--  xAxisTitle chart attribute  -->
                    <cell type="text" data-format="text" alignment="left" chart-attr-name="xAxisTitle">X Axis Title</cell>
					
	     <!--  xAxisRefObjValue chart attribute  -->
                    <cell type="text" data-format="text" alignment="left" chart-attr-name="xAxisRefObjValue">Group A</cell>
					
	     <!--  xAxisRefObjLegendText chart attribute  -->
                    <cell type="text" data-format="text" alignment="left" chart-attr-name="xAxisRefObjLegendText">X Axis Object Reference Text</cell>
					
	     <!--  xAxisRefObjHoverDescValue chart attribute  -->
                    <cell type="text" data-format="text" alignment="left" chart-attr-name="xAxisRefObjHoverDescValue">X Axis Sample Reference Line</cell>
					
	     <!--  yAxisTitle chart attribute  -->
                    <cell type="text" data-format="text" alignment="left" chart-attr-name="yAxisTitle">Y Axis Title</cell>
					
	      <!--  yAxisRefObjValue chart attribute  -->
                    <cell type="text" data-format="text" alignment="left" chart-attr-name="yAxisRefObjValue">25000</cell>
					
	     <!--  yAxisRefObjLegendText chart attribute  -->
                    <cell type="text" data-format="text" alignment="left" chart-attr-name="yAxisRefObjLegendText">Y Axis Object Reference Text</cell>
					
	      <!--  yAxisRefObjHoverDescValue chart attribute  -->
                    <cell type="text" data-format="text" alignment="left" chart-attr-name="yAxisRefObjHoverDescValue">Y Axis Sample Reference Line</cell>
					
	     <!-- hover series label attribute  -->
                    <cell type="text" data-format="text" alignment="left" chart-attr-name="hoverSeriesLabel">Test Series</cell>
					
	     <!-- hover value label attribute  -->
                    <cell type="text" data-format="text" alignment="left" chart-attr-name="hoverValueLabel">Test Value</cell>
					
	      <!-- hover group label attribute  -->
                    <cell type="text" data-format="text" alignment="left" chart-attr-name="hoverGroupLabel">Test Group</cell>
					
	      <!-- stackValue chart attribute  -->
                    <cell type="chart_text" data-format="text" alignment="left" chart-attr-name="stackValue">on</cell>
                </band>
			
            </bands>
        </frame>
    	
        <layout type="columner">
            <component frame-name="barRefObjFrame" column="1" visual-type="ojBarRefObj" visual-style="oj-sm-12" visual-title=""/>
        </layout>

    </report>

Parent topic: Visualizations