Enterprise RTView® 
User Guide


Pie Scales
 

Alert Properties
 
Property Name Description
thresholdColorPieFlag If selected, a portion of the pie will display the threshold color when it exceeds that threshold. This property only applies if either the valueHighAlarmEnabledFlag or the valueHighWarningEnabledFlag is selected.
thresholdLineThickness Select Thin, Medium or Thick to set the thickness of the threshold lines. This property is only used if the thresholdLineVisFlag is selected.
thresholdLineVisFlag Select to draw a line across the bar at the level of each enabled threshold. This line will be the same color as the threshold color. This property is only used if the valueHighAlarmEnabledFlag or valueHighWarningEnabledFlag is selected.
valueHighAlarmEnabledFlag Select to enable the high alarm range and the following related properties: 
valueHighAlarm Specify the minimum value for the high alarm range.
 
valueHighAlarmColor Specify the color for the high alarm range.
valueHighWarningEnabledFlag Select to enable the high warning range and the following related properties:
valueHighWarning Specify the minimum value for the high warning range.
 
valueHighWarningColor Specify the color for the high warning range.

Background Properties
 
Property Name Description
bgBorderColor Select the  button and choose a color from the palette to set the color of the edge on the background rectangle. This property is only applicable if bgBorderFlag is selected.
bgBorderFlag If selected, a border is drawn around the background rectangle,
bgColor Select the  button and choose a color from the palette to set the background color. 
bgEdgeWidth Set the width of the 3D edge on the background rectangle. This property is only available if the bgStyle selected is 3D Rectangle.
bgGradientColor2 Select the  button and choose from the palette to set the second color in the gradient. The bgColor property sets the first color in the gradient. NOTE: This property will be ignored if bgGradientMode is set to None.
bgGradientMode Display a gradient in the background rectangle. Select from the following options:
 
  None No gradient
  Diagonal Edge Gradient is drawn at a 45 degree angle from the top left to the bottom right corner of the object.
  Diagonal Center Gradient is drawn at a 45 degree angle from the center to the top left and the bottom right corners of the object.
  Horizontal Edge Gradient is drawn horizontally from the top to the bottom of the object.
  Horizontal Center Gradient is drawn horizontally from the center to the top and bottom of the object.
  Vertical Edge Gradient is drawn vertically from the left to the right of the object.
  Vertical Center Gradient is drawn vertically from the center to the left and right of the object.
bgRaisedFlag Reverses the direction of the gradient, as well as that of the 3D edge if the bgStyle selected is 3D Rectangle.
bgRoundness Set the arc length of the rounded corners. This property is only available if the bgStyle selected is Round Rectangle.

NOTE: The value of bgRoundness cannot exceed half the value of the objWidth or the objHeight. If bgRoundness does exceed that value, then half (of the smaller of the two values) of objWidth or objHeight will be used instead. For example if objWidth is 100 and objHeight is 50, then the value of bgRoundness cannot exceed 25. If it does, then half the value of objHeight (25) will be used instead.

bgShadowFlag Select to display a drop shadow on the background rectangle.
bgStyle Choose one of  the following three options from the drop down menu:
 
Rectangle Select to display a background rectangle.
3D Rectangle Select to display a 3D edge on the background rectangle. If selected, use bgEdgeWidth to set the width of the 3D edge.
Round Rectangle Select to display a background rectangle with rounded edges. If selected, use bgRoundness to set the arc length of the rounded corners.
bgVisFlag Select to display the background rectangle.
borderPixels Set the amount of space (in pixels) between the scale and the border.

Data Properties
 
Property Name Description
value Attach your data.
valueDivisor If specified, this divisor is applied to the value, valueMin and valueMax.
valueMax Set the maximum range for the scale. This value must be larger than valueMin.
valueMin Set the minimum range for the scale. This value must be smaller than valueMax.

Data Format Properties 
 
Property Name Description
valueFormat Select or enter the numeric format of value displayed in the value label. To enter a format, use syntax from the Java DecimalFormat class.
valueTextColor Select the  button and choose from the palette to set the color of the value label.
valueTextFont Select the font to use for the value label.
valueTextHeight Specify the height for the value label.
valueTextPosition Set the position of value label. Select from the following options:
  • Outside Max - Position outside the maximum value.
  • Inside Max - Position inside the maximum value.
  • Outside Current - Position outside the current value.
  • Inside Current - Position inside the current value.
  • Center - Position at the center of the scale.
  • Inside Min - Position inside the minimum value.
  • Outside Min - Position outside the minimum value.
