ValueRangeRecord (POI API Documentation)

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.ValueRangeRecord

All Implemented Interfaces:

Duplicatable, GenericRecord
```
public final class ValueRangeRecord
extends StandardRecord
```
The value range record defines the range of the value axis.

Field Summary

Fields
Modifier and Type Field and Description

static short sid

Fields
Modifier and Type	Field and Description
`static short`	`sid`

Constructor Summary

Constructors
Constructor and Description

ValueRangeRecord()

ValueRangeRecord(RecordInputStream in)

ValueRangeRecord(ValueRangeRecord other)

Constructors
Constructor and Description
`ValueRangeRecord()`
`ValueRangeRecord(RecordInputStream in)`
`ValueRangeRecord(ValueRangeRecord other)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ValueRangeRecord`	`copy()`
`double`	`getCategoryAxisCross()` Get the category axis cross field for the ValueRange record.
`protected int`	`getDataSize()`
`java.util.Map<java.lang.String,java.util.function.Supplier<?>>`	`getGenericProperties()`
`HSSFRecordTypes`	`getGenericRecordType()`
`double`	`getMajorIncrement()` Get the major increment field for the ValueRange record.
`double`	`getMaximumAxisValue()` Get the maximum axis value field for the ValueRange record.
`double`	`getMinimumAxisValue()` Get the minimum axis value field for the ValueRange record.
`double`	`getMinorIncrement()` Get the minor increment field for the ValueRange record.
`short`	`getOptions()` Get the options field for the ValueRange record.
`short`	`getSid()` return the non static version of the id for this record.
`boolean`	`isAutomaticCategoryCrossing()` category crossing point is automatically selected
`boolean`	`isAutomaticMajor()` automatic major unit selected
`boolean`	`isAutomaticMaximum()` automatic maximum value selected
`boolean`	`isAutomaticMinimum()` automatic minimum value selected
`boolean`	`isAutomaticMinor()` automatic minor unit selected
`boolean`	`isCrossCategoryAxisAtMaximum()` category axis to cross at maximum value
`boolean`	`isLogarithmicScale()` use logarithmic scale
`boolean`	`isReserved()` reserved, must equal 1 (excel dev.
`boolean`	`isValuesInReverse()` values are reverses in graph
`void`	`serialize(LittleEndianOutput out)` Write the data content of this BIFF record.
`void`	`setAutomaticCategoryCrossing(boolean value)` Sets the automatic category crossing field value.
`void`	`setAutomaticMajor(boolean value)` Sets the automatic major field value.
`void`	`setAutomaticMaximum(boolean value)` Sets the automatic maximum field value.
`void`	`setAutomaticMinimum(boolean value)` Sets the automatic minimum field value.
`void`	`setAutomaticMinor(boolean value)` Sets the automatic minor field value.
`void`	`setCategoryAxisCross(double field_5_categoryAxisCross)` Set the category axis cross field for the ValueRange record.
`void`	`setCrossCategoryAxisAtMaximum(boolean value)` Sets the cross category axis at maximum field value.
`void`	`setLogarithmicScale(boolean value)` Sets the logarithmic scale field value.
`void`	`setMajorIncrement(double field_3_majorIncrement)` Set the major increment field for the ValueRange record.
`void`	`setMaximumAxisValue(double field_2_maximumAxisValue)` Set the maximum axis value field for the ValueRange record.
`void`	`setMinimumAxisValue(double field_1_minimumAxisValue)` Set the minimum axis value field for the ValueRange record.
`void`	`setMinorIncrement(double field_4_minorIncrement)` Set the minor increment field for the ValueRange record.
`void`	`setOptions(short field_6_options)` Set the options field for the ValueRange record.
`void`	`setReserved(boolean value)` Sets the reserved field value.
`void`	`setValuesInReverse(boolean value)` Sets the values in reverse field value.

Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize

Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord
getGenericChildren

- Field Detail
  - sid
```
public static final short sid
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ValueRangeRecord
```
public ValueRangeRecord()
```
  - ValueRangeRecord
```
public ValueRangeRecord(ValueRangeRecord other)
```
  - ValueRangeRecord
```
public ValueRangeRecord(RecordInputStream in)
```
- Method Detail
  - serialize
```
public void serialize(LittleEndianOutput out)
```
    Description copied from class: StandardRecord
    
    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 RecordBase.getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).
    
    Specified by:
    
    serialize in class StandardRecord
    
    Parameters:
    
    out - the output object
  - getDataSize
```
protected int getDataSize()
```
    Specified by:
    
    getDataSize in class StandardRecord
  - 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 ValueRangeRecord copy()
```
    Specified by:
    
    copy in interface Duplicatable
    
    Specified by:
    
    copy in class StandardRecord
    
    Returns:
    
    a deep copy of the implementing class / instance
  - getMinimumAxisValue
```
public double getMinimumAxisValue()
```
    Get the minimum axis value field for the ValueRange record.
  - setMinimumAxisValue
```
public void setMinimumAxisValue(double field_1_minimumAxisValue)
```
    Set the minimum axis value field for the ValueRange record.
  - getMaximumAxisValue
```
public double getMaximumAxisValue()
```
    Get the maximum axis value field for the ValueRange record.
  - setMaximumAxisValue
```
public void setMaximumAxisValue(double field_2_maximumAxisValue)
```
    Set the maximum axis value field for the ValueRange record.
  - getMajorIncrement
```
public double getMajorIncrement()
```
    Get the major increment field for the ValueRange record.
  - setMajorIncrement
```
public void setMajorIncrement(double field_3_majorIncrement)
```
    Set the major increment field for the ValueRange record.
  - getMinorIncrement
```
public double getMinorIncrement()
```
    Get the minor increment field for the ValueRange record.
  - setMinorIncrement
```
public void setMinorIncrement(double field_4_minorIncrement)
```
    Set the minor increment field for the ValueRange record.
  - getCategoryAxisCross
```
public double getCategoryAxisCross()
```
    Get the category axis cross field for the ValueRange record.
  - setCategoryAxisCross
```
public void setCategoryAxisCross(double field_5_categoryAxisCross)
```
    Set the category axis cross field for the ValueRange record.
  - getOptions
```
public short getOptions()
```
    Get the options field for the ValueRange record.
  - setOptions
```
public void setOptions(short field_6_options)
```
    Set the options field for the ValueRange record.
  - setAutomaticMinimum
```
public void setAutomaticMinimum(boolean value)
```
    Sets the automatic minimum field value. automatic minimum value selected
  - isAutomaticMinimum
```
public boolean isAutomaticMinimum()
```
    automatic minimum value selected
    
    Returns:
    
    the automatic minimum field value.
  - setAutomaticMaximum
```
public void setAutomaticMaximum(boolean value)
```
    Sets the automatic maximum field value. automatic maximum value selected
  - isAutomaticMaximum
```
public boolean isAutomaticMaximum()
```
    automatic maximum value selected
    
    Returns:
    
    the automatic maximum field value.
  - setAutomaticMajor
```
public void setAutomaticMajor(boolean value)
```
    Sets the automatic major field value. automatic major unit selected
  - isAutomaticMajor
```
public boolean isAutomaticMajor()
```
    automatic major unit selected
    
    Returns:
    
    the automatic major field value.
  - setAutomaticMinor
```
public void setAutomaticMinor(boolean value)
```
    Sets the automatic minor field value. automatic minor unit selected
  - isAutomaticMinor
```
public boolean isAutomaticMinor()
```
    automatic minor unit selected
    
    Returns:
    
    the automatic minor field value.
  - setAutomaticCategoryCrossing
```
public void setAutomaticCategoryCrossing(boolean value)
```
    Sets the automatic category crossing field value. category crossing point is automatically selected
  - isAutomaticCategoryCrossing
```
public boolean isAutomaticCategoryCrossing()
```
    category crossing point is automatically selected
    
    Returns:
    
    the automatic category crossing field value.
  - setLogarithmicScale
```
public void setLogarithmicScale(boolean value)
```
    Sets the logarithmic scale field value. use logarithmic scale
  - isLogarithmicScale
```
public boolean isLogarithmicScale()
```
    use logarithmic scale
    
    Returns:
    
    the logarithmic scale field value.
  - setValuesInReverse
```
public void setValuesInReverse(boolean value)
```
    Sets the values in reverse field value. values are reverses in graph
  - isValuesInReverse
```
public boolean isValuesInReverse()
```
    values are reverses in graph
    
    Returns:
    
    the values in reverse field value.
  - setCrossCategoryAxisAtMaximum
```
public void setCrossCategoryAxisAtMaximum(boolean value)
```
    Sets the cross category axis at maximum field value. category axis to cross at maximum value
  - isCrossCategoryAxisAtMaximum
```
public boolean isCrossCategoryAxisAtMaximum()
```
    category axis to cross at maximum value
    
    Returns:
    
    the cross category axis at maximum field value.
  - setReserved
```
public void setReserved(boolean value)
```
    Sets the reserved field value. reserved, must equal 1 (excel dev. guide says otherwise)
  - isReserved
```
public boolean isReserved()
```
    reserved, must equal 1 (excel dev. guide says otherwise)
    
    Returns:
    
    the reserved field value.
  - getGenericRecordType
```
public HSSFRecordTypes getGenericRecordType()
```
    Specified by:
    
    getGenericRecordType in interface GenericRecord
    
    Specified by:
    
    getGenericRecordType in class Record
  - getGenericProperties
```
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
```

Class ValueRangeRecord

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.poi.hssf.record.StandardRecord

Methods inherited from class org.apache.poi.hssf.record.Record

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

Field Detail

sid

Constructor Detail

ValueRangeRecord

ValueRangeRecord

ValueRangeRecord

Method Detail

serialize

getDataSize

getSid

copy

getMinimumAxisValue

setMinimumAxisValue

getMaximumAxisValue

setMaximumAxisValue

getMajorIncrement

setMajorIncrement

getMinorIncrement

setMinorIncrement

getCategoryAxisCross

setCategoryAxisCross

getOptions

setOptions

setAutomaticMinimum

isAutomaticMinimum

setAutomaticMaximum

isAutomaticMaximum

setAutomaticMajor

isAutomaticMajor

setAutomaticMinor

isAutomaticMinor

setAutomaticCategoryCrossing

isAutomaticCategoryCrossing

setLogarithmicScale

isLogarithmicScale

setValuesInReverse

isValuesInReverse

setCrossCategoryAxisAtMaximum

isCrossCategoryAxisAtMaximum

setReserved

isReserved

getGenericRecordType

getGenericProperties