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

public final Class AxisRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.hssf.record.HSSFRecordTypes, .RecordInputStream, .StandardRecord, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
The axis record defines the type of an axis.

Field Summary

Modifier and TypeField and Description
public static final short
AXIS_TYPE_CATEGORY_OR_X_AXIS

public static final short
AXIS_TYPE_SERIES_AXIS

public static final short
AXIS_TYPE_VALUE_AXIS

private short
field_1_axisType

private int
field_2_reserved1

private int
field_3_reserved2

private int
field_4_reserved3

private int
field_5_reserved4

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
AxisRecord()

public
AxisRecord(AxisRecord other)

public
AxisRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public AxisRecord
copy()

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

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

public short

Returns:

One of AXIS_TYPE_CATEGORY_OR_X_AXIS AXIS_TYPE_VALUE_AXIS AXIS_TYPE_SERIES_AXIS
getAxisType()

Get the axis type field for the Axis record.

protected int
getDataSize()

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

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 int
getReserved1()

Get the reserved1 field for the Axis record.

public int
getReserved2()

Get the reserved2 field for the Axis record.

public int
getReserved3()

Get the reserved3 field for the Axis record.

public int
getReserved4()

Get the reserved4 field for the Axis record.

public short
getSid()

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

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

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
setAxisType(short
One of AXIS_TYPE_CATEGORY_OR_X_AXIS AXIS_TYPE_VALUE_AXIS AXIS_TYPE_SERIES_AXIS
field_1_axisType)

Set the axis type field for the Axis record.

public void
setReserved1(int field_2_reserved1)

Set the reserved1 field for the Axis record.

public void
setReserved2(int field_3_reserved2)

Set the reserved2 field for the Axis record.

public void
setReserved3(int field_4_reserved3)

Set the reserved3 field for the Axis record.

public void
setReserved4(int field_5_reserved4)

Set the reserved4 field for the Axis record.

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

Field Detail

AXIS_TYPE_CATEGORY_OR_X_AXISback to summary
public static final short AXIS_TYPE_CATEGORY_OR_X_AXIS
AXIS_TYPE_SERIES_AXISback to summary
public static final short AXIS_TYPE_SERIES_AXIS
AXIS_TYPE_VALUE_AXISback to summary
public static final short AXIS_TYPE_VALUE_AXIS
field_1_axisTypeback to summary
private short field_1_axisType
field_2_reserved1back to summary
private int field_2_reserved1
field_3_reserved2back to summary
private int field_3_reserved2
field_4_reserved3back to summary
private int field_4_reserved3
field_5_reserved4back to summary
private int field_5_reserved4
sidback to summary
public static final short sid

Constructor Detail

AxisRecordback to summary
public AxisRecord()
AxisRecordback to summary
public AxisRecord(AxisRecord other)
AxisRecordback to summary
public AxisRecord(RecordInputStream in)

Method Detail

copyback to summary
public AxisRecord copy()

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

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

Returns:AxisRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getAxisTypeback to summary
public short getAxisType()

Get the axis type field for the Axis record.

Returns:short

One of AXIS_TYPE_CATEGORY_OR_X_AXIS AXIS_TYPE_VALUE_AXIS AXIS_TYPE_SERIES_AXIS

getDataSizeback to summary
protected int getDataSize()

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

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
getReserved1back to summary
public int getReserved1()

Get the reserved1 field for the Axis record.

getReserved2back to summary
public int getReserved2()

Get the reserved2 field for the Axis record.

getReserved3back to summary
public int getReserved3()

Get the reserved3 field for the Axis record.

getReserved4back to summary
public int getReserved4()

Get the reserved4 field for the Axis record.

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

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

setAxisTypeback to summary
public void setAxisType(short field_1_axisType)

Set the axis type field for the Axis record.

Parameters
field_1_axisType:short

One of AXIS_TYPE_CATEGORY_OR_X_AXIS AXIS_TYPE_VALUE_AXIS AXIS_TYPE_SERIES_AXIS

setReserved1back to summary
public void setReserved1(int field_2_reserved1)

Set the reserved1 field for the Axis record.

setReserved2back to summary
public void setReserved2(int field_3_reserved2)

Set the reserved2 field for the Axis record.

setReserved3back to summary
public void setReserved3(int field_4_reserved3)

Set the reserved3 field for the Axis record.

setReserved4back to summary
public void setReserved4(int field_5_reserved4)

Set the reserved4 field for the Axis record.