<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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</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">chart2</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/></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="#getFirstDiagram">getFirstDiagram</a></td> <td class="imsum_right">@todo allow more than one diagram </td> </tr> <tr> <td class="imsum_left"><a href="#setFirstDiagram">setFirstDiagram</a></td> <td class="imsum_right">@todo allow more than one diagram </td> </tr> <tr> <td class="imsum_left"><a href="#createInternalDataProvider">createInternalDataProvider</a></td> <td class="imsum_right">creates an internal com::sun::star::chart2::XDataProvider that is handled by the chart document itself. </td> </tr> <tr> <td class="imsum_left"><a href="#hasInternalDataProvider">hasInternalDataProvider</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getDataProvider">getDataProvider</a></td> <td class="imsum_right">Returns the currently set data provider. This may be an internal one, if <a href="#createInternalDataProvider">createInternalDataProvider</a> has been called before, or an external one if ::XDataReceiver::attachDataProvider has been called. </td> </tr> <tr> <td class="imsum_left"><a href="#setChartTypeManager">setChartTypeManager</a></td> <td class="imsum_right">sets a new component that is able to create different chart type templates (components of type <a href="ChartTypeTemplate.html">ChartTypeTemplate</a>) </td> </tr> <tr> <td class="imsum_left"><a href="#getChartTypeManager">getChartTypeManager</a></td> <td class="imsum_right">retrieves the component that is able to create different chart type templates (components of type <a href="ChartTypeTemplate.html">ChartTypeTemplate</a>) </td> </tr> <tr> <td class="imsum_left"><a href="#getPageBackground">getPageBackground</a></td> <td class="imsum_right">Gives access to the page background appearance. </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="getFirstDiagram" class="membertitle">getFirstDiagram</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>getFirstDiagram</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>@todo allow more than one diagram </dd> <dd><p>Notes: this is preliminary, we need an API that supports more than one diagram. The method name getDiagram exists in the css.chart API, so there is would be no way to chose either this or the other method from Basic (it would chose one or the other by random).</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setFirstDiagram" class="membertitle">setFirstDiagram</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>setFirstDiagram</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>@todo allow more than one diagram </dd> <dd><p>Notes: this is preliminary, we need an API that supports more than one diagram. The method name setDiagram exists in the css.chart API, so there is would be no way to chose either this or the other method from Basic (it would chose one or the other by random).</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createInternalDataProvider" class="membertitle">createInternalDataProvider</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>createInternalDataProvider</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bCloneExistingData )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/CloseVetoException.html">CloseVetoException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates an internal com::sun::star::chart2::XDataProvider that is handled by the chart document itself. </dd> <dd><p>When the model is stored, the data provider will also be stored in a sub-storage.</p> </dd> <dt><b>Parameter bCloneExistingData</b></dt> <dd>if <b>true</b> and a data provider was previously attached, its referred data will be copied to the new internal data provider. Note, that the range representation set before will usually change after cloning.</p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::util:CloseVetoException If the new data provider could not be created due to a failed removal of the former data provider. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasInternalDataProvider" class="membertitle">hasInternalDataProvider</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">boolean</td> </tr> <tr> <td valign="top"><b>hasInternalDataProvider</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd><b>true</b> if the data provider set at the chart document is an internal one. <p>This is the case directly after <a href="#createInternalDataProvider">createInternalDataProvider</a> has been called, but this is not necessary. The chart can also create an internal data provider by other means, e.g. a call to ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a>::<a href="../frame/XModel.html#initNew">initNew</a>. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDataProvider" class="membertitle">getDataProvider</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::chart2::<a href="data/module-ix.html">data</a>::<a href="data/XDataProvider.html">XDataProvider</a></td> </tr> <tr> <td valign="top"><b>getDataProvider</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the currently set data provider. This may be an internal one, if <a href="#createInternalDataProvider">createInternalDataProvider</a> has been called before, or an external one if ::XDataReceiver::attachDataProvider has been called. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setChartTypeManager" class="membertitle">setChartTypeManager</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>setChartTypeManager</b>(</td> <td valign="top">[in] <a href="XChartTypeManager.html">XChartTypeManager</a></td> <td valign="bottom"> xNewManager );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets a new component that is able to create different chart type templates (components of type <a href="ChartTypeTemplate.html">ChartTypeTemplate</a>) </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getChartTypeManager" class="membertitle">getChartTypeManager</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="XChartTypeManager.html">XChartTypeManager</a></td> </tr> <tr> <td valign="top"><b>getChartTypeManager</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the component that is able to create different chart type templates (components of type <a href="ChartTypeTemplate.html">ChartTypeTemplate</a>) </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getPageBackground" class="membertitle">getPageBackground</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>getPageBackground</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Gives access to the page background appearance. </dd> <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 a single diagram (the part where data points are actually plotted in), you have to get its wall. You can get the wall by calling <a href="XDiagram.html">XDiagram</a>::<a href="XDiagram.html#getWall">getWall</a>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
1786
