Chart FX for Java 6.2

SoftwareFX.ChartFX
Class UserLegendBoxItem

java.lang.Object
  extended bySoftwareFX.ChartFX.UserLegendBoxItem

public final class UserLegendBoxItem
extends java.lang.Object

Provides access to the UserLegendBoxItem object.

This Base class is not intended to be used directly by the programmer, however, derived classes of the UserLegendBoxItem can be used for user legend box customization. For example, the UserLegendBox class is derived from the UserLegendBoxItem and its members accessible through the use of the UserLegendBox.getItem(int) property.

The UserLegendBoxItem class members allow you to create each key that will exist in a user legend box as well as assign attributes to each one.


Constructor Summary
UserLegendBoxItem()
           
 
Method Summary
 java.awt.Color getAlternateColor()
          Used to set the background color for a user legend marker when a pattern is configured.
 PointAttributes getAttributes()
          Gets or sets a PointAttributes object for the selected item.
 Line getBorder()
          Deprecated. You should use getAttributes instead.
 java.awt.Color getBorderColor()
          Gets or sets the border color for a UserLegendBoxItem.
 int getBorderEffect()
          Specifies the marker border effects for a selected user legend item.
 short getBorderWidth()
          Gets or sets the width for the UserLegendBoxItem border.
 java.awt.Color getColor()
          Sets a color for the selected user legend box marker.
 java.lang.String getKeyLabel()
          Allows you to set a short label to be used in the user legend box.
 java.lang.String getLabel()
          Allows you to set a text string for the selected user legend key.
 Link getLink()
          Gets the Link object for a selected UserLegendBoxItem.
 int getMarkerShape()
          Used to specify the point type used to paint markers for the user legend box items.
 int getPattern()
          Allows you to set a pattern for a selected marker in the user legend.
 java.awt.Image getPicture()
          Allows you to set an image as the key marker in the user legend.
 boolean isShowLine()
          Gets or sets a value used to indicate the line marker style for a user legend item.
 void setAlternateColor(java.awt.Color value)
          Used to set the background color for a user legend marker when a pattern is configured.
 void setAttributes(PointAttributes value)
          Gets or sets a PointAttributes object for the selected item.
 void setBorder(Line line)
          Deprecated. You should use getAttributes instead.
 void setBorderColor(java.awt.Color value)
          Gets or sets the border color for a UserLegendBoxItem.
 void setBorderEffect(int value)
          Specifies the marker border effects for a selected user legend item.
 void setBorderWidth(short value)
          Gets or sets the width for the UserLegendBoxItem border.
 void setColor(java.awt.Color value)
          Sets a color for the selected user legend box marker.
 void setKeyLabel(java.lang.String value)
          Allows you to set a short label to be used in the user legend box.
 void setLabel(java.lang.String value)
          Allows you to set a text string for the selected user legend key.
 void setMarkerShape(int value)
          Used to specify the point type used to paint markers for the user legend box items.
 void setPattern(int value)
          Allows you to set a pattern for a selected marker in the user legend.
 void setPicture(java.awt.Image value)
          Allows you to set an image as the key marker in the user legend.
 void setShowLine(boolean value)
          Gets or sets a value used to indicate the line marker style for a user legend item.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserLegendBoxItem

public UserLegendBoxItem()
Method Detail

getAlternateColor

public java.awt.Color getAlternateColor()

Used to set the background color for a user legend marker when a pattern is configured.

