Chart components

You can use tags and attributes to change the chart components in a report template. The chart components are fp:cells, fp:chart, and fp:prioritylist.

fp:cells

The fp:cells component displays two or more fp:chart tags in a table. The component uses the common attributes and one mandatory attribute, cols. The cols attribute determines the number of columns and their sizes. The default value for cols is false.

The fp:cells tag must contain more than zero tags, and the number of tags must be a multiple of the number of columns specified by the cols attribute. For example, if you have three columns, the number of tags must be a number that is a multiple of three.

In this example, the table has three columns, and the middle column is wider than the other columns.
<fp:cells cols="30,40,30"
	<fp:chart ...	 />
	<fp:chart ... />
	<fp:chart ... />
	<fp:chart ... />
	<fp:chart ... />
	<fp:chart ... />
/>

fp:chart

The fp:chart component presents a chart that displays the priorities for one or more criteria and one or more members. This component has the common attributes. The fp:chart component uses the common tags and the tags in the following table.
Table 1. fp:chart tags
Tag Description Attributes Example
chartType A mandatory tag of type chartType that determines the chart type, such as a bar chart or an XY chart.
  • changeable: A mandatory attribute that determines when the value can be changed. This attribute works the same way as the changeable attribute for fp:*Param tags.
  • id: A mandatory attribute that specifies the ID of the tag.
  • name: A mandatory attribute that specifies the name of the tag. The name must be "chartSorting".
  • descr: An optional attribute that describes the chartSize tag. The description is displayed when the report type is created or edited, or when the report is generated. The default value is "" (no description).
  • defaultvalue: An optional attribute that can be set to one of the following values:
    • bar: a bar chart (the default value)
    • stackedbar: a stacked bar chart
    • xy: an XY chart
    • stackedxy: a stacked XY chart
    • pie: a pie chart
    • radar: a radar chart
<fp:chartType
	changeable="template"
	id="2"
	name="chartType"
	descr="Type of chart"
	defaultvalue="bar"
/>
  The pwcDomain tags specify the criterion-member tuples that are displayed in a chart. These tags are of type pwcDomain. You must use at least one pwcDomain tag. The set of pwcDomain tags needed is determined by the chart type:
  • X: The tag for the bar chart type; specifies the criterion-member tuple on the X axis
  • no name: The tag for the stackedbar chart type. You can use any number of pwcDomain tags.
  • X Y: The tag for the xy chart type. X represents the criterion-member tuple on the X axis. Y represents the criterion-member tuple on the Y axis.
  • not applicable: The tag for the stackedxy chart type. The pwcDomains are not used.
  • X [Y]: The tag for the pie chart type. X represents the criterion-member tuple that uses the circle sector. [Y] represents the criterion-member tuple that uses the height. If [Y] is not set, the height is same for all elements.
  • no name: The tag for the radar chart type. Any number of pwcDomain tags can be used, and their names do not matter.
  • changeable: A mandatory attribute that determines when the value can be changed. This attribute works the same way as the changeable attribute for fp:*Param tags.
  • charttypeid: A mandatory attribute that specifies the ID of the chartType tag. The user interface uses the chartType tag value to determine whether the chartSorting tag is displayed.
  • id: A mandatory attribute that specifies the ID of the tag.
  • masterid: A mandatory attribute that specifies the ID for the viewParam that controls this parameter. In the user interface, you must set the master viewParam first, or you cannot know which criteria are available.
  • name: A mandatory attribute that specifies the name of the tag. The name must be "chartSorting".
  • allmembersid: An optional attribute that specifies the ID of the allMembers checkboxParam tag.
  • descr: An optional attribute that describes the pwcDomain tag. The description is displayed when the report type is created or edited or when the report is generated. The default value is "" (no description)
<fp:pwcDomain
		changeable="template"
		charttypeid="2"
		id="9"
		masterid="1"
		name="x"
		descr="The X axis"
		allmembersid="99"
/>
viewId A mandatory tag of type viewParam that contains a view ID.    
fp:chartfilter Stacked XY charts and stacked bar charts that are generated as quick reports use the X, Y, and sector selections on screen. By default, the normal reports select all X, Y, and sector check boxes. By using fp:chartfilter tags, you can change the set of selected check boxes for normal reports. You can find the values of the tags in one of the following ways:
  • Set the database loglevel to notice.
  • Generate a quick report that has the set of selected check boxes that you want.
  • Copy the fp:chartfilter values from log file.
 
