bigaugesection.xml

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

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

<class name="BiGaugeSection" extends="BiComponent">

	<description>
		This component is used to show a section for a <link class="BiGauge">gauge</link>.
		A guage can have several sections and these are usually used to split
		the gaguge values into logical value ranges.
	</description>

	<arguments>
		<argument name="oGauge">
			<type><link class="BiGauge">BiGauge</link></type>
			<description>
				The gauge that the section is part of
			</description>
		</argument>
		<argument name="nStart" type="number" optional="true" default="90">
			<description>
				The start value for the section
			</description>
		</argument>
		<argument name="nEnd" type="number" optional="true" default="100">
			<description>
				The end value for the section
			</description>
		</argument>
	</arguments>

	<staticMethods/>

	<staticFields/>

	<methods/>

	<properties>
		<property name="gauge" description="The gauge that the section is a part of" get="true">
			<type><link class="BiGauge">BiGauge</link></type>
		</property>
		<property name="startValue" type="Number" get="true" set="true">
			<description>
				The start value of the section
			</description>
		</property>
		<property name="endValue" type="Number" get="true" set="true">
			<description>
				The end value of the section
			</description>
		</property>
		<property name="color" type="String" description="The color of the section" get="true" set="true"/>
	</properties>

	<events/>

	<remarks>
		A gauge can have any number of sections. To add and remove sections just
		use the normal <link class="BiComponent" field="add">add</link> and
		<link class="BiComponent" field="remove">remove</link> methods.<br/>
		<br/>
		When the gauge is created one section, called <link class="BiGauge" field="warningSection">warningSection</link>
		is already created. There are a few properties of the gauge that work
		directly on this section but you can also work directly on the section
		object.
	</remarks>

</class>