Charting - WorkView - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Premier - external - Premier

WorkView

Platform
OnBase
Product
WorkView
Release
Foundation 24.1
License
Premier

AxisLabelFormat

Controls the axis label text and how its data is formatted. For example, if the X axis labels represent dollar amounts, you can use the following tag to have them show in whole numbers and with commas:

<<AxisLabelFormat: X, C0>>

“C0” is a .NET formatting string. See the following links for more information:

Numbers: http://msdn.microsoft.com/en-us/library/dwhawy9k(v=vs.110).aspx

Date/Time: http://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx

AxisTitle

Sets the text title for the specified axis. Example:

<<AxisTitle: Y, Amount (Dollars) >>

AxisRange

Sets the range for the specified axis. Charts are normally “self adjusting” and the axis labels will adjust to best fit the data provided. However, this can be deceiving when charting percentages and all are in the low range. Use this tag to have the chart paint with a standard range, regardless of data points. Specify the axis, minimum, and maximum values. Example:

<<AxisRange: Y, 0, 100 >>

PointWidth

Controls the width of the bars in a bar chart (and others). Range is 0 through 2. Example:

<<PointWidth: 0.5>>

BackgroundColor

Sets the background color of the chart, but offers optional control of the background gradient. Color must be specified as a web-style RGB string (ex: #FF1422). Gradients are specified by the names in the .NET enumerator GradientStyle. Example:

<<BackgroundColor: #848484, TopBottom >>

Resource for GradientStyle:

http://msdn.microsoft.com/en-us/library/system.web.ui.datavisualization.charting.gradientstyle(v=vs.110).aspx

BorderColor

Sets the color of the chart's border line. Color must be specified as a web-style RGB string (ex: #FF1422). You may also optionally specify a numeric value as a second parameter, which will represent the thickness of the border line. An optional third parameter sets the style of the border line as defined by the .NET enumeration ChartDashStyle. Example:

<<BorderColor: #b54001, 2, Solid >>

Resource for ChartDashStyle:

http://msdn.microsoft.com/en-us/library/system.web.ui.datavisualization.charting.chartdashstyle(v=vs.110).aspx

BorderSkinStyle

Another style option to control the border of the chart. The provided value will be from the .NET enumeration BorderSkinStyle. Example:

<<BorderSkinStyle: Emboss >>

Resource for BorderSkinStyle:

http://msdn.microsoft.com/en-us/library/system.web.ui.datavisualization.charting.borderskinstyle(v=vs.110).aspx

Chart

Defines a template block that will produce a chart from the specified NameValueMap. The settings contained by this template block controls all aspects of the chart produced and can consist of combinations of the items defined next. An existing NameValueMap must be specified. Example:

<<Chart:AmountByStatus>>

ChartType

Specifies the type of chart to create, for example, pie or bar. Currently supported charts include:

  • Bar

  • Column

  • Area

  • Pie

  • Doughnut

  • Candlestick

  • Radar

  • Funnel

  • Pyramid

ChartWidth

Controls the width of the area in which to render the chart. The chart itself may be sized to this width, or parts may be truncated if the width is too conservative. Example:

<<ChartWidth:500>>

ChartHeight

Controls the height of the area in which to render the chart. The chart itself may be sized to this width, or parts may be truncated if the height is too conservative. Example:

<<ChartHeight:500>>

MinimumBucketSize

Used to set a minimum value for a Named section to be reported as an individual section. If specified, and a named value is below this threshold, the value will be appended in a general “Other” section. Example:

<<MinimumBucketSize:2>>

ShowCountOn

Indicates if and where the count for a section should be displayed. Possible text parameter options can include: Label, Legend, and Title. Multiple values should simply be separated by a comma. Example:

<<ShowCountOn: Label, Legend, Title>>

ShowGroupNameOn

Controls where chart group names are displayed. By default, both LABELS and LEGENDS are displayed, but you may specify LABELS and/or LEGEND for specific control.

Suppress

Used to specify one or more chart items to suppress. Possible text parameter options can include: Label, Legend, and Title. Multiple values should be separated by a comma. Example:

<<Suppress: Label, Legend, Title>>

ShowPercentageOn

Indicates if and where the overall percentage for a section should be displayed. Possible text-parameter options can include: Label, Legend, and Title. Multiple values should simply be separated by a comma. Example:

<< ShowPercentageOn: Label, Legend, Title>>

ChartData

Applicable only to FilterAsChart blocks. Sets the attribute name to use as the source for chart values. Example:

<<ChartData: amount>>

ValueFormat

Specifies a format modifier for the numeric values displayed by the chart. See the list of modifiers under data values. Example:

<<ValueFormat: CurrencyWhole>>

PercentageFormat

Specifies a format modifier for the percentage values displayed by the chart. See the list of modifiers under data values. Examples:

<<ValueFormat: CurrencyWhole>>

<<ValueFormat: “F1” >>

GroupByAttribute

Application only to FilterAsChart blocks. Identifies the attribute to use for grouping the chart data. Example:

<<GroupByAttribute: Status>>

ChartTitle

Specifies a string that will be displayed as the chart title. Example:

<<ChartTitle: AP Issues by Status/Bar>>

LegendHeading

Specifies a string that will appear as the heading of the legend area. Example:

<<LegendHeading: Legend>>

DataSort

Specifies how to sort the chart sections as they list in the legend. You may specify values of Name or Value to sort by the section names, or section values, respectively. Append the string Descending as an additional parameter to force a descending sort. Example:

<<DataSort: Value, Descending>>

BlankLegendText

Specifies the string to display if a section name is blank. Example:

<<BlankLegendText: No Reviewer >>

SetChartProperty

A generic tag that allows for a chart property to be set manually, outside the scope of a specific Report Processor tag. Example: <<SetChartProperty: chartPropertyName, chartPropertyValue>> Where the property name and chart value will be chart-type specific and found in the Microsoft .Net Chart Control documentation.

Examples:

<<SetChartProperty: PieDrawingStyle, Concave>>

<<SetChartProperty: PieDrawingStyle, SoftEdge>>

<<SetChartProperty: PieLabelStyle, Outside>>

<<SetChartProperty: PieLineColor, Black>>

Resource for chart properties:

http://msdn.microsoft.com/en-us/library/dd456764(v=vs.110).aspx

DisplayIn3d

The existence of this tag causes the chart to be displayed in a 3D look. Example:

<<DisplayIn3d>>

ExplodeHighest

Will tell the chart control to explode, or “pull out” the section in the chart that has the highest value. Example:

<<ExplodeHighest>>

ExplodeLowest

Will tell the chart control to explode, or “pull out” the section in the chart that has the lowest value. Example:

<<ExplodeLowest>>

Explode

Will tell the chart control to explode or “pull out” the section with the specified name. Example:

<<Explode: North East Region>>

FilterAsChart

An extension of the Chart tag. No NameValueMap is specified here. Instead, a filter name is provided and the chart settings in the contained block must specify GroupByAttribute and, optionally, a ChartData tag (see above). If ChartData is not specified as a source for values to report, a simple count per GroupByAttribute is charted. Example:

<<FilterAsChart:Issues - All Issues-Original>>

<<ChartType:Bar>>

<<GroupByAttribute:Status>>

<<ChartData: amount>>

<<End>>

SuppressEndLabel

For BarCharts, this option allows axis labels to be suppressed at each end of the axis. Example:

<<SuppressEndLabel: X>>

Note:

The .NET API determines the X axis and Y axis orientation. In some situations, this may not be where you would typically expect the X axis and Y axis. You may need to adjust your properties to accommodate the position of each axis.