<fp:chart ...>
...
<fp:chartfilter name="x" value="16/10" />
<fp:chartfilter name="y" value="162" />
<fp:chartfilter name="z" value="162,16/10"/>
...
</fp:chart>
allMembers An optional tag of type checkboxParam that determines which priorities are included: all members' priorities or the currently logged in member's priorities. The default value is false (only the current member's priorities are included).    
chartSize An optional tag of type chartSize that determines the size of the chart.
  • changeable: A mandatory attribute that determines when the value can be changed. This attribute works the same way as the changeable attribute for fp:*Param tags.
  • id: A mandatory attribute that specifies the ID of the tag.
  • name: A mandatory attribute that specifies the name of the tag. The name of the tag must be "chartSize".
  • descr: An optional attribute that describes the chartSize tag. The description is displayed when the report type is created or edited or when the report is generated. The default value is "" (no description).
  • defaultvalue: An optional attribute. This attribute can be set to one of the following values:
    • extra_small
    • small
    • normal (default value)
    • large
    • extra_large
<fp:chartSize
	changeable="template"
	id="3"
	name="chartSize"
	descr="Size of chart"
	defaultvalue="small"
/>
chartSorting An optional tag of type chartSorting that determines the sort order in the chart. This tag is applicable for bar charts and stacked bar charts only.
  • changeable: A mandatory attribute that determines when the value can be changed. This attribute works the same way as the changeable attribute for fp:*Param tags.
  • charttypeid: A mandatory attribute that specifies the ID of the chartType tag. The user interface uses the chartType tag value to determine whether the chartSorting tag is displayed.
  • id: A mandatory attribute that specifies the ID of the tag.
  • name: A mandatory attribute that specifies the name of the tag. This attribute must be set to "chartSorting".
  • descr: An optional attribute that describes the chartSorting tag. The description is displayed when the report type is created or edited or when the report is generated. The default value is "" (no description).
  • defaultvalue: An optional attribute that can be set to one of the following values:
    • original: The order of the elements in a tree
    • bestattop: The best element first (default value)
    • bestatbottom: The best element last
<fp:chartSorting
	changeable="template"
	charttypeid="2"
	id="4"
	name="chartSorting"
	descr="Sorting"
	defaultvalue="bestatbottom"
/>
disagree An optional tag of type checkboxParam that determines whether disagreement is presented in a chart. This tag is applicable to stacked bar charts only. The default value is false (no disagreement indicator).    
prefix An optional tag of type checkboxParam that determines whether prefixes are presented in the chart. The default value is true.    
title An optional tag of type checkboxParam that determines whether titles are presented in the chart. The default value is true.    
<fp:chart descr="A chart" id="430">
	<fp:viewParam
		name="viewId"
		descr="The view that contains the elements"
		changeable="template"
		id="1"
	/>
	<fp:chartType
		name="chartType"
		descr="Type of chart"
		changeable="template"
		id="2"
		defaultvalue="xy"
	/>
	<fp:chartSize
		name="chartSize"
		descr="Size of chart"
		changeable="template"
		id="3"
		defaultvalue="small"
	/>
	<fp:chartSorting
		name="chartSorting"
		descr="Sorting"
		changeable="template"
		id="4"
		charttypeid="2"
		defaultvalue="bestattop"
	/>
	<fp:checkboxParam
		name="allMembers"
		descr="Use all members' prioritizations"
		changeable="template"
		defaultvalue="false"
		id="5"
	/>
	<fp:checkboxParam
		name="disagree"
		descr="Show disagreement in stacked bar"
		changeable="template"
		defaultvalue="false"
		id="6"
	/>
	<fp:checkboxParam
		name="prefix"
		descr="Show element prefix"
		changeable="template"
		defaultvalue="false"
		id="7"
	/>
	<fp:checkboxParam
		name="title"
		descr="Show element titles"
		changeable="template"
		defaultvalue="true"
		id="8"
	/>
	<fp:pwcDomain
		name="x"
		descr="X axis"
		changeable="template"
		id="9"
		charttypeid="2"
		masterid="1"
		allmembersid="5"
	/>
	<fp:pwcDomain
		name="y"
		descr="Y axis"
		changeable="template"
		id="10"
		charttypeid="2"
		masterid="1"
		allmembersid="5"
	/>
	<fp:pwcDomain
		name="z"
		descr="Z axis"
		changeable="template"
		id="11"
		charttypeid="2"
		masterid="1"
		allmembersid="5"
	/>
</fp:chart>

fp:prioritylist

The fp:prioritylist component displays priorities in a table instead of a chart. The priority list contains all the criteria that is associated with the view.

The fp:priority list component uses the common attributes and the common tags, and also uses one mandatory tag, viewId. The viewId tag is of type viewParam and contains a view ID.

<fp:prioritylist descr="A priority list" id="430">
	<fp:viewParam
			name="viewId"
			descr="The view that contains the elements"
			changeable="template"
			id="1"
/>
</fp:prioritylist>

Feedback