Package org.apache.poi.xddf.usermodel.chart

Class XDDFChart

    • 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

      • DEFAULT_X

        public static final int DEFAULT_X
        default x-coordinate of chart in emu
        See Also:
        Constant Field Values

      • DEFAULT_Y

        public static final int DEFAULT_Y
        default y-coordinate value of chart in emu
        See Also:
        Constant Field Values

      • chartSpace

        protected final org.openxmlformats.schemas.drawingml.x2006.chart.CTChartSpace chartSpace
        Root element of the Chart part

    • Constructor Detail

      • XDDFChart

        protected XDDFChart()
        Construct a chart.

      • XDDFChart

        protected XDDFChart​(PackagePart part)
             throws IOException,
                    XmlException
        Construct a DrawingML 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
        XmlException
        Since:
        POI 3.14-Beta1

    • Method Detail

      • getCTChartSpace

        @Internal
public org.openxmlformats.schemas.drawingml.x2006.chart.CTChartSpace getCTChartSpace()
        Return the underlying CTChartSpace bean, the root element of the Chart part.
        Returns:
        the underlying CTChartSpace bean

      • getCTChart

        @Internal
public org.openxmlformats.schemas.drawingml.x2006.chart.CTChart getCTChart()
        Return the underlying CTChart bean, within the Chart Space
        Returns:
        the underlying CTChart bean

      • getCTPlotArea

        @Internal
protected org.openxmlformats.schemas.drawingml.x2006.chart.CTPlotArea getCTPlotArea()
        Return the underlying CTPlotArea bean, within the Chart
        Returns:
        the underlying CTPlotArea bean

      • clear

        public void clear()
        Clear all properties, as if a new instance had just been created.
        Since:
        POI 4.1.2

      • isPlotOnlyVisibleCells

        public boolean isPlotOnlyVisibleCells()
        Returns:
        true if only visible cells will be present on the chart, false otherwise

      • setPlotOnlyVisibleCells

        public void setPlotOnlyVisibleCells​(boolean only)
        Parameters:
        only - a flag specifying if only visible cells should be present on the chart

      • setFloor

        public void setFloor​(int thickness)

      • setBackWall

        public void setBackWall​(int thickness)

      • setSideWall

        public void setSideWall​(int thickness)

      • setAutoTitleDeleted

        public void setAutoTitleDeleted​(boolean deleted)

      • displayBlanksAs

        public void displayBlanksAs​(DisplayBlanks as)
        Since:
        4.0.1

      • getTitleOverlay

        public Boolean getTitleOverlay()
        Since:
        4.0.1

      • setTitleOverlay

        public void setTitleOverlay​(boolean overlay)
        Since:
        4.0.1

      • setTitleText

        public void setTitleText​(String text)
        Sets the title text as a static string.
        Parameters:
        text - to use as new title
        Since:
        4.0.1

      • getTitle

        public XDDFTitle getTitle()
        Since:
        4.0.1

      • removeTitle

        public void removeTitle()
        Remove the chart title.
        Since:
        POI 5.0.0

      • getOrAddView3D

        public XDDFView3D getOrAddView3D()
        Get or Add chart 3D view into chart
        Returns:
        this method will add 3D view

      • getFormattedTitle

        @Beta
