WinStudio

Specify Gauge Settings Dialog Box

Use this dialog box to specify settings for a gauge component. Not all settings are required; if you do not specify a value for an optional setting, a default value is used.

Gauges are single or multiple value indicators that are used in dashboards, real-time monitors and reports. They are used to display Key Performance Indicators (KPIs), progress indicators and quantity indicators.

As used in this topic:

Alpha is a transparency setting from 0-100. 100 means no transparency, that is, solid color. 0 means invisible. Numbers from 1 to 99 are levels of transparency, with the lower numbers being more transparent and higher numbers less transparent/more solid.
Color values are stored in a hexadecimal RGB (Red/Green/Blue) format. Each color value (R,G, and B) is assigned a value from 0 to 255, which in hexadecimal notation is 00 to FF. Each value represents the amount of color, so for example, FF0000 is solid red, 000000 is solid black, and FFFFFF is solid white. You can use the Color dialog box to select a color or create a custom color.
Critical numbers are based on a stored procedure calculation or on an IDO calculation. The system includes basic preconfigured critical numbers. You can copy and modify these or create new critical numbers . For more information, see About Critical Numbers.

NOTE: Only users who have the appropriate licenses can bind a gauge to a critical number, or view a result in a critical number gauge.

This dialog box has these tabs:

General
Color Ranges
Trendpoints
Cosmetics
Other
Angular
Linear
LED
Cylinder
Bullet
Gauge XML

General Tab

This tab specifies general information about the type of gauge, as well as the data source.

Field	Description
Gauge Type	Specify the type of gauge: AngularGauge Bulb Cylinder HLED HLinearGauge Thermometer VLED HBullet VBullet To see an example of the selected gauge type, click Preview. Some of the tabs are enabled when you select a specific type.
Caption	Specify the caption (title) for the gauge.
Sub-Caption	Specify the subtitle, if any, for the gauge.
Lower/Upper Limit	Specify the minimum and maximum values to be plotted on the gauge scale.
Lower/Upper Limit Display	Specify the text that describes the minimum and maximum values. For example, you could use "Bad" for the minimum and "Good" for the maximum.
Number Prefix/Suffix	Prefix: Specify a value to add it as a prefix to all numbers plotted on the primary axis. For example, to display all numbers as dollars, specify $ as the prefix. Suffix: Specify a value to add it as a suffix to all numbers plotted on the primary axis. For example, to display all numbers as per year, specify /yr as the suffix.
Decimal Places	Specify the number of decimal places to round to. This controls the decimal precision of all numbers on the chart. For example, if your data includes 0.12352, 0.134 and 0.13, and you set this value to 3, the data is displayed as 0.124, 0.134 and 0.13.
Animated	Select to animate the gauge so that data displays gradually, rather than all at once.
Show Value	Select to display the value on the gauge.
Show Shadow	Select to add a shadow effect to the gauge.
Show Tick Marks	Select to show tick marks. By default, the marks are on the outside of the gauge.
Show Tick Values	Select to show tick values. By default, the values are on the outside of the gauge.
Place Ticks Inside	Select to show the tick marks on the inside of the gauge.
Place Values Inside	Select to show the tick values on the outside of the gauge.
Ticks Below Gauge	Select to show the tick marks below the gauge.
Show Gauge Border	Select to display a border around the gauge.
Theme Color	Double-click to display the Color dialog box, where you can select a color or define a custom color. The color is displayed in hexadecimal after you apply your changes. A palette is derived for the gauge, based on this color.
Gauge Border Color/Thickness/ Alpha	Color: Double-click to display the Color dialog box, where you can select a color or define a custom color for the border around the gauge. The color is displayed in hexadecimal after you apply your changes. Thickness: Specify the thickness of the border, in pixels. Alpha: Specify the transparency of the border.
Data Source	Select if the source of the data is a collection or critical number. Additional fields are enabled.
Critical Number	Select a critical number to be displayed by the gauge.
Canned Critical Number	Select a canned (predefined) critical number to be displayed by the gauge. There is a chance that canned critical numbers will be renumbered by the system. For example, if you set up a critical number "5", the canned critical number "5" is renumbered to "6".
As Of Date	Specify the date against which the critical number is calculated.
Group	Specify the group for the critical number. This field is only enabled for critical numbers that are set up to allow grouping.
Date Range	Select a specific date range for the critical number. This field is only enabled for critical numbers with date ranges specified at setup.
Drilldown	Select a drilldown for the critical number.
Caption Format	Select the caption format to use for the critical number: Long Short Default None (static gauge option)
Sub-Caption Format	Select the sub-caption format to use for the critical number: All (goal/alert/actual) Actual None (static gauge option)
Goal Value	Specify the goal critical number.
Alert Value	Specify the value to signify that a critical number has an alert status.
Automatic Refresh Interval	Specify in minutes the interval at which the critical number is recalculated and displayed.

