biabstractchartbase.xml

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

<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiAbstractChartBase" extends="BiComponent">

	<description>
		This is the abstract base class for <link class="BiAbstractChart">BiAbstractChart</link>
		and <link class="BiAbstractChart2">BiAbstractChart2</link>. All the charts
		in <link class="BiGraph">BiGraph</link> and <link class="BiGraph2">BiGraph2</link>
		extend either <link class="BiAbstractChart">BiAbstractChart</link> or
		<link class="BiAbstractChart2">BiAbstractChart2</link>.
	</description>

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

	<staticMethods/>

	<staticFields/>

	<methods>
		<method name="getComponentByCategoryId">
			<description>
				Returns the component (if any) that is being used to display the
				chart point given by the category id.
			</description>
			<arguments>
				<argument name="sCategoryId" description="The id of the category to get the component for"
					type="String"/>
			</arguments>
			<returns>
				<type><link class="BiAbstractChartSectionBase">BiAbstractChartSectionBase</link></type>
			</returns>
		</method>
		<method name="getIconHtml">
			<description>
				Returns the HTML code needed to display an icon representing the chart.
				Implementing this function allows the component to act as an icon for a label.
			</description>
			<arguments>
				<argument name="bHasText">
					<description>Boolean whether the icon should be used with text</description>
					<type>Boolean</type>
				</argument>
				<argument name="bEnabled">
					<description>Whether the icon is enabled</description>
					<type>Boolean</type>
				</argument>
				<argument name="sIconPosition">
					<description>
						The position of the icon. Valid values are "left", "right"
						"top" and "bottom".
					</description>
					<type>String</type>
				</argument>
				<argument name="nIconTextGap">
					<description>
						The gap between the text and the icon.
					</description>
					<type>Number</type>
				</argument>
				<argument name="sClassName" type="String" optional="true">
					<description>
						Optional class name to put on the HTML element representing
						the icon.
					</description>
				</argument>
			</arguments>
			<returns><type>String</type></returns>
		</method>
	</methods>

	<properties>
		<property name="series" description="The series that the chart is displaying" get="true">
			<type><link class="BiChartSeries">BiChartSeries</link></type>
		</property>
		<property name="graph" description="The graphs that the chart is part of" get="true">
			<type><link class="BiGraph">BiGraph</link></type>
		</property>
		<property name="strokeOpacity" type="Number" description="The stroke opacity for the chart" get="true"/>
		<property name="strokeColor" type="String" description="The stroke color for the chart" get="true"/>
		<property name="fillOpacity" type="Number" description="The fill opacity for the chart" get="true"/>
		<property name="fillColor" type="String" description="The fill color for the chart" get="true"/>
		<property name="fillColor2" type="String" description="The alternate fill color used when fill type is gradient" get="true"/>
		<property name="fillType" type="String" description="The fill type used when painting the chart" get="true"/>
		<property name="fillAngle" type="Number" description="The fill angle used when painting the chart." get="true"/>
		<property name="markerType" type="String" get="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"/>
		<property name="explode" type="Number" description="The amount to move the pie chart sections from the middle" get="true"/>
		<property name="barSpacing" type="Number" get="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>
		<property name="supportsValueAxis" type="Boolean" description="Whether this type of graph supports a value axis" get="true"/>
		<property name="supportsCategoryAxis" type="Boolean" description="Whether this type of graph supports a category axis" get="true"/>
		<property name="supportsGridLines" type="Boolean" description="Whether this type of graph supports grid lines" get="true"/>
		<property name="title" type="String" description="Returns the title of the series being displayed" get="true"/>
	</properties>

	<events/>

	<remarks/>

</class>