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

public final Class ValueRangeRecord

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

Field Summary

Modifier and TypeField and Description
private static final BitField
automaticCategoryCrossing

private static final BitField
automaticMajor

private static final BitField
automaticMaximum

private static final BitField
automaticMinimum

private static final BitField
automaticMinor

private static final BitField
crossCategoryAxisAtMaximum

private double
field_1_minimumAxisValue

private double
field_2_maximumAxisValue

private double
field_3_majorIncrement

private double
field_4_minorIncrement

private double
field_5_categoryAxisCross

private short
field_6_options

private static final BitField
logarithmicScale

private static final BitField
reserved

public static final short
sid

private static final BitField
valuesInReverse

Constructor Summary

AccessConstructor and Description
public
ValueRangeRecord()

public
ValueRangeRecord(ValueRangeRecord other)

public
ValueRangeRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public ValueRangeRecord
copy()

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

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

public double
getCategoryAxisCross()

Get the category axis cross field for the ValueRange 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 double
getMajorIncrement()

Get the major increment field for the ValueRange record.

public double
getMaximumAxisValue()

Get the maximum axis value field for the ValueRange record.

public double
getMinimumAxisValue()

Get the minimum axis value field for the ValueRange record.

public double
getMinorIncrement()

Get the minor increment field for the ValueRange record.

public short
getOptions()

Get the options field for the ValueRange 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 automatic category crossing field value.
isAutomaticCategoryCrossing()

category crossing point is automatically selected

public boolean

Returns:

the automatic major field value.
isAutomaticMajor()

automatic major unit selected

public boolean

Returns:

the automatic maximum field value.
isAutomaticMaximum()

automatic maximum value selected

public boolean

Returns:

the automatic minimum field value.
isAutomaticMinimum()

automatic minimum value selected

public boolean

Returns:

the automatic minor field value.
isAutomaticMinor()

automatic minor unit selected

public boolean

Returns:

the cross category axis at maximum field value.
isCrossCategoryAxisAtMaximum()

category axis to cross at maximum value

public boolean

Returns:

the logarithmic scale field value.
isLogarithmicScale()

use logarithmic scale

public boolean

Returns:

the reserved field value.
isReserved()

