Package org.apache.poi.hssf.record.chart

Class LineFormatRecord

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.LineFormatRecord
All Implemented Interfaces:
org.apache.poi.common.Duplicatable, GenericRecord
public final class LineFormatRecord extends StandardRecord
Describes a line format record. The line format record controls how a line on a chart appears.

  • Field Details

  • Constructor Details

    • LineFormatRecord

      public LineFormatRecord()

    • LineFormatRecord

      public LineFormatRecord(LineFormatRecord other)

    • LineFormatRecord

      public LineFormatRecord(RecordInputStream in)

  • Method Details

    • serialize

      public void serialize(LittleEndianOutput out)

    • 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 LineFormatRecord copy()
      Specified by:
      copy in interface org.apache.poi.common.Duplicatable
      Specified by:
      copy in class StandardRecord

    • getLineColor

      public int getLineColor()
      Get the line color field for the LineFormat record.

    • setLineColor

      public void setLineColor(int field_1_lineColor)
      Set the line color field for the LineFormat record.

    • getLinePattern

      public short getLinePattern()
      Get the line pattern field for the LineFormat record.
      Returns:
      One of LINE_PATTERN_SOLID LINE_PATTERN_DASH LINE_PATTERN_DOT LINE_PATTERN_DASH_DOT LINE_PATTERN_DASH_DOT_DOT LINE_PATTERN_NONE LINE_PATTERN_DARK_GRAY_PATTERN LINE_PATTERN_MEDIUM_GRAY_PATTERN LINE_PATTERN_LIGHT_GRAY_PATTERN

    • setLinePattern

      public void setLinePattern(short field_2_linePattern)
      Set the line pattern field for the LineFormat record.
      Parameters:
      field_2_linePattern - One of LINE_PATTERN_SOLID LINE_PATTERN_DASH LINE_PATTERN_DOT LINE_PATTERN_DASH_DOT LINE_PATTERN_DASH_DOT_DOT LINE_PATTERN_NONE LINE_PATTERN_DARK_GRAY_PATTERN LINE_PATTERN_MEDIUM_GRAY_PATTERN LINE_PATTERN_LIGHT_GRAY_PATTERN

    • getWeight

      public short getWeight()
      Get the weight field for the LineFormat record.
      Returns:
      One of WEIGHT_HAIRLINE WEIGHT_NARROW WEIGHT_MEDIUM WEIGHT_WIDE

    • setWeight

      public void setWeight(short field_3_weight)
      Set the weight field for the LineFormat record.
      Parameters:
      field_3_weight - One of WEIGHT_HAIRLINE WEIGHT_NARROW WEIGHT_MEDIUM WEIGHT_WIDE

    • getFormat

      public short getFormat()
      Get the format field for the LineFormat record.

    • setFormat

      public void setFormat(short field_4_format)
      Set the format field for the LineFormat record.

    • getColourPaletteIndex

      public short getColourPaletteIndex()
      Get the colour palette index field for the LineFormat record.

    • setColourPaletteIndex

      public void setColourPaletteIndex(short field_5_colourPaletteIndex)
      Set the colour palette index field for the LineFormat record.

    • setAuto

      public void setAuto(boolean value)
      Sets the auto field value. automatic format

    • isAuto

      public boolean isAuto()
      automatic format
      Returns:
      the auto field value.

    • setDrawTicks

      public void setDrawTicks(boolean value)
      Sets the draw ticks field value. draw tick marks

    • isDrawTicks

      public boolean isDrawTicks()
      draw tick marks
      Returns:
      the draw ticks field value.

    • setUnknown

      public void setUnknown(boolean value)
      Sets the unknown field value. book marks this as reserved = 0 but it seems to do something

    • isUnknown

      public boolean isUnknown()
      book marks this as reserved = 0 but it seems to do something
      Returns:
      the unknown field value.

    • getGenericRecordType

      public HSSFRecordTypes getGenericRecordType()
      Specified by:
      getGenericRecordType in interface GenericRecord
      Specified by:
      getGenericRecordType in class Record

    • getGenericProperties

      public Map<String,Supplier<?>> getGenericProperties()