Major and Minor Tick Marks

Field	Description
Count	The gauge automatically sets the number of tick marks to use. You can override that number here.
Color	Double-click to display the Color dialog box, where you can select a color or define a custom color for the tick marks. The color is displayed in hexadecimal after you apply your changes.
Alpha	Specify the transparency of tick marks.
Height	Specify the height of the tick marks, in pixels.
Thickness	Specify the thickness of the tick marks, in pixels.

Chart Data (Collection)

These fields are displayed if you select Collection as the Data Source.

Field	Description
Data Source	Select Collection to use properties from an IDO collection.
Collection	Specify the collection whose properties you want to include on the gauge. The drop-down list includes all IDO collections that are available on the current form.
Available Properties	Select a property from the collection and click Add>> to add it to the list of fields you want to include. For example, you might want to show a gauge of sales on a form. To remove a property from the list of fields you want to chart, click <<Remove. Use the Up and Down buttons to move properties within the list. You can specify multiple properties for the AngularGauge and HLinearGauge types. If you specify multiple properties for the other gauge types, they are ignored.

Chart Data (Critical Number)

These fields are displayed if you select Critical Number as the Data Source.

Field	Description
Data Source	Select Critical Number .
Critical Number	Select an existing critical number that generates the data for the control.
Canned Critical Number	Select a predefined (canned) critical number.
As Of Date	For time-sensitive numbers, specify the date to pass to the critical number calculation program.
Group	Select a value if you want to group data by a variety of fields.
Date Range	Select the date ranges to be included.
Drilldown	Specify an integer for the drilldown to run when the user double-clicks on the gauge. If this value is not specified, the gauge uses the first drilldown set on the critical number.
Caption/Sub-Caption Format	Select the format to use for the caption and sub-caption. If this format is set to anything other than None, the main caption/sub-caption is disabled, since the value is then set based on the Critical Number. To manually set the caption or sub-caption on a critical number-based gauge, specify None here.
Goal Value	If you want to override the goal value set in the critical number, specify a decimal value to compare to the actual value.
Alert Value	If you want to override the actual value set in the critical number, specify a decimal value to compare to the actual value.
Automatic Refresh Interval	Specify the interval, in minutes, at which to refresh the critical number.
Filter1-5	Specify filters to use on the critical number.
Additional Input Parameters	Click to enter up to 50 additional filters based on the setup of the critical number. The filters are enabled and labeled dynamically, based on the critical number chosen.

Color Ranges Tab

You can create color ranges to classify your data. For each range, specify the minimum and maximum limits, a label for the range and the color and alpha for the range and its border.

Field	Description
Color	Double-click to display the Color dialog box, where you can select a color or define a custom color for the range. The color is displayed in hexadecimal after you apply your changes.
Alpha	Specify the range transparency, from 0 to 100.
Min/Max	Specify the minimum and maximum values for this range.
Border Color	Double-click to display the Color dialog box, where you can select a color or define a custom color for the range border. The color is displayed in hexadecimal after you apply your changes.
Border Alpha	Specify the range border transparency, from 0 to 100.
Label	Specify a label for this range.

Trendpoints Tab

You can set trend-points on the gauge, for example, to mark last year's value.

Field	Description
Start Value	Specify the starting value for the trend-point. If you want a single value, specify it here.
End Value	Specify the ending value for the trend-point, if you want a range of values.
Display Value	Specify the label to display with the trend-point.
Value Inside	Select to display the label inside the gauge.
Color	Double-click to display the Color dialog box, where you can select a color or define a custom color for the trend-point. The color is displayed in hexadecimal after you apply your changes.
Dashed	Select to display the trend-point as a dashed line.
Use Marker	Select to display a triangular marker for each trend-point.
Marker Color	Double-click to display the Color dialog box, where you can select a color or define a custom color for the trend-point marker. The color is displayed in hexadecimal after you apply your changes.
Marker Tooltext	Specify tooltip text to display for the marker when the user hovers over it.

Cosmetics Tab

Number Formatting

