<dvt:legendArea>

legendArea legend area


Use the legendArea tag to determine the characteristics and display properties of the legend area of a graph. The legend area identifies the series and reference lines in a graph.

Relationship with other tags

This component must be a child of one of the following components:

The legendArea tag can have the following child tag: specialEffects.

Example

The following example shows the XML for a legendArea tag.

        <dvt:graph>
            <dvt:legendArea visible="true" alongGraphEdge="false"
                automaticPlacement="AP_ALWAYS"
                position="LAP_RIGHT" borderColor="#cccccc" fillColor="#ffffff" 
                borderTransparent="false"
                fillTransparent="true">
            </dvt:legendArea>
        </dvt:graph>

Attributes

Name Type Supports EL? Description
id java.lang.String no Specifies the identifier for the component
automaticPlacement java.lang.String no Specifies whether the graph should automatically position the legend area on the graph. Valid values are:
  • AP_ALWAYS - (Default) Automatic graph layout determines whether to position the legend on the right or the bottom.
  • AP_NEVER - Automatic graph layout respects the setting of the position attribute of the legend area.
borderColor java.lang.String no Specifies the color of the border for the legend area. Enter values in RGB hexadecimal. The example borderColor="#000000" specifies black.
borderTransparent boolean no Indicates whether the border of the legend area is transparent. To make the legend area transparent, set both the borderTransparent and fillTransparent attributes to "true". Valid values are:
  • true - (Default) If the legend border is transparent.
  • false - If the legend border is visible.
Note: When an attribute or an object is transparent, it is not visible, but you can select it.
fillTransparent boolean no Indicates whether the fill of the legend area is transparent. To make the legend area transparent, set both the borderTransparent and fillTransparent attributes to "true". Valid values are:
  • true - (Default) If the fill color of the legend area is transparent.
  • false - If the fill color of the legend area is visible.
Note: When an attribute or an object is transparent, it is not visible, but you can select it.
fillColor java.lang.String no Specifies the color of the fill for the legend area. Enter values in RGB hexadecimal. The example color="#000000" specifies black color. This color property takes 6 or 8 digit hex as input. When 8 digit hex is used, the first 2 digits represent transparency, otherwise the color is opaque.
position java.lang.String no Specifies a constant that indicates the position of this legend area on the graph. Valid values are:
  • LAP_BOTTOM - Positions the legend area at the bottom of the graph.
  • LAP_LEFT - Positions the legend area on the left of the graph.
  • LAP_RIGHT - (Default) Positions the legend area on the right of the graph.
  • LAP_TOP - Positions the legend area at the top of the graph.
alongGraphEdge boolean no Indicates whether the legend items are separate from each other, and they are along the entire edge of the graph, or whether the legend items are grouped together with little space between individual legend items. Valid values are:
  • true - Indicates the legend items are separate from each other, and they are along the entire edge of the graph.
  • false - (Default) Indicates the legend items are grouped together with little space between individual legend items.
rendered boolean no Indicates whether the legend area of the graph is to be rendered. Valid values are "true" (Default) and "false".