bigraphbase.xml

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

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

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

	<description>
		This is the abstract base class for <link class="BiGraph">BiGraph</link>
		and <link class="BiGraph2">BiGraph2</link>. If Mozilla support is needed
		use <link class="BiGraph2">BiGraph2</link>. If line chart and/or pie chart
		is needed then use <link class="BiGraph">BiGraph</link>.
	</description>

	<arguments/>

	<staticMethods/>

	<staticFields/>

	<methods>
		<method name="addSeries">
			<description>
				Adds a series to the series collection
			</description>
			<arguments>
				<argument name="oSeries" description="The series to add">
					<type><link class="BiChartSeries">BiChartSeries</link></type>
				</argument>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="removeSeries">
			<description>
				Removes a series from the series collection
			</description>
			<arguments>
				<argument name="oSeries" description="The series to remove">
					<type><link class="BiChartSeries">BiChartSeries</link></type>
				</argument>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="clearSeries">
			<description>
				Removes all series from the series collection
			</description>
			<arguments/>
			<returns type="void"/>
		</method>
		<method name="getSeriesById">
			<description>Returns the series with the given id</description>
			<arguments>
				<argument name="sId" description="The id of the series to retrieve" type="String"/>
			</arguments>
			<returns>
				<type><link class="BiChartSeries">BiChartSeries</link></type>
			</returns>
		</method>
		<method name="addCategory">
			<description>Adds a category to the categories collection</description>
			<arguments>
				<argument name="oCategory" description="The category to add">
					<type><link class="BiChartCategory">BiChartCategory</link></type>
				</argument>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="removeCategory">
			<description>Removes a category from the categories collection</description>
			<arguments>
				<argument name="oCategory" description="The category to remove">
					<type><link class="BiChartCategory">BiChartCategory</link></type>
				</argument>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="clearCategories">
			<description>Removes all categories from the categories collection</description>
			<arguments/>
			<returns type="void"/>
		</method>
		<method name="getCategoryById">
			<description>Returns the category with the given id</description>
			<arguments>
				<argument name="sId" description="The id of the category to retrieve" type="String"/>
			</arguments>
			<returns>
				<type><link class="BiChartCategory">BiChartCategory</link></type>
			</returns>
		</method>
		<method name="addPoint">
			<description>Adds a point to the points collection</description>
			<arguments>
				<argument name="oPoint" description="The point to add">
					<type><link class="BiChartPoint">BiChartPoint</link></type>
				</argument>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="removePoint">
			<description>Removes a point from the points collection</description>
			<arguments>
				<argument name="oPoint" description="The point to remove">
					<type><link class="BiChartPoint">BiChartPoint</link></type>
				</argument>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="clearPoints">
			<description>Removes all points from the points collection</description>
			<arguments/>
			<returns type="void"/>
		</method>
		<method name="getPointByIds">
			<description>Returns the point with the given series id and the given category id</description>
			<arguments>
				<argument name="sSeriesId" description="The series id of the point to retrieve" type="String"/>
				<argument name="sCategoryId" description="The category id of the point to retrieve" type="String"/>
			</arguments>
			<returns>
				<type><link class="BiChartPoint">BiChartPoint</link></type>
			</returns>
		</method>
		<method name="getComponentByIds">
			<description>This returns the component used to render the section for a certain data point.</description>
			<arguments>
				<argument name="sSeriesId" description="The id of the series to get the component for" type="String"/>
				<argument name="sCategoryId" description="The id of the category to get the component for" type="String"/>
			</arguments>
			<returns>
				<type><link class="BiAbstractChartSection">BiAbstractChartSection</link></type>
			</returns>
		</method>
		<method name="getChartPresentationBySeriesId">
			<description>This returns the chart presentation used to describe how to render chart belonging to a series.</description>
			<arguments>
				<argument name="sSeriesId" description="The id of the series to get the presentation for" type="String"/>
			</arguments>
			<returns>
				<type><link class="BiChartPresentation">BiChartPresentation</link></type>
			</returns>
		</method>
		<method name="getChartForSeries">
			<description>Returns the chart component used to display the series.</description>
			<arguments>
				<argument name="oSeries" description="The series to get the chart for">
					<type><link class="BiChartSeries">BiChartSeries</link></type>
				</argument>
			</arguments>
			<returns>
				<type><link class="BiAbstractChart">BiAbstractChart</link></type>
			</returns>
		</method>
		<method name="update">
			<description>
				Updates the graph and recreates the internal charts. This should
				be called after changes to the graph.
			</description>
			<arguments/>
			<returns type="void"/>
		</method>
		<method name="updatePoint">
			<description>
				Updates the graph and recreates the internal representations
				for the given point. This should be called after changes to a point
				or a series. Leaving out the category makes this update all the
				points in the given series.
			</description>
			<arguments>
				<argument name="sSeriesId" type="string">
					<description>
						The id of the series that the graph should be update to
						reflect. This usually updates the chart assosciated with
						the series.
					</description>
				</argument>
				<argument name="sCategoryId" type="string" optional="true">
					<description>
						The id of the category that the graph should be update to
						reflect. If provided this means that a point should be udpated.
						This usually updates means that a certain bar or marker is
						updated.
					</description>
				</argument>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="fromXmlDocument">
			<description>This takes an XML document describing the graph data and the graph
				presentation and makes the graph reflect that information.</description>
			<arguments>
				<argument name="oDocument" description="The XML document describing the graph">
					<type><link class="BiXmlDocument">BiXmlDocument</link></type>
				</argument>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="toXmlDocument">
			<description>Serializes the graph to an XML document.</description>
			<arguments/>
			<returns>
				<type><link class="BiXmlDocument">BiXmlDocument</link></type>
			</returns>
		</method>
		<method name="getContextMenuForPoint">
			<description>
				This method is used to return the context menu for a certain point.
				Override this method to provide yout own menus.
			</description>
			<arguments>
				<argument name="oSeries" description="The series to get the tool tip for">
					<type><link class="BiChartSeries">BiChartSeries</link></type>
				</argument>
				<argument name="oCategory" description="The category to get the tool tip for">
					<type><link class="BiChartCategory">BiChartCategory</link></type>
				</argument>
			</arguments>
			<returns>
				<type><link class="BiMenu">BiMenu</link></type>
			</returns>
		</method>
		<method name="getToolTipForPoint">
			<description>
				This method is used to return the tool tip to show for a certain point.
				Override this method to provide yout own tool tips.
			</description>
			<arguments>
				<argument name="oSeries" description="The series to get the tool tip for">
					<type><link class="BiChartSeries">BiChartSeries</link></type>
				</argument>
				<argument name="oCategory" description="The category to get the tool tip for">
					<type><link class="BiChartCategory">BiChartCategory</link></type>
				</argument>
			</arguments>
			<returns>
				<type><link class="BiToolTip">BiToolTip</link></type>
			</returns>
		</method>
	</methods>

	<properties>
		<property name="presentationManager" description="This returns the presentation manager for the graph" get="true">
			<type><link class="BiChartPresentationManager">BiChartPresentationManager</link></type>
		</property>
		<property name="chartArea" description="This property points to the chart area component" get="true">
			<type><link class="BiChartArea">BiChartArea</link></type>
		</property>
		<property name="valueAxis" description="This property points to the value axis component" get="true">
			<type><link class="BiChartValueAxis">BiChartValueAxis</link></type>
		</property>
		<property name="categoryAxis" description="This property points to the category axis component" get="true">
			<type><link class="BiChartCategoryAxis">BiChartCategoryAxis</link></type>
		</property>
		<property name="gridLines" description="This property points to the grid lines component" get="true">
			<type><link class="BiChartGridLines">BiChartGridLines</link></type>
		</property>
		<property name="legend" description="This property points to the legend component" get="true">
			<type><link class="BiChartLegend">BiChartLegend</link></type>
		</property>
		<property name="autoScale" type="Boolean" get="true" set="true">
			<description>
				Allows you turn off the automatic scaling of the graph
			</description>
		</property>
		<property name="grid" get="true">
			<description>
				This property returns the <link class="BiGrid">grid</link> used
				as the <link class="BiGridChart">grid chart</link> if the
				<link field="chartType">chart type</link> is set to <code>grid</code>.
				Otherwise this is <code>null</code>.
			</description>
			<type><link class="BiGridChart">BiGridChart</link></type>
		</property>
		<property name="fontSize" get="true" set="true">
			<description>
				Sets the font size for the legend and axes. If <link>autoScale</link>
				is true then this does not apply.
			</description>
			<type>Number</type>
		</property>
		<property name="series" description="This is an array containing the series used for the data of the graph.
			After this property is changed the graph component needs to be updated." get="true" set="true">
			<type><link class="BiChartSeries">BiChartSeries[]</link></type>
		</property>
		<property name="categories" description="This is an array containing the categories used for the data of the graph.
			After this property is changed the graph component needs to be updated." get="true" set="true">
			<type><link class="BiChartCategory">BiChartCategory[]</link></type>
		</property>
		<property name="points" description="This is an array containing the points used for the data of the graph." get="true" set="true">
			<type><link class="BiChartPoint">BiChartPoint[]</link></type>
		</property>
		<property name="chartType" type="String" get="true" set="true">
			<description>
				The type of the chart. Available types are:<br/>
				<br/>
				bar<br/>
				column<br/>
				grid<br/>
				line<br/>
				pie<br/>
				percentagestackedbar<br/>
				percentagestackedcolum<br/>
				stackedbar<br/>
				stackedcolumn<br/>
				grid
			</description>
		</property>
		<property name="charts" description="This is an array containing the chart components used to display the charts." get="true">
			<type><link class="BiAbstractChart">BiAbstractChart[]</link></type>
		</property>
	</properties>

	<events>
		<event name="pointclick" description="Fires when the user clicks on a point in the graph">
			<type><link class="BiChartMouseEvent">BiChartMouseEvent</link></type>
		</event>
		<event name="pointcontextmenu" description="Fires when the user right clicks on a point">
			<type><link class="BiChartMouseEvent">BiChartMouseEvent</link></type>
		</event>
		<event name="pointdblclick" description="Fires when the user double clicks on a point">
			<type><link class="BiChartMouseEvent">BiChartMouseEvent</link></type>
		</event>
		<event name="pointmousedown" description="Fires when the user presses down the mouse button on a point">
			<type><link class="BiChartMouseEvent">BiChartMouseEvent</link></type>
		</event>
		<event name="pointmousemove" description="Fires when the user moves the mouse over a point">
			<type><link class="BiChartMouseEvent">BiChartMouseEvent</link></type>
		</event>
		<event name="pointmouseout">
			<type><link class="BiChartMouseEvent">BiChartMouseEvent</link></type>
			<description>
				Fires when the mouse pointer leaves a point
			</description>
		</event>
		<event name="pointmouseover">
			<type><link class="BiChartMouseEvent">BiChartMouseEvent</link></type>
			<description>
				Fires when the mouse pointer enters a point
			</description>
		</event>
		<event name="pointmouseup" description="Fires when the releases the mouse button on a point">
			<type><link class="BiChartMouseEvent">BiChartMouseEvent</link></type>
		</event>
		<event name="pointmousewheel" description="This event is fired when the user scrolls the mouse wheel over a point">
			<type><link class="BiChartMouseEvent">BiChartMouseEvent</link></type>
		</event>
	</events>

</class>