Remarks:
  • The forecolor of the pattern is configured using the setColor(java.awt.Color) property. The background color of the pattern is configured using the AlternateColor property.

  • The setPattern(int) property is used to configure the HatchStyle pattern for the marker.

  • For more information regarding the Color type, please refer to the Java API Documentation.

  • See Also:
    setColor(java.awt.Color), setPattern(int)

    getAttributes

    public PointAttributes getAttributes()

    Gets or sets a PointAttributes object for the selected item.

    Remarks:
  • This property may be used to get or set a PointAttributes object for a selected UserLegendBoxItem. For more information regarding the supported members, please see the PointAttributes for more information.

  • See Also:
    PointAttributes

    getBorder

    public Line getBorder()
    Deprecated. You should use getAttributes instead.

    See Also:
    PointAttributes

    getBorderColor

    public java.awt.Color getBorderColor()

    Gets or sets the border color for a UserLegendBoxItem.

    Remarks:
  • In order for this property to take effect, you must set the setBorderEffect(int) to BorderEffect.NONE.

  • To control the width of the border, please refer to the setBorderWidth(short) member.

  • For more information regarding the Color type, please refer to the Java API Documentation.

  • See Also:
    setBorderEffect(int), setBorderWidth(short)

    getBorderEffect

    public int getBorderEffect()

    Specifies the marker border effects for a selected user legend item.

    Values:
    BorderEffect : Specify different border effects that may be applied to a object.
    ValueDescription
    NONENo border effect is applied. The border effect must be None for the BorderColor property to take effect.
    RAISEDThe border has raised inner and outer edges.
    LIGHTApply light color to the border using the series/points color.
    DARKApply dark color to the border using the series/points color.
    OPPOSITEChooses between dark and light border depending on the object color. If the color is dark Chart FX will choose a light border color. If the color is light Chart FX will choose a dark border color.
    SHADOWThe border will have shadow.

    Remarks:
  • The BorderEffect property must be set to BorderEffect.NONE for the setColor(java.awt.Color) property to have any effect on the selected UserLegendBoxItem border

  • Use the setColor(java.awt.Color) property to define the marker color for the user legend box item selected.

  • The setMarkerShape(int) property allows you to select a marker shape for a selected user legend item.

  • See Also:
    setColor(java.awt.Color), setMarkerShape(int), Chart.setUserLegendBox(boolean), Chart.getUserLegendBoxObj(), Chart, LegendBox

    getBorderWidth

    public short getBorderWidth()

    Gets or sets the width for the UserLegendBoxItem border.

    Remarks:
  • To control the color of the border, please refer to the setBorderColor(java.awt.Color) member.

  • This setAttributes(SoftwareFX.ChartFX.PointAttributes) property may be used to get or set a PointAttributes object for a selected UserLegendBoxItem. For more information regarding the supported members, please see the PointAttributes for more information.

  • See Also:
    setAttributes(SoftwareFX.ChartFX.PointAttributes), setBorderColor(java.awt.Color)

    getColor

    public java.awt.Color getColor()

    Sets a color for the selected user legend box marker.

    Remarks:
  • If no color is specified for a user legend box, no default marker or color will be painted in the user legend box. If you select a color, a marker will be created (default shape: Rect)

  • You can specify the marker shape for user legend items using the setMarkerShape(int) property.Chart.setBackColor(java.awt.Color)Chart.setInsideColor(java.awt.Color)

  • A border color may be set using the setColor(java.awt.Color) property, however, the setBorderEffect(int) must be set to BorderEffect.NONE.

  • For more information regarding the Color type, please refer to the Java API Documentation.

  • See Also:
    setBorderEffect(int), setMarkerShape(int), Chart.getUserLegendBoxObj(), LegendBox, UserLegendBox

    getKeyLabel

    public java.lang.String getKeyLabel()

    Allows you to set a short label to be used in the user legend box.

    Remarks:
  • The KeyLabel property allows you to specify a small string that will be associated with a corresponding setLabel(java.lang.String). When the UserLegendBox.setShowMarkers(boolean) property is False, the configured key labels are used instead of the marker shapes. This is very useful when you wish to define an abbreviation used in a chart:

    SFX: SoftwareFX

  • Each user legend box item may have one KeyLabel configured.

  • The LegendBox.setTextColor(java.awt.Color) property of the UserLegendBox may be used to set the color of the labels configured.

  • See Also:
    setLabel(java.lang.String), UserLegendBox.setShowMarkers(boolean), LegendBox.setTextColor(java.awt.Color), LegendBox, UserLegendBox

    getLabel

    public java.lang.String getLabel()

    Allows you to set a text string for the selected user legend key.

    Remarks:
  • The LegendBox.setTextColor(java.awt.Color) property of the LegendBox class may be used to set the color of the labels configured.

  • The setKeyLabel(java.lang.String) property allows you to specify a small string that will be associated a Label. When the UserLegendBox.setShowMarkers(boolean) property is False, the configured key labels are used instead of the marker shapes. This is very useful when you wish to define an abbreviation used in a chart:

    SFX: SoftwareFX

  • Markers may be used with the labels in the user legend box. You can use the setMarkerShape(int) property to set a desired marker shape.Chart.setInsideColor(java.awt.Color)

  • The setColor(java.awt.Color) property may be used to apply color assignments to the user legend box markers.Chart.setPointLabelColor(java.awt.Color)

  • See Also:
    setColor(java.awt.Color), setKeyLabel(java.lang.String), setMarkerShape(int), UserLegendBox.setShowMarkers(boolean), LegendBox.setTextColor(java.awt.Color), Chart.setUserLegendBox(boolean), Chart.getUserLegendBoxObj(), LegendBox, Chart

    getLink

    public Link getLink()

    Gets the Link object for a selected UserLegendBoxItem.

    Remarks:
  • Developers may obtain the Link object for a UserLegendBoxItem using this property. Using the supported Link class members, developers may configure a Link.setUrl(java.lang.String) and Link.setTarget(java.lang.String) for the object.

  • See Also:
    Link.setUrl(java.lang.String), Link.setTarget(java.lang.String), Link

    getMarkerShape

    public int getMarkerShape()

    Used to specify the point type used to paint markers for the user legend box items.

    Values:
    MarkerShape : Defines different shapes used to paint point markers in the chart.
    ValueDescription
    NONEDo not display point markers.
    RECTDisplays a rectangle.
    CIRCLEDisplays a circle.
    TRIANGLEDisplays a triangle.
    DIAMONDDisplays a diamond.
    MARBLEDisplays a 3D marble.
    HORZ_LINEDisplays a horizontal line.
    VERT_LINEDisplays a vertical line.
    CROSSDisplays a cross.
    INVERTED_TRIANGLEDisplays a rotated triangle.
    XDisplays an X.
    MANYSelects a combination of the above.
    PICTUREDisplays a configured picture.

    Remarks:
  • Use the setColor(java.awt.Color) property to define the color for the selected key legend item marker.

  • The setLabel(java.lang.String) property allows you to set text to be associated with the item marker.Chart.setPointFont(java.awt.Font)

  • Borders may be applied to markers using the setColor(java.awt.Color) property. Be sure to set the setBorderEffect(int) to None
    when assigning a border color.

  • If you hide the markers using the UserLegendBox.setShowMarkers(boolean) property, labels will be numbered or using the configured setKeyLabel(java.lang.String).

  • See Also:
    setColor(java.awt.Color), setBorderEffect(int), setColor(java.awt.Color), setLabel(java.lang.String), Chart.setUserLegendBox(boolean), UserLegendBox.setShowMarkers(boolean), Chart.getUserLegendBoxObj(), LegendBox

    getPattern

    public int getPattern()

    Allows you to set a pattern for a selected marker in the user legend.

    Values:
    HatchStyle : Specifies the different hatch patterns available.
    ValueDescription
    BACKWARD_DIAGONALA pattern of lines on a diagonal from upper right to lower left.
    CROSSSpecifies horizontal and vertical lines that cross.
    DARK_DOWNWARD_DIAGONALSpecifies diagonal lines that slant to the right from top points to bottom points, are spaced 50 percent closer together than, and are twice the width of ForwardDiagonal. This hatch pattern is not antialiased.
    DARK_HORIZONTALSpecifies horizontal lines that are spaced 50 percent closer together than Horizontal and are twice the width of HatchStyleHorizontal.
    DARK_UPWARD_DIAGONALSpecifies diagonal lines that slant to the left from top points to bottom points, are spaced 50 percent closer together than BackwardDiagonal, and are twice its width, but the lines are not antialiased.
    DARK_VERTICALSpecifies vertical lines that are spaced 50 percent closer together than Vertical and are twice its width.
    DASHED_DOWNWARD_DIAGONALSpecifies dashed diagonal lines, that slant to the right from top points to bottom points.
    DASHED_HORIZONTALSpecifies dashed horizontal lines.
    DASHED_UPWARD_DIAGONALSpecifies dashed diagonal lines, that slant to the left from top points to bottom points.
    DASHED_VERTICALSpecifies dashed vertical lines.
    DIAGONAL_BRICKSpecifies a hatch that has the appearance of layered bricks that slant to the left from top points to bottom points.
    DIAGONAL_CROSSSpecifies forward diagonal and backward diagonal lines that cross. The lines are antialiased.
    DIVOTSpecifies a hatch that has the appearance of divots.
    DOTTED_DIAMONDSpecifies forward diagonal and backward diagonal lines, each of which is composed of dots, that cross.
    DOTTED_GRIDSpecifies horizontal and vertical lines, each of which is composed of dots, that cross.
    FORWARD_DIAGONALA pattern of lines on a diagonal from upper left to lower right.
    HORIZONTALA pattern of horizontal lines.
    HORIZONTAL_BRICKSpecifies a hatch that has the appearance of horizontally layered bricks.
    LARGE_CHECKER_BOARDSpecifies a hatch that has the appearance of a checkerboard with squares that are twice the size of SmallCheckerBoard.
    LARGE_CONFETTISpecifies a hatch that has the appearance of confetti, and is composed of larger pieces than SmallConfetti.
    LARGE_GRIDSpecifies the hatch style Cross.
    LIGHT_DOWNWARD_DIAGONALSpecifies diagonal lines that slant to the right from top points to bottom points and are spaced 50 percent closer together than DownwardDiagonal, but they are not antialiased.
    LIGHT_HORIZONTALSpecifies horizontal lines that are spaced 50 percent closer together than Horizontal.
    LIGHT_UPWARD_DIAGONALSpecifies diagonal lines that slant to the left from top points to bottom points and are spaced 50 percent closer together than BackwardDiagonal, but they are not antialiased.
    LIGHT_VERTICALSpecifies vertical lines that are spaced 50 percent closer together than Vertical.
    MAXSpecifies hatch style SolidDiamond.
    MINSpecifies hatch style Horizonal.
    NARROW_HORIZONTALSpecifies horizontal lines that are spaced 75 percent closer together than hatch style Horizontal (or 25 percent closer together than LightHorizontal).
    NARROW_VERTICALSpecifies vertical lines that are spaced 75 percent closer together than hatch style Vertical (or 25 percent closer together than LightVertical).
    OUTLINED_DIAMONDSpecifies forward diagonal and backward diagonal lines that cross but are not antialiased.
    PERCENT_05Specifies a 5-percent hatch. The ratio of foreground color to background color is 5:100.
    PERCENT_10Specifies a 10-percent hatch. The ratio of foreground color to background color is 10:100.
    PERCENT_20Specifies a 20-percent hatch. The ratio of foreground color to background color is 20:100.
    PERCENT_25Specifies a 25-percent hatch. The ratio of foreground color to background color is 25:100.
    PERCENT_30Specifies a 30-percent hatch. The ratio of foreground color to background color is 30:100.
    PERCENT_40Specifies a 40-percent hatch. The ratio of foreground color to background color is 40:100.
    PERCENT_50Specifies a 50-percent hatch. The ratio of foreground color to background color is 50:100.
    PERCENT_60Specifies a 60-percent hatch. The ratio of foreground color to background color is 60:100.
    PERCENT_70Specifies a 70-percent hatch. The ratio of foreground color to background color is 70:100.
    PERCENT_75Specifies a 75-percent hatch. The ratio of foreground color to background color is 75:100.
    PERCENT_80Specifies a 80-percent hatch. The ratio of foreground color to background color is 80:100.
    PERCENT_90Specifies a 90-percent hatch. The ratio of foreground color to background color is 90:100.
    PLAIDSpecifies a hatch that has the appearance of a plaid material.
    SHINGLESpecifies a hatch that has the appearance of diagonally-layered shingles that slant to the right from top points to bottom points.
    SMALL_CHECKER_BOARDSpecifies a hatch that has the appearance of a checkerboard.
    SMALL_CONFETTISpecifies a hatch that has the appearance of confetti.
    SMALL_GRIDSpecifies horizontal and vertical lines that cross and are spaced 50 percent closer together than hatch style Cross.
    SOLID_DIAMONDSpecifies a hatch that has the appearance of a checkerboard placed diagonally.
    SPHERESpecifies a hatch that has the appearance of spheres laid adjacent to one another.
    TRELLISSpecifies a hatch that has the appearance of a trellis.
    VERTICALA pattern of vertical lines.
    WAVESpecifies horizontal lines that are composed of tildes.
    WEAVESpecifies a hatch that has the appearance of a woven material.
    WIDE_DOWNWARD_DIAGONALSpecifies diagonal lines that slant to the right from top points to bottom points, have the same spacing as hatch style ForwardDiagonal, and are triple its width, but are not antialiased.
    WIDE_UPWARD_DIAGONALSpecifies diagonal lines that slant to the left from top points to bottom points, have the same spacing as hatch style BackwardDiagonal, and are triple its width, but are not antialiased.
    ZIG_ZAGSpecifies horizontal lines that are composed of zigzags.

    Remarks:
  • This property exposes the supported by the HatchStyle type.

  • The forecolor of the pattern is configured using the setColor(java.awt.Color) property. The background color of the pattern is configured using the setAlternateColor(java.awt.Color) property.

  • See Also:
    setColor(java.awt.Color), setAlternateColor(java.awt.Color)

    getPicture

    public java.awt.Image getPicture()

    Allows you to set an image as the key marker in the user legend.

    Remarks:
  • Setting this property will override any settings configured using the setMarkerShape(int) property.

  • You can use any supported image type which the Java API supports. For more information regarding the image formats, please refer to the Java API Documentation.

  • See Also:
    setColor(java.awt.Color), setBorderEffect(int), setColor(java.awt.Color), setKeyLabel(java.lang.String), setMarkerShape(int), UserLegendBox.getItem(int), PointAttributes.setPicture(java.awt.Image), PointAttributes

    isShowLine

    public boolean isShowLine()

    Gets or sets a value used to indicate the line marker style for a user legend item.

    Remarks:
  • When set to True, this property forces the marker of a user legend item to display as a line with the marker (like series legend in Line charts).

  • The setMarkerShape(int) property may be used in combination with this property to display a different markershape with the ShowLine attribute.

  • See Also:
    setMarkerShape(int)

    setAlternateColor

    public void setAlternateColor(java.awt.Color value)

    Used to set the background color for a user legend marker when a pattern is configured.

    Remarks:
  • The forecolor of the pattern is configured using the setColor(java.awt.Color) property. The background color of the pattern is configured using the AlternateColor property.

  • The setPattern(int) property is used to configure the HatchStyle pattern for the marker.

  • For more information regarding the Color type, please refer to the Java API Documentation.

  • See Also:
    setColor(java.awt.Color), setPattern(int)

    setAttributes

    public void setAttributes(PointAttributes value)

    Gets or sets a PointAttributes object for the selected item.

    Remarks:
  • This property may be used to get or set a PointAttributes object for a selected UserLegendBoxItem. For more information regarding the supported members, please see the PointAttributes for more information.

  • See Also:
    PointAttributes

    setBorder

    public void setBorder(Line line)
    Deprecated. You should use getAttributes instead.

    See Also:
    PointAttributes

    setBorderColor

    public void setBorderColor(java.awt.Color value)

    Gets or sets the border color for a UserLegendBoxItem.

    Remarks:
  • In order for this property to take effect, you must set the setBorderEffect(int) to BorderEffect.NONE.

  • To control the width of the border, please refer to the setBorderWidth(short) member.

  • For more information regarding the Color type, please refer to the Java API Documentation.

  • See Also:
    setBorderEffect(int), setBorderWidth(short)

    setBorderEffect

    public void setBorderEffect(int value)

    Specifies the marker border effects for a selected user legend item.

    Values:
    BorderEffect : Specify different border effects that may be applied to a object.
    ValueDescription
    NONENo border effect is applied. The border effect must be None for the BorderColor property to take effect.
    RAISEDThe border has raised inner and outer edges.
    LIGHTApply light color to the border using the series/points color.
    DARKApply dark color to the border using the series/points color.
    OPPOSITEChooses between dark and light border depending on the object color. If the color is dark Chart FX will choose a light border color. If the color is light Chart FX will choose a dark border color.
    SHADOWThe border will have shadow.

    Remarks:
  • The BorderEffect property must be set to BorderEffect.NONE for the setColor(java.awt.Color) property to have any effect on the selected UserLegendBoxItem border

  • Use the setColor(java.awt.Color) property to define the marker color for the user legend box item selected.

  • The setMarkerShape(int) property allows you to select a marker shape for a selected user legend item.

  • See Also:
    setColor(java.awt.Color), setMarkerShape(int), Chart.setUserLegendBox(boolean), Chart.getUserLegendBoxObj(), Chart, LegendBox

    setBorderWidth

    public void setBorderWidth(short value)

    Gets or sets the width for the UserLegendBoxItem border.

    Remarks:
  • To control the color of the border, please refer to the setBorderColor(java.awt.Color) member.

  • This setAttributes(SoftwareFX.ChartFX.PointAttributes) property may be used to get or set a PointAttributes object for a selected UserLegendBoxItem. For more information regarding the supported members, please see the PointAttributes for more information.

  • See Also:
    setAttributes(SoftwareFX.ChartFX.PointAttributes), setBorderColor(java.awt.Color)

    setColor

    public void setColor(java.awt.Color value)

    Sets a color for the selected user legend box marker.

    Remarks:
  • If no color is specified for a user legend box, no default marker or color will be painted in the user legend box. If you select a color, a marker will be created (default shape: Rect)

  • You can specify the marker shape for user legend items using the setMarkerShape(int) property.Chart.setBackColor(java.awt.Color)Chart.setInsideColor(java.awt.Color)

  • A border color may be set using the setColor(java.awt.Color) property, however, the setBorderEffect(int) must be set to BorderEffect.NONE.

  • For more information regarding the Color type, please refer to the Java API Documentation.

  • See Also:
    setBorderEffect(int), setMarkerShape(int), Chart.getUserLegendBoxObj(), LegendBox, UserLegendBox

    setKeyLabel

    public void setKeyLabel(java.lang.String value)

    Allows you to set a short label to be used in the user legend box.

    Remarks:
  • The KeyLabel property allows you to specify a small string that will be associated with a corresponding setLabel(java.lang.String). When the UserLegendBox.setShowMarkers(boolean) property is False, the configured key labels are used instead of the marker shapes. This is very useful when you wish to define an abbreviation used in a chart:

    SFX: SoftwareFX

  • Each user legend box item may have one KeyLabel configured.

  • The LegendBox.setTextColor(java.awt.Color) property of the UserLegendBox may be used to set the color of the labels configured.

  • See Also:
    setLabel(java.lang.String), UserLegendBox.setShowMarkers(boolean), LegendBox.setTextColor(java.awt.Color), LegendBox, UserLegendBox

    setLabel

    public void setLabel(java.lang.String value)

    Allows you to set a text string for the selected user legend key.

    Remarks:
  • The LegendBox.setTextColor(java.awt.Color) property of the LegendBox class may be used to set the color of the labels configured.

  • The setKeyLabel(java.lang.String) property allows you to specify a small string that will be associated a Label. When the UserLegendBox.setShowMarkers(boolean) property is False, the configured key labels are used instead of the marker shapes. This is very useful when you wish to define an abbreviation used in a chart:

    SFX: SoftwareFX

  • Markers may be used with the labels in the user legend box. You can use the setMarkerShape(int) property to set a desired marker shape.Chart.setInsideColor(java.awt.Color)

  • The setColor(java.awt.Color) property may be used to apply color assignments to the user legend box markers.Chart.setPointLabelColor(java.awt.Color)

  • See Also:
    setColor(java.awt.Color), setKeyLabel(java.lang.String), setMarkerShape(int), UserLegendBox.setShowMarkers(boolean), LegendBox.setTextColor(java.awt.Color), Chart.setUserLegendBox(boolean), Chart.getUserLegendBoxObj(), LegendBox, Chart

    setMarkerShape

    public void setMarkerShape(int value)

    Used to specify the point type used to paint markers for the user legend box items.

    Values:
    MarkerShape : Defines different shapes used to paint point markers in the chart.
    ValueDescription
    NONEDo not display point markers.
    RECTDisplays a rectangle.
    CIRCLEDisplays a circle.
    TRIANGLEDisplays a triangle.
    DIAMONDDisplays a diamond.
    MARBLEDisplays a 3D marble.
    HORZ_LINEDisplays a horizontal line.
    VERT_LINEDisplays a vertical line.
    CROSSDisplays a cross.
    INVERTED_TRIANGLEDisplays a rotated triangle.
    XDisplays an X.
    MANYSelects a combination of the above.
    PICTUREDisplays a configured picture.

    Remarks:
  • Use the setColor(java.awt.Color) property to define the color for the selected key legend item marker.

  • The setLabel(java.lang.String) property allows you to set text to be associated with the item marker.Chart.setPointFont(java.awt.Font)

  • Borders may be applied to markers using the setColor(java.awt.Color) property. Be sure to set the setBorderEffect(int) to None
    when assigning a border color.

  • If you hide the markers using the UserLegendBox.setShowMarkers(boolean) property, labels will be numbered or using the configured setKeyLabel(java.lang.String).

  • See Also:
    setColor(java.awt.Color), setBorderEffect(int), setColor(java.awt.Color), setLabel(java.lang.String), Chart.setUserLegendBox(boolean), UserLegendBox.setShowMarkers(boolean), Chart.getUserLegendBoxObj(), LegendBox

    setPattern

    public void setPattern(int value)

    Allows you to set a pattern for a selected marker in the user legend.

    Values:
    HatchStyle : Specifies the different hatch patterns available.
    ValueDescription
    BACKWARD_DIAGONALA pattern of lines on a diagonal from upper right to lower left.
    CROSSSpecifies horizontal and vertical lines that cross.
    DARK_DOWNWARD_DIAGONALSpecifies diagonal lines that slant to the right from top points to bottom points, are spaced 50 percent closer together than, and are twice the width of ForwardDiagonal. This hatch pattern is not antialiased.
    DARK_HORIZONTALSpecifies horizontal lines that are spaced 50 percent closer together than Horizontal and are twice the width of HatchStyleHorizontal.
    DARK_UPWARD_DIAGONALSpecifies diagonal lines that slant to the left from top points to bottom points, are spaced 50 percent closer together than BackwardDiagonal, and are twice its width, but the lines are not antialiased.
    DARK_VERTICALSpecifies vertical lines that are spaced 50 percent closer together than Vertical and are twice its width.
    DASHED_DOWNWARD_DIAGONALSpecifies dashed diagonal lines, that slant to the right from top points to bottom points.
    DASHED_HORIZONTALSpecifies dashed horizontal lines.
    DASHED_UPWARD_DIAGONALSpecifies dashed diagonal lines, that slant to the left from top points to bottom points.
    DASHED_VERTICALSpecifies dashed vertical lines.
    DIAGONAL_BRICKSpecifies a hatch that has the appearance of layered bricks that slant to the left from top points to bottom points.
    DIAGONAL_CROSSSpecifies forward diagonal and backward diagonal lines that cross. The lines are antialiased.
    DIVOTSpecifies a hatch that has the appearance of divots.
    DOTTED_DIAMONDSpecifies forward diagonal and backward diagonal lines, each of which is composed of dots, that cross.
    DOTTED_GRIDSpecifies horizontal and vertical lines, each of which is composed of dots, that cross.
    FORWARD_DIAGONALA pattern of lines on a diagonal from upper left to lower right.
    HORIZONTALA pattern of horizontal lines.
    HORIZONTAL_BRICKSpecifies a hatch that has the appearance of horizontally layered bricks.
    LARGE_CHECKER_BOARDSpecifies a hatch that has the appearance of a checkerboard with squares that are twice the size of SmallCheckerBoard.
    LARGE_CONFETTISpecifies a hatch that has the appearance of confetti, and is composed of larger pieces than SmallConfetti.
    LARGE_GRIDSpecifies the hatch style Cross.
    LIGHT_DOWNWARD_DIAGONALSpecifies diagonal lines that slant to the right from top points to bottom points and are spaced 50 percent closer together than DownwardDiagonal, but they are not antialiased.
    LIGHT_HORIZONTALSpecifies horizontal lines that are spaced 50 percent closer together than Horizontal.
    LIGHT_UPWARD_DIAGONALSpecifies diagonal lines that slant to the left from top points to bottom points and are spaced 50 percent closer together than BackwardDiagonal, but they are not antialiased.
    LIGHT_VERTICALSpecifies vertical lines that are spaced 50 percent closer together than Vertical.
    MAXSpecifies hatch style SolidDiamond.
    MINSpecifies hatch style Horizonal.
    NARROW_HORIZONTALSpecifies horizontal lines that are spaced 75 percent closer together than hatch style Horizontal (or 25 percent closer together than LightHorizontal).
    NARROW_VERTICALSpecifies vertical lines that are spaced 75 percent closer together than hatch style Vertical (or 25 percent closer together than LightVertical).
    OUTLINED_DIAMONDSpecifies forward diagonal and backward diagonal lines that cross but are not antialiased.
    PERCENT_05Specifies a 5-percent hatch. The ratio of foreground color to background color is 5:100.
    PERCENT_10Specifies a 10-percent hatch. The ratio of foreground color to background color is 10:100.
    PERCENT_20Specifies a 20-percent hatch. The ratio of foreground color to background color is 20:100.
    PERCENT_25Specifies a 25-percent hatch. The ratio of foreground color to background color is 25:100.
    PERCENT_30Specifies a 30-percent hatch. The ratio of foreground color to background color is 30:100.
    PERCENT_40Specifies a 40-percent hatch. The ratio of foreground color to background color is 40:100.
    PERCENT_50Specifies a 50-percent hatch. The ratio of foreground color to background color is 50:100.
    PERCENT_60Specifies a 60-percent hatch. The ratio of foreground color to background color is 60:100.
    PERCENT_70Specifies a 70-percent hatch. The ratio of foreground color to background color is 70:100.
    PERCENT_75Specifies a 75-percent hatch. The ratio of foreground color to background color is 75:100.
    PERCENT_80Specifies a 80-percent hatch. The ratio of foreground color to background color is 80:100.
    PERCENT_90Specifies a 90-percent hatch. The ratio of foreground color to background color is 90:100.
    PLAIDSpecifies a hatch that has the appearance of a plaid material.
    SHINGLESpecifies a hatch that has the appearance of diagonally-layered shingles that slant to the right from top points to bottom points.
    SMALL_CHECKER_BOARDSpecifies a hatch that has the appearance of a checkerboard.
    SMALL_CONFETTISpecifies a hatch that has the appearance of confetti.
    SMALL_GRIDSpecifies horizontal and vertical lines that cross and are spaced 50 percent closer together than hatch style Cross.
    SOLID_DIAMONDSpecifies a hatch that has the appearance of a checkerboard placed diagonally.
    SPHERESpecifies a hatch that has the appearance of spheres laid adjacent to one another.
    TRELLISSpecifies a hatch that has the appearance of a trellis.
    VERTICALA pattern of vertical lines.
    WAVESpecifies horizontal lines that are composed of tildes.
    WEAVESpecifies a hatch that has the appearance of a woven material.
    WIDE_DOWNWARD_DIAGONALSpecifies diagonal lines that slant to the right from top points to bottom points, have the same spacing as hatch style ForwardDiagonal, and are triple its width, but are not antialiased.
    WIDE_UPWARD_DIAGONALSpecifies diagonal lines that slant to the left from top points to bottom points, have the same spacing as hatch style BackwardDiagonal, and are triple its width, but are not antialiased.
    ZIG_ZAGSpecifies horizontal lines that are composed of zigzags.

    Remarks:
  • This property exposes the supported by the HatchStyle type.

  • The forecolor of the pattern is configured using the setColor(java.awt.Color) property. The background color of the pattern is configured using the setAlternateColor(java.awt.Color) property.

  • See Also:
    setColor(java.awt.Color), setAlternateColor(java.awt.Color)

    setPicture

    public void setPicture(java.awt.Image value)

    Allows you to set an image as the key marker in the user legend.

    Remarks:
  • Setting this property will override any settings configured using the setMarkerShape(int) property.

  • You can use any supported image type which the Java API supports. For more information regarding the image formats, please refer to the Java API Documentation.

  • See Also:
    setColor(java.awt.Color), setBorderEffect(int), setColor(java.awt.Color), setKeyLabel(java.lang.String), setMarkerShape(int), UserLegendBox.getItem(int), PointAttributes.setPicture(java.awt.Image), PointAttributes

    setShowLine

    public void setShowLine(boolean value)

    Gets or sets a value used to indicate the line marker style for a user legend item.

    Remarks:
  • When set to True, this property forces the marker of a user legend item to display as a line with the marker (like series legend in Line charts).

  • The setMarkerShape(int) property may be used in combination with this property to display a different markershape with the ShowLine attribute.

  • See Also:
    setMarkerShape(int)

    http://www.softwarefx.com

    2005 Software FX, Inc. All Rights Reserved. Chart FX is a registered trademark of Software FX, Inc
    All other names are trademarks or registered trademarks of their respective owners.