valueVisFlag Control visibility of the value label.

Interaction Properties
 
Property Name Description
command Assign a command to your pie scale. See Building Displays>Define/Execute Command for information.
commandCloseWindowOnSuccess If selected, the window that initiates a system command will automatically close when the system command is executed successfully. This property only applies to system commands.

With data source commands, the window is closed whether or not the command is executed successfully.

For multiple commands, this property is applied to each command individually. Therefore if the first command in the multiple command sequence succeeds, the window will close before the rest of the commands are executed.

NOTE: The commandCloseWindowOnSuccess property is not supported in the Display Server.

commandConfirm If selected, the command confirmation dialog is enabled. Use the commandConfirmText property to write your own text for the confirmation dialog, otherwise text from the command property will be used.

For multiple commands, if you Confirm the execution then all individual commands will be executed in sequence with no further confirmation. If the you Cancel the execution, none of the commands in the sequence will executed.

commandConfirmText Enter command confirmation text directly in the Property Value field or select the  button to open the Edit commandConfirmText dialog. If commandConfirmText is not specified, then text from the command property will be used.
drillDownTarget Name of display (.rtv) file targeted as a drill down. See Building Displays>Drill Down Displays for information.

When you double-click on a trace in the scale, the following predefined substitutions will be set on the specified drillDownTarget:

  • $traceNumber - number of the trace (1 to 10) that contains the selected point
  • $traceLabel - label of selected trace
  • $pointValue - data value of point
  • $pointTimestamp - timestamp of point
  • $pointLabel - data label (if any) of point
  • $pointIndex - position of point in trace data (0 to maxPointsPerTrace)

NOTE: When drillDownSelectMode is set to Anywhere double-clicking anywhere on the scale will activate the specified drillDownTarget, however you must double-click on a trace in the scale to set the substitutions listed above.

mouseOverText Enter a tool tip for this scale. To display the tool tip, move your mouse over the object. To enter a multi-line tool tip, use \n to delimit the lines (e.g. my\nscale). NOTE: The object must be visible (i.e. visFlag property is selected), in order for the tool tip to be visible.

Label Properties
 
Property Name Description
label Edit label text directly in the Property Value field or select the  button to open the Edit Label dialog.
labelMinTabWidth Specify minimum width of the label tab. NOTE: This property is only applies if labelTextPosY is set to TabTop.
labelTextColor Select the  button and choose from the palette to set the color of the label text.
labelTextFont Select the font style of the label text from drop down menu.
labelTextHeight Set the height (in pixels) of the label text.
labelTextPosX Set x-axis position of label text. Select from the following options:
  • Left - Position outside the left side of the background rectangle.
  • Inside Left - Position inside the left side of the background rectangle.
  • Center - Position in the center of the background rectangle.
  • Inside Right - Position inside the right side of the background rectangle.
  • Right - Position outside the right side of the background rectangle.
labelTextPosY Set y-axis position of label text. Select from the following options:
  • Outside Top - Position well above the background rectangle.
  • Top - Position just above the background rectangle.
  • Title Top - Position along the top line of the background rectangle.
  • Tab Top - Position tab just above the background rectangle. NOTE: Height and width of the label tab is dependent on the height and width of the text. Use the labelMinTabWidth property to specify a minimum tab width.
  • Inside Top - Position inside the top of the background rectangle.
  • Center - Position in the center of the background rectangle.
  • Inside Bottom - Position inside the bottom of the background rectangle.
  • Bottom - Position just below the background rectangle.
  • Outside Bottom - Position well below the background rectangle.
labelVisFlag Control visibility of the label.

Object Properties
 
Property Name Description
anchor  Specify where to anchor an object in the display. NOTE: If an object has the dock property set, the anchor property will be ignored.

The anchor property is only applied when the dimensions of the display are modified, either by editing Background Properties or resizing the window in Layout mode

Select None, or one or more the following options:

None Object not anchored. This is the default.
Top Anchor top of object at top of display.
Left Anchor left side of object at left of display.
Bottom Anchor bottom of object at bottom of display.
Right Anchor right side of object at right of display.

When a display is resized, the number of pixels between an anchored object and the specified location remain constant. If an object is anchored on opposite sides (i.e. Top and Bottom or Left and Right), the object will be stretched to fill the available space.

dock Specify the docking location of an object in the display.

Select from the following options:

None Object is not docked. This is the default.
Top Dock object at top of display.
Left Dock object at left of display.
Bottom Dock object at bottom of display.
Right Dock object at right of display.
Fill Dock object in available space remaining in the display after all docked objects are positioned.