public XDDFTextBody getFormattedTitle()
        Get the chart title body if there is one, i.e. title is set and is not a formula.
        Returns:
        text body or null, if title is a formula or no title is set.

      • findDefinedParagraphProperty

        public <R> Optional<R> findDefinedParagraphProperty​(Predicate<org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraphProperties> isSet,
                                                    Function<org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraphProperties,​R> getter)
        Specified by:
        findDefinedParagraphProperty in interface TextContainer

      • findDefinedRunProperty

        public <R> Optional<R> findDefinedRunProperty​(Predicate<org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties> isSet,
                                              Function<org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties,​R> getter)
        Specified by:
        findDefinedRunProperty in interface TextContainer

      • deleteShapeProperties

        public void deleteShapeProperties()

      • deleteLegend

        public void deleteLegend()

      • incrementSeriesCount

        protected long incrementSeriesCount()

      • clearChartSeries

        public void clearChartSeries()
        Clear all chart series, as if a new instance had just been created.
        Since:
        POI 4.1.2

      • createSeriesAxis

        public XDDFSeriesAxis createSeriesAxis​(AxisPosition pos)
        this method will return series axis with specified position
        Parameters:
        pos - axis position Left, Right, Top, Bottom
        Returns:
        series axis with specified position

      • createData

        public XDDFChartData createData​(ChartTypes type,
                                XDDFChartAxis category,
                                XDDFValueAxis values)
        this method will return specified chart data with category and series values
        Parameters:
        type - chart type
        category - category values of chart
        values - series values of chart
        Returns:
        specified chart data.

      • setValueRange

        public void setValueRange​(int axisIndex,
                          Double minimum,
                          Double maximum,
                          Double majorUnit,
                          Double minorUnit)
        Set value range (basic Axis Options)
        Parameters:
        axisIndex - 0 - primary axis, 1 - secondary axis
        minimum - minimum value; Double.NaN - automatic; null - no change
        maximum - maximum value; Double.NaN - automatic; null - no change
        majorUnit - major unit value; Double.NaN - automatic; null - no change
        minorUnit - minor unit value; Double.NaN - automatic; null - no change

      • createRelationshipInChart

        public PackageRelationship createRelationshipInChart​(POIXMLRelation chartRelation,
                                                     POIXMLFactory chartFactory,
                                                     int chartIndex)
        method to create relationship with embedded part for example writing xlsx file stream into output stream
        Parameters:
        chartRelation - relationship object
        chartFactory - ChartFactory object
        chartIndex - index used to suffix on file
        Returns:
        return relation part which used to write relation in .rels file and get relation id
        Since:
        POI 4.0.0

      • getChartRelation

        protected abstract POIXMLRelation getChartRelation()
        Returns:
        the chart relation in the implementing subclass.
        Since:
        POI 4.0.0

      • getChartWorkbookRelation

        protected abstract POIXMLRelation getChartWorkbookRelation()
        Returns:
        the chart workbook relation in the implementing subclass.
        Since:
        POI 4.0.0

      • getChartFactory

        protected abstract POIXMLFactory getChartFactory()
        Returns:
        the chart factory in the implementing subclass.
        Since:
        POI 4.0.0

      • fillSheet

        protected void fillSheet​(XSSFSheet sheet,
                         XDDFDataSource<?> categoryData,
                         XDDFNumericalDataSource<?> valuesData)
        this method writes the data into sheet
        Parameters:
        sheet - sheet of embedded excel
        categoryData - category values
        valuesData - data values
        Since:
        POI 4.0.0

      • importContent

        public void importContent​(XDDFChart other)
        import content from other chart to created chart
        Parameters:
        other - chart object
        Since:
        POI 4.0.0

      • setSheetTitle

        public CellReference setSheetTitle​(String title,
                                   int column)
        set sheet title in excel file
        Parameters:
        title - title of sheet
        column - column index
        Returns:
        return cell reference
        Since:
        POI 4.0.0

      • setWorkbook

        public void setWorkbook​(XSSFWorkbook workbook)
        while reading chart from template file then we need to parse and store embedded excel file in chart object show that we can modify value according to use
        Parameters:
        workbook - workbook object which we read from chart embedded part
        Since:
        POI 4.0.0

      • setExternalId

        public void setExternalId​(String id)
        set the relation id of embedded excel relation id into external data relation tag
        Parameters:
        id - relation id of embedded excel relation id into external data relation tag
        Since:
        POI 4.0.0

      • getChartIndex

        protected int getChartIndex()
        Returns:
        method return chart index
        Since:
        POI 4.0.0

      • setChartIndex

        public void setChartIndex​(int chartIndex)
        Set chart index which can be used for relation part.
        Parameters:
        chartIndex - chart index which can be used for relation part.

      • replaceReferences

        public void replaceReferences​(XSSFSheet newSheet)
        Replace references to the sheet name in the data supporting the chart.
        Parameters:
        newSheet - sheet to be used in the data references.
        Since:
        POI 5.1.0