reserved, must equal 1 (excel dev.

public boolean

Returns:

the values in reverse field value.
isValuesInReverse()

values are reverses in graph

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
setAutomaticCategoryCrossing(boolean value)

Sets the automatic category crossing field value.

public void
setAutomaticMajor(boolean value)

Sets the automatic major field value.

public void
setAutomaticMaximum(boolean value)

Sets the automatic maximum field value.

public void
setAutomaticMinimum(boolean value)

Sets the automatic minimum field value.

public void
setAutomaticMinor(boolean value)

Sets the automatic minor field value.

public void
setCategoryAxisCross(double field_5_categoryAxisCross)

Set the category axis cross field for the ValueRange record.

public void
setCrossCategoryAxisAtMaximum(boolean value)

Sets the cross category axis at maximum field value.

public void
setLogarithmicScale(boolean value)

Sets the logarithmic scale field value.

public void
setMajorIncrement(double field_3_majorIncrement)

Set the major increment field for the ValueRange record.

public void
setMaximumAxisValue(double field_2_maximumAxisValue)

Set the maximum axis value field for the ValueRange record.

public void
setMinimumAxisValue(double field_1_minimumAxisValue)

Set the minimum axis value field for the ValueRange record.

public void
setMinorIncrement(double field_4_minorIncrement)

Set the minor increment field for the ValueRange record.

public void
setOptions(short field_6_options)

Set the options field for the ValueRange record.

public void
setReserved(boolean value)

Sets the reserved field value.

public void
setValuesInReverse(boolean value)

Sets the values in reverse field value.

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

Field Detail

automaticCategoryCrossingback to summary
private static final BitField automaticCategoryCrossing
automaticMajorback to summary
private static final BitField automaticMajor
automaticMaximumback to summary
private static final BitField automaticMaximum
automaticMinimumback to summary
private static final BitField automaticMinimum
automaticMinorback to summary
private static final BitField automaticMinor
crossCategoryAxisAtMaximumback to summary
private static final BitField crossCategoryAxisAtMaximum
field_1_minimumAxisValueback to summary
private double field_1_minimumAxisValue
field_2_maximumAxisValueback to summary
private double field_2_maximumAxisValue
field_3_majorIncrementback to summary
private double field_3_majorIncrement
field_4_minorIncrementback to summary
private double field_4_minorIncrement
field_5_categoryAxisCrossback to summary
private double field_5_categoryAxisCross
field_6_optionsback to summary
private short field_6_options
logarithmicScaleback to summary
private static final BitField logarithmicScale
reservedback to summary
private static final BitField reserved
sidback to summary
public static final short sid
valuesInReverseback to summary
private static final BitField valuesInReverse

Constructor Detail

ValueRangeRecordback to summary
public ValueRangeRecord()
ValueRangeRecordback to summary
public ValueRangeRecord(ValueRangeRecord other)
ValueRangeRecordback to summary
public ValueRangeRecord(RecordInputStream in)

Method Detail

copyback to summary
public ValueRangeRecord copy()

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

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

Returns:ValueRangeRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getCategoryAxisCrossback to summary
public double getCategoryAxisCross()

Get the category axis cross field for the ValueRange 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
getMajorIncrementback to summary
public double getMajorIncrement()

Get the major increment field for the ValueRange record.

getMaximumAxisValueback to summary
public double getMaximumAxisValue()

Get the maximum axis value field for the ValueRange record.

getMinimumAxisValueback to summary
public double getMinimumAxisValue()

Get the minimum axis value field for the ValueRange record.

getMinorIncrementback to summary
public double getMinorIncrement()

Get the minor increment field for the ValueRange record.

getOptionsback to summary
public short getOptions()

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

isAutomaticCategoryCrossingback to summary
public boolean isAutomaticCategoryCrossing()

category crossing point is automatically selected

Returns:boolean

the automatic category crossing field value.

isAutomaticMajorback to summary
public boolean isAutomaticMajor()

automatic major unit selected

Returns:boolean

the automatic major field value.

isAutomaticMaximumback to summary
public boolean isAutomaticMaximum()

automatic maximum value selected

Returns:boolean

the automatic maximum field value.

isAutomaticMinimumback to summary
public boolean isAutomaticMinimum()

automatic minimum value selected

Returns:boolean

the automatic minimum field value.

isAutomaticMinorback to summary
public boolean isAutomaticMinor()

automatic minor unit selected

Returns:boolean

the automatic minor field value.

isCrossCategoryAxisAtMaximumback to summary
public boolean isCrossCategoryAxisAtMaximum()

category axis to cross at maximum value

Returns:boolean

the cross category axis at maximum field value.

isLogarithmicScaleback to summary
public boolean isLogarithmicScale()

use logarithmic scale

Returns:boolean

the logarithmic scale field value.

isReservedback to summary
public boolean isReserved()

reserved, must equal 1 (excel dev. guide says otherwise)

Returns:boolean

the reserved field value.

isValuesInReverseback to summary
public boolean isValuesInReverse()

values are reverses in graph

Returns:boolean

the values in reverse 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

setAutomaticCategoryCrossingback to summary
public void setAutomaticCategoryCrossing(boolean value)

Sets the automatic category crossing field value. category crossing point is automatically selected

setAutomaticMajorback to summary
public void setAutomaticMajor(boolean value)

Sets the automatic major field value. automatic major unit selected

setAutomaticMaximumback to summary
public void setAutomaticMaximum(boolean value)

Sets the automatic maximum field value. automatic maximum value selected

setAutomaticMinimumback to summary
public void setAutomaticMinimum(boolean value)

Sets the automatic minimum field value. automatic minimum value selected

setAutomaticMinorback to summary
public void setAutomaticMinor(boolean value)

Sets the automatic minor field value. automatic minor unit selected

setCategoryAxisCrossback to summary
public void setCategoryAxisCross(double field_5_categoryAxisCross)

Set the category axis cross field for the ValueRange record.

setCrossCategoryAxisAtMaximumback to summary
public void setCrossCategoryAxisAtMaximum(boolean value)

Sets the cross category axis at maximum field value. category axis to cross at maximum value

setLogarithmicScaleback to summary
public void setLogarithmicScale(boolean value)

Sets the logarithmic scale field value. use logarithmic scale

setMajorIncrementback to summary
public void setMajorIncrement(double field_3_majorIncrement)

Set the major increment field for the ValueRange record.

setMaximumAxisValueback to summary
public void setMaximumAxisValue(double field_2_maximumAxisValue)

Set the maximum axis value field for the ValueRange record.

setMinimumAxisValueback to summary
public void setMinimumAxisValue(double field_1_minimumAxisValue)

Set the minimum axis value field for the ValueRange record.

setMinorIncrementback to summary
public void setMinorIncrement(double field_4_minorIncrement)

Set the minor increment field for the ValueRange record.

setOptionsback to summary
public void setOptions(short field_6_options)

Set the options field for the ValueRange record.

setReservedback to summary
public void setReserved(boolean value)

Sets the reserved field value. reserved, must equal 1 (excel dev. guide says otherwise)

setValuesInReverseback to summary
public void setValuesInReverse(boolean value)

Sets the values in reverse field value. values are reverses in graph