📄 biolapgridviewmanager.html
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"><html><!--Generated using api.website.xsl version 2003-07-17--><head><META http-equiv="Content-Type" content="text/html; charset=utf-8"><title>BiOlapGridViewManager</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type="text/css" rel="stylesheet" href="api.css"><script type="text/javascript"> function showDerivedClasses() { var ul = document.getElementById("api-derived-classes"); var lis = ul.childNodes; var l = lis.length; for (var i = 1; i < l; i++) lis[i].style.display = ""; lis[0].style.display = "none"; } </script></head><body><h1 id="BiOlapGridViewManager">BiOlapGridViewManager</h1><p>This class handles the visual properties of a<code><a href="BiOlapGrid.html">BiOlapGrid</a></code> </p><p>This class extends <code><a href="BiObject.html">BiObject</a></code> and therefore all methods and fields available for <code><a href="BiObject.html">BiObject</a></code> are also available for <code>BiOlapGridViewManager</code>.</p><ul class="partial-class-tree"><li><code><a href="BiObject.html">BiObject</a></code><ul><li><code>BiOlapGridViewManager</code><ul id="api-derived-classes"></ul></li></ul></li></ul><h2>Constructor</h2><p><code> new BiOlapGridViewManager(<span class="methodArgument">oOlapGrid</span>)</code></p><h3>Parameters</h3><table><thead><tr><td>Name</td><td>Type</td><td class="optional-header">Optional</td><td>Default</td><td>Descripton</td></tr></thead><tbody><tr><td><code>oOlapGrid</code></td><td><code class="type"> <code><a href="BiOlapGrid.html">BiOlapGrid</a></code> </code></td><td class="optional-column"></td><td></td><td>The OLAP grid this view manager is to be used with</td></tr></tbody></table><h2>Properties</h2><table><thead><tr><td>Name</td><td>Type</td><td class="get-header">get</td><td class="set-header">set</td><td>Descripton</td></tr></thead><tbody><tr><td><a name="axisHeight"></a><code>axisHeight</code></td><td><code class="type">Number</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>Returns the height of the column header for the axis.</td></tr><tr><td><a name="axisOnTop"></a><code>axisOnTop</code></td><td><code class="type">Number</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"><img src="check.png" alt="checked"></td><td>This is used to tell which axis is to be shown as the column headers and which to be shown as the row headers. A value of 0 means that the first axis should be shown at the top.</td></tr><tr><td><a name="axisWidth"></a><code>axisWidth</code></td><td><code class="type">Number</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>Returns the width of the row header for the axis</td></tr><tr><td><a name="cellMinimumHeight"></a><code>cellMinimumHeight</code></td><td><code class="type">Number</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"><img src="check.png" alt="checked"></td><td>The minimum height a cell might have. This is used when the user resizes a row. Setting this does not update the exisiting rows.</td></tr><tr><td><a name="cellMinimumWidth"></a><code>cellMinimumWidth</code></td><td><code class="type">Number</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"><img src="check.png" alt="checked"></td><td>The minimum width a cell might have. This is used when the user resizes a colum. Setting this does not update the exisiting columns.</td></tr><tr><td><a name="cellPaddingX"></a><code>cellPaddingX</code></td><td><code class="type">Number</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>This returns the amount of padding to take into account when sizing the cells This returns different values depending on the user agent.</td></tr><tr><td><a name="cellPaddingY"></a><code>cellPaddingY</code></td><td><code class="type">Number</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>This returns the amount of padding to take into account when sizing the cells This returns different values depending on the user agent.</td></tr><tr><td><a name="dataModel"></a><code>dataModel</code></td><td><code class="type"> <code><a href="BiOlapGridDataModel.html">BiOlapGridDataModel</a></code> </code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>The data model that is used with the OLAP grid</td></tr><tr><td><a name="fixedLeftWidth"></a><code>fixedLeftWidth</code></td><td><code class="type">Number</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>This is the width of the row header and the fixed columns</td></tr><tr><td><a name="fixedTopHeight"></a><code>fixedTopHeight</code></td><td><code class="type">Number</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>This is the height of the header and the fixed rows</td></tr><tr><td><a name="headerCellPaddingX"></a><code>headerCellPaddingX</code></td><td><code class="type">Number</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>This returns the amount of padding to take into account when sizing the header cells. This returns different values depending on the user agent.</td></tr><tr><td><a name="olapGrid"></a><code>olapGrid</code></td><td><code class="type"> <code><a href="BiOlapGrid.html">BiOlapGrid</a></code> </code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>The OLAP grid this view manager is to be used with</td></tr><tr><td><a name="scrollLeft"></a><code>scrollLeft</code></td><td><code class="type">Number</code></td><td class="get-column"></td><td class="set-column"><img src="check.png" alt="checked"></td><td>Sets the scroll left to the view manager so that the view manager can figure out what column to start at</td></tr><tr><td><a name="scrollTop"></a><code>scrollTop</code></td><td><code class="type">Number</code></td><td class="get-column"></td><td class="set-column"><img src="check.png" alt="checked"></td><td>Sets the scroll top to the view manager so that the view manager can figure out what row to start at</td></tr><tr><td><a name="showGridLines"></a><code>showGridLines</code></td><td><code class="type">Boolean</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"><img src="check.png" alt="checked"></td><td>Whether to show grid lines between the cells in the OLAP grid</td></tr><tr><td><a name="visibleCellsHeight"></a><code>visibleCellsHeight</code></td><td><code class="type">Number</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>This is the sum of all the cell heights in the scrollable part of the grid</td></tr><tr><td><a name="visibleCellsWidth"></a><code>visibleCellsWidth</code></td><td><code class="type">Number</code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>This is the sum of all the cell widths in the scrollable part of the grid</td></tr></tbody></table><h2>Methods</h2><table><thead><tr><td>Name</td><td>Description</td></tr></thead><tbody><tr><td><code><a href="#getAreaHeight">getAreaHeight</a></code></td><td>The returns the height (in pixels) of an area</td></tr><tr><td><code><a href="#getAreaWidth">getAreaWidth</a></code></td><td>The returns the width (in pixels) of an area</td></tr><tr><td><code><a href="#getAxisCellHeight">getAxisCellHeight</a></code></td><td>This returns the height of a cell in the row header for the given axis. This is the width in pixels.</td></tr><tr><td><code><a href="#getAxisCellIsVisible">getAxisCellIsVisible</a></code></td><td>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</td></tr><tr><td><code><a href="#getAxisCellPositionWidth">getAxisCellPositionWidth</a></code></td><td>The number of positions the axis header cell takes up. This only includes visible cells</td></tr><tr><td><code><a href="#getAxisCellStartPosition">getAxisCellStartPosition</a></code></td><td>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.</td></tr><tr><td><code><a href="#getAxisCellWidth">getAxisCellWidth</a></code></td><td>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.</td></tr><tr><td><code><a href="#getAxisDimensionCount">getAxisDimensionCount</a></code></td><td>This returns the number of visible dimensions for the given axis</td></tr><tr><td><code><a href="#getAxisDimensionVisible">getAxisDimensionVisible</a></code></td><td>Whether the dimension is visible</td></tr><tr><td><code><a href="#getAxisPositionDistance">getAxisPositionDistance</a></code></td><td>This returns the distance (in positions) between 2 cells. This subtracts any hidden cells between the 2 cells</td></tr><tr><td><code><a href="#getCellAt">getCellAt</a></code></td><td>This return the cell at a the given location in the OLAP grid. This returns an object with an x and y field.</td></tr><tr><td><code><a href="#getCellHeight">getCellHeight</a></code></td><td>Returns the height for the given cell</td></tr><tr><td><code><a href="#getCellLeft">getCellLeft</a></code></td><td>Returns the left position of a cell. This is relative to the first cell and it takes hidden columns into account</td></tr><tr><td><code><a href="#getCellTop">getCellTop</a></code></td><td>Returns the top position of a cell. This is relative to the first cell and it takes hidden rows into account</td></tr><tr><td><code><a href="#getCellVisible">getCellVisible</a></code></td><td>Returns whether the cell is visible</td></tr><tr><td><code><a href="#getCellWidth">getCellWidth</a></code></td><td>Returns the width for the given cell</td></tr><tr><td><code><a href="#getDimensionAt">getDimensionAt</a></code></td><td>Returns the dimension index at the distance x from the edge</td></tr><tr><td><code><a href="#getDimensionHeight">getDimensionHeight</a></code></td><td>The height for the header representing a dimension in the column header</td></tr><tr><td><code><a href="#getDimensionLeft">getDimensionLeft</a></code></td><td>This returns the left position of a dimension header in the axis header</td></tr><tr><td><code><a href="#getDimensionTop">getDimensionTop</a></code></td><td>This returns the top position of a dimension header in the axis header</td></tr><tr><td><code><a href="#getDimensionWidth">getDimensionWidth</a></code></td><td>The width for the header representing a dimension in the row header</td></tr><tr><td><code><a href="#getFirstViewCell">getFirstViewCell</a></code></td><td>This returns the first cell in the view. This is the first cell that should be shown in the scrollable part of the viewport of the OLAP grid.</td></tr><tr><td><code><a href="#getFirstVisibleCell">getFirstVisibleCell</a></code></td><td>This returns the first visible cell on the axis. This includes the cells in the fixed section of the viewport.</td></tr><tr><td><code><a href="#getFirstVisibleDimension">getFirstVisibleDimension</a></code></td><td>This returns the first visible dimension</td></tr><tr><td><code><a href="#getFixedCell">getFixedCell</a></code></td><td>This is the first cell in the fixed section of the viewport.</td></tr><tr><td><code><a href="#getLastVisibleCell">getLastVisibleCell</a></code></td><td>This returns the last visible cell on the axis</td></tr><tr><td><code><a href="#getMinCellPosition">getMinCellPosition</a></code></td><td>Returns the leftmost position of two</td></tr><tr><td><code><a href="#getNextAxisPosition">getNextAxisPosition</a></code></td><td>This returns the position of the next axis header cell</td></tr><tr><td><code><a href="#getNextDimension">getNextDimension</a></code></td><td>This returns the next visible dimension</td></tr><tr><td><code><a href="#getNextVisibleCell">getNextVisibleCell</a></code></td><td>Returns the next visible cell</td></tr><tr><td><code><a href="#getNonFixedCell">getNonFixedCell</a></code></td><td>This is the first cell in the scrollable (non fixed) section of the viewport.</td></tr><tr><td><code><a href="#getPreviousVisibleCell">getPreviousVisibleCell</a></code></td><td>Returns the previous visible cell</td></tr><tr><td><code><a href="#getShowHeaders">getShowHeaders</a></code></td><td>Whether to show the headers for the axis</td></tr><tr><td><code><a href="#getVisibleCellIndex">getVisibleCellIndex</a></code></td><td>This returns the index of the cell taken hidden cells into account. If the given cell is hidden this returns null.</td></tr><tr><td><code><a href="#getVisibleCellsCount">getVisibleCellsCount</a></code></td><td>This is the number of visible cells. This includes cells in the fixed as well as the non fixed section of the viewport.</td></tr><tr><td><code><a href="#resetCache">resetCache</a></code></td><td>Resets the cached properties. This is called a size change so that the cache is up to date</td></tr><tr><td><code><a href="#scrollAreaIntoView">scrollAreaIntoView</a></code></td><td>This scrolls the OLAP grid so that the given area becomes visible</td></tr><tr><td><code><a href="#scrollCellIntoView">scrollCellIntoView</a></code></td><td>Scrolls the OLAP grid so that the given cell becomes visible</td></tr><tr><td><code><a href="#scrollColumnIntoView">scrollColumnIntoView</a></code></td><td>Scrolls the OLAP grid so that the given column becomes visible</td></tr><tr><td><code><a href="#scrollRowIntoView">scrollRowIntoView</a></code></td><td>Scrolls the OLAP grid so that the given row becomes visible</td></tr><tr><td><code><a href="#setAxisDimensionVisible">setAxisDimensionVisible</a></code></td><td>Sets whether the dimension is visible</td></tr><tr><td><code><a href="#setCellHeight">setCellHeight</a></code></td><td>Sets the cell height for a given cell</td></tr><tr><td><code><a href="#setCellVisible">setCellVisible</a></code></td><td>Sets the visibility for a cell (for a row or a column)</td></tr><tr><td><code><a href="#setCellWidth">setCellWidth</a></code></td><td>Sets the cell width for a given cell</td></tr><tr><td><code><a href="#setDimensionHeight">setDimensionHeight</a></code></td><td>Sets the height for the header representing a dimension in the column header</td></tr><tr><td><code><a href="#setDimensionWidth">setDimensionWidth</a></code></td><td>Sets the width for the header representing a dimension in the row header</td></tr><tr><td><code><a href="#setFixedCell">setFixedCell</a></code></td><td>Sets the first cell in the fixed section of the viewport.</td></tr><tr><td><code><a href="#setNonFixedCell">setNonFixedCell</a></code></td><td>Sets the first cell in the scrollable (non fixed) section of the viewport.</td></tr><tr><td><code><a href="#setShowHeaders">setShowHeaders</a></code></td><td>Sets whether the headers for the axis is shown</td></tr></tbody></table><h2>Events</h2><p>None.</p><h2>Static Methods</h2><p>None.</p><h2>Static Fields</h2><p>None.</p><h2>Remarks</h2><p> </p><h2>Method Details</h2><h3><a name="getAreaHeight"></a>getAreaHeight</h3><p>The returns the height (in pixels) of an area</p><h4>Syntax</h4><pre class="method-syntax">object.getAreaHeight(<span class="methodArgument">oArea</span>)</pre><h4>Parameters</h4><table><thead><tr><td>Name</td><td>Type</td><td class="optional-header">Optional</td><td>Default</td><td>Descripton</td></tr></thead><tbody><tr><td><code>oArea</code></td><td><code class="type"> <code><a href="BiArea.html">BiArea</a></code> </code></td><td class="optional-column"></td><td></td><td>The area to get the height for</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">Number</code></p><h3><a name="getAreaWidth"></a>getAreaWidth</h3><p>The returns the width (in pixels) of an area</p><h4>Syntax</h4><pre class="method-syntax">object.getAreaWidth(<span class="methodArgument">oArea</span>)</pre><h4>Parameters</h4><table><thead><tr><td>Name</td><td>Type</td><td class="optional-header">Optional</td><td>Default</td><td>Descripton</td></tr></thead><tbody><tr><td><code>oArea</code></td><td><code class="type"> <code><a href="BiArea.html">BiArea</a></code> </code></td><td class="optional-column"></td><td></td><td>The area to get the width for</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">Number</code></p><h3><a name="getAxisCellHeight"></a>getAxisCellHeight</h3><p>This returns the height of a cell in the row header for the given axis. This is the width in pixels.</p><h4>Syntax</h4><pre class="method-syntax">object.getAxisCellHeight(<span class="methodArgument">nDim</span>, <span class="methodArgument">nPos</span>)</pre><h4>Parameters</h4>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -