CustomLegendItem (Chart FX for Java 8.0 API Specification)

java.lang.Object
- com.softwarefx.chartfx.server.CustomLegendItem

public final class CustomLegendItem
extends java.lang.Object

Provides access to the customization of a specific custom item in the LegendBox.

A CustomLegendItem is an additional item added to the legend of a chart that contains relevant information to explain what is being depicted in a chart.

The CustomLegendItem fills the void when the series legend and values cannot convey the desired information. The supported members of the CustomLegendItem allow you to configure and add extra legend items to the standard legend box.

Java

PopulateCarProduction(chart1);
chart1.getTitles().add(new TitleDockable("Vehicles Production by Type"));
chart1.setGallery(Gallery.LINES);
Annotations annots;
annots = new Annotations();
chart1.getExtensions().add(((IExtension)annots));
int w;
w = 14;
int h;
h = 14;
AnnotationPolygon polygon;
polygon = new AnnotationPolygon();
SfxNET.System.Drawing.Point[] p;
p = new SfxNET.System.Drawing.Point[] {new SfxNET.System.Drawing.Point(0, (h / 2)), new SfxNET.System.Drawing.Point((w / 2), h), new SfxNET.System.Drawing.Point(w, (h / 2)), new SfxNET.System.Drawing.Point((w / 2), 0)};
polygon.setVertices(p);
polygon.getChartBorder().setColor(new java.awt.Color(255,0,0,255));
polygon.getChartBorder().setWidth((short)2);
polygon.Attach(((DataUnit)6.0), ((DataUnit)10.0));
annots.getList().add(((AnnotationObject)polygon));
CustomLegendItem legendItem;
legendItem = new CustomLegendItem();
legendItem.setText("New Fiscal Year");
legendItem.setColor(new java.awt.Color(255,0,0,255));
legendItem.setMarkerShape(MarkerShape.DIAMOND);
chart1.getLegendBox().getCustomItems().add(legendItem);

public static void PopulateCarProduction(Chart chart1) {
    CarProduction[] production = new CarProduction[] {
        new CarProduction("Jan", 1760, 535, 695 ) ,
        new CarProduction("Feb", 1849, 395, 688 ) ,
        new CarProduction("Mar", 2831, 685, 1047 ) ,
        new CarProduction("Apr", 2851, 984, 1652 ) ,
        new CarProduction("May", 2961, 1579, 1889 ) ,
        new CarProduction("Jun", 1519, 1539, 1766 ) ,
        new CarProduction("Jul", 2633, 1489, 1361 ) ,
        new CarProduction("Aug", 1140, 650, 874 ) ,
        new CarProduction("Sep", 1626, 653, 693 ) ,
        new CarProduction("Oct", 1478, 2236, 786 ) ,
        new CarProduction("Nov", 1306, 1937, 599 ) ,
        new CarProduction("Dec", 1607, 2138, 678 )
    };

    ObjectProvider objProvider = new ObjectProvider(production);
    chart1.getDataSourceSettings().setDataSource(objProvider);

}

public static class CarProduction {

    private CarProduction(String month, int sedan, int coupe, int SUV) {
        this.setMonth(month);
        this.setSedan(sedan);
        this.setCoupe(coupe);
        this.setSUV(SUV);
    }

    private String privateMonth;

    public final String getMonth() {
        return privateMonth;
    }

    public final void setMonth(String value) {
        privateMonth = value;
    }
    private int privateSedan;

    public final int getSedan() {
        return privateSedan;
    }

    public final void setSedan(int value) {
        privateSedan = value;
    }
    private int privateCoupe;

    public final int getCoupe() {
        return privateCoupe;
    }

    public final void setCoupe(int value) {
        privateCoupe = value;
    }
    private int privateSUV;

    public final int getSUV() {
        return privateSUV;
    }

    public final void setSUV(int value) {
        privateSUV = value;
    }
}

Constructor Summary

Constructors
Constructor and Description

CustomLegendItem()
Constructs a newly allocated CustomLegendItem object

Constructors
Constructor and Description
`CustomLegendItem()` Constructs a newly allocated CustomLegendItem object

Method Summary

