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

public final Class AxisOptionsRecord

extends StandardRecord
Class Inheritance
Static Imports
org.apache.poi.util.GenericRecordUtil.getBitsAsString
The axis options record provides unit information and other various tidbits about the axis.

Field Summary

Modifier and TypeField and Description
private static final BitField
defaultBase

private static final BitField
defaultCross

private static final BitField
defaultDateSettings

private static final BitField
defaultMajor

private static final BitField
defaultMaximum

private static final BitField
defaultMinimum

private static final BitField
defaultMinorUnit

private short
field_1_minimumCategory

private short
field_2_maximumCategory

private short
field_3_majorUnitValue

private short
field_4_majorUnit

private short
field_5_minorUnitValue

private short
field_6_minorUnit

private short
field_7_baseUnit

private short
field_8_crossingPoint

private short
field_9_options

private static final int[]
FLAG_MASKS

private static final String[]
FLAG_NAMES

private static final BitField
isDate

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
AxisOptionsRecord()

public
AxisOptionsRecord(AxisOptionsRecord other)

public
AxisOptionsRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public AxisOptionsRecord
copy()

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

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

public short
getBaseUnit()

Get the base unit field for the AxisOptions record.

public short
getCrossingPoint()

Get the crossing point field for the AxisOptions 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 short
getMajorUnit()

Get the major unit field for the AxisOptions record.

public short
getMajorUnitValue()

Get the major unit value field for the AxisOptions record.

public short
getMaximumCategory()

Get the maximum category field for the AxisOptions record.

public short
getMinimumCategory()

Get the minimum category field for the AxisOptions record.

public short
getMinorUnit()

Get the minor unit field for the AxisOptions record.

public short
getMinorUnitValue()

Get the minor unit value field for the AxisOptions record.

public short
getOptions()

Get the options field for the AxisOptions 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 boolean

Returns:

the default base field value.
isDefaultBase()

use the default base unit

public boolean

Returns:

the default cross field value.
isDefaultCross()

use the default crossing point

public boolean

Returns:

the default date settings field value.
isDefaultDateSettings()

use default date setttings for this axis

public boolean

Returns:

the default major field value.
isDefaultMajor()

use the default major unit

public boolean

Returns:

the default maximum field value.
isDefaultMaximum()

use the default maximum category

public boolean

Returns:

the default minimum field value.
isDefaultMinimum()

use the default minimum category

public boolean

Returns:

the default minor unit field value.
isDefaultMinorUnit()

use the default minor unit

public boolean

Returns:

the isDate field value.
isIsDate()

this is a date axis

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
setBaseUnit(short field_7_baseUnit)

Set the base unit field for the AxisOptions record.

public void
setCrossingPoint(short field_8_crossingPoint)

Set the crossing point field for the AxisOptions record.

public void
setDefaultBase(boolean value)

Sets the default base field value.

public void
setDefaultCross(boolean value)

Sets the default cross field value.

public void
setDefaultDateSettings(boolean value)

Sets the default date settings field value.

public void
setDefaultMajor(boolean value)

Sets the default major field value.

public void
setDefaultMaximum(boolean value)

Sets the default maximum field value.

public void
setDefaultMinimum(boolean value)

Sets the default minimum field value.

public void
setDefaultMinorUnit(boolean value)

Sets the default minor unit field value.

public void
setIsDate(boolean value)

Sets the isDate field value.

public void
setMajorUnit(short field_4_majorUnit)

Set the major unit field for the AxisOptions record.

public void
setMajorUnitValue(short field_3_majorUnitValue)

Set the major unit value field for the AxisOptions record.

public void
setMaximumCategory(short field_2_maximumCategory)

Set the maximum category field for the AxisOptions record.

public void
setMinimumCategory(short field_1_minimumCategory)

Set the minimum category field for the AxisOptions record.

public void
setMinorUnit(short field_6_minorUnit)

Set the minor unit field for the AxisOptions record.

public void
setMinorUnitValue(short field_5_minorUnitValue)

Set the minor unit value field for the AxisOptions record.

public void
setOptions(short field_9_options)

Set the options field for the AxisOptions record.

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

Field Detail

defaultBaseback to summary
private static final BitField defaultBase
defaultCrossback to summary
private static final BitField defaultCross
defaultDateSettingsback to summary
private static final BitField defaultDateSettings
defaultMajorback to summary
private static final BitField defaultMajor
defaultMaximumback to summary
private static final BitField defaultMaximum
defaultMinimumback to summary
private static final BitField defaultMinimum
defaultMinorUnitback to summary
private static final BitField defaultMinorUnit
field_1_minimumCategoryback to summary
private short field_1_minimumCategory
field_2_maximumCategoryback to summary
private short field_2_maximumCategory
field_3_majorUnitValueback to summary
private short field_3_majorUnitValue
field_4_majorUnitback to summary
private short field_4_majorUnit
field_5_minorUnitValueback to summary
private short field_5_minorUnitValue
field_6_minorUnitback to summary
private short field_6_minorUnit
field_7_baseUnitback to summary
private short field_7_baseUnit
field_8_crossingPointback to summary
private short field_8_crossingPoint
field_9_optionsback to summary
private short field_9_options
FLAG_MASKSback to summary
private static final int[] FLAG_MASKS
FLAG_NAMESback to summary
private static final String[] FLAG_NAMES
isDateback to summary
private static final BitField isDate
sidback to summary
public static final short sid

