Enterprise RTView® 
User Guide


Legend
The legend (class name: obj_legend) is useful for displaying a legend that is too lengthy for the built-in legends of the graph objects. The legend is used in conjunction with a bar graph, pie graph, radar graph or xy graph. The legend only displays legend information from the graph object it is connected to. Connect the legend by entering the name of the graph object in the legend's graphName property. Setup all formatting for the legend data in the graph object it will reflect.
 

Data Properties
Attach your legend to the graph object by entering the value from objName field of the graph object in the legend's graphName property.

Background Properties
Specify how the background is displayed in your legend.
 
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 a color for the second color in the gradient. Default is white. NOTE: The bgColor property sets the first color in the gradient.
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 legend and the border.

Legend Properties
Specify the way the legend is displayed.
 
Property Name Description
legendBgColor Select the  button and choose a background color for the legend.
legendBgGradientColor2 Select the  button and choose a color for the second color in the gradient. Default is white. NOTE: The legendBgColor property sets the first color in the gradient.
legendBgGradientMode Display a gradient in the legend background. 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.
legendValueVisFlag Select to display the numerical values of your data in the legend. 
 


 
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.