Methods
Modifier and Type	Method and Description
`java.awt.Color`	`getAlternateColor()` Gets or sets the background color of a custom legend item marker when a pattern is configured using the Pattern property.
`PointAttributes`	`getAttributes()` Gets or sets the PointAttributes object for the custom legend item.
`BorderAttributes`	`getBorder()` Gets a BorderAttributes object allowing you to modify the border properties for this CustomLegendItem.
`java.awt.Color`	`getColor()` Gets or sets the Color for the marker of the Custom Legend Item.
`com.softwarefx.server.Link`	`getLink()` Gets the Link object allowing you to associate a url to a CustomLegendItem.
`MarkerShape`	`getMarkerShape()` Represents the shape of the marker.
`CustomLegendItem`	`getParent()` Gets or sets a parent CustomLegendItem object Java CustomLegendItem ParentCustomLegendItem; ParentCustomLegendItem = new CustomLegendItem(); CustomLegendItem ChildCustomLegendItem; ChildCustomLegendItem = new CustomLegendItem(); ChildCustomLegendItem.setParent(ParentCustomLegendItem);
`HatchStyle`	`getPattern()` Gets or sets a HatchStyle pattern for the marker of a CustomLegendItem.
`java.awt.Image`	`getPicture()` Gets or sets an image to be used as a marker for a CustomLegendItem.
`java.lang.String`	`getText()` Gets or sets the text string of the custom legend item.
`boolean`	`isShowLine()` Gets or sets a value used to display a line marker for a CustomLegendItem.
`void`	`resetShowLine()` Set the property ShowLine to its default value.
`void`	`setAlternateColor(java.awt.Color value)` Gets or sets the background color of a custom legend item marker when a pattern is configured using the Pattern property.
`void`	`setAttributes(PointAttributes value)` Gets or sets the PointAttributes object for the custom legend item.
`void`	`setColor(java.awt.Color value)` Gets or sets the Color for the marker of the Custom Legend Item.
`void`	`setMarkerShape(MarkerShape value)` Represents the shape of the marker.
`void`	`setParent(CustomLegendItem value)` Gets or sets a parent CustomLegendItem object Java CustomLegendItem ParentCustomLegendItem; ParentCustomLegendItem = new CustomLegendItem(); CustomLegendItem ChildCustomLegendItem; ChildCustomLegendItem = new CustomLegendItem(); ChildCustomLegendItem.setParent(ParentCustomLegendItem);
`void`	`setPattern(HatchStyle value)` Gets or sets a HatchStyle pattern for the marker of a CustomLegendItem.
`void`	`setPicture(java.awt.Image value)` Gets or sets an image to be used as a marker for a CustomLegendItem.
`void`	`setShowLine(boolean value)` Gets or sets a value used to display a line marker for a CustomLegendItem.
`void`	`setText(java.lang.String value)` Gets or sets the text string of the custom legend item.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- CustomLegendItem
```
public CustomLegendItem()
```
  Constructs a newly allocated CustomLegendItem object

Method Detail

getAlternateColor

public java.awt.Color getAlternateColor()

Gets or sets the background color of a custom legend item marker when a pattern is configured using the Pattern property.

Java

CustomLegendItem item;
item = new CustomLegendItem();
item.setColor(new java.awt.Color(255,0,0,255));
item.setAlternateColor(new java.awt.Color(0,0,255,255));
item.setPattern(HatchStyle.BACKWARD_DIAGONAL);
chart1.getLegendBox().getCustomItems().add(item);

setAlternateColor

public void setAlternateColor(java.awt.Color value)

Gets or sets the background color of a custom legend item marker when a pattern is configured using the Pattern property.

Java

CustomLegendItem item;
item = new CustomLegendItem();
item.setColor(new java.awt.Color(255,0,0,255));
item.setAlternateColor(new java.awt.Color(0,0,255,255));
item.setPattern(HatchStyle.BACKWARD_DIAGONAL);
chart1.getLegendBox().getCustomItems().add(item);

Parameters:: value -

getAttributes

public PointAttributes getAttributes()

Gets or sets the PointAttributes object for the custom legend item.

Java

CustomLegendItem item;
item = new CustomLegendItem();
item.setColor(new java.awt.Color(255,0,0,255));
item.setText("Custom Item 1");
item.getAttributes().setMarkerSize((short)3);
chart1.getLegendBox().getCustomItems().add(item);

setAttributes

public void setAttributes(PointAttributes value)

Gets or sets the PointAttributes object for the custom legend item.

Java

CustomLegendItem item;
item = new CustomLegendItem();
item.setColor(new java.awt.Color(255,0,0,255));
item.setText("Custom Item 1");
item.getAttributes().setMarkerSize((short)3);
chart1.getLegendBox().getCustomItems().add(item);

Parameters:: value -

getBorder

public BorderAttributes getBorder()

Gets a BorderAttributes object allowing you to modify the border properties for this CustomLegendItem.

Java

