Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8-incubating / simple-odf / apidocs / org / odftoolkit / simple / chart / ChartContainer.html
blob: 68cbdd2dc5e9fd12b8c7440cac4ab984004f49c0 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Fri Feb 22 10:35:17 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>ChartContainer (Simple ODF API v0.8-incubating - http://incubator.apache.org/odftoolkit/)</title>
<meta name="date" content="2013-02-22">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ChartContainer (Simple ODF API v0.8-incubating - http://incubator.apache.org/odftoolkit/)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ChartContainer.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/chart/ChartType.html" title="enum in org.odftoolkit.simple.chart"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/chart/ChartContainer.html" target="_top">Frames</a></li>
<li><a href="ChartContainer.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.odftoolkit.simple.chart</div>
<h2 title="Interface ChartContainer" class="title">Interface ChartContainer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/odftoolkit/simple/chart/AbstractChartContainer.html" title="class in org.odftoolkit.simple.chart">AbstractChartContainer</a>, <a href="../../../../org/odftoolkit/simple/PresentationDocument.html" title="class in org.odftoolkit.simple">PresentationDocument</a>, <a href="../../../../org/odftoolkit/simple/presentation/Slide.html" title="class in org.odftoolkit.simple.presentation">Slide</a>, <a href="../../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a>, <a href="../../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple">TextDocument</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ChartContainer</span></pre>
<div class="block">ChartContainer is a container which maintains Chart(s) as element(s).
Chart(s) can be added, removed and iterated in this container.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart"><code>Chart</code></a>,
<a href="../../../../org/odftoolkit/simple/TextDocument.html" title="class in org.odftoolkit.simple"><code>TextDocument</code></a>,
<a href="../../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple"><code>SpreadsheetDocument</code></a>,
<a href="../../../../org/odftoolkit/simple/PresentationDocument.html" title="class in org.odftoolkit.simple"><code>PresentationDocument</code></a>,
<a href="../../../../org/odftoolkit/simple/presentation/Slide.html" title="class in org.odftoolkit.simple.presentation"><code>Slide</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/ChartContainer.html#createChart(java.lang.String, org.odftoolkit.simple.chart.DataSet, java.awt.Rectangle)">createChart</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title,
<a href="../../../../org/odftoolkit/simple/chart/DataSet.html" title="class in org.odftoolkit.simple.chart">DataSet</a>&nbsp;dataset,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</code>
<div class="block">Creates a new Chart for this container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/ChartContainer.html#createChart(java.lang.String, org.odftoolkit.simple.SpreadsheetDocument, org.odftoolkit.odfdom.type.CellRangeAddressList, boolean, boolean, boolean, java.awt.Rectangle)">createChart</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title,
<a href="../../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a>&nbsp;document,
org.odftoolkit.odfdom.type.CellRangeAddressList&nbsp;cellRangeAddr,
boolean&nbsp;firstRowAsLabel,
boolean&nbsp;firstColumnAsLabel,
boolean&nbsp;rowAsDataSeries,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</code>
<div class="block">Creates a new Chart for this container.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/ChartContainer.html#createChart(java.lang.String, java.lang.String[], java.lang.String[], double[][], java.awt.Rectangle)">createChart</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;labels,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;legends,
double[][]&nbsp;data,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</code>
<div class="block">Creates a new Chart for this container.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/ChartContainer.html#deleteChartById(java.lang.String)">deleteChartById</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;chartId)</code>
<div class="block">Deletes chart by chart id.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/ChartContainer.html#deleteChartByTitle(java.lang.String)">deleteChartByTitle</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title)</code>
<div class="block">Deletes chart(s) by chart title.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/ChartContainer.html#getChartById(java.lang.String)">getChartById</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;chartId)</code>
<div class="block">Gets chart with specified id.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/ChartContainer.html#getChartByTitle(java.lang.String)">getChartByTitle</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title)</code>
<div class="block">Gets chart list with specified title.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/chart/ChartContainer.html#getChartCount()">getChartCount</a></strong>()</code>
<div class="block">Returns the chart count of this container</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="createChart(java.lang.String, org.odftoolkit.simple.chart.DataSet, java.awt.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChart</h4>
<pre><a href="../../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&nbsp;createChart(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title,
<a href="../../../../org/odftoolkit/simple/chart/DataSet.html" title="class in org.odftoolkit.simple.chart">DataSet</a>&nbsp;dataset,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</pre>
<div class="block">Creates a new Chart for this container.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - chart title.</dd><dd><code>dataset</code> - chart data set.</dd><dd><code>rect</code> - chart rectangle.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the created chart.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="createChart(java.lang.String, org.odftoolkit.simple.SpreadsheetDocument, org.odftoolkit.odfdom.type.CellRangeAddressList, boolean, boolean, boolean, java.awt.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChart</h4>
<pre><a href="../../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&nbsp;createChart(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title,
<a href="../../../../org/odftoolkit/simple/SpreadsheetDocument.html" title="class in org.odftoolkit.simple">SpreadsheetDocument</a>&nbsp;document,
org.odftoolkit.odfdom.type.CellRangeAddressList&nbsp;cellRangeAddr,
boolean&nbsp;firstRowAsLabel,
boolean&nbsp;firstColumnAsLabel,
boolean&nbsp;rowAsDataSeries,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</pre>
<div class="block">Creates a new Chart for this container.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - chart title.</dd><dd><code>document</code> - the data source spreadsheet document.</dd><dd><code>cellRangeAddr</code> - the cell range address list which is used as chart data set.</dd><dd><code>firstRowAsLabel</code> - whether uses first row as label.</dd><dd><code>firstColumnAsLabel</code> - whether uses first column as label.</dd><dd><code>rowAsDataSeries</code> - whether uses data as series.</dd><dd><code>rect</code> - chart rectangle.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the created chart.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="createChart(java.lang.String, java.lang.String[], java.lang.String[], double[][], java.awt.Rectangle)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChart</h4>
<pre><a href="../../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&nbsp;createChart(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;labels,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;legends,
double[][]&nbsp;data,
<a href="http://download.oracle.com/javase/6/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;rect)</pre>
<div class="block">Creates a new Chart for this container.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - chart rectangle.</dd><dd><code>labels</code> - label strings</dd><dd><code>legends</code> - legend strings</dd><dd><code>data</code> - chart data set.</dd><dd><code>rect</code> - chart rectangle.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the created chart.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="deleteChartById(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteChartById</h4>
<pre>void&nbsp;deleteChartById(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;chartId)</pre>
<div class="block">Deletes chart by chart id.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>chartId</code> - the id of specified chart.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="deleteChartByTitle(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deleteChartByTitle</h4>
<pre>void&nbsp;deleteChartByTitle(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title)</pre>
<div class="block">Deletes chart(s) by chart title.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - the title of specified chart(s).</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="getChartById(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChartById</h4>
<pre><a href="../../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&nbsp;getChartById(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;chartId)</pre>
<div class="block">Gets chart with specified id.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>chartId</code> - the id of this chart.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the chart with specified id.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="getChartByTitle(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChartByTitle</h4>
<pre><a href="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart">Chart</a>&gt;&nbsp;getChartByTitle(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;title)</pre>
<div class="block">Gets chart list with specified title.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>title</code> - the title of specified chart(s).</dd>
<dt><span class="strong">Returns:</span></dt><dd>the chart(s) with specified title.</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
<a name="getChartCount()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getChartCount</h4>
<pre>int&nbsp;getChartCount()</pre>
<div class="block">Returns the chart count of this container</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the chart count of this container</dd><dt><span class="strong">Since:</span></dt>
<dd>0.6</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ChartContainer.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/odftoolkit/simple/chart/Chart.html" title="class in org.odftoolkit.simple.chart"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/chart/ChartType.html" title="enum in org.odftoolkit.simple.chart"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/chart/ChartContainer.html" target="_top">Frames</a></li>
<li><a href="ChartContainer.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2010-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>