Package loci.poi.hssf.record
Class CategorySeriesAxisRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.CategorySeriesAxisRecord
This record refers to a category or series axis and is used to specify label/tickmark frequency.
NOTE: This source is automatically generated please do not modify this file. Either subclass or
remove the record in src/records/definitions.
- Author:
- Glen Stampoultzis (glens at apache.org)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a CategorySeriesAxis record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.shortGet the crossing point field for the CategorySeriesAxis record.shortGet the label frequency field for the CategorySeriesAxis record.shortGet the options field for the CategorySeriesAxis record.intSize of record (exluding 4 byte header)shortgetSid()return the non static version of the id for this record.shortGet the tick mark frequency field for the CategorySeriesAxis record.booleanaxis crosses at the far rightbooleancategories are displayed in reverse orderbooleanset true to indicate axis crosses between categories and false to cross axis midwayintserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetCrossesFarRight(boolean value) Sets the crosses far right field value.voidsetCrossingPoint(short field_1_crossingPoint) Set the crossing point field for the CategorySeriesAxis record.voidsetLabelFrequency(short field_2_labelFrequency) Set the label frequency field for the CategorySeriesAxis record.voidsetOptions(short field_4_options) Set the options field for the CategorySeriesAxis record.voidsetReversed(boolean value) Sets the reversed field value.voidsetTickMarkFrequency(short field_3_tickMarkFrequency) Set the tick mark frequency field for the CategorySeriesAxis record.voidsetValueAxisCrossing(boolean value) Sets the value axis crossing field value.toString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(short id) Checks the sid matches the expected side for this recordMethods inherited from class loci.poi.hssf.record.Record
isInValueSection, isValue, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
CategorySeriesAxisRecord
public CategorySeriesAxisRecord() -
CategorySeriesAxisRecord
Constructs a CategorySeriesAxis record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Checks the sid matches the expected side for this record- Specified by:
validateSidin classRecord- Parameters:
id- the expected sid.
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array. -
getRecordSize
public int getRecordSize()Size of record (exluding 4 byte header)- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
clone
-
getCrossingPoint
public short getCrossingPoint()Get the crossing point field for the CategorySeriesAxis record. -
setCrossingPoint
public void setCrossingPoint(short field_1_crossingPoint) Set the crossing point field for the CategorySeriesAxis record. -
getLabelFrequency
public short getLabelFrequency()Get the label frequency field for the CategorySeriesAxis record. -
setLabelFrequency
public void setLabelFrequency(short field_2_labelFrequency) Set the label frequency field for the CategorySeriesAxis record. -
getTickMarkFrequency
public short getTickMarkFrequency()Get the tick mark frequency field for the CategorySeriesAxis record. -
setTickMarkFrequency
public void setTickMarkFrequency(short field_3_tickMarkFrequency) Set the tick mark frequency field for the CategorySeriesAxis record. -
getOptions
public short getOptions()Get the options field for the CategorySeriesAxis record. -
setOptions
public void setOptions(short field_4_options) Set the options field for the CategorySeriesAxis record. -
setValueAxisCrossing
public void setValueAxisCrossing(boolean value) Sets the value axis crossing field value. set true to indicate axis crosses between categories and false to cross axis midway -
isValueAxisCrossing
public boolean isValueAxisCrossing()set true to indicate axis crosses between categories and false to cross axis midway- Returns:
- the value axis crossing field value.
-
setCrossesFarRight
public void setCrossesFarRight(boolean value) Sets the crosses far right field value. axis crosses at the far right -
isCrossesFarRight
public boolean isCrossesFarRight()axis crosses at the far right- Returns:
- the crosses far right field value.
-
setReversed
public void setReversed(boolean value) Sets the reversed field value. categories are displayed in reverse order -
isReversed
public boolean isReversed()categories are displayed in reverse order- Returns:
- the reversed field value.
-