biolapgridviewmanager.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="api.xsl"?>
<class name="BiOlapGridViewManager" extends="BiObject">
	<description>This class handles the visual properties of a<link class="BiOlapGrid">BiOlapGrid</link>
	</description>
	<arguments>
		<argument name="oOlapGrid">
			<description>The OLAP grid this view manager is to be
 								used with</description>
			<type>
				<link class="BiOlapGrid">BiOlapGrid</link>
			</type>
		</argument>
	</arguments>
	<staticMethods>
	</staticMethods>
	<staticFields>
	</staticFields>
	<methods>
		<method name="resetCache">
			<description>Resets the cached properties. This is called a size change so that the cache
 is up to date</description>
			<arguments>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="scrollColumnIntoView">
			<description>Scrolls the OLAP grid so that the given column becomes visible</description>
			<arguments>
				<argument name="x">
					<description>The index of the column to scroll into view</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="scrollRowIntoView">
			<description>Scrolls the OLAP grid so that the given row becomes visible</description>
			<arguments>
				<argument name="y">
					<description>The index of the row to scroll into view</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="scrollCellIntoView">
			<description>Scrolls the OLAP grid so that the given cell becomes visible</description>
			<arguments>
				<argument name="x">
					<description>The column index of the cell to scroll into view</description>
					<type>Number</type>
				</argument>
				<argument name="y">
					<description>The row index of the cell to scroll into view</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="scrollAreaIntoView">
			<description>This scrolls the OLAP grid so that the given area becomes visible</description>
			<arguments>
				<argument name="oArea">
					<description>The area to scroll into view</description>
					<type>
						<link class="BiArea">BiArea</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getAreaWidth">
			<description>The returns the width (in pixels) of an area</description>
			<arguments>
				<argument name="oArea">
					<description>The area to get the width for</description>
					<type>
						<link class="BiArea">BiArea</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getAreaHeight">
			<description>The returns the height (in pixels) of an area</description>
			<arguments>
				<argument name="oArea">
					<description>The area to get the height for</description>
					<type>
						<link class="BiArea">BiArea</link>
					</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getVisibleCellsCount">
			<description>This is the number of visible cells. This includes cells in the fixed as well
 as the non fixed section of the viewport.</description>
			<arguments>
				<argument name="nAxis">
					<description>The axis to get the cell count for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getFirstVisibleCell">
			<description>This returns the first visible cell on the axis. This includes the cells in
 the fixed section of the viewport.</description>
			<arguments>
				<argument name="nAxis">
					<description>The axis to get the cell for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getLastVisibleCell">
			<description>This returns the last visible cell on the axis</description>
			<arguments>
				<argument name="nAxis">
					<description>The axis to get the cell for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getShowHeaders">
			<description>Whether to show the headers for the axis</description>
			<arguments>
				<argument name="nAxis">
					<description>The axis</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="setShowHeaders">
			<description>Sets whether the headers for the axis is shown</description>
			<arguments>
				<argument name="nAxis">
					<description>The axis</description>
					<type>Number</type>
				</argument>
				<argument name="b">
					<description>Shown or not</description>
					<type>Boolean</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getDimensionHeight">
			<description>The height for the header representing a dimension in the column header</description>
			<arguments>
				<argument name="nDim">
					<description>The dimension index</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="setDimensionHeight">
			<description>Sets the height for the header representing a dimension in the column header</description>
			<arguments>
				<argument name="nDim">
					<description>The dimension index</description>
					<type>Number</type>
				</argument>
				<argument name="nHeight">
					<description>The new height for the dimension</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getDimensionWidth">
			<description>The width for the header representing a dimension in the row header</description>
			<arguments>
				<argument name="nDim">
					<description>The dimension index</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="setDimensionWidth">
			<description>Sets the width for the header representing a dimension in the row header</description>
			<arguments>
				<argument name="nDim">
					<description>The dimension index</description>
					<type>Number</type>
				</argument>
				<argument name="nWidth">
					<description>The new width for the dimension</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getAxisCellWidth">
			<description>This returns the width of a cell in the column header for the given axis. This
 width is the number of pixels the cell should take up.</description>
			<arguments>
				<argument name="nDim">
					<description>The dimension index</description>
					<type>Number</type>
				</argument>
				<argument name="nPos">
					<description>The start position of the cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getAxisCellHeight">
			<description>This returns the height of a cell in the row header for the given axis. This
 is the width in pixels.</description>
			<arguments>
				<argument name="nDim">
					<description>The dimension index</description>
					<type>Number</type>
				</argument>
				<argument name="nPos">
					<description>The start position of the cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getAxisDimensionCount">
			<description>This returns the number of visible dimensions for the given axis</description>
			<arguments>
				<argument name="nAxis">
					<description>The axis to get the dimension count for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getAxisDimensionVisible">
			<description>Whether the dimension is visible</description>
			<arguments>
				<argument name="nAxis">
					<description>The axis that the dimension is part of</description>
					<type>Number</type>
				</argument>
				<argument name="nDim">
					<description>The index of the dimension</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="setAxisDimensionVisible">
			<description>Sets whether the dimension is visible</description>
			<arguments>
				<argument name="nAxis">
					<description>The axis that the dimension is part of</description>
					<type>Number</type>
				</argument>
				<argument name="nDim">
					<description>The index of the dimension</description>
					<type>Number</type>
				</argument>
				<argument name="bVisible">
					<description>Whether to show the dimension</description>
					<type>Boolean</type>
				</argument>
			</arguments>
			<returns>
				<type>void</type>
			</returns>
		</method>
		<method name="getAxisCellIsVisible">
			<description>Whether the axis cell is visible. For this to be true it is enough that any
 of the cells the axis cell covers is visible</description>
			<arguments>
				<argument name="nAxis">
					<description>The axis that the dimension is part of</description>
					<type>Number</type>
				</argument>
				<argument name="nDim">
					<description>The index of the dimension</description>
					<type>Number</type>
				</argument>
				<argument name="nPos">
					<description>The start position of the axis cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Boolean</type>
			</returns>
		</method>
		<method name="getAxisCellPositionWidth">
			<description>The number of positions the axis header cell takes up. This only includes
 visible cells</description>
			<arguments>
				<argument name="nAxis">
					<description>The axis that the dimension is part of</description>
					<type>Number</type>
				</argument>
				<argument name="nDim">
					<description>The index of the dimension</description>
					<type>Number</type>
				</argument>
				<argument name="nPos">
					<description>The start position of the axis cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getNextDimension">
			<description>This returns the next visible dimension</description>
			<arguments>
				<argument name="nAxis">
					<description>The axis that the dimension is part of</description>
					<type>Number</type>
				</argument>
				<argument name="nDim">
					<description>The dimension index to get the next after</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getFirstVisibleDimension">
			<description>This returns the first visible dimension</description>
			<arguments>
				<argument name="nAxis">
					<description>The axis that you want the dimension for</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getNextAxisPosition">
			<description>This returns the position of the next axis header cell</description>
			<arguments>
				<argument name="nAxis">
					<description>The axis to the cells are part of</description>
					<type>Number</type>
				</argument>
				<argument name="nDim">
					<description>The index of the dimension</description>
					<type>Number</type>
				</argument>
				<argument name="nPos">
					<description>The start position of the axis cell</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getAxisCellStartPosition">
			<description>This takes a position and returns the position where the axis cell starts.
 This asks the data model for this information since the data model might be
 able to do a more efficient implementation than looping over all cells.</description>
			<arguments>
				<argument name="nAxis">
					<description>The axis to the cell is part of</description>
					<type>Number</type>
				</argument>
				<argument name="nDim">
					<description>The index of the dimension</description>
					<type>Number</type>
				</argument>
				<argument name="nPos">
					<description>A position that is part of the axis cell.</description>
					<type>Number</type>
				</argument>
			</arguments>
			<returns>
				<type>Number</type>
			</returns>
		</method>
		<method name="getAxisPositionDistance">
			<description>This returns the distance (in positions) between 2 cells. This subtracts any
 hidden cells between the 2 cells</description>
			<arguments>