Chart (Simple ODS library 1.7.0 API)

java.lang.Object
- com.github.miachm.sods.Chart

```
public class Chart
extends Object
```
Represents a chart embedded in a Sheet. Charts in SODS store metadata such as title, footer, legend configuration, and range addresses used to pull data from the sheet. This object does not perform rendering; it captures the information required to serialize the chart into the ODS output.

Constructor Summary

Constructors
Constructor and Description

Chart()

Constructors
Constructor and Description
`Chart()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCategory(Object category)` Adds a category value to this chart.
`void`	`addData(String data)` Adds a data range address to this chart.
`void`	`addSeries(ChartSeries series)` Adds a series to this chart.
`List<Object>`	`getCategories()` Returns the category values used by the chart.
`String`	`getCategoriesRangeAddress()` Returns the A1 range address for the categories.
`Range`	`getCategoriesRangeObject()` Resolves the categories range address into a `Range`.
`List<String>`	`getData()` Returns the data ranges used by the chart.
`String`	`getFooter()` Returns the chart footer text.
`String`	`getHeight()` Returns the chart height.
`String`	`getLegend()` Returns the legend configuration string.
`ChartStyle`	`getPlotAreaStyle()` Returns the plot area style.
`List<ChartSeries>`	`getSeries()` Returns the series list associated with this chart.
`Sheet`	`getSheet()` Returns the sheet that owns this chart.
`ChartStyle`	`getStyle()` Returns the chart style.
`String`	`getTitle()` Returns the chart title.
`String`	`getType()` Returns the chart type identifier.
`ChartStyle`	`getWallStyle()` Returns the wall style.
`String`	`getWidth()` Returns the chart width.
`String`	`getX()` Returns the X position.
`ChartAxis`	`getXAxis()` Returns the X axis configuration.
`String`	`getXAxisLabel()` Returns the label for the X axis.
`String`	`getY()` Returns the Y position.
`ChartAxis`	`getYAxis()` Returns the Y axis configuration.
`String`	`getYAxisLabel()` Returns the label for the Y axis.
`boolean`	`isDisplayLabel()` Returns whether labels are displayed.
`boolean`	`isShowWall()` Returns whether the wall is displayed.
`void`	`setCategoriesRangeAddress(String categoriesRangeAddress)` Sets the A1 range address for categories.
`void`	`setDisplayLabel(boolean displayLabel)` Enables or disables label display.
`void`	`setFooter(String footer)` Sets the chart footer text.
`void`	`setHeight(String height)` Sets the chart height.
`void`	`setLegend(String legend)` Sets the legend configuration value.
`void`	`setPlotAreaStyle(ChartStyle plotAreaStyle)` Sets the plot area style.
`void`	`setShowWall(boolean showWall)` Enables or disables wall display.
`void`	`setStyle(ChartStyle style)` Sets the chart style.
`void`	`setTitle(String title)` Sets the chart title.
`void`	`setType(String type)` Sets the chart type identifier.
`void`	`setWallStyle(ChartStyle wallStyle)` Sets the wall style.
`void`	`setWidth(String width)` Sets the chart width.
`void`	`setX(String x)` Sets the X position.
`void`	`setXAxisLabel(String xAxisLabel)` Sets the label for the X axis.
`void`	`setY(String y)` Sets the Y position.
`void`	`setYAxisLabel(String yAxisLabel)` Sets the label for the Y axis.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Chart
```
public Chart()
```
- Method Detail
  - getType
```
public String getType()
```
    Returns the chart type identifier. The type is the ODS chart kind (for example, bar, line, or pie) as stored in the document. It is used by the writer to determine how to serialize the chart.
    
    Returns:
    
    The chart type.
  - getTitle
```
public String getTitle()
```
    Returns the chart title. The title is typically displayed at the top of the chart and provides a short description of the data being visualized.
    
    Returns:
    
    The title text.
  - getFooter
```
public String getFooter()
```
    Returns the chart footer text. The footer is a secondary text area usually shown below the chart. It is commonly used for data source notes or additional context.
    
    Returns:
    
    The footer text.
  - getLegend
```
public String getLegend()
```
    Returns the legend configuration string. The legend describes the mapping between series and their visual styles (colors, markers). This value controls how the legend is represented in the output document.
    
    Returns:
    
    The legend value.
  - getData
