biabstractchartsectionbase.xml

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

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

	<description>
		Used as base class for marker, column rect and pie chart section. These
		are used to create the visual presentation for the data points of a chart.
	</description>

	<arguments>
		<argument name="oChart">
			<description>The chart that the chart section is part of</description>
			<type><link class="BiAbstractChart">BiAbstractChart</link></type>
		</argument>
		<argument name="oCategory">
			<description>The category that the chart section is displaying</description>
			<type><link class="BiChartCategory">BiChartCategory</link></type>
		</argument>
	</arguments>

	<staticMethods/>

	<staticFields/>

	<methods>
		<method name="hasStrokeColor">
			<description>Returns true if the <link>strokeColor</link> property has been set on the section</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasStrokeOpacity">
			<description>Returns true if the <link>strokeOpacity</link> property has been set on the section</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasFillOpacity">
			<description>Returns true if the <link>fillOpacity</link> property has been set on the section</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasFillColor">
			<description>Returns true if the <link>fillColor</link> property has been set on the section</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasFillColor2">
			<description>Returns true if the <link>fillColor2</link> property has been set on the section</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasFillType">
			<description>Returns true if the <link>fillType</link> property has been set on the section</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasFillAngle">
			<description>Returns true if the <link>fillAngle</link> property has been set on the section</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasMarkerType">
			<description>Returns true if the <link>markerType</link> property has been set on the section</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasMarkerVisible">
			<description>Returns true if the <link>markerVisible</link> property has been set on the section</description>
			<returns type="Boolean"/>
		</method>
		<method name="hasExplode">
			<description>Returns true if the <link>explode</link> property has been set on the section</description>
			<returns type="Boolean"/>
		</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="chart" description="The chart that the chart section is part of" get="true">
			<type><link class="BiAbstractChart">BiAbstractChart</link></type>
		</property>
		<property name="series" description="The series that the chart section is displaying" get="true">
			<type><link class="BiChartSeries">BiChartSeries</link></type>
		</property>
		<property name="category" description="The category that the chart section is displaying" get="true">
			<type><link class="BiChartCategory">BiChartCategory</link></type>
		</property>
		<property name="graph" description="The graphs that the chart section is part of" get="true">
			<type><link class="BiGraphBase">BiGraphBase</link></type>
		</property>
		<property name="strokeOpacity" type="Number" description="The stroke opacity for the chart" get="true" set="true"/>
		<property name="strokeColor" type="String" description="The stroke color for the chart" get="true" set="true"/>
		<property name="fillOpacity" type="Number" description="The fill opacity for the chart" get="true" set="true"/>
		<property name="fillColor" type="String" description="The fill color for the chart" get="true" set="true"/>
		<property name="fillColor2" type="String" description="The alternate fill color used when fill type is gradient" get="true" set="true"/>
		<property name="fillType" type="String" description="The fill type used when painting the chart" get="true" set="true"/>
		<property name="fillAngle" type="Number" description="The fill angle used when painting the chart." get="true" set="true"/>
		<property name="markerType" type="String" description="The marker type for the chart" get="true" set="true"/>
		<property name="markerVisible" type="String" description="Whether markers are visible for the chart" get="true" set="true"/>
		<property name="explode" type="Number" description="The amount to move the pie chart section from the center (percentage of radius)" get="true" set="true"/>
		<property name="toolTip" get="true">
			<description>
				Returns the tool tip to show. If this returns null no tool tip is used for the section.
			</description>
			<type><link class="BiToolTip">BiToolTip</link></type>
		</property>
		<property name="contextMenu" get="true">
			<description>
				Returns the context menu for the section. This returns null if no
				specific context menu is available for the section.
			</description>
			<type><link class="BiMenu">BiMenu</link></type>
		</property>
		<property name="title" type="String" description="Returns the title of the category the section is part of" get="true"/>
	</properties>

	<events/>

	<remarks>
		It is preferred to set the properties on the graph
		<link class="BiChartPresentationManager">presentation manager</link>
		instead of directly setting it on the section. Setting the property on
		the <link class="BiChartPresentationManager">presentation manager</link>
		makes it persist when changing the type of the chart and other changes
		that require the sections to be recreated.
	</remarks>

</class>