CustomLegendItem c;
c = new CustomLegendItem();
c.setText("Custom Item");
c.getChartBorder().setColor(new java.awt.Color(0,0,0,255));
chart1.getLegendBox().getCustomItems().add(c);
chart1.setGallery(Gallery.BAR);
PopulateBirthVariation(chart1);
chart1.getTitles().add(new TitleDockable("Data Birth Variation"));

public static void PopulateBirthVariation(Chart chart1) {
    BirthVariation[] variations = new BirthVariation[] {
        new BirthVariation("2007", 4.5, 4.9 ),
        new BirthVariation("2008", -1.8, 1.2 ),
        new BirthVariation("2009", 2.3, -2.6 ),
        new BirthVariation("2010", 2.0, 3.0),
        new BirthVariation("2011", -0.5, -1.7 ),
        new BirthVariation("2012", 3.1, -0.9 )
    };

    ObjectProvider objProvider = new ObjectProvider(variations);
    chart1.getDataSourceSettings().setDataSource(objProvider);


}

public static class BirthVariation {

    public BirthVariation(String year, double male, double female) {
        this.setYear(year);
        this.setMale(male);
        this.setFemale(female);
    }
    private String privateYear;

    public final String getYear() {
        return privateYear;
    }

    public final void setYear(String value) {
        privateYear = value;
    }
    private double privateMale;

    public final double getMale() {
        return privateMale;
    }

    public final void setMale(double value) {
        privateMale = value;
    }
    private double privateFemale;

    public final double getFemale() {
        return privateFemale;
    }

    public final void setFemale(double value) {
        privateFemale = value;
    }
}

getColor
```
public java.awt.Color getColor()
```
Gets or sets the Color for the marker of the Custom Legend Item.

Named colors are supported (e.g. Red), to use Hex notation you have to use quotes (e.g. "#FF00FF").
For more information regarding the Color type, please refer to the Documentation.
To set the color of the Custom Legend Item:
Java
chart1.getLegendBox().getCustomItems().get(0).setColor(new java.awt.Color(165,42,42,255));

setColor
```
public void setColor(java.awt.Color value)
```
Gets or sets the Color for the marker of the Custom Legend Item.

Named colors are supported (e.g. Red), to use Hex notation you have to use quotes (e.g. "#FF00FF").
For more information regarding the Color type, please refer to the Documentation.
To set the color of the Custom Legend Item:
Java
chart1.getLegendBox().getCustomItems().get(0).setColor(new java.awt.Color(165,42,42,255));
Parameters:
value -

getLink

public com.softwarefx.server.Link getLink()

Gets the Link object allowing you to associate a url to a CustomLegendItem.

Java

chart1.getLegendBox().getCustomItems().get(0).getLink().setUrl("http://www.softwarefx.com");

getMarkerShape
```
public MarkerShape getMarkerShape()
```
Represents the shape of the marker.

If you hide the markers using the MarkerShape.None method, labels will be numbered.
The MarkerShape BorderAttributes may be configured by accessing the setBorder method.
Selects an inverted triangles as the marker shape for the first custom legend item:
Java
chart1.getLegendBox().getCustomItems().get(0).setMarkerShape(MarkerShape.INVERTED_TRIANGLE);

setMarkerShape
```
public void setMarkerShape(MarkerShape value)
```
Represents the shape of the marker.

If you hide the markers using the MarkerShape.None method, labels will be numbered.
The MarkerShape BorderAttributes may be configured by accessing the setBorder method.
Selects an inverted triangles as the marker shape for the first custom legend item:
Java
chart1.getLegendBox().getCustomItems().get(0).setMarkerShape(MarkerShape.INVERTED_TRIANGLE);
Parameters:
value -

getParent

public CustomLegendItem getParent()

Gets or sets a parent CustomLegendItem object

Java

CustomLegendItem ParentCustomLegendItem;
ParentCustomLegendItem = new CustomLegendItem();
CustomLegendItem ChildCustomLegendItem;
ChildCustomLegendItem = new CustomLegendItem();
ChildCustomLegendItem.setParent(ParentCustomLegendItem);

setParent

public void setParent(CustomLegendItem value)

Gets or sets a parent CustomLegendItem object

Java

CustomLegendItem ParentCustomLegendItem;
ParentCustomLegendItem = new CustomLegendItem();
CustomLegendItem ChildCustomLegendItem;
ChildCustomLegendItem = new CustomLegendItem();
ChildCustomLegendItem.setParent(ParentCustomLegendItem);

Parameters:: value -

getPattern

public HatchStyle getPattern()

