<html> <head> <title>Interface XChartDocument</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XChartDocument-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">chart</a> :: </p> </td> </tr> <tr> <td class="title">interface XChartDocument</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XChartDocument</strong> ┗ ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a> ┗ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left">::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>represents a component which is created from an URL and arguments. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>manages the chart document. </dd> <dt><b>See also</b></dt> <dd><a href="XDiagram.html">XDiagram</a>, <a href="XChartData.html">XChartData</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getTitle">getTitle</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getSubTitle">getSubTitle</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getLegend">getLegend</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getArea">getArea</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getDiagram">getDiagram</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#setDiagram">setDiagram</a></td> <td class="imsum_right">sets the diagram for the chart document. </td> </tr> <tr> <td class="imsum_left"><a href="#getData">getData</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#attachData">attachData</a></td> <td class="imsum_right">attaches data to the chart. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getTitle" class="membertitle">getTitle</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/XShape.html">XShape</a></td> </tr> <tr> <td valign="top"><b>getTitle</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the shape of the main title of the chart document. </dd> <dt><b>See also</b></dt> <dd><a href="ChartTitle.html">ChartTitle</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSubTitle" class="membertitle">getSubTitle</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/XShape.html">XShape</a></td> </tr> <tr> <td valign="top"><b>getSubTitle</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the shape of the subtitle of the chart document. <p>Usually the subtitle is smaller than the main title by default. And it is most commonly placed below the main title by default.</p> </dd> <dt><b>See also</b></dt> <dd><a href="ChartTitle.html">ChartTitle</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLegend" class="membertitle">getLegend</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/XShape.html">XShape</a></td> </tr> <tr> <td valign="top"><b>getLegend</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the shape of the legend of the chart document. </dd> <dt><b>See also</b></dt> <dd><a href="ChartLegend.html">ChartLegend</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getArea" class="membertitle">getArea</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> </tr> <tr> <td valign="top"><b>getArea</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the properties of the background area of the chart document. <p>The area's extent is equal to the document size. If you want to access properties of the background area of the diagram, in which the actual data is represented, you have to change the chart wall which you get from the <a href="X3DDisplay.html">X3DDisplay</a>.</p> </dd> <dt><b>See also</b></dt> <dd><a href="ChartArea.html">ChartArea</a>, <a href="X3DDisplay.html">X3DDisplay</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDiagram" class="membertitle">getDiagram</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XDiagram.html">XDiagram</a></td> </tr> <tr> <td valign="top"><b>getDiagram</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the diagram of the chart document. </dd> <dt><b>See also</b></dt> <dd><a href="Diagram.html">Diagram</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setDiagram" class="membertitle">setDiagram</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setDiagram</b>(</td> <td valign="top">[in] <a href="XDiagram.html">XDiagram</a></td> <td valign="bottom"> xDiagram );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the diagram for the chart document. </dd> <dd><p>Setting a new diagram implicitly disposes the previous diagram.</p> </dd> <dt><b>Parameter xDiagram</b></dt> <dd>the new diagram that should be set for the chart. To create such a diagram component, you can use the ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XMultiServiceFactory.html">XMultiServiceFactory</a>, which should be implemented by an <a href="XChartDocument.html">XChartDocument</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getData" class="membertitle">getData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XChartData.html">XChartData</a></td> </tr> <tr> <td valign="top"><b>getData</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the data of the chart. <p>The returned object supports interface <a href="XChartDataArray.html">XChartDataArray</a> which can be used to access the concrete data.</p> <p>Since OOo 3.3 the returned object also supports interface <a href="XComplexDescriptionAccess.html">XComplexDescriptionAccess</a> which can be used to access complex hierarchical axis descriptions.</p> <p>Since OOo 3.4 the returned object also supports interface <a href="XDateCategories.html">XDateCategories</a>.</p> </dd> <dt><b>See also</b></dt> <dd><a href="XChartData.html">XChartData</a>, <a href="XChartDataArray.html">XChartDataArray</a>, <a href="XComplexDescriptionAccess.html">XComplexDescriptionAccess</a>, <a href="XDateCategories.html">XDateCategories</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="attachData" class="membertitle">attachData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>attachData</b>(</td> <td valign="top">[in] <a href="XChartData.html">XChartData</a></td> <td valign="bottom"> xData );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>attaches data to the chart. </dd> <dd><p>The given object needs to support interface <a href="XChartDataArray.html">XChartDataArray</a>.</p> <p>Since OOo 3.3 if the given object might support interface <a href="XComplexDescriptionAccess.html">XComplexDescriptionAccess</a> which allows to set complex hierarchical axis descriptions.</p> <p>Since OOo 3.4 if the given object might support interface <a href="XDateCategories.html">XDateCategories</a> which allows to set date values as x values for category charts.</p> <p>The given data is copied before it is applied to the chart. So changing xData after this call will have no effect on the chart.</p> </dd> <dt><b>Parameter xData</b></dt> <dd>the object that provides the new data. </dd> <dt><b>See also</b></dt> <dd><a href="XChartData.html">XChartData</a>, <a href="XChartDataArray.html">XChartDataArray</a>, <a href="XComplexDescriptionAccess.html">XComplexDescriptionAccess</a>, <a href="XDateCategories.html">XDateCategories</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
