[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

LegendPosition

Enum Class LegendPosition

java.lang.Object
java.lang.Enum<LegendPosition>
com.grapecity.documents.excel.drawing.LegendPosition
All Implemented Interfaces:
Serializable, Comparable<LegendPosition>, Constable
public enum LegendPosition extends Enum<LegendPosition>
Specifies the position of the legend on a chart.

Use this enumeration with ILegend.setPosition(LegendPosition) to place the legend above, below, to the left of, or to the right of the chart, or to use a custom legend position.


 worksheet.getRange("A1:C3").setValue(new Object[][] {
     {"Region", "Sales", "Cost"},
     {"North", 100, 80},
     {"South", 120, 90}
 });
 IShape shape = worksheet.getShapes().addChart(ChartType.ColumnClustered, 20, 20, 320, 220);
 shape.getChart().getSeriesCollection().add(worksheet.getRange("A1:C3"), RowCol.Columns, true, true);
 shape.getChart().getLegend().setPosition(LegendPosition.Right);

  • Enum Constant Details

    • Custom

      public static final LegendPosition Custom
      Specifies a custom position.

    • Top

      public static final LegendPosition Top
      Specifies a position above the chart.

    • Left

      public static final LegendPosition Left
      Specifies a position to the left of the chart.

    • Bottom

      public static final LegendPosition Bottom
      Specifies a position below the chart.

    • Corner

      public static final LegendPosition Corner
      Specifies a position in the upper right-hand corner of the chart border.

  • Method Details

    • values

      public static LegendPosition[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static LegendPosition valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null