Package org.apache.poi.hssf.record.chart

Class LegendRecord

java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.chart.LegendRecord
All Implemented Interfaces:
org.apache.poi.common.Duplicatable, GenericRecord
public final class LegendRecord extends StandardRecord
Defines a legend for a chart.

  • Field Details

  • Constructor Details

    • LegendRecord

      public LegendRecord()

    • LegendRecord

      public LegendRecord(LegendRecord other)

    • LegendRecord

      public LegendRecord(RecordInputStream in)

  • Method Details

    • serialize

      public void serialize(LittleEndianOutput out)

    • getSid

      public short getSid()
      Description copied from class: Record
      return the non static version of the id for this record.
      Specified by:
      getSid in class Record
      Returns:
      he id for this record

    • copy

      public LegendRecord copy()
      Specified by:
      copy in interface org.apache.poi.common.Duplicatable
      Specified by:
      copy in class StandardRecord

    • getXAxisUpperLeft

      public int getXAxisUpperLeft()
      Get the x axis upper left field for the Legend record.

    • setXAxisUpperLeft

      public void setXAxisUpperLeft(int field_1_xAxisUpperLeft)
      Set the x axis upper left field for the Legend record.

    • getYAxisUpperLeft

      public int getYAxisUpperLeft()
      Get the y axis upper left field for the Legend record.

    • setYAxisUpperLeft

      public void setYAxisUpperLeft(int field_2_yAxisUpperLeft)
      Set the y axis upper left field for the Legend record.

    • getXSize

      public int getXSize()
      Get the x size field for the Legend record.

    • setXSize

      public void setXSize(int field_3_xSize)
      Set the x size field for the Legend record.

    • getYSize

      public int getYSize()
      Get the y size field for the Legend record.

    • setYSize

      public void setYSize(int field_4_ySize)
      Set the y size field for the Legend record.

    • getType

      public byte getType()
      Get the type field for the Legend record.
      Returns:
      One of TYPE_BOTTOM TYPE_CORNER TYPE_TOP TYPE_RIGHT TYPE_LEFT TYPE_UNDOCKED

    • setType

      public void setType(byte field_5_type)
      Set the type field for the Legend record.
      Parameters:
      field_5_type - One of TYPE_BOTTOM TYPE_CORNER TYPE_TOP TYPE_RIGHT TYPE_LEFT TYPE_UNDOCKED

    • getSpacing

      public byte getSpacing()
      Get the spacing field for the Legend record.
      Returns:
      One of SPACING_CLOSE SPACING_MEDIUM SPACING_OPEN

    • setSpacing

      public void setSpacing(byte field_6_spacing)
      Set the spacing field for the Legend record.
      Parameters:
      field_6_spacing - One of SPACING_CLOSE SPACING_MEDIUM SPACING_OPEN

    • getOptions

      public short getOptions()
      Get the options field for the Legend record.

    • setOptions

      public void setOptions(short field_7_options)
      Set the options field for the Legend record.

    • setAutoPosition

      public void setAutoPosition(boolean value)
      Sets the auto position field value. automatic positioning (1=docked)

    • isAutoPosition

      public boolean isAutoPosition()
      automatic positioning (1=docked)
      Returns:
      the auto position field value.

    • setAutoSeries

      public void setAutoSeries(boolean value)
      Sets the auto series field value. excel 5 only (true)

    • isAutoSeries

      public boolean isAutoSeries()
      excel 5 only (true)
      Returns:
      the auto series field value.

    • setAutoXPositioning

      public void setAutoXPositioning(boolean value)
      Sets the auto x positioning field value. position of legend on the x axis is automatic

    • isAutoXPositioning

      public boolean isAutoXPositioning()
      position of legend on the x axis is automatic
      Returns:
      the auto x positioning field value.

    • setAutoYPositioning

      public void setAutoYPositioning(boolean value)
      Sets the auto y positioning field value. position of legend on the y axis is automatic

    • isAutoYPositioning

      public boolean isAutoYPositioning()
      position of legend on the y axis is automatic
      Returns:
      the auto y positioning field value.

    • setVertical

      public void setVertical(boolean value)
      Sets the vertical field value. vertical or horizontal legend (1 or 0 respectively). Always 0 if not automatic.

    • isVertical

      public boolean isVertical()
      vertical or horizontal legend (1 or 0 respectively). Always 0 if not automatic.
      Returns:
      the vertical field value.

    • setDataTable

      public void setDataTable(boolean value)
      Sets the data table field value. 1 if chart contains data table

    • isDataTable

      public boolean isDataTable()
      1 if chart contains data table
      Returns:
      the data table field value.

    • getGenericRecordType

      public HSSFRecordTypes getGenericRecordType()
      Specified by:
      getGenericRecordType in interface GenericRecord
      Specified by:
      getGenericRecordType in class Record

    • getGenericProperties

      public Map<String,Supplier<?>> getGenericProperties()