bichartcategory.xml

来自「ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．」· XML 代码 · 共 71 行

<?xml version="1.0"?>

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

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

	<description>
		This class is used to describe the categories of the data for a
		<link class="BiGraph">graph</link>.
	</description>

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

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

	<staticFields/>

	<methods>
		<method name="toXmlElement">
			<description>Serializes the category 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>
		<method name="fromXmlElement">
			<description>
				Sets the properties of the category from an XML element
			</description>
			<arguments>
				<argument name="oNode" type="XmlElement" description="The element describing the category"/>
			</arguments>
			<returns type="void"/>
		</method>
	</methods>

	<properties>
		<property name="title" type="String" description="The title of the category" get="true" set="true"/>
		<property name="id" type="String" description="The id of the category" get="true"/>
		<property name="index" type="Number" description="The index of the category" get="true"/>
	</properties>

	<events/>

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

</class>