```
public List<String> getData()
```
    Returns the data ranges used by the chart. Each entry is an A1-style String range address that points to a block of values in the sheet. These addresses are used by the writer to link chart series to sheet cells.
    
    Returns:
    
    The data range list.
  - getCategories
```
public List<Object> getCategories()
```
    Returns the category values used by the chart. Categories are the labels that appear along the category axis (for example, months or product names).
    
    Returns:
    
    An unmodifiable list of category values.
  - getCategoriesRangeAddress
```
public String getCategoriesRangeAddress()
```
    Returns the A1 range address for the categories. This address points to the cells that contain category labels (typically the X-axis labels).
    
    Returns:
    
    The range address.
  - getCategoriesRangeObject
```
public Range getCategoriesRangeObject()
```
    Resolves the categories range address into a Range. This is a convenience method that looks up the range against the owning sheet, if present.
    
    Returns:
    
    The categories range, or null if it cannot be resolved.
  - getSeries
```
public List<ChartSeries> getSeries()
```
    Returns the series list associated with this chart. Each series corresponds to a plotted dataset and contains its own range addresses and style configuration.
    
    Returns:
    
    An unmodifiable list of series.
  - getSheet
```
public Sheet getSheet()
```
    Returns the sheet that owns this chart. This link is set when a chart is added to a sheet and is used to resolve range addresses.
    
    Returns:
    
    The parent sheet.
  - getWidth
```
public String getWidth()
```
    Returns the chart width. This is a serialized size value (for example, "8cm") stored in the document for layout purposes.
    
    Returns:
    
    The width value.
  - getHeight
```
public String getHeight()
```
    Returns the chart height. This is a serialized size value (for example, "6cm") stored in the document for layout purposes.
    
    Returns:
    
    The height value.
  - getX
```
public String getX()
```
    Returns the X position. This is the horizontal offset used to place the chart within the sheet.
    
    Returns:
    
    The X position value.
  - getY
```
public String getY()
```
    Returns the Y position. This is the vertical offset used to place the chart within the sheet.
    
    Returns:
    
    The Y position value.
  - getXAxisLabel
```
public String getXAxisLabel()
```
    Returns the label for the X axis. Axis labels are descriptive captions shown next to the axis to clarify what the axis values represent.
    
    Returns:
    
    The X axis label.
  - getYAxisLabel
```
public String getYAxisLabel()
```
    Returns the label for the Y axis. Axis labels are descriptive captions shown next to the axis to clarify what the axis values represent.
    
    Returns:
    
    The Y axis label.
  - isDisplayLabel
```
public boolean isDisplayLabel()
```
    Returns whether labels are displayed. Labels typically refer to data point labels or series labels that can be shown directly on the chart.
    
    Returns:
    
    True if labels are displayed.
  - getStyle
```
public ChartStyle getStyle()
```
    Returns the chart style. This style groups chart, graphic, and text properties applied at the chart level. It's safe to manipulate the returned style since it is a copy. Call setStyle(ChartStyle) to apply changes.
    
    Returns:
    
    A copy of the chart style.
  - getPlotAreaStyle
```
public ChartStyle getPlotAreaStyle()
```
    Returns the plot area style. The plot area is the region where data series are drawn. Styles here affect the background and borders of that region. It's safe to manipulate the returned style since it is a copy. Call setPlotAreaStyle(ChartStyle) to apply changes.
    
    Returns:
    
    A copy of the plot area style.
  - getWallStyle
```
public ChartStyle getWallStyle()
```
    Returns the wall style. The wall is the back plane used in 3D charts. Styles here affect its appearance. It's safe to manipulate the returned style since it is a copy. Call setWallStyle(ChartStyle) to apply changes.
    
    Returns:
    
    A copy of the wall style.
  - getXAxis
```
public ChartAxis getXAxis()
```
    Returns the X axis configuration. This provides access to style information for the horizontal axis.
    
    Returns:
    
    The X axis.
  - getYAxis
```
public ChartAxis getYAxis()
```
    Returns the Y axis configuration. This provides access to style information for the vertical axis.
    
    Returns:
    
    The Y axis.
  - isShowWall
```
public boolean isShowWall()
```
    Returns whether the wall is displayed. The wall is a background plane used mainly for 3D charts.
    
    Returns:
    
    True if the wall is displayed.
  - setType
```
public void setType(String type)
```
    Sets the chart type identifier. The type is stored as an ODS chart kind and determines how the chart will be serialized.
    
    Parameters:
    
    type - The chart type.
  - setTitle