Field	Description
Default Number Scale and Unit/ Value	Use the number scale and number scale unit/value together to define units of scaling for the gauge. By default, gauges use (1000,1000) (K,M) scaling, which equates to 1000 = 1K and 1000K = 1M. To add billions to the scaling, set the Scale to 1000,1000,1000 and the Unit/Value to K,M,B, which equates to 1000=1K, 1000K=1M, and 1000M = 1B. To use a time scale, set the Scale to 60,60,24,7 and the Unit/Value to min,hr,day,wk, which equates to 60 seconds = 1 min, 60 minute = 1 hr, 24 hrs = 1 day, and 7 days = 1 week.
Decimal Separator	Specify a decimal separator if you do not want to use the default value, which is a period.
Thousand Separator	Specify a thousands separator if you do not want to use the default value, which is a comma.
Format Number	Select to automatically add commas to numbers in the appropriate places.
Force Decimals	Select to include trailing zeros if necessary so that all values in the gauge are displayed to the decimal precision specified in Decimal Places, below.
Format Number Scale	Select to automatically format numbers by adding K (kilo, for thousands) or M (million) and truncating the numbers. For example, 10,000 is truncated to 10K.

Padding and Margins

Padding and margins are specified in pixels.

Field	Description
Left/Right/Top/BottomMargins	Margins are the padding between the start of the gauge and the gauge itself. . Each of the margins - left, right, top, and bottom - can be set individually. Use this attribute to override the default space with a higher value. You cannot specify a lower value. This attribute is helpful if you have multiple gauges on a page and you want all of them to align with each other.
Value Padding	Specify the space between the columns or anchors and the value text boxes.

Gradient

Field	Description
Gauge Fill Mix	Specify a gradient mix formula for the gauge. The formula can include these literals, in a list separated by commas: {dark-xx}, where xx represents the percentage of base color darkness. For example, dark-10 represents a color which is 10% darker than the color originally present there {light-xx}, where xx represents the percentage of base color lightness {color}, which is the actual base color {HexCode} like {FFFFFF} or {FF0000}
Gauge Fill Ratio	Specify a gradient fill ratio for the gauge. The ratio determines how far the color spreads before it is mixed with the next color to form a gradient. Separate the ratios by commas, for example: 60,20,20. The sum of the ratios should equal 100, and the number of ratios in the list should equal the number of colors you specify in the Gauge Fill Mix. The system maps each ratio to the corresponding color in the mix.

Cosmetics

Field	Description
Back Color/Alpha/ Ratio/Angle	Color: Double-click to display the Color dialog box, where you can select a color or define a custom color for the background. The color is displayed in hexadecimal after you apply your changes. To use a gradient fill, specify all the colors required for the gradient fill, separated by commas. Alpha: For each color you specified above, specify the transparency of the background, from 0 to 100. Separate the alphas by commas. Ratio: Specify the ratio of each color in the gradient on a scale of 100. The total of the ratios must equal 100. For example, to plot an equidistant gradient for two colors, specify the ratio as 0,100. Angle: Specify the angle of the gradient fill, in degrees, from 0 to 360.
Show Border	Select to display an outer border around the gauge.
Border Color/ Thickness/Alpha	Color: Double-click to display the Color dialog box, where you can select a color or define a custom color for the border around the gauge. The color is displayed in hexadecimal after you apply your changes. Thickness: Specify the thickness of the border, in pixels. Alpha: Specify the transparency of the border.

Font

Field	Description
Base Font	Specify the font to use for all text on the gauge.
Base Font Size/Color	Specify a font size (0 to 72) and double-click in the Color field to select a font color.

Other Tab

Field	Description
Show Tooltip	Select to display tool tips when the mouse hovers over a data point.
Show Tooltip Shadow	Select to display a shadow on tool tips.
Tooltip Back Color	Double-click to select a background color for the tool tip.
Tooltip Border Color	Double-click to select a border color for the tool tip.

Angular Tab

The information on this tab is used when you select AngularGauge as the gauge type.

