XSSFManualLayout (POI API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.xssf.usermodel.charts
Class XSSFManualLayout

java.lang.Object
  org.apache.poi.xssf.usermodel.charts.XSSFManualLayout

All Implemented Interfaces:: ManualLayout

@Beta public final class XSSFManualLayout
extends java.lang.Object
implements ManualLayout
extends java.lang.Object
implements ManualLayout

Represents a SpreadsheetML manual layout.

Author:: Roman Kashitsyn

Constructor Summary
`XSSFManualLayout(org.openxmlformats.schemas.drawingml.x2006.chart.CTLayout ctLayout)` Create a new SpreadsheetML manual layout.
`XSSFManualLayout(XSSFChart chart)` Create a new SpreadsheetML manual layout for chart.

Method Summary
`org.openxmlformats.schemas.drawingml.x2006.chart.CTManualLayout`	`getCTManualLayout()` Return the underlying CTManualLayout bean.
`LayoutMode`	`getHeightMode()` Returns current height mode of this
`double`	`getHeightRatio()` Returns current fraction of the height of the chart.
`LayoutTarget`	`getTarget()` Returns current layout target.
`LayoutMode`	`getWidthMode()` Returns current width mode of this manual layout.
`double`	`getWidthRatio()` Returns current fraction of the width of the chart.
`double`	`getX()` Returns the x location of the chart element.
`LayoutMode`	`getXMode()` Returns current x-coordinnate layout mode.
`double`	`getY()` Returns current y location of the chart element.
`LayoutMode`	`getYMode()` Returns current y-coordinate layout mode.
`void`	`setHeightMode(LayoutMode mode)` Specifies how to interpret the Height element for this manual layout.
`void`	`setHeightRatio(double ratio)` Specifies the height (if Height Mode is Factor) or bottom (if Height Mode is edge) of the chart element as a fraction of the height of the chart.
`void`	`setTarget(LayoutTarget target)` Sets the layout target.
`void`	`setWidthMode(LayoutMode mode)` Specifies how to interpret the Width element for this manual layout.
`void`	`setWidthRatio(double ratio)` Specifies the width (if Width Mode is Factor) or right (if Width Mode is Edge) of the chart element as a fraction of the width of the chart.
`void`	`setX(double x)` Specifies the x location (left) of the chart element as a fraction of the width of the chart.
`void`	`setXMode(LayoutMode mode)` Sets the x-coordinate layout mode.
`void`	`setY(double y)` Specifies the y location (top) of the chart element as a fraction of the height of the chart.
`void`	`setYMode(LayoutMode mode)` Sets the y-coordinate layout mode.

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

Constructor Detail

XSSFManualLayout

public XSSFManualLayout(org.openxmlformats.schemas.drawingml.x2006.chart.CTLayout ctLayout)

Create a new SpreadsheetML manual layout.

Parameters:: ctLayout - a Spreadsheet ML layout that should be used as base.

XSSFManualLayout

public XSSFManualLayout(XSSFChart chart)

Create a new SpreadsheetML manual layout for chart.

Parameters:: chart - a chart to create layout for.

Method Detail

getCTManualLayout

@Internal
public org.openxmlformats.schemas.drawingml.x2006.chart.CTManualLayout getCTManualLayout()

Return the underlying CTManualLayout bean.

Returns:: the underlying CTManualLayout bean.