Package io.keikai.model

Interface SChart

All Known Implementing Classes:
AbstractChartAdv, ChartImpl
public interface SChart
Represents a chart in a sheet.
Since:
3.5.0
Author:
dennis

  • Method Details

    • getId

      String getId()

    • getSheet

      SSheet getSheet()

    • getType

      SChart.ChartType getType()

    • getData

      SChartData getData()

    • getAnchor

      ViewAnchor getAnchor()

    • setAnchor

      void setAnchor(ViewAnchor anchor)

    • getTitle

      String getTitle()

    • getXAxisTitle

      String getXAxisTitle()

    • getYAxisTitle

      String getYAxisTitle()

    • setTitle

      void setTitle(String title)

    • setXAxisTitle

      void setXAxisTitle(String xAxisTitle)

    • setYAxisTitle

      void setYAxisTitle(String yAxisTitle)

    • getTitleFormula

      default String getTitleFormula()
      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".

      Since:
      7.0.0

    • setTitleFormula

      default void setTitleFormula(String formula)
      Binds the chart title to a worksheet cell. When set, 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.

      Since:
      7.0.0

    • getXAxisTitleFormula

      default String getXAxisTitleFormula()
      Returns the formula backing the category (X) axis title, or null.
      Since:
      7.0.0

    • setXAxisTitleFormula

      default void setXAxisTitleFormula(String formula)
      Binds the category (X) axis title to a worksheet cell. (KEIKAI-787)
      Since:
      7.0.0

    • getYAxisTitleFormula

      default String getYAxisTitleFormula()
      Returns the formula backing the value (Y) axis title, or null.
      Since:
      7.0.0

    • setYAxisTitleFormula

      default void setYAxisTitleFormula(String formula)
      Binds the value (Y) axis title to a worksheet cell. (KEIKAI-787)
      Since:
      7.0.0

    • setLegendPosition

      void setLegendPosition(SChart.ChartLegendPosition pos)

    • getLegendPosition

      SChart.ChartLegendPosition getLegendPosition()

    • setGrouping

      void setGrouping(SChart.ChartGrouping grouping)

    • getGrouping

      SChart.ChartGrouping getGrouping()

    • getBarDirection

      SChart.BarDirection getBarDirection()

    • isThreeD

      boolean isThreeD()

    • setThreeD

      void setThreeD(boolean threeD)

    • getValueAxises

      List<SChartAxis> getValueAxises()

    • getCategoryAxises

      List<SChartAxis> getCategoryAxises()

    • getDateAxises

      List<SChartAxis> getDateAxises()

    • addValueAxis

      void addValueAxis(SChartAxis axis)

    • addCategoryAxis

      void addCategoryAxis(SChartAxis axis)

    • addDateAxis

      void addDateAxis(SChartAxis axis)

    • getRotX

      int getRotX()

    • setRotX

      void setRotX(int rotX)

    • getRotY

      int getRotY()

    • setRotY

      void setRotY(int rotY)

    • getPerspective

      int getPerspective()

    • setPerspective

      void setPerspective(int perspective)

    • getHPercent

      int getHPercent()

    • setHPercent

      void setHPercent(int percent)

    • getDepthPercent

      int getDepthPercent()

    • setDepthPercent

      void setDepthPercent(int percent)

    • isRightAngleAxes

      boolean isRightAngleAxes()

    • setRightAngleAxes

      void setRightAngleAxes(boolean b)

    • getBarOverlap

      int getBarOverlap()

    • setBarOverlap

      void setBarOverlap(int overlap)

    • setPlotOnlyVisibleCells

      void setPlotOnlyVisibleCells(boolean plotOnlyVisibleCells)

    • isPlotOnlyVisibleCells

      boolean isPlotOnlyVisibleCells()

    • setEmptyAsGaps

      void setEmptyAsGaps(boolean emptyAsGaps)

    • isEmptyAsGaps

      boolean isEmptyAsGaps()

    • setSparkline

      void setSparkline(boolean sparkline)

    • isSparkline

      boolean isSparkline()

    • setWinloseSpark

      void setWinloseSpark(boolean winlose)

    • isWinloseSpark

      boolean isWinloseSpark()

    • getName

      String getName()
      Returns the name.
      Returns:
      name
      Since:
      6.2.0

    • setName

      void setName(String name)
      Sets the name.
      Since:
      6.2.0

    • getChartAreaFill

      SColor getChartAreaFill()
      Returns the chart-area (chart frame) fill colour, or null when the source uses the application default. KEIKAI-520.
      Since:
      7.0.0

    • setChartAreaFill

      void setChartAreaFill(SColor color)
      Sets the chart-area (chart frame) fill colour. KEIKAI-520.
      Since:
      7.0.0

    • getChartAreaLineColor

      SColor getChartAreaLineColor()
      Returns the chart-area (chart frame) border/line colour, or null when the source uses the application default. KEIKAI-520.
      Since:
      7.0.0

    • setChartAreaLineColor

      void setChartAreaLineColor(SColor color)
      Sets the chart-area (chart frame) border/line colour. KEIKAI-520.
      Since:
      7.0.0

    • isChartAreaNoLine

      boolean isChartAreaNoLine()
      Returns true when the chart-area frame border is explicitly suppressed (OOXML <a:ln><a:noFill/></a:ln>). KEIKAI-520.
      Since:
      7.0.0

    • setChartAreaNoLine

      void setChartAreaNoLine(boolean noLine)
      Sets whether the chart-area frame border is explicitly suppressed. KEIKAI-520.
      Since:
      7.0.0