bichartpresentation.xml

ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．

<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>

<class name="BiChartPresentation" extends="BiObject">

	<description>
		This class is used to define the presentation attributes for a chart.
	</description>

	<arguments>
		<argument name="oGraph">
			<description>The graph that the chart presentation is part of</description>
			<type><link class="BiGraph">BiGraph</link></type>
		</argument>
		<argument name="oSeries">
			<description>The series that the chart presentation is representing</description>
			<type><link class="BiChartSeries">BiChartSeries</link></type>
		</argument>
	</arguments>

	<staticMethods>
		<method name="fromXmlElement">
			<description>Creates a new chart presentation object from an XML element</description>
			<arguments>
				<argument name="oGraph" description="The graph that the presentationchart belongs to">
					<type><link class="BiGraph">BiGraph</link></type>
				</argument>
				<argument name="oNode" type="XmlElement" description="The element describing the chart presentation"/>
			</arguments>
			<returns>
				<type><link class="BiChartPresentation">BiChartPresentation</link></type>
			</returns>
		</method>
	</staticMethods>

	<staticFields/>

	<methods>
		<method name="hasStrokeOpacity">
			<description>Returns true if the <link>strokeOpacity</link> property has been set on the chart presentation</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasStrokeColor">
			<description>Returns true if the <link>strokeColor</link> property has been set on the chart presentation</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasFillOpacity">
			<description>Returns true if the <link>fillOpacity</link> property has been set on the chart presentation</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasFillColor">
			<description>Returns true if the <link>fillColor</link> property has been set on the chart presentation</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasFillColor2">
			<description>Returns true if the <link>fillColor2</link> property has been set on the chart presentation</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasFillType">
			<description>Returns true if the <link>fillType</link> property has been set on the chart presentation</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasFillAngle">
			<description>Returns true if the <link>fillAngle</link> property has been set on the chart presentation</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasMarkerType">
			<description>Returns true if the <link>markerType</link> property has been set on the chart presentation</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasMarkerVisible">
			<description>Returns true if the <link>markerVisible</link> property has been set on the chart presentation</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasExplode">
			<description>Returns true if the <link>explode</link> property has been set on the chart presentation</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasBarSpacing">
			<description>Returns true if the <link>barSpacing</link> property has been set on the chart presentation</description>
			<returns type="Boolean"/>
		</method>
		<method name="toXmlElement">
			<description>Serializes the chart presentation to an XML element</description>
			<arguments>
				<argument name="oDoc" description="The XML document to create the element in">
					<type><link class="BiXmlDocument">BiXmlDocument</link></type>
				</argument>
			</arguments>
			<returns type="XmlElement"/>
		</method>
		<method name="fromXmlElement">
			<description>Gets the properties of the chart presentation an XML element</description>
			<arguments>
				<argument name="oNode" type="XmlElement" description="The element describing the chart presentation"/>
			</arguments>
			<returns type="void"/>
		</method>
	</methods>

	<properties>
		<property name="strokeOpacity" type="Number" description="The stroke opacity for the chart" get="true" set="true"/>
		<property name="strokeColor" type="String" description="The stroke color for the chart" get="true" set="true"/>
		<property name="fillColor" type="String" description="The fill color for the chart" get="true" set="true"/>
		<property name="fillOpacity" type="Number" description="The fill opacity for the chart" get="true" set="true"/>
		<property name="fillColor2" type="String" description="The alternate fill color used when fill type is gradient" get="true" set="true"/>
		<property name="fillType" type="String" description="The fill type used when painting the chart" get="true" set="true"/>
		<property name="fillAngle" type="Number" description="The fill angle used when painting the chart." get="true" set="true"/>
		<property name="markerType" type="String" get="true" set="true">
			<description>The marker type for the line chart. Valid values are<br/>
				<br/>
				circle<br/>
				square<br/>
				trianle<br/>
				diamond
			</description>
		</property>
		<property name="markerVisible" type="String" description="Whether markers are visible for the chart" get="true" set="true"/>
		<property name="explode" type="Number" description="The amount to move the pie chart sections from the middle" get="true" set="true"/>
		<property name="barSpacing" type="Number" get="true" set="true">
			<description>
				This is the relative distance between the bars or columns of different categories.
				<code>1</code> means that the distance is the same as the width/height of the column/bar.
				<code>0</code> means that there is no spacing.
			</description>
		</property>
	</properties>

	<events/>

	<remarks>
		Changes to this might not become updated until the chart is updated. It
		is therefore bettter to use the <link class="BiChartPresentationManager">BiChartPresentationManager</link>
	</remarks>
</class>