Class ChartImpl

All Implemented Interfaces:
LinkedModelObject, SChart, Serializable

public class ChartImpl extends AbstractChartAdv
Since:
3.5.0
Author:
dennis
See Also:
  • Constructor Details

  • Method Details

    • getSheet

      public SSheet getSheet()
    • getId

      public String getId()
    • getAnchor

      public ViewAnchor getAnchor()
    • setAnchor

      public void setAnchor(ViewAnchor anchor)
    • getType

      public SChart.ChartType getType()
    • getData

      public SChartData getData()
    • getTitle

      public String getTitle()
    • setTitle

      public void setTitle(String title)
    • getXAxisTitle

      public String getXAxisTitle()
    • setXAxisTitle

      public void setXAxisTitle(String xAxisTitle)
    • getYAxisTitle

      public String getYAxisTitle()
    • setYAxisTitle

      public void setYAxisTitle(String yAxisTitle)
    • getTitleFormula

      public String getTitleFormula()
      Description copied from interface: SChart
      Returns the formula (a cell reference such as Sheet1!$A$1) backing the chart title, or null when the title is a plain literal.

      Declared default for backward compatibility: existing SChart implementations that predate KEIKAI-787 keep compiling and report "no formula".

    • setTitleFormula

      public void setTitleFormula(String formula)
      Description copied from interface: SChart
      Binds the chart title to a worksheet cell. When set, SChart.getTitle() returns the evaluated value of formula. Pass null to clear the binding and fall back to the literal title. (KEIKAI-787)

      The default implementation throws UnsupportedOperationException; implementations that support formula-backed titles (e.g. ChartImpl) override it.

    • getXAxisTitleFormula

      public String getXAxisTitleFormula()
      Description copied from interface: SChart
      Returns the formula backing the category (X) axis title, or null.
    • setXAxisTitleFormula

      public void setXAxisTitleFormula(String formula)
      Description copied from interface: SChart
      Binds the category (X) axis title to a worksheet cell. (KEIKAI-787)
    • getYAxisTitleFormula

      public String getYAxisTitleFormula()
      Description copied from interface: SChart
      Returns the formula backing the value (Y) axis title, or null.
    • setYAxisTitleFormula

      public void setYAxisTitleFormula(String formula)
      Description copied from interface: SChart
      Binds the value (Y) axis title to a worksheet cell. (KEIKAI-787)
    • destroy

      public void destroy()
      Description copied from interface: LinkedModelObject
      Destroy / release this model object, for example all the dependency, parent linking. this method has to be called before remove this linking from parent object
    • checkOrphan

      public void checkOrphan()
    • getLegendPosition

      public SChart.ChartLegendPosition getLegendPosition()
    • setLegendPosition

      public void setLegendPosition(SChart.ChartLegendPosition pos)
    • getGrouping

      public SChart.ChartGrouping getGrouping()
    • setGrouping

      public void setGrouping(SChart.ChartGrouping grouping)
    • getBarDirection

      public SChart.BarDirection getBarDirection()
    • isThreeD

      public boolean isThreeD()
    • setThreeD

      public void setThreeD(boolean threeD)
    • isEmptyAsGaps

      public boolean isEmptyAsGaps()
    • setEmptyAsGaps

      public void setEmptyAsGaps(boolean emptyAsGaps)
    • isSparkline

      public boolean isSparkline()
    • setSparkline

      public void setSparkline(boolean sparkline)
    • isWinloseSpark

      public boolean isWinloseSpark()
    • setWinloseSpark

      public void setWinloseSpark(boolean winlose)
    • addValueAxis

      public void addValueAxis(SChartAxis axis)
    • addCategoryAxis

      public void addCategoryAxis(SChartAxis axis)
    • addDateAxis

      public void addDateAxis(SChartAxis axis)
    • getValueAxises

      public List<SChartAxis> getValueAxises()
    • getCategoryAxises

      public List<SChartAxis> getCategoryAxises()
    • getDateAxises

      public List<SChartAxis> getDateAxises()
    • getRotX

      public int getRotX()
    • setRotX

      public void setRotX(int rotX)
    • getRotY

      public int getRotY()
    • setRotY

      public void setRotY(int rotY)
    • getPerspective

      public int getPerspective()
    • setPerspective

      public void setPerspective(int perspective)
    • getHPercent

      public int getHPercent()
    • setHPercent

      public void setHPercent(int percent)
    • getDepthPercent

      public int getDepthPercent()
    • setDepthPercent

      public void setDepthPercent(int percent)
    • isRightAngleAxes

      public boolean isRightAngleAxes()
    • setRightAngleAxes

      public void setRightAngleAxes(boolean b)
    • getBarOverlap

      public int getBarOverlap()
    • setBarOverlap

      public void setBarOverlap(int overlap)
    • isPlotOnlyVisibleCells

      public boolean isPlotOnlyVisibleCells()
    • setPlotOnlyVisibleCells

      public void setPlotOnlyVisibleCells(boolean plotOnlyVisibleCells)
    • getSeriesColors

      public List<SColor> getSeriesColors()
      Description copied from class: AbstractChartAdv
      Gets the default colors for series
      Specified by:
      getSeriesColors in class AbstractChartAdv
    • setSeriesColors

      public void setSeriesColors(List<SColor> colors)
      Description copied from class: AbstractChartAdv
      Sets the default colors for series. When all colors are used, rollback to beginning again.
      Specified by:
      setSeriesColors in class AbstractChartAdv
    • getChartData

      public List<SChartData> getChartData()
      Specified by:
      getChartData in class AbstractChartAdv
    • createChartData

      public SChartData createChartData(SChart.ChartType type)
      Description copied from class: AbstractChartAdv
      this method will return specified chart data with category and series values
      Specified by:
      createChartData in class AbstractChartAdv
      Parameters:
      type - chart type
      Returns:
      specified chart data.
    • addChartData

      public void addChartData(SChartData chartData)
      Specified by:
      addChartData in class AbstractChartAdv
    • isAutoTitleDeleted

      public Boolean isAutoTitleDeleted()
      Specified by:
      isAutoTitleDeleted in class AbstractChartAdv
    • setAutoTitleDeleted

      public void setAutoTitleDeleted(Boolean autoTitleDeleted)
      Specified by:
      setAutoTitleDeleted in class AbstractChartAdv
    • isShowTitle

      public boolean isShowTitle()
      Specified by:
      isShowTitle in class AbstractChartAdv
    • setShowTitle

      public void setShowTitle(boolean showTitle)
      Specified by:
      setShowTitle in class AbstractChartAdv
    • isShowDataLabelsOverMax

      public boolean isShowDataLabelsOverMax()
      Specified by:
      isShowDataLabelsOverMax in class AbstractChartAdv
    • setShowDataLabelsOverMax

      public void setShowDataLabelsOverMax(boolean showDataLabelsOverMax)
      Specified by:
      setShowDataLabelsOverMax in class AbstractChartAdv
    • setSparklineNegativePointVisible

      public void setSparklineNegativePointVisible(boolean visible)
      Specified by:
      setSparklineNegativePointVisible in class AbstractChartAdv
    • isSparklineNegativePointVisible

      public boolean isSparklineNegativePointVisible()
      Specified by:
      isSparklineNegativePointVisible in class AbstractChartAdv
    • setSparklineFirstPointVisible

      public void setSparklineFirstPointVisible(boolean visible)
      Specified by:
      setSparklineFirstPointVisible in class AbstractChartAdv
    • isSparklineFirstPointVisible

      public boolean isSparklineFirstPointVisible()
      Specified by:
      isSparklineFirstPointVisible in class AbstractChartAdv
    • setSparklineLastPointVisible

      public void setSparklineLastPointVisible(boolean visible)
      Specified by:
      setSparklineLastPointVisible in class AbstractChartAdv
    • isSparklineLastPointVisible

      public boolean isSparklineLastPointVisible()
      Specified by:
      isSparklineLastPointVisible in class AbstractChartAdv
    • setSparklineHighPointVisible

      public void setSparklineHighPointVisible(boolean visible)
      Specified by:
      setSparklineHighPointVisible in class AbstractChartAdv
    • isSparklineHighPointVisible

      public boolean isSparklineHighPointVisible()
      Specified by:
      isSparklineHighPointVisible in class AbstractChartAdv
    • setSparklineLowPointVisible

      public void setSparklineLowPointVisible(boolean visible)
      Specified by:
      setSparklineLowPointVisible in class AbstractChartAdv
    • isSparklineLowPointVisible

      public boolean isSparklineLowPointVisible()
      Specified by:
      isSparklineLowPointVisible in class AbstractChartAdv
    • setSparklineMarkerVisible

      public void setSparklineMarkerVisible(boolean visible)
      Specified by:
      setSparklineMarkerVisible in class AbstractChartAdv
    • isSparklineMarkerVisible

      public boolean isSparklineMarkerVisible()
      Specified by:
      isSparklineMarkerVisible in class AbstractChartAdv
    • setSparklineSeriesColor

      public void setSparklineSeriesColor(SColor color)
      Specified by:
      setSparklineSeriesColor in class AbstractChartAdv
    • getSparklineSeriesColor

      public SColor getSparklineSeriesColor()
      Specified by:
      getSparklineSeriesColor in class AbstractChartAdv
    • setSparklineNegativePointColor

      public void setSparklineNegativePointColor(SColor color)
      Specified by:
      setSparklineNegativePointColor in class AbstractChartAdv
    • getSparklineNegativePointColor

      public SColor getSparklineNegativePointColor()
      Specified by:
      getSparklineNegativePointColor in class AbstractChartAdv
    • setSparklineFirstPointColor

      public void setSparklineFirstPointColor(SColor color)
      Specified by:
      setSparklineFirstPointColor in class AbstractChartAdv
    • getSparklineFirstPointColor

      public SColor getSparklineFirstPointColor()
      Specified by:
      getSparklineFirstPointColor in class AbstractChartAdv
    • setSparklineLastPointColor

      public void setSparklineLastPointColor(SColor color)
      Specified by:
      setSparklineLastPointColor in class AbstractChartAdv
    • getSparklineLastPointColor

      public SColor getSparklineLastPointColor()
      Specified by:
      getSparklineLastPointColor in class AbstractChartAdv
    • setSparklineHighPointColor

      public void setSparklineHighPointColor(SColor color)
      Specified by:
      setSparklineHighPointColor in class AbstractChartAdv
    • getSparklineHighPointColor

      public SColor getSparklineHighPointColor()
      Specified by:
      getSparklineHighPointColor in class AbstractChartAdv
    • setSparklineLowPointColor

      public void setSparklineLowPointColor(SColor color)
      Specified by:
      setSparklineLowPointColor in class AbstractChartAdv
    • getSparklineLowPointColor

      public SColor getSparklineLowPointColor()
      Specified by:
      getSparklineLowPointColor in class AbstractChartAdv
    • setSparklineMarkerColor

      public void setSparklineMarkerColor(SColor color)
      Specified by:
      setSparklineMarkerColor in class AbstractChartAdv
    • getSparklineMarkerColor

      public SColor getSparklineMarkerColor()
      Specified by:
      getSparklineMarkerColor in class AbstractChartAdv
    • getName

      public String getName()
      Description copied from interface: SChart
      Returns the name.
      Returns:
      name
    • setName

      public void setName(String name)
      Description copied from interface: SChart
      Sets the name.
    • getChartAreaFill

      public SColor getChartAreaFill()
      Description copied from interface: SChart
      Returns the chart-area (chart frame) fill colour, or null when the source uses the application default. KEIKAI-520.
    • setChartAreaFill

      public void setChartAreaFill(SColor color)
      Description copied from interface: SChart
      Sets the chart-area (chart frame) fill colour. KEIKAI-520.
    • getChartAreaLineColor

      public SColor getChartAreaLineColor()
      Description copied from interface: SChart
      Returns the chart-area (chart frame) border/line colour, or null when the source uses the application default. KEIKAI-520.
    • setChartAreaLineColor

      public void setChartAreaLineColor(SColor color)
      Description copied from interface: SChart
      Sets the chart-area (chart frame) border/line colour. KEIKAI-520.
    • isChartAreaNoLine

      public boolean isChartAreaNoLine()
      Description copied from interface: SChart
      Returns true when the chart-area frame border is explicitly suppressed (OOXML <a:ln><a:noFill/></a:ln>). KEIKAI-520.
    • setChartAreaNoLine

      public void setChartAreaNoLine(boolean noLine)
      Description copied from interface: SChart
      Sets whether the chart-area frame border is explicitly suppressed. KEIKAI-520.