Gets or sets a HatchStyle pattern for the marker of a CustomLegendItem.

Java

CustomLegendItem item;
item = new CustomLegendItem();
chart1.getLegendBox().getCustomItems().add(item);
item.setText("Warning");
item.setMarkerShape(MarkerShape.RECT);
item.setColor(new java.awt.Color(255,0,0,255));
item.setAlternateColor(new java.awt.Color(0,0,255,255));
item.setPattern(HatchStyle.BACKWARD_DIAGONAL);

setPattern

public void setPattern(HatchStyle value)

Gets or sets a HatchStyle pattern for the marker of a CustomLegendItem.

Java

CustomLegendItem item;
item = new CustomLegendItem();
chart1.getLegendBox().getCustomItems().add(item);
item.setText("Warning");
item.setMarkerShape(MarkerShape.RECT);
item.setColor(new java.awt.Color(255,0,0,255));
item.setAlternateColor(new java.awt.Color(0,0,255,255));
item.setPattern(HatchStyle.BACKWARD_DIAGONAL);

Parameters:: value -

getPicture
```
public java.awt.Image getPicture()
```
Gets or sets an image to be used as a marker for a CustomLegendItem.

Setting this method will override any settings configured using the setMarkerShape method.

Sets the first custom item marker to an image:
Java
File imageFile = new File("image.png"); BufferedImage image = ImageIO.read(imageFile); chart1.getLegendBox().getCustomItems().get(0).setPicture(image);

setPicture
```
public void setPicture(java.awt.Image value)
```
Gets or sets an image to be used as a marker for a CustomLegendItem.

Setting this method will override any settings configured using the setMarkerShape method.

Sets the first custom item marker to an image:
Java
File imageFile = new File("image.png"); BufferedImage image = ImageIO.read(imageFile); chart1.getLegendBox().getCustomItems().get(0).setPicture(image);
Parameters:
value -

isShowLine

public boolean isShowLine()

Gets or sets a value used to display a line marker for a CustomLegendItem.

Java

CustomLegendItem item;
item = new CustomLegendItem();
item.setColor(new java.awt.Color(255,0,0,255));
item.setText("Custom Item 1");
item.setMarkerShape(MarkerShape.CIRCLE);
item.setShowLine(true);
chart1.getLegendBox().getCustomItems().add(item);

See Also:: resetShowLine

setShowLine

public void setShowLine(boolean value)

Gets or sets a value used to display a line marker for a CustomLegendItem.

Java

CustomLegendItem item;
item = new CustomLegendItem();
item.setColor(new java.awt.Color(255,0,0,255));
item.setText("Custom Item 1");
item.setMarkerShape(MarkerShape.CIRCLE);
item.setShowLine(true);
chart1.getLegendBox().getCustomItems().add(item);

Parameters:: value -
See Also:: resetShowLine

getText
```
public java.lang.String getText()
```
Gets or sets the text string of the custom legend item.

The setText method of the LegendBox object is used to access the CustomLegendItemCollection object of a chart. By accessing a CustomLegendItem from the collection, you can modify the text of the item using this method.
The setTextColor method is used to control the color for a legend's text.
To add a custom legend item:
Java
CustomLegendItem c; c = new CustomLegendItem(); c.setText("Custom Item"); c.setMarkerShape(MarkerShape.MARBLE); c.setColor(new java.awt.Color(255,165,0,255)); chart1.getLegendBox().getCustomItems().add(c);

setText
```
public void setText(java.lang.String value)
```
Gets or sets the text string of the custom legend item.

The setText method of the LegendBox object is used to access the CustomLegendItemCollection object of a chart. By accessing a CustomLegendItem from the collection, you can modify the text of the item using this method.
The setTextColor method is used to control the color for a legend's text.
To add a custom legend item:
Java
CustomLegendItem c; c = new CustomLegendItem(); c.setText("Custom Item"); c.setMarkerShape(MarkerShape.MARBLE); c.setColor(new java.awt.Color(255,165,0,255)); chart1.getLegendBox().getCustomItems().add(c);
Parameters:
value -

resetShowLine
```
public void resetShowLine()
```
Set the property ShowLine to its default value.

See Also:
isShowLine

Class CustomLegendItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CustomLegendItem

Method Detail

getAlternateColor

setAlternateColor

getAttributes

setAttributes

getBorder

getColor

setColor

getLink

getMarkerShape

setMarkerShape

getParent

setParent

getPattern

setPattern

getPicture

setPicture

isShowLine

setShowLine

getText

setText

resetShowLine