Field	Description
Gauge Start Angle	Specify the angle from which the gauge starts drawing, from -360 to 360. The default value is 180.
Gauge End Angle	Specify the angle at which the gauge ends, from -360 to 360. The default value is 180
Value Below Pivot	Select to display the value below the pivot.
Pivot Radius	Specify the radius of the pivot, in pixels.
Pivot Fill Color/ Alpha/Angle	Color: Double-click to display the Color dialog box, where you can select a color or define a custom color for the pivot. The color is displayed in hexadecimal after you apply your changes. To use a gradient fill, specify all the colors required for the gradient fill, separated by commas. Alpha: For each color you specified above, specify the transparency of the background, from 0 to 100. Separate the alphas by commas. Angle: Specify the angle of the gradient fill, in degrees, from 0 to 360.
Pivot Fill Type	Specify the gradient fill type. Radial is the default value. You can also specify linear.
Pivot Fill Mix	Specify a gradient mix formula for the gauge. The formula can include these literals, in a list separated by commas: {dark-xx}, where xx represents the percentage of base color darkness. For example, dark-10 represents a color which is 10% darker than the color originally present there {light-xx}, where xx represents the percentage of base color lightness {color}, which is the actual base color {HexCode} like {FFFFFF} or {FF0000}
Pivot Fill Ratio	Specify a gradient fill ratio for the gauge. The ratio determines how far the color spreads before it is mixed with the next color to form a gradient. Separate the ratios by commas, for example: 60,20,20. The sum of the ratios should equal 100, and the number of ratios in the list should equal the number of colors you specify in the Gauge Fill Mix. The system maps each ratio to the corresponding color in the mix.
Show Pivot Border	Select to display a border for the pivot.
Pivot Border Thickness/Color/ Alpha	Thickness: Specify the thickness of the border, in pixels. Color: Double-click to display the Color dialog box, where you can select a color or define a custom color for the border. The color is displayed in hexadecimal after you apply your changes. Alpha: Specify the transparency of the border.
Gauge Outer/Inner Radius	Specify the outer and inner radius for the color range scale.

Linear Tab

The information on this tab is used when you select HLinearGauge as the gauge type.

Field	Description
Pointer Radius	Specify the radius of the pointer.
Pointer Back Color/Alpha	Color: Double-click to display the Color dialog box, where you can select a color or define a custom back color for the pointer. The color is displayed in hexadecimal after you apply your changes. Alpha: Specify the transparency of the pointer.
Pointer Sides	Specify the number of sides for the pointer.
Pointer Border Color/Alpha/ Thickness	Color: Double-click to display the Color dialog box, where you can select a color or define a custom color for the border. The color is displayed in hexadecimal after you apply your changes. Thickness: Specify the thickness of the border, in pixels. Alpha: Specify the transparency of the border.
Value Above Pointer	Select to display the value above the pointer.
Pointer on Top	Select to display the pointer on top of the scale. By default, the pointer is below the scale.
Show Gauge Labels	Select to display labels.

LED Tab

The information on this tab is used when you select HLED or VLED as the gauge type.

Field	Description
LED Size/Gap	Specify the size of the LED bars and the gap between them, in pixels.
Use Same Fill Color	When you divide the LED scale into color ranges, by default the LED bars in each zone use the fill color of the various ranges. Select this option to fill all of the LED bars with one color, which is the color of the range where the current value falls.
Use Same Fill Back Color	Select to set all non-activated (background) LEDs to the same color.

Cylinder Tab

The information on this tab is used when you select Cylinder as the gauge type.

Field	Description
Origin X/Y	Specify the X and Y coordinates for the bottom left portion of the cylinder .
Radius/Height	Specify the radius and height of the cylinder, in pixels.
Y Scale	Specify the units of scaling, from 0 to 50, for the Y-scale perspective (top view of the cylinder).
Fill Color	Double-click to display the Color dialog box, where you can select a color or define a custom color for the cylinder. The color is displayed in hexadecimal after you apply your changes.

Bullet Tab

The information on this tab is used when you select Bullet as the gauge type.

Field	Description
Target Value	Specify the value that indicates the target.
Plot as Dot	Select to display the plot as a point, instead of bar.
Plot/Target Fill Percent	Specify the thickness of the value bar and target line as a percentage of the total graph height/width (height in horizontal bullet graph; width in vertical bullet graph) .
Plot Fill Color/Alpha	Color: Double-click to display the Color dialog box, where you can select a color or define a custom color for the plot fill. The color is displayed in hexadecimal after you apply your changes. Alpha: Specify the transparency of the plot fill.
Show Plot Border	Select to display a border for the bullet chart.
Plot Border Color/ Thickness/Alpha	Color: Double-click to display the Color dialog box, where you can select a color or define a custom color for the border. The color is displayed in hexadecimal after you apply your changes. Thickness: Specify the thickness of the border, in pixels. Alpha: Specify the transparency of the border.
Target Color/ Thickness	Color: Double-click to display the Color dialog box, where you can select a color or define a custom color for the target area. The color is displayed in hexadecimal after you apply your changes. Thickness: Specify the thickness of the target area, in pixels.
Caption Padding	Specify a value in pixels to control the vertical space between the caption and the top of the gauge.
Canvas Left/Right Margin	Specify the space, in pixels, between the gauge and the left and right margins.

Gauge XML Tab

This tab displays the XML that is used to generate the gauge in the form. The XML is display-only.

Buttons

To save your changes, click Apply.

To preview the gauge using the options that you selected, click Preview. The previewed example does not show Framework data.