bichartseries.xml

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

<?xml version="1.0"?>

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


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

	<description>
		This describes a series of values that is used with the <link class="BiGraph">graph</link>
		control. Each series has a unique <link>id</link> and every value of the series
		belongs to a certain <link class="BiChartCategory">category</link>.
	</description>

	<arguments>
		<argument name="oGraph" description="The graph that the series belongs to">
			<type><link class="BiGraph">BiGraph</link></type>
		</argument>
		<argument name="sId" type="String" description="The id of the series"/>
		<argument name="sTitle" type="String" description="The title of the series" optional="true"/>

		<argument name="oValues" type="Number[]" optional="true" default="[]"
			description="The values in the series given in the same order as the categories"/>
	</arguments>

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

	<staticFields/>

	<methods>
		<method name="getValueByCategory">
			<description>Returns the value for the given category</description>
			<arguments>
				<argument name="oCategory" description="The category to get the value for">
					<type><link class="BiChartCategory">BiChartCategory</link></type>
				</argument>
			</arguments>
			<returns type="Number"/>
		</method>
		<method name="setValueByCategory">
			<description>Sets the value for the given category</description>
			<arguments>
				<argument name="oCategory" description="The category to set the value for">
					<type><link class="BiChartCategory">BiChartCategory</link></type>
				</argument>
				<argument name="nValue" type="Number" description="The value to set"/>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="getValueByCategoryId">
			<description>Returns the value for the given category id</description>
			<arguments>
				<argument name="sCatId" type="String" description="The category id to get the value for"/>
			</arguments>
			<returns type="Number"/>
		</method>
		<method name="setValueByCategoryId">
			<description>Sets the value for the given category id</description>
			<arguments>
				<argument name="sCatId" type="String" description="The category id to set the value for"/>
				<argument name="nValue" type="Number" description="The value to set"/>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="getValueByIndex">
			<description>Returns the value for the given index</description>
			<arguments>
				<argument name="i" type="Number" description="The index to get the value for"/>
			</arguments>
			<returns type="Number"/>
		</method>
		<method name="setValueByIndex">
			<description>Sets the value for the given index</description>
			<arguments>
				<argument name="i" type="Number" description="The category id to set the value for"/>
				<argument name="nValue" type="Number" description="The value to set"/>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="toXmlElement">
			<description>Serializes the series to an XML element (sub tree)</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>
	</methods>

	<properties>
		<property name="title" type="String" description="The title of the series" get="true" set="true"/>
		<property name="id" type="String" description="The id of the series" get="true"/>
		<property name="index" type="Number" description="The index of the series" get="true"/>
		<property name="maximumValue" type="Number" description="The maximum of the values in the series" get="true"/>
		<property name="minimumValue" type="Number" description="The maximum of the values in the series" get="true"/>
		<property name="sum" type="Number" description="The sum of the values in the series" get="true"/>
		<property name="absSum" type="Number" description="The sum of the absolute values in the series" get="true"/>
		<property name="values" type="Number[]" get="true" set="true">
			<description>
				The values in the series. This is the same order as the order of
				the categories. If a value for a certain category is missing the
				value for that is <code>null</code> in the array.
			</description>
		</property>
	</properties>

	<events/>

	<remarks>
		Changing the series does not update the chart. The graph components needs
		to be updated manually.
	</remarks>

</class>