If the dimensions of the display are modified, either by editing Background Properties or resizing the window in Layout mode, the properties (objX, objY, objWidth and objHeight) of docked objects will automatically adapt to match the new size of the display.

When multiple objects are docked to the same side of the display, the first object is docked against the side of the display, the next object is docked against the edge of the first object, and so on.

When objects are docked to multiple sides of the display, the order in which objects were added to the display controls docking position. For example, let's say the first object added to the display is docked at the Top and the second object is docked at the Left. Consequently, the first object will fill the entire width of the display and the second object will fill the left side of the display from the bottom of the first object to the bottom of the display.

Objects in a display have the dock property set to Fill, are laid out across a grid in the available space remaining after all docked objects are positioned. By default, the grid has one row and as many columns as there are objects in the display. You can modify the grid in the Background Properties dialog.

Once an object is docked, there are some limitations on how that object can be modified.

  • Docked objects cannot be dragged or repositioned using objX and objY properties.
  • Docked objects cannot be resized using the objWidth or objHeight properties. To resize you must drag on the resize handle.
  • Docked objects can only be resized toward the center of the display (e.g. If an object is docked at the Top, only its height can be increased by dragging down toward the center of the display).
  • Docked objects set to Fill cannot be resized at all.
  • Docked objects cannot be moved using Align. Non-docked objects can be aligned against a docked object, but a docked object will not move to align against another object.
  • Docked objects are ignored by Distribute.
objHeight  Set height of the object in pixels.
objName Name given to facilitate object management via the Object List dialog. Select Tools>Object List.
objWidth Set width of the object in pixels.
objX Set the x position of the object.
objY Set the y position of the object.
transparencyPercent Set transparency of the object. Enter a value between 0 and 100. A value of 0, the default, sets the object to be completely opaque. A value of 100 will render the object completely transparent.
visFlag Control visibility of the object.

Pie Properties
 
Property Name Description
clockWiseFlag If selected, the pie is drawn from the start angle in a clockwise direction. Otherwise, it is drawn counter-clockwise.
pie3dThickness Specify the thickness of the 3D edge of the pie. If the value is 0, the pie will be drawn 2D.
pieBgColor Select the  button and choose from the palette to set the color of the background color of the pie. NOTE: This property only applies if pieBgOpaqueFlag is selected.
pieBgOpaqueFlag If selected, the pie background is filled in. Otherwise, it is transparent.
pieBorderColor Select the border color for the pie. NOTE: This property only applies if pieBorderFlag is selected.
pieBorderFlag If selected, a border is displayed around the edge of the pie.
pieColor Select the  button and choose from the palette to set the color of the pie.
pieGradientColor2 Select the  button and choose from the palette to set the second color in the gradient. The pieColor property sets the first color in the gradient. NOTE: This property will be ignored if pieGradientMode is set to None.
pieGradientMode Display a gradient in the pie. Select from the following options:
  • None - No gradient.
  • Diagonal Edge - Gradient is drawn at a 45 degree angle from the top left to the bottom right corner.
  • Diagonal Center - Gradient is drawn at a 45 degree angle from the center to the top left and the bottom right corners.
  • Horizontal Edge - Gradient is drawn horizontally from the top to the bottom.
  • Horizontal Center - Gradient is drawn horizontally from the center to the top and bottom.
  • Vertical Edge - Gradient is drawn vertically from the left to the right.
  • Vertical Center - Gradient is drawn vertically from the center to the left and right.
pieRaisedFlag Reverses the direction of the gradient.
startAngle Set the start angle of the pie. Start angles range from 0 to 360, with 0 pointing straight to the right and increasing clockwise around the circle. Default is 180 (pointing straight to the left).
 


 
Enterprise RTView contains components licensed under the Apache License Version 2.0.

 

Treemap Algorithms v1.0  is used without modifications and licensed by MPL Version 1.1. Copyright © 2001 University of Maryland, College Park, MD

 

Datejs is licensed under MIT. Copyright © Coolite Inc.

 

JCalendar 1.3.2 is licensed under LGPL. Copyright © Kai Toedter.

 

jQuery is licensed under MIT. Copyright © John Resig,

 
JMS, JMX and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. They are mentioned in this document for identification purposes only. 

 
SL, SL-GMS, GMS, Enterprise RTView, SL Corporation, and the SL logo are trademarks or registered trademarks of Sherrill-Lubinski Corporation in the United States and other countries. Copyright © 1998-2009 Sherrill-Lubinski Corporation. All Rights Reserved.