Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 1553

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Service ChartAxis</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="ChartAxis-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="#IncludedServices" class="navisub">Included Services</a></td>
<td class="navisub"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></td>
<td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td>
<td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></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">service ChartAxis</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Specifies the axes in a diagram.
 
 </dd>
<dd><p>Note: The text properties correlate to all axis description
 elements, not to just a single text element.</p>
 </dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="IncludedServices"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Included Services</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../drawing/module-ix.html">drawing</a>::<a href="../drawing/LineProperties.html">LineProperties</a></td>
<td class="imsum_right"><dl>
<dt><b>Description</b></dt>
<dd>set the properties for the entire axis line as well as for the
 tick marks.
 </dd>
</dl>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../style/module-ix.html">style</a>::<a href="../style/CharacterProperties.html">CharacterProperties</a></td>
<td class="imsum_right"><dl>
<dt><b>Description</b></dt>
<dd>set the properties for all text labels of the axis
 </dd>
</dl>
</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../xml/module-ix.html">xml</a>::<a href="../xml/UserDefinedAttributeSupplier.html">UserDefinedAttributeSupplier</a></td>
<td class="imsum_right"><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>If a <a href="ChartAxis.html">ChartAxis</a> may be stored as XML element, this
 service should be supported in order to preserve unparsed XML
 attributes.

 </dd>
