ChartProperties (Simple ODS library 1.7.0 API)

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

```
public class ChartProperties
extends Object
```
Holds chart-specific properties. These options map to ODS chart settings and control aspects like axis positioning, label handling, symbol rendering, and layout behavior.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ChartProperties.TreatEmptyCells
How empty cells are treated in chart data.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ChartProperties.TreatEmptyCells` How empty cells are treated in chart data.

Constructor Summary

Constructors
Constructor and Description

ChartProperties()

Constructors
Constructor and Description
`ChartProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getAutoPosition()` Returns whether auto-positioning is enabled.
`Boolean`	`getAutoSize()` Returns whether auto-sizing is enabled.
`Integer`	`getAxisPosition()` Returns the axis position index.
`Boolean`	`getDisplayLabel()` Returns whether labels are displayed.
`Boolean`	`getIncludeHiddenCells()` Returns whether hidden cells are included.
`Boolean`	`getLinkDataStyleToSource()` Returns whether data style is linked to the source.
`Boolean`	`getLogarithmic()` Returns whether logarithmic scaling is enabled.
`Boolean`	`getReverseDirection()` Returns whether the axis direction is reversed.
`Boolean`	`getRightAngledAxes()` Returns whether right-angled axes are enabled.
`String`	`getSymbolHeight()` Returns the symbol height.
`String`	`getSymbolName()` Returns the symbol name.
`String`	`getSymbolType()` Returns the symbol type.
`String`	`getSymbolWidth()` Returns the symbol width.
`Boolean`	`getTextLineBreak()` Returns whether text line breaks are enabled.
`ChartProperties.TreatEmptyCells`	`getTreatEmptyCells()` Returns the empty-cell behavior.
`Boolean`	`getTryStaggeringFirst()` Returns whether to try staggering labels first.
`void`	`setAutoPosition(boolean autoPosition)` Sets whether auto-positioning is enabled.
`void`	`setAutoSize(boolean autoSize)` Sets whether auto-sizing is enabled.
`void`	`setAxisPosition(int axisPosition)` Sets the axis position index.
`void`	`setDisplayLabel(boolean displayLabel)` Sets whether labels are displayed.
`void`	`setIncludeHiddenCells(boolean includeHiddenCells)` Sets whether hidden cells are included.
`void`	`setLinkDataStyleToSource(boolean linkDataStyleToSource)` Sets whether data style is linked to the source.
`void`	`setLogarithmic(boolean logarithmic)` Sets whether logarithmic scaling is enabled.
`void`	`setReverseDirection(boolean reverseDirection)` Sets whether the axis direction is reversed.
`void`	`setRightAngledAxes(boolean rightAngledAxes)` Sets whether right-angled axes are enabled.
`void`	`setSymbolHeight(String symbolHeight)` Sets the symbol height.
`void`	`setSymbolName(String symbolName)` Sets the symbol name.
`void`	`setSymbolType(String symbolType)` Sets the symbol type.
`void`	`setSymbolWidth(String symbolWidth)` Sets the symbol width.
`void`	`setTextLineBreak(boolean textLineBreak)` Sets whether text line breaks are enabled.
`void`	`setTreatEmptyCells(ChartProperties.TreatEmptyCells treatEmptyCells)` Sets how empty cells are treated.
`void`	`setTryStaggeringFirst(boolean tryStaggeringFirst)` Sets whether to try staggering labels first.

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

- Constructor Detail
  - ChartProperties
```
public ChartProperties()
```
- Method Detail
  - getDisplayLabel
```
public Boolean getDisplayLabel()
```
    Returns whether labels are displayed. Labels are typically value labels or series labels that can be rendered directly on the chart.
    
    Returns:
    
    True if labels are displayed.
  - getLogarithmic
```
public Boolean getLogarithmic()
```
    Returns whether logarithmic scaling is enabled. When enabled, the axis is scaled logarithmically instead of linearly.
    
    Returns:
    
    True if logarithmic scaling is enabled.
  - getReverseDirection
```
public Boolean getReverseDirection()
```
    Returns whether the axis direction is reversed. Reversed axes display values in the opposite direction.
    
    Returns:
    
    True if the axis direction is reversed.
  - getLinkDataStyleToSource
```
public Boolean getLinkDataStyleToSource()
```
    Returns whether data style is linked to the source. When enabled, the chart follows the data style defined in the sheet.
    
    Returns:
    
    True if linked to source.
  - getAutoPosition
```
public Boolean getAutoPosition()
```
    Returns whether auto-positioning is enabled. Auto-positioning allows the document engine to place elements automatically within the chart area.
    
    Returns:
    
    True if auto-positioning is enabled.
  - getAutoSize
```
public Boolean getAutoSize()
```
    Returns whether auto-sizing is enabled. Auto-size allows the document engine to size elements based on content.
    
    Returns:
    
    True if auto-sizing is enabled.
  - getRightAngledAxes
```
public Boolean getRightAngledAxes()
```
    Returns whether right-angled axes are enabled. When enabled, axes are forced to render at right angles.
    
    Returns:
    
    True if right-angled axes are enabled.
  - getIncludeHiddenCells
```
public Boolean getIncludeHiddenCells()
```
    Returns whether hidden cells are included. When enabled, hidden rows/columns can still contribute values to the chart.
    
    Returns:
    
    True if hidden cells are included.
  - getTextLineBreak
```
public Boolean getTextLineBreak()
```
    Returns whether text line breaks are enabled. This affects how multi-line labels are rendered.
    
    Returns:
    
    True if text line breaks are enabled.
  - getTryStaggeringFirst
```
public Boolean getTryStaggeringFirst()
```
    Returns whether to try staggering labels first. Staggering is used to reduce label overlap by alternating positions.
    
    Returns:
    
    True if staggering is preferred.
  - getSymbolType
```
public String getSymbolType()
```
    Returns the symbol type. This describes the marker style used for points (for example, circle or square).
    
    Returns:
    
    The symbol type.
  - getSymbolName
```
public String getSymbolName()
```
    Returns the symbol name. The name corresponds to an ODS symbol identifier.
    
    Returns:
    
    The symbol name.
  - getSymbolWidth
```
public String getSymbolWidth()
```
    Returns the symbol width. This is a serialized size value (for example, "0.2cm").
    
    Returns:
    
    The symbol width.
  - getSymbolHeight
```
public String getSymbolHeight()
```
    Returns the symbol height. This is a serialized size value (for example, "0.2cm").
    
    Returns:
    
    The symbol height.
  - getTreatEmptyCells
```
public ChartProperties.TreatEmptyCells getTreatEmptyCells()
```
    Returns the empty-cell behavior. This determines whether empty cells are ignored, treated as zero, or rendered as gaps in the chart.
    
    Returns:
    
    The empty-cell behavior.
  - getAxisPosition
```
public Integer getAxisPosition()
```
    Returns the axis position index. This value indicates where the axis intersects relative to the plot area.
    
    Returns:
    
    The axis position.
  - setDisplayLabel
```
public void setDisplayLabel(boolean displayLabel)
```
    Sets whether labels are displayed. Labels are typically value labels or series labels shown on the chart.
    
    Parameters:
    
    displayLabel - True to display labels.
  - setLogarithmic
```
public void setLogarithmic(boolean logarithmic)
```
    Sets whether logarithmic scaling is enabled. When enabled, the axis is scaled logarithmically.
    
    Parameters:
    
    logarithmic - True to enable logarithmic scaling.
  - setReverseDirection
```
public void setReverseDirection(boolean reverseDirection)
```
    Sets whether the axis direction is reversed. Reversed axes display values in the opposite direction.
    
    Parameters:
    
    reverseDirection - True to reverse axis direction.
  - setLinkDataStyleToSource
```
public void setLinkDataStyleToSource(boolean linkDataStyleToSource)
```
    Sets whether data style is linked to the source. When enabled, the chart follows the data style defined in the sheet.
    
    Parameters:
    
    linkDataStyleToSource - True to link to source.
  - setAutoPosition
```
public void setAutoPosition(boolean autoPosition)
```
    Sets whether auto-positioning is enabled. Auto-positioning lets the document engine place elements automatically.
    
    Parameters:
    
    autoPosition - True to enable auto-positioning.
  - setAutoSize
```
public void setAutoSize(boolean autoSize)
```
    Sets whether auto-sizing is enabled. Auto-size lets the document engine size elements based on content.
    
    Parameters:
    
    autoSize - True to enable auto-sizing.
  - setRightAngledAxes
```
public void setRightAngledAxes(boolean rightAngledAxes)
```
    Sets whether right-angled axes are enabled. When enabled, axes are forced to render at right angles.
    
    Parameters:
    
    rightAngledAxes - True to enable right-angled axes.
  - setIncludeHiddenCells
```
public void setIncludeHiddenCells(boolean includeHiddenCells)
```
    Sets whether hidden cells are included. Hidden rows/columns can still contribute values to the chart when enabled.
    
    Parameters:
    
    includeHiddenCells - True to include hidden cells.
  - setTextLineBreak
```
public void setTextLineBreak(boolean textLineBreak)
```
    Sets whether text line breaks are enabled. This affects how multi-line labels are rendered.
    
    Parameters:
    
    textLineBreak - True to enable text line breaks.
  - setTryStaggeringFirst
```
public void setTryStaggeringFirst(boolean tryStaggeringFirst)
```
    Sets whether to try staggering labels first. Staggering is used to reduce label overlap by alternating positions.
    
    Parameters:
    
    tryStaggeringFirst - True to try staggering first.
  - setSymbolType
```
public void setSymbolType(String symbolType)
```
    Sets the symbol type. This describes the marker style used for points (for example, circle or square).
    
    Parameters:
    
    symbolType - The symbol type.
  - setSymbolName
```
public void setSymbolName(String symbolName)
```
    Sets the symbol name. The name corresponds to an ODS symbol identifier.
    
    Parameters:
    
    symbolName - The symbol name.
  - setSymbolWidth
```
public void setSymbolWidth(String symbolWidth)
```
    Sets the symbol width. The value is stored as a size string in the document.
    
    Parameters:
    
    symbolWidth - The symbol width.
  - setSymbolHeight
```
public void setSymbolHeight(String symbolHeight)
```
    Sets the symbol height. The value is stored as a size string in the document.
    
    Parameters:
    
    symbolHeight - The symbol height.
  - setTreatEmptyCells
```
public void setTreatEmptyCells(ChartProperties.TreatEmptyCells treatEmptyCells)
```
    Sets how empty cells are treated. This determines whether empty cells are ignored, treated as zero, or rendered as gaps.
    
    Parameters:
    
    treatEmptyCells - The empty-cell behavior.
  - setAxisPosition
```
public void setAxisPosition(int axisPosition)
```
    Sets the axis position index. This value indicates where the axis intersects relative to the plot area.
    
    Parameters:
    
    axisPosition - The axis position.

Class ChartProperties

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChartProperties

Method Detail

getDisplayLabel

getLogarithmic

getReverseDirection

getLinkDataStyleToSource

getAutoPosition

getAutoSize

getRightAngledAxes

getIncludeHiddenCells

getTextLineBreak

getTryStaggeringFirst

getSymbolType

getSymbolName

getSymbolWidth

getSymbolHeight

getTreatEmptyCells

getAxisPosition

setDisplayLabel

setLogarithmic

setReverseDirection

setLinkDataStyleToSource

setAutoPosition

setAutoSize

setRightAngledAxes

setIncludeHiddenCells

setTextLineBreak

setTryStaggeringFirst

setSymbolType

setSymbolName

setSymbolWidth

setSymbolHeight

setTreatEmptyCells

setAxisPosition