```
public void setTitle(String title)
```
    Sets the chart title. The title is typically displayed at the top of the chart.
    
    Parameters:
    
    title - The title text.
  - setFooter
```
public void setFooter(String footer)
```
    Sets the chart footer text. The footer is a secondary text area used for notes or data sources.
    
    Parameters:
    
    footer - The footer text.
  - setLegend
```
public void setLegend(String legend)
```
    Sets the legend configuration value. The legend is used to identify series and their styling.
    
    Parameters:
    
    legend - The legend value.
  - addData
```
public void addData(String data)
```
    Adds a data range address to this chart. Data ranges point to the sheet cells that provide values for plotting.
    
    Parameters:
    
    data - The range address.
  - addCategory
```
public void addCategory(Object category)
```
    Adds a category value to this chart. Categories define the labels along the category axis.
    
    Parameters:
    
    category - The category value.
  - setCategoriesRangeAddress
```
public void setCategoriesRangeAddress(String categoriesRangeAddress)
```
    Sets the A1 range address for categories. The address should reference cells that contain category labels.
    
    Parameters:
    
    categoriesRangeAddress - The range address.
  - addSeries
```
public void addSeries(ChartSeries series)
```
    Adds a series to this chart. Series define the plotted datasets and their styling. The chart will set itself as the series owner so ranges can be resolved.
    
    Parameters:
    
    series - The series to add. If null, it is ignored.
  - setWidth
```
public void setWidth(String width)
```
    Sets the chart width. The value is stored as a serialized size (for example, "8cm").
    
    Parameters:
    
    width - The width value.
  - setHeight
```
public void setHeight(String height)
```
    Sets the chart height. The value is stored as a serialized size (for example, "6cm").
    
    Parameters:
    
    height - The height value.
  - setX
```
public void setX(String x)
```
    Sets the X position. This value controls the horizontal placement of the chart in the sheet.
    
    Parameters:
    
    x - The X position value.
  - setY
```
public void setY(String y)
```
    Sets the Y position. This value controls the vertical placement of the chart in the sheet.
    
    Parameters:
    
    y - The Y position value.
  - setXAxisLabel
```
public void setXAxisLabel(String xAxisLabel)
```
    Sets the label for the X axis. Axis labels help users understand what the axis values represent.
    
    Parameters:
    
    xAxisLabel - The label text.
  - setYAxisLabel
```
public void setYAxisLabel(String yAxisLabel)
```
    Sets the label for the Y axis. Axis labels help users understand what the axis values represent.
    
    Parameters:
    
    yAxisLabel - The label text.
  - setDisplayLabel
```
public void setDisplayLabel(boolean displayLabel)
```
    Enables or disables label display. Labels typically refer to value labels or series labels shown directly on the chart.
    
    Parameters:
    
    displayLabel - True to display labels.
  - setStyle
```
public void setStyle(ChartStyle style)
```
    Sets the chart style. The provided style is copied, so subsequent changes to the input object do not affect the chart.
    
    Parameters:
    
    style - The chart style.
  - setPlotAreaStyle
```
public void setPlotAreaStyle(ChartStyle plotAreaStyle)
```
    Sets the plot area style. The provided style is copied, so subsequent changes to the input object do not affect the chart.
    
    Parameters:
    
    plotAreaStyle - The plot area style.
  - setWallStyle
```
public void setWallStyle(ChartStyle wallStyle)
```
    Sets the wall style. The provided style is copied, so subsequent changes to the input object do not affect the chart.
    
    Parameters:
    
    wallStyle - The wall style.
  - setShowWall
```
public void setShowWall(boolean showWall)
```
    Enables or disables wall display. The wall is a background plane used mainly for 3D charts.
    
    Parameters:
    
    showWall - True to display the wall.

Class Chart

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Chart

Method Detail

getType

getTitle

getFooter

getLegend

getData

getCategories

getCategoriesRangeAddress

getCategoriesRangeObject

getSeries

getSheet

getWidth

getHeight

getX

getY

getXAxisLabel

getYAxisLabel

isDisplayLabel

getStyle

getPlotAreaStyle

getWallStyle

getXAxis

getYAxis

isShowWall

setType

setTitle

setFooter

setLegend

addData

addCategory

setCategoriesRangeAddress

addSeries

setWidth

setHeight

setX

setY

setXAxisLabel

setYAxisLabel

setDisplayLabel

setStyle

setPlotAreaStyle

setWallStyle

setShowWall