Scatter 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 – x, y

<cell type="column" data-format="currency" alignment="right" suppress-formatting="true" print-width="70" chart-attr-name="xAxisItem">salesTotal</cell>

<cell type="column" data-format="currency" alignment="right" suppress-formatting="true" print-width="70" chart-attr-name="yAxisItem">salesTotal</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. Value is derived based on the cell type definition.

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

“yAxisItem” is a constant attribute name. 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.

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.

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.

hoverBehavior

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

“hoverBehavior” is a constant attribute name. The cell type must be set to “chart_text”. The valid value is dim.

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.

hoverYLabel

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

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

hoverXLabel

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

“hoverXLabel” is a constant attribute name. 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.

dataTypeXAxisFormat

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

“dataTypeXAxisFormat” is a constant attribute name. 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.

dataTypeYAxisFormat

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

“dataTypeYAxisFormat” is a constant attribute name. 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 Scatter Chart JSON Data

<report>
	<frame type="table" query-name="MajorGroupsQuery" name="scatterFrame">
		<bands>
			<band type="table-body">
				<cell type="text" data-format="text" alignment="left" print-width="140" indent-level="3" chart-attr-name="seriesName">Series1</cell>				
				<cell type="column" data-format="currency" alignment="right" suppress-formatting="true" print-width="70" chart-attr-name="xAxisItem">salesTotal</cell>
				<cell type="column" data-format="currency" alignment="right" suppress-formatting="true" print-width="70" chart-attr-name="yAxisItem">salesTotal</cell>
				
				<cell type="text" data-format="text" alignment="left" print-width="140" indent-level="3" chart-attr-name="seriesName">Series2</cell>
				<cell type="column" data-format="currency" alignment="right" suppress-formatting="true" print-width="70" chart-attr-name="xAxisItem">salesTotal</cell>
				<cell type="column" data-format="currency" alignment="right" suppress-formatting="true" print-width="70" chart-attr-name="yAxisItem">salesTotal</cell>
				
				<cell type="column" data-format="text" alignment="left" chart-attr-name="groupData">majorGroupNameMaster</cell>
				
				<!-- extra cell to match count in table-body -->
				<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">
				<!--  xAxisTitle chart attribute  -->
				<cell type="text" data-format="text" alignment="left" chart-attr-name="xAxisTitle">X Axis Title</cell>
				
				<!--  yAxisTitle chart attribute  -->
				<cell type="text" data-format="text" alignment="left" chart-attr-name="yAxisTitle">Y Axis Title</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>
				
				<!-- hover Y label attribute  -->
				<cell type="text" data-format="text" alignment="left" chart-attr-name="hoverYLabel">Test Y</cell>
				
				<!-- hover X label attribute  -->
				<cell type="text" data-format="text" alignment="left" chart-attr-name="hoverXLabel">Test X</cell>
				
				<!--  hoverBehavior chart attribute  -->
				<cell type="chart_text" data-format="text" alignment="left" chart-attr-name="hoverBehavior">dim</cell>
				
				<!--  hideShowBehavior chart attribute  -->
				<cell type="chart_text" data-format="text" alignment="left" chart-attr-name="hideShowBehavior">withoutRescale</cell>
				
				<!--  dataTypeXAxisFormat chart attribute  -->
				<cell type="chart_text" data-format="text" alignment="left" chart-attr-name="dataTypeXAxisFormat">integer</cell>
				
				<!--  dataTypeYAxisFormat chart attribute  -->
				<cell type="chart_text" data-format="text" alignment="left" chart-attr-name="dataTypeYAxisFormat">percent</cell>
			</band>
		</bands>
	</frame>
<layout type="columner">
	<component frame-name="scatterFrame" column="1" visual-type="ojScatter" visual-style="oj-sm-12" visual-title=""/>
</layout>
</report>