Constructor Detail

AxisOptionsRecordback to summary
public AxisOptionsRecord()
AxisOptionsRecordback to summary
public AxisOptionsRecord(AxisOptionsRecord other)
AxisOptionsRecordback to summary
public AxisOptionsRecord(RecordInputStream in)

Method Detail

copyback to summary
public AxisOptionsRecord copy()

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

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

Returns:AxisOptionsRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getBaseUnitback to summary
public short getBaseUnit()

Get the base unit field for the AxisOptions record.

getCrossingPointback to summary
public short getCrossingPoint()

Get the crossing point field for the AxisOptions record.

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
getMajorUnitback to summary
public short getMajorUnit()

Get the major unit field for the AxisOptions record.

getMajorUnitValueback to summary
public short getMajorUnitValue()

Get the major unit value field for the AxisOptions record.

getMaximumCategoryback to summary
public short getMaximumCategory()

Get the maximum category field for the AxisOptions record.

getMinimumCategoryback to summary
public short getMinimumCategory()

Get the minimum category field for the AxisOptions record.

getMinorUnitback to summary
public short getMinorUnit()

Get the minor unit field for the AxisOptions record.

getMinorUnitValueback to summary
public short getMinorUnitValue()

Get the minor unit value field for the AxisOptions record.

getOptionsback to summary
public short getOptions()

Get the options field for the AxisOptions 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

isDefaultBaseback to summary
public boolean isDefaultBase()

use the default base unit

Returns:boolean

the default base field value.

isDefaultCrossback to summary
public boolean isDefaultCross()

use the default crossing point

Returns:boolean

the default cross field value.

isDefaultDateSettingsback to summary
public boolean isDefaultDateSettings()

use default date setttings for this axis

Returns:boolean

the default date settings field value.

isDefaultMajorback to summary
public boolean isDefaultMajor()

use the default major unit

Returns:boolean

the default major field value.

isDefaultMaximumback to summary
public boolean isDefaultMaximum()

use the default maximum category

Returns:boolean

the default maximum field value.

isDefaultMinimumback to summary
public boolean isDefaultMinimum()

use the default minimum category

Returns:boolean

the default minimum field value.

isDefaultMinorUnitback to summary
public boolean isDefaultMinorUnit()

use the default minor unit

Returns:boolean

the default minor unit field value.

isIsDateback to summary
public boolean isIsDate()

this is a date axis

Returns:boolean

the isDate 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

setBaseUnitback to summary
public void setBaseUnit(short field_7_baseUnit)

Set the base unit field for the AxisOptions record.

setCrossingPointback to summary
public void setCrossingPoint(short field_8_crossingPoint)

Set the crossing point field for the AxisOptions record.

setDefaultBaseback to summary
public void setDefaultBase(boolean value)

Sets the default base field value. use the default base unit

setDefaultCrossback to summary
public void setDefaultCross(boolean value)

Sets the default cross field value. use the default crossing point

setDefaultDateSettingsback to summary
public void setDefaultDateSettings(boolean value)

Sets the default date settings field value. use default date setttings for this axis

setDefaultMajorback to summary
public void setDefaultMajor(boolean value)

Sets the default major field value. use the default major unit

setDefaultMaximumback to summary
public void setDefaultMaximum(boolean value)

Sets the default maximum field value. use the default maximum category

setDefaultMinimumback to summary
public void setDefaultMinimum(boolean value)

Sets the default minimum field value. use the default minimum category

setDefaultMinorUnitback to summary
public void setDefaultMinorUnit(boolean value)

Sets the default minor unit field value. use the default minor unit

setIsDateback to summary
public void setIsDate(boolean value)

Sets the isDate field value. this is a date axis

setMajorUnitback to summary
public void setMajorUnit(short field_4_majorUnit)

Set the major unit field for the AxisOptions record.

setMajorUnitValueback to summary
public void setMajorUnitValue(short field_3_majorUnitValue)

Set the major unit value field for the AxisOptions record.

setMaximumCategoryback to summary
public void setMaximumCategory(short field_2_maximumCategory)

Set the maximum category field for the AxisOptions record.

setMinimumCategoryback to summary
public void setMinimumCategory(short field_1_minimumCategory)

Set the minimum category field for the AxisOptions record.

setMinorUnitback to summary
public void setMinorUnit(short field_6_minorUnit)

Set the minor unit field for the AxisOptions record.

setMinorUnitValueback to summary
public void setMinorUnitValue(short field_5_minorUnitValue)

Set the minor unit value field for the AxisOptions record.

setOptionsback to summary
public void setOptions(short field_9_options)

Set the options field for the AxisOptions record.