<dt><b/></dt>
<dd/></dl>
</td>
</tr>
</table>
<a name="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Exported Interfaces</td>
</tr>
<tr>
<td class="imsum_left">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td>
<td class="imsum_right"><dl>
<dt>(referenced entity's summary:)</dt>
<dd>provides information about and access to the 
 properties from an implementation. 
 
 </dd>
</dl>
</td>
</tr>
</table>
<a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Properties' Summary</td>
</tr>
<tr>
<td class="imsum_left">double<br>
<a href="#Max">Max</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>Contains the maximum value for the axis scale.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">double<br>
<a href="#Min">Min</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>Contains the minimum value for the axis scale.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">double<br>
<a href="#Origin">Origin</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>Contains the origin of the axis scale.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">double<br>
<a href="#StepMain">StepMain</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>Contains the distance between the main tick marks.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">double<br>
<a href="#StepHelp">StepHelp</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>Contains the distance between the help tick marks.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#AutoMax">AutoMax</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>The maximium value of the axis scale is calculated by the chart if
 this property is <b>true</b>.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#AutoMin">AutoMin</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>The minimum value of the axis scale is calculated by the chart if
 this property is <b>true</b>.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#AutoOrigin">AutoOrigin</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>The origin is calculated by the chart if this property is <b>true</b>.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#AutoStepMain">AutoStepMain</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>The distance between the main tick marks is calculated by the chart
 if this property is <b>true</b>.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#AutoStepHelp">AutoStepHelp</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>The distance between the help tick marks is calculated by the
 chart if this property is <b>true</b>.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#Logarithmic">Logarithmic</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>Determines if the axis is scaled logarithmically or
 not (linear).
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#DisplayLabels">DisplayLabels</a></td>
<td class="imsum_right">Determines whether to display text at the axis or not.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">long<br>
<a href="#TextRotation">TextRotation</a></td>
<td class="imsum_right">Determines the rotation of the text elements
 (axis description) in 100th degrees.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">long<br>
<a href="#Marks">Marks</a></td>
<td class="imsum_right">Determines the position of the marks.&nbsp;</td>
</tr>
<tr>
<td class="imsum_left">long<br>
<a href="#HelpMarks">HelpMarks</a></td>
<td class="imsum_right">Determines the position of the help marks.&nbsp;</td>
</tr>
<tr>
<td class="imsum_left">long<br>
<a href="#Overlap">Overlap</a></td>
<td class="imsum_right">Determines the overlap of the bars in a bar-type chart.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">long<br>
<a href="#GapWidth">GapWidth</a></td>
<td class="imsum_right">Specifies the width of the gaps between each set of data points
 in a bar chart.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="ChartAxisArrangeOrderType.html">ChartAxisArrangeOrderType</a><br>
<a href="#ArrangeOrder">ArrangeOrder</a></td>
<td class="imsum_right">The axis description may be arranged in a special order for a
 better placement.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#TextBreak">TextBreak</a></td>
<td class="imsum_right">Determines if long text is broken into multiple lines.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#TextCanOverlap">TextCanOverlap</a></td>
<td class="imsum_right">Determines if certain labels are hidden, if they would otherwise overlap.
 In this case, the value of this property must be set to <b>false</b>.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">long<br>
<a href="#NumberFormat">NumberFormat</a></td>
<td class="imsum_right">Contains the type id for the number formatter of the axis.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#LinkNumberFormatToSource">LinkNumberFormatToSource</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>determines whether to use the number format given by the
 container application, e.g. a spreadsheet document, or from
 the own property <a href="#NumberFormat">NumberFormat</a>.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left">boolean<br>
<a href="#ReverseDirection">ReverseDirection</a></td>
<td class="imsum_right"><b>[ OPTIONAL ]<br>
</b>Determines if the axis orientation is mathematical or reversed.
 &nbsp;</td>
</tr>
</table>
<a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Properties' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="Max" class="membertitle">Max</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>double <b>Max</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>Contains the maximum value for the axis scale.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Min" class="membertitle">Min</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>double <b>Min</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>Contains the minimum value for the axis scale.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Origin" class="membertitle">Origin</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>double <b>Origin</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>Contains the origin of the axis scale.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="StepMain" class="membertitle">StepMain</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>double <b>StepMain</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>Contains the distance between the main tick marks.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="StepHelp" class="membertitle">StepHelp</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>double <b>StepHelp</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>Contains the distance between the help tick marks.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="AutoMax" class="membertitle">AutoMax</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>AutoMax</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>The maximium value of the axis scale is calculated by the chart if
 this property is <b>true</b>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="AutoMin" class="membertitle">AutoMin</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>AutoMin</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>The minimum value of the axis scale is calculated by the chart if
 this property is <b>true</b>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="AutoOrigin" class="membertitle">AutoOrigin</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>AutoOrigin</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>The origin is calculated by the chart if this property is <b>true</b>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="AutoStepMain" class="membertitle">AutoStepMain</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>AutoStepMain</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>The distance between the main tick marks is calculated by the chart
 if this property is <b>true</b>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="AutoStepHelp" class="membertitle">AutoStepHelp</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>AutoStepHelp</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>The distance between the help tick marks is calculated by the
 chart if this property is <b>true</b>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Logarithmic" class="membertitle">Logarithmic</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>Logarithmic</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>Determines if the axis is scaled logarithmically or
 not (linear).
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="DisplayLabels" class="membertitle">DisplayLabels</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>DisplayLabels</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Determines whether to display text at the axis or not.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="TextRotation" class="membertitle">TextRotation</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>TextRotation</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Determines the rotation of the text elements
 (axis description) in 100th degrees.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Marks" class="membertitle">Marks</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>Marks</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Determines the position of the marks.</dd>
<dt><b>See also</b></dt>
<dd><a href="ChartAxisMarks.html">ChartAxisMarks</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="HelpMarks" class="membertitle">HelpMarks</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>HelpMarks</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Determines the position of the help marks.</dd>
<dt><b>See also</b></dt>
<dd><a href="ChartAxisMarks.html">ChartAxisMarks</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="Overlap" class="membertitle">Overlap</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>Overlap</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Determines the overlap of the bars in a bar-type chart.
 
 </dd>
<dd><p>The value is given in percent of the width of the bars. The
 valid range is -100% to +100%. +100% means full overlap, -100%
 indicates a distance of one bar between 2 neighboring bars.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="GapWidth" class="membertitle">GapWidth</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>GapWidth</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Specifies the width of the gaps between each set of data points
 in a bar chart.
 
 </dd>
<dd><p>The value is given in percent of the width of a bar; the
 valid range is 0 to 600%.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="ArrangeOrder" class="membertitle">ArrangeOrder</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td><a href="ChartAxisArrangeOrderType.html">ChartAxisArrangeOrderType</a> <b>ArrangeOrder</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The axis description may be arranged in a special order for a
 better placement.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="TextBreak" class="membertitle">TextBreak</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>TextBreak</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Determines if long text is broken into multiple lines.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="TextCanOverlap" class="membertitle">TextCanOverlap</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>TextCanOverlap</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Determines if certain labels are hidden, if they would otherwise overlap.
 In this case, the value of this property must be set to <b>false</b>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="NumberFormat" class="membertitle">NumberFormat</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>long <b>NumberFormat</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Contains the type id for the number formatter of the axis.

 </dd>
<dt><b>See also</b></dt>
<dd>::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XNumberFormatter.html">XNumberFormatter</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="LinkNumberFormatToSource" class="membertitle">LinkNumberFormatToSource</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>LinkNumberFormatToSource</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>determines whether to use the number format given by the
 container application, e.g. a spreadsheet document, or from
 the own property <a href="#NumberFormat">NumberFormat</a>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="ReverseDirection" class="membertitle">ReverseDirection</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>boolean <b>ReverseDirection</b>;<hr>
<dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>optional</i></dd>
<dt><b>Description</b></dt>
<dd>Determines if the axis orientation is mathematical or reversed.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<br>&nbsp;<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>