bichartpresentationmanager.xml

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

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

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

	<description>
		This class is used to find the properties for different visual aspects of
		of the graph.
	</description>

	<arguments>
		<argument name="oGraph">
			<description>The graph that the presentation manager is part of</description>
			<type><link class="BiGraph">BiGraph</link></type>
		</argument>
	</arguments>

	<staticMethods/>

	<staticFields/>

	<methods>
		<method name="getDefaultColor" description="Returns the default color for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The id of the series"/>
				<argument name="sCategoryId" type="String" description="The id of the category" optional="true"/>
			</arguments>
			<returns type="String"/>
		</method>
		<method name="getDefaultMarker" description="Returns the default marker type for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The id of the series"/>
				<argument name="sCategoryId" type="String" description="The id of the category" optional="true"/>
			</arguments>
			<returns type="String"/>
		</method>
		<method name="getFillOpacityForPoint" description="Returns the fill opacity for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point" optional="true"/>
			</arguments>
			<returns type="Number"/>
		</method>
		<method name="getFillColorForPoint" description="Returns the fill color for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point" optional="true"/>
			</arguments>
			<returns type="String"/>
		</method>
		<method name="getFillColor2ForPoint" description="Returns the alternate fill color for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point" optional="true"/>
			</arguments>
			<returns type="String"/>
		</method>
		<method name="getFillTypeForPoint" description="Returns the fill type for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point" optional="true"/>
			</arguments>
			<returns type="String"/>
		</method>
		<method name="getFillAngleForPoint" description="Returns the fill angle for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point" optional="true"/>
			</arguments>
			<returns type="Number"/>
		</method>
		<method name="getStrokeOpacityForPoint" description="Returns the stroke opacity for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point" optional="true"/>
			</arguments>
			<returns type="Number"/>
		</method>
		<method name="getStrokeColorForPoint" description="Returns the stroke color for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point" optional="true"/>
			</arguments>
			<returns type="String"/>
		</method>
		<method name="getMarkerTypeForPoint" description="Returns the marker type for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point" optional="true"/>
			</arguments>
			<returns type="String"/>
		</method>
		<method name="getMarkerVisibleForPoint" description="Returns whether the marker should be visible for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point" optional="true"/>
			</arguments>
			<returns type="Boolean"/>
		</method>
		<method name="getExplodeForPoint" description="Returns the explode value (the distance to move the pie chart section) for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point" optional="true"/>
			</arguments>
			<returns type="Number"/>
		</method>
		<method name="getBarSpacingForPoint" description="Returns the bar spacing for the graph.
			The bar spacing is the same for the entire graph so the arguments are not used.">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point" optional="true"/>
			</arguments>
			<returns type="Number"/>
		</method>

		<method name="setFillOpacityForPoint" description="Sets the fill opacity for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point"/>
				<argument name="nFillOpacity" type="Number" description="The fill opacity for the point"/>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="setFillColorForPoint" description="Sets the fill color for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point"/>
				<argument name="sFillColor" type="String" description="The fill color for the point"/>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="setFillColor2ForPoint" description="Sets the alternate fill color for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point"/>
				<argument name="sFillColor2" type="String" description="The altrenate fill color for the point"/>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="setFillTypeForPoint" description="Sets the fill type for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point"/>
				<argument name="sFillType" type="String" description="The fill type for the point"/>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="setFillAngleForPoint" description="Sets the fill angle for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point"/>
				<argument name="nFillAngle" type="Number" description="The fill angle for the point"/>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="setStrokeOpacityForPoint" description="Sets the stroke opacity for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point"/>
				<argument name="nStrokeOpacity" type="Number" description="The stroke opacity for the point"/>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="setStrokeColorForPoint" description="Sets the stroke color for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point"/>
				<argument name="sStrokeColor" type="String" description="The stroke color for the point"/>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="setMarkerTypeForPoint" description="Sets the marker type for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point"/>
				<argument name="sMarkerType" type="String" description="The marker type for the point"/>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="setMarkerVisibleForPoint" description="Sets the marker visible for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point"/>
				<argument name="bMarkerVisible" type="Boolean" description="The marker visible for the point"/>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="setExplodeForPoint" description="Sets the explode value for the point with the given ids">
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point"/>
				<argument name="nExplode" type="Number" description="The explode value for the point"/>
			</arguments>
			<returns type="void"/>
		</method>
		<method name="setBarSpacingForPoint">
			<description>
				Sets the bar spacing for the graph. Since the bar spacing is the
				same for all charts in the graph the <code>sSeriesId</code> and
				<code>sCategoryId</code> arguments are ignored here.
			</description>
			<arguments>
				<argument name="sSeriesId" type="String" description="The series id of the point"/>
				<argument name="sCategoryId" type="String" description="The category id of the point"/>
				<argument name="nBarSpacing" type="Number" description="The bar spacing for the graph"/>
			</arguments>
			<returns type="void"/>
		</method>
	</methods>

	<properties/>

	<events/>

	<remarks>
		Visual changes to points should be done using this class instead of directly
		changing the <link class="BiAbstractChart">BiAbstractChart</link> or
		the <link class="BiAbstractChartSection">BiAbstractChartSection</link>.
	</remarks>
</class>