Class XWPFChart

All Implemented Interfaces:
TextContainer

@Beta public class XWPFChart extends XDDFChart
Represents a Chart in a .docx file
  • Field Details

    • DEFAULT_WIDTH

      public static final int DEFAULT_WIDTH
      default width of chart in emu
      See Also:
    • DEFAULT_HEIGHT

      public static final int DEFAULT_HEIGHT
      default height of chart in emu
      See Also:
  • Constructor Details

    • XWPFChart

      protected XWPFChart()
      constructor to Create a new chart in document
      Since:
      POI 4.0.0
    • XWPFChart

      protected XWPFChart(PackagePart part) throws IOException, org.apache.xmlbeans.XmlException
      Construct a chart from a package part.
      Parameters:
      part - the package part holding the chart data, the content type must be application/vnd.openxmlformats-officedocument.drawingml.chart+xml
      Throws:
      IOException
      org.apache.xmlbeans.XmlException
      Since:
      POI 4.0.0
  • Method Details

    • getChartRelation

      protected POIXMLRelation getChartRelation()
      Specified by:
      getChartRelation in class XDDFChart
      Returns:
      the chart relation in the implementing subclass.
    • getChartWorkbookRelation

      protected POIXMLRelation getChartWorkbookRelation()
      Specified by:
      getChartWorkbookRelation in class XDDFChart
      Returns:
      the chart workbook relation in the implementing subclass.
    • getChartFactory

      protected POIXMLFactory getChartFactory()
      Specified by:
      getChartFactory in class XDDFChart
      Returns:
      the chart factory in the implementing subclass.
    • getChecksum

      public Long getChecksum()
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • attach

      protected void attach(String chartRelId, XWPFRun run) throws InvalidFormatException, IOException
      Attach this chart known by its relation id to the given text run.
      Parameters:
      chartRelId - the relation id of this chart in its parent document.
      run - the text run to which this chart will be inlined.
      Throws:
      InvalidFormatException
      IOException
      Since:
      POI 4.0.0
    • setChartHeight

      public void setChartHeight(long height)
      set chart height
      Parameters:
      height - height of chart
      Since:
      POI 4.0.0
    • setChartWidth

      public void setChartWidth(long width)
      set chart width
      Parameters:
      width - width of chart
      Since:
      POI 4.0.0
    • getChartHeight

      public long getChartHeight()
      get chart height
      Since:
      POI 4.0.0
    • getChartWidth

      public long getChartWidth()
      get chart width
      Since:
      POI 4.0.0
    • setChartBoundingBox

      public void setChartBoundingBox(long width, long height)
      set chart height and width
      Parameters:
      width - width of chart
      height - height of chart
      Since:
      POI 4.0.0
    • setChartTopMargin

      public void setChartTopMargin(long margin)
      set margin from top
      Parameters:
      margin - margin from top
      Since:
      POI 4.0.0
    • getChartTopMargin

      public long getChartTopMargin(long margin)
      get margin from Top
      Parameters:
      margin -
      Since:
      POI 4.0.0
    • setChartBottomMargin

      public void setChartBottomMargin(long margin)
      set margin from bottom
      Parameters:
      margin - margin from Bottom
      Since:
      POI 4.0.0
    • getChartBottomMargin

      public long getChartBottomMargin(long margin)
      get margin from Bottom
      Parameters:
      margin -
      Since:
      POI 4.0.0
    • setChartLeftMargin

      public void setChartLeftMargin(long margin)
      set margin from left
      Parameters:
      margin - margin from left
      Since:
      POI 4.0.0
    • getChartLeftMargin

      public long getChartLeftMargin(long margin)
      get margin from left
      Parameters:
      margin -
      Since:
      POI 4.0.0
    • setChartRightMargin

      public void setChartRightMargin(long margin)
      set margin from Right
      Parameters:
      margin - from right
      Since:
      POI 4.0.0
    • getChartRightMargin

      public long getChartRightMargin(long margin)
      get margin from Right
      Parameters:
      margin -
      Since:
      POI 4.0.0
    • setChartMargin

      public void setChartMargin(long top, long right, long bottom, long left)
      set chart margin
      Parameters:
      top - margin from top
      right - margin from right
      bottom - margin from bottom
      left - margin from left
      Since:
      POI 4.0.0