Top Description Fields Constructors Methods
org.apache.poi.hssf.record.chart

public final Class SheetPropertiesRecord

extends StandardRecord
Class Inheritance
Static Imports
org.apache.poi.util.GenericRecordUtil.getBitsAsString, .GenericRecordUtil.getEnumBitsAsString
Describes a chart sheet properties record. SHTPROPS (0x1044)

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

Field Summary

Modifier and TypeField and Description
private static final BitField
autoPlotArea

private static final BitField
chartTypeManuallyFormatted

private static final BitField
defaultPlotDimensions

private static final BitField
doNotSizeWithWindow

public static final byte
EMPTY_INTERPOLATED

public static final byte
EMPTY_NOT_PLOTTED

public static final byte
EMPTY_ZERO

private int
field_1_flags

private int
field_2_empty

private static final BitField
plotVisibleOnly

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
SheetPropertiesRecord()

public
SheetPropertiesRecord(SheetPropertiesRecord other)

public
SheetPropertiesRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public SheetPropertiesRecord
copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

public int

Returns:

One of EMPTY_NOT_PLOTTED EMPTY_ZERO EMPTY_INTERPOLATED
getEmpty()

Get the empty field for the SheetProperties record.

public int
getFlags()

Get the flags field for the SheetProperties record.

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

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

public boolean

Returns:

the auto plot area field value.
isAutoPlotArea()

??

public boolean

Returns:

the chart type manually formatted field value.
isChartTypeManuallyFormatted()

Has the chart type been manually formatted?

public boolean

Returns:

the default plot dimensions field value.
isDefaultPlotDimensions()

Indicates that the default area dimensions should be used.

public boolean

Returns:

the do not size with window field value.
isDoNotSizeWithWindow()

Do not size the chart when the window changes size

public boolean

Returns:

the plot visible only field value.
isPlotVisibleOnly()

Only show visible cells on the chart.

public void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

public void
setAutoPlotArea(boolean value)

Sets the auto plot area field value.

public void
setChartTypeManuallyFormatted(boolean value)

Sets the chart type manually formatted field value.

public void
setDefaultPlotDimensions(boolean value)

Sets the default plot dimensions field value.

public void
setDoNotSizeWithWindow(boolean value)

Sets the do not size with window field value.

public void
setEmpty(byte
One of EMPTY_NOT_PLOTTED EMPTY_ZERO EMPTY_INTERPOLATED
empty)

Set the empty field for the SheetProperties record.

public void
setPlotVisibleOnly(boolean value)

Sets the plot visible only field value.

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

autoPlotAreaback to summary
private static final BitField autoPlotArea
chartTypeManuallyFormattedback to summary
private static final BitField chartTypeManuallyFormatted
defaultPlotDimensionsback to summary
private static final BitField defaultPlotDimensions
doNotSizeWithWindowback to summary
private static final BitField doNotSizeWithWindow
EMPTY_INTERPOLATEDback to summary
public static final byte EMPTY_INTERPOLATED
EMPTY_NOT_PLOTTEDback to summary
public static final byte EMPTY_NOT_PLOTTED
EMPTY_ZEROback to summary
public static final byte EMPTY_ZERO
field_1_flagsback to summary
private int field_1_flags
field_2_emptyback to summary
private int field_2_empty
plotVisibleOnlyback to summary
private static final BitField plotVisibleOnly
sidback to summary
public static final short sid

Constructor Detail

SheetPropertiesRecordback to summary
public SheetPropertiesRecord()
SheetPropertiesRecordback to summary
public SheetPropertiesRecord(SheetPropertiesRecord other)
SheetPropertiesRecordback to summary
public SheetPropertiesRecord(RecordInputStream in)

Method Detail

copyback to summary
public SheetPropertiesRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:SheetPropertiesRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getEmptyback to summary
public int getEmpty()

Get the empty field for the SheetProperties record.

Returns:int

One of EMPTY_NOT_PLOTTED EMPTY_ZERO EMPTY_INTERPOLATED

getFlagsback to summary
public int getFlags()

Get the flags field for the SheetProperties record.

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

he id for this record

isAutoPlotAreaback to summary
public boolean isAutoPlotArea()

??

Returns:boolean

the auto plot area field value.

isChartTypeManuallyFormattedback to summary
public boolean isChartTypeManuallyFormatted()

Has the chart type been manually formatted?

Returns:boolean

the chart type manually formatted field value.

isDefaultPlotDimensionsback to summary
public boolean isDefaultPlotDimensions()

Indicates that the default area dimensions should be used.

Returns:boolean

the default plot dimensions field value.

isDoNotSizeWithWindowback to summary
public boolean isDoNotSizeWithWindow()

Do not size the chart when the window changes size

Returns:boolean

the do not size with window field value.

isPlotVisibleOnlyback to summary
public boolean isPlotVisibleOnly()

Only show visible cells on the chart.

Returns:boolean

the plot visible only field value.

serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

setAutoPlotAreaback to summary
public void setAutoPlotArea(boolean value)

Sets the auto plot area field value. ??

setChartTypeManuallyFormattedback to summary
public void setChartTypeManuallyFormatted(boolean value)

Sets the chart type manually formatted field value. Has the chart type been manually formatted?

setDefaultPlotDimensionsback to summary
public void setDefaultPlotDimensions(boolean value)

Sets the default plot dimensions field value. Indicates that the default area dimensions should be used.

setDoNotSizeWithWindowback to summary
public void setDoNotSizeWithWindow(boolean value)

Sets the do not size with window field value. Do not size the chart when the window changes size

setEmptyback to summary
public void setEmpty(byte empty)

Set the empty field for the SheetProperties record.

Parameters
empty:byte

One of EMPTY_NOT_PLOTTED EMPTY_ZERO EMPTY_INTERPOLATED

setPlotVisibleOnlyback to summary
public void setPlotVisibleOnly(boolean value)

Sets the plot visible only field value. Only show visible cells on the chart.