<html> <head> <title>Interface XChartTypeTemplate</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="XChartTypeTemplate-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">chart2</a> :: </p> </td> </tr> <tr> <td class="title">interface XChartTypeTemplate</td> </tr> <tr> <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="#createDiagramByDataSource">createDiagramByDataSource</a></td> <td class="imsum_right">Creates a new diagram based upon the given data . </td> </tr> <tr> <td class="imsum_left"><a href="#getAvailableCreationParameterNames">getAvailableCreationParameterNames</a></td> <td class="imsum_right">Return the names of parameters that are interpreted in the <a href="#createDiagramByDataSource">createDiagramByDataSource</a> method. </td> </tr> <tr> <td class="imsum_left"><a href="#changeDiagram">changeDiagram</a></td> <td class="imsum_right">Analyses the given diagram and reinterprets its <a href="DataSeries.html">DataSeries</a> and ::Categories and creates a new diagram based on these series. </td> </tr> <tr> <td class="imsum_left"><a href="#changeDiagramData">changeDiagramData</a></td> <td class="imsum_right">Changes the given diagram <code>xDiagram</code> by using the new data given in <code>xDataSource</code>. </td> </tr> <tr> <td class="imsum_left"><a href="#matchesTemplate">matchesTemplate</a></td> <td class="imsum_right">States whether the given diagram could have been created by the template. </td> </tr> <tr> <td class="imsum_left"><a href="#getChartTypeForNewSeries">getChartTypeForNewSeries</a></td> <td class="imsum_right">Provides a chart type object that can be used to create new series. </td> </tr> <tr> <td class="imsum_left"><a href="#getDataInterpreter">getDataInterpreter</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#applyStyle">applyStyle</a></td> <td class="imsum_right">Applies a chart-type specific style (e.g. symbols) to all series in the sequence aSeries. </td> </tr> <tr> <td class="imsum_left"><a href="#resetStyles">resetStyles</a></td> <td class="imsum_right">Resets all styles that were changed from the default at any object in the chart and have not been later modified. </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="createDiagramByDataSource" class="membertitle">createDiagramByDataSource</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>createDiagramByDataSource</b>(</td> <td valign="top">[in] ::com::sun::star::chart2::<a href="data/module-ix.html">data</a>::<a href="data/XDataSource.html">XDataSource</a></td> <td valign="bottom"> xDataSource,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> aArguments );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Creates a new diagram based upon the given data . </dd> <dt><b>Parameter xDataSource</b></dt> <dd>This data source will be interpreted in a chart-type specific way and appropriate <a href="DataSeries.html">DataSeries</a> will be created which serve as input for the new diagram. </dd> <dt><b>Parameter aArguments</b></dt> <dd>Arguments that tell the template how to slice the given range. The properties should be defined in a separate service. <p>For standard parameters that may be used, see the service <a href="StandardDiagramCreationParameters.html">StandardDiagramCreationParameters</a>. </p> </dd> <dt><b>Returns</b></dt> <dd>The new diagram which represents this <a href="ChartTypeTemplate.html">ChartTypeTemplate</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAvailableCreationParameterNames" class="membertitle">getAvailableCreationParameterNames</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">sequence< string ></td> </tr> <tr> <td valign="top"><b>getAvailableCreationParameterNames</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return the names of parameters that are interpreted in the <a href="#createDiagramByDataSource">createDiagramByDataSource</a> method. </dd> <dt><b>See also</b></dt> <dd><a href="#StandardChartTypeTemplateParameters">StandardChartTypeTemplateParameters</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="changeDiagram" class="membertitle">changeDiagram</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>changeDiagram</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>Analyses the given diagram and reinterprets its <a href="DataSeries.html">DataSeries</a> and ::Categories and creates a new diagram based on these series. </dd> <dd><p>Note, that if <a href="#matchesTemplate">matchesTemplate</a> returns <b>true</b> for the given <a href="XDiagram.html">XDiagram</a>, the latter should not be changed.</p> </dd> <dt><b>Parameter xDiagram</b></dt> <dd>The diagram given will be modified such that it represents this <a href="ChartTypeTemplate.html">ChartTypeTemplate</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="changeDiagramData" class="membertitle">changeDiagramData</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>changeDiagramData</b>(</td> <td valign="top">[in] <a href="XDiagram.html">XDiagram</a></td> <td valign="bottom"> xDiagram,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::chart2::<a href="data/module-ix.html">data</a>::<a href="data/XDataSource.html">XDataSource</a></td> <td valign="bottom"> xDataSource,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> aArguments );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Changes the given diagram <code>xDiagram</code> by using the new data given in <code>xDataSource</code>. </dd> <dd><p>Note that the data is interpreted in a way that fits this template, but not necessarily the chart-types of the diagram. This method should only be called if the data-format of the diagram is compatible with the data-format of this template.</p> <p>Ideally a <a href="#matchesTemplate">matchesTemplate</a> call for the given diagram should return <b>true</b> before this method is called.</p> </dd> <dt><b>Parameter xDataSource</b></dt> <dd>This data source will be interpreted in a chart-type specific way and the <a href="DataSeries.html">DataSeries</a> found in <code>xDiagram</code> will be adapted to the new data. Missing data series will be created and unused ones will be deleted in <code>xDiagram</code>. </dd> <dt><b>Parameter aArguments</b></dt> <dd>Arguments that tell the template how to slice the given range. The properties should be defined in a separate service. <p>For standard parameters that may be used, see the service <a href="StandardDiagramCreationParameters.html">StandardDiagramCreationParameters</a>. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="matchesTemplate" class="membertitle">matchesTemplate</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>matchesTemplate</b>(</td> <td valign="top">[in] <a href="XDiagram.html">XDiagram</a></td> <td valign="bottom"> xDiagram,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bAdaptProperties );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>States whether the given diagram could have been created by the template. </dd> <dd><p>The template will parse the ::DataSeriesTree of the diagram to determine if the structure matches the one which would have been created by <a href="#createDiagramByDataSource">createDiagramByDataSource</a>.</p> <p>For analysis all parts of the diagram may be used, e.g. also properties set at the data series (like symbols)./p> </dd> <dt><b>Parameter xDiagram</b></dt> <dd>The diagram to be analyzed. </dd> <dt><b>Parameter bAdaptProperties</b></dt> <dd>If <b>true</b> the properties of the template are set, such that the template matches more accurately. E.g. for a line-chart with symbols the property "Symbol" would be set to <b>true</b>. If this parameter is <b>false</b> the template itselfs stays unmodified. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the diagram given is structurally identical to a diagram that was created using <a href="#createDiagramByDataSource">createDiagramByDataSource</a> or <a href="#changeDiagram">changeDiagram</a>. If <b>false</b> is returned the template stays unmodified even if <code>bAdaptProperties</code> is <b>true</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getChartTypeForNewSeries" class="membertitle">getChartTypeForNewSeries</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="XChartType.html">XChartType</a></td> </tr> <tr> <td valign="top"><b>getChartTypeForNewSeries</b>(</td> <td valign="top">[in] sequence< <a href="XChartType.html">XChartType</a> ></td> <td valign="bottom"> aFormerlyUsedChartTypes );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Provides a chart type object that can be used to create new series. </dd> <dt><b>Parameter aFormerlyUsedChartTypes</b></dt> <dd>The list can be used to copy some aspects from old charttypes during the creation of a new chart type. The list might be empty. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDataInterpreter" class="membertitle">getDataInterpreter</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="XDataInterpreter.html">XDataInterpreter</a></td> </tr> <tr> <td valign="top"><b>getDataInterpreter</b>();</td> </tr> </table> <hr> <dl></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="applyStyle" class="membertitle">applyStyle</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>applyStyle</b>(</td> <td valign="top">[in] <a href="XDataSeries.html">XDataSeries</a></td> <td valign="bottom"> xSeries,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nChartTypeGroupIndex,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nSeriesIndex,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nSeriesCount );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Applies a chart-type specific style (e.g. symbols) to all series in the sequence aSeries. </dd> <dt><b>Parameter xSeries</b></dt> <dd>a single data series to which a style will be applied </dd> <dt><b>Parameter nChartTypeGroupIndex</b></dt> <dd>Denotes in which chart-type group the series lies, such this method can apply different styles for different chart-type groups </dd> <dt><b>Parameter nSeriesIndex</b></dt> <dd>The index of the series inside the current chart-type group. nSeriesIndex does not uniquely identify a data series alone, but only together with nChartTypeGroupIndex </dd> <dt><b>Parameter nSeriesCount</b></dt> <dd>The number of series in the current chart-type group. @todo In the future, this should only change the "Style" property and no hard attributes. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="resetStyles" class="membertitle">resetStyles</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>resetStyles</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>Resets all styles that were changed from the default at any object in the chart and have not been later modified. </dd> <dd><p>In <a href="#createDiagramByDataSource">createDiagramByDataSource</a> or <a href="#changeDiagram">changeDiagram</a> a template might e.g. change the page background color or the line style of all data series. This method should reset all objects that still have the changed settings to the default.</p> <p>If for example the template changed the ::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/LineStyle.html">LineStyle</a> of all series to NONE, this method should reset all series with LineStyle NONE back to SOLID. If a series has a style DASH, it must not be changed.</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 © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
1784
