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

Class SheetPropertiesRecord

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.SheetPropertiesRecord
All Implemented Interfaces:
org.apache.poi.common.Duplicatable, GenericRecord
public final class SheetPropertiesRecord extends StandardRecord
Describes a chart sheet properties record. SHTPROPS (0x1044)

(As with all chart related records, documentation is lacking. See ChartRecord for more details)

  • Field Details

  • Constructor Details

    • SheetPropertiesRecord

      public SheetPropertiesRecord()

    • SheetPropertiesRecord

      public SheetPropertiesRecord(SheetPropertiesRecord other)

    • SheetPropertiesRecord

      public SheetPropertiesRecord(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 SheetPropertiesRecord copy()
      Specified by:
      copy in interface org.apache.poi.common.Duplicatable
      Specified by:
      copy in class StandardRecord

    • getFlags

      public int getFlags()
      Get the flags field for the SheetProperties record.

    • getEmpty

      public int getEmpty()
      Get the empty field for the SheetProperties record.
      Returns:
      One of EMPTY_NOT_PLOTTED EMPTY_ZERO EMPTY_INTERPOLATED

    • setEmpty

      public void setEmpty(byte empty)
      Set the empty field for the SheetProperties record.
      Parameters:
      empty - One of EMPTY_NOT_PLOTTED EMPTY_ZERO EMPTY_INTERPOLATED

    • setChartTypeManuallyFormatted

      public void setChartTypeManuallyFormatted(boolean value)
      Sets the chart type manually formatted field value. Has the chart type been manually formatted?

    • isChartTypeManuallyFormatted

      public boolean isChartTypeManuallyFormatted()
      Has the chart type been manually formatted?
      Returns:
      the chart type manually formatted field value.

    • setPlotVisibleOnly

      public void setPlotVisibleOnly(boolean value)
      Sets the plot visible only field value. Only show visible cells on the chart.

    • isPlotVisibleOnly

      public boolean isPlotVisibleOnly()
      Only show visible cells on the chart.
      Returns:
      the plot visible only field value.

    • setDoNotSizeWithWindow

      public void setDoNotSizeWithWindow(boolean value)
      Sets the do not size with window field value. Do not size the chart when the window changes size

    • isDoNotSizeWithWindow

      public boolean isDoNotSizeWithWindow()
      Do not size the chart when the window changes size
      Returns:
      the do not size with window field value.

    • setDefaultPlotDimensions

      public void setDefaultPlotDimensions(boolean value)
      Sets the default plot dimensions field value. Indicates that the default area dimensions should be used.

    • isDefaultPlotDimensions

      public boolean isDefaultPlotDimensions()
      Indicates that the default area dimensions should be used.
      Returns:
      the default plot dimensions field value.

    • setAutoPlotArea

      public void setAutoPlotArea(boolean value)
      Sets the auto plot area field value. ??

    • isAutoPlotArea

      public boolean isAutoPlotArea()
      ??
      Returns:
      the auto plot area field value.

    • getGenericRecordType

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

    • getGenericProperties

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