Package org.apache.poi.xwpf.usermodel

Class XWPFChart

  • All Implemented Interfaces:
    org.apache.poi.xddf.usermodel.text.TextContainer
    @Beta
public class XWPFChart
extends org.apache.poi.xddf.usermodel.chart.XDDFChart
    Represents a Chart in a .docx file

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

        org.apache.poi.ooxml.POIXMLDocumentPart.RelationPart

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DEFAULT_HEIGHT
      default height of chart in emu
      static int DEFAULT_WIDTH
      default width of chart in emu

      • Fields inherited from class org.apache.poi.xddf.usermodel.chart.XDDFChart

        DEFAULT_X, DEFAULT_Y

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      long getChartBottomMargin​(long margin)
      get margin from Bottom
      long getChartHeight()
      get chart height
      long getChartLeftMargin​(long margin)
      get margin from left
      long getChartRightMargin​(long margin)
      get margin from Right
      long getChartTopMargin​(long margin)
      get margin from Top
      long getChartWidth()
      get chart width
      java.lang.Long getChecksum()  
      int hashCode()  
      void setChartBottomMargin​(long margin)
      set margin from bottom
      void setChartBoundingBox​(long width, long height)
      set chart height and width
      void setChartHeight​(long height)
      set chart height
      void setChartLeftMargin​(long margin)
      set margin from left
      void setChartMargin​(long top, long right, long bottom, long left)
      set chart margin
      void setChartRightMargin​(long margin)
      set margin from Right
      void setChartTopMargin​(long margin)
      set margin from top
      void setChartWidth​(long width)
      set chart width

      • Methods inherited from class org.apache.poi.xddf.usermodel.chart.XDDFChart

        clear, clearChartSeries, createCategoryAxis, createData, createDateAxis, createRelationshipInChart, createSeriesAxis, createValueAxis, deleteLegend, deleteShapeProperties, displayBlanksAs, findDefinedParagraphProperty, findDefinedRunProperty, formatRange, getAxes, getChartSeries, getCTChart, getCTChartSpace, getFormattedTitle, getOrAddLegend, getOrAddManualLayout, getOrAddShapeProperties, getOrAddView3D, getTitle, getTitleOverlay, getWorkbook, importContent, isPlotOnlyVisibleCells, plot, saveWorkbook, setAutoTitleDeleted, setBackWall, setChartIndex, setExternalId, setFloor, setPlotOnlyVisibleCells, setSheetTitle, setSideWall, setTitleOverlay, setTitleText, setValueRange, setWorkbook

      • Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

        _invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, isCommited, isCommitted, setCommited, setCommitted, toString

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • DEFAULT_WIDTH

        public static final int DEFAULT_WIDTH
        default width of chart in emu
        See Also:
        Constant Field Values

      • DEFAULT_HEIGHT

        public static final int DEFAULT_HEIGHT
        default height of chart in emu
        See Also:
        Constant Field Values

    • Method Detail

      • getChecksum

        public java.lang.Long getChecksum()

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • 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