📄 biolapgriddatamodel.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>BiOlapGridDataModel</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="BiOlapGridDataModel">BiOlapGridDataModel</h1><p>This defines the interface that is needed for a data model for a<code><a href="BiOlapGrid.html">BiOlapGrid</a></code>. This actually implements a dummy data model. Extend this class to create more useful data models.<br> <br> * All methods in this data model can be safely overriden without calling the super class since there are no side effects in any of the methods.</p><p>This class extends <code><a href="BiEventTarget.html">BiEventTarget</a></code> and therefore all methods and fields available for <code><a href="BiEventTarget.html">BiEventTarget</a></code> are also available for <code>BiOlapGridDataModel</code>.</p><ul class="partial-class-tree"><li><code><a href="BiObject.html">BiObject</a></code><ul><li><code><a href="BiEventTarget.html">BiEventTarget</a></code><ul><li><code>BiOlapGridDataModel</code><ul id="api-derived-classes"></ul></li></ul></li></ul></li></ul><h2>Constructor</h2><p><code> new BiOlapGridDataModel()</code></p><h3>Parameters</h3><p>No parameters.</p><h2>Properties</h2><p>None.</p><h2>Methods</h2><table><thead><tr><td>Name</td><td>Description</td></tr></thead><tbody><tr><td><code><a href="#getAxisCellStartPosition">getAxisCellStartPosition</a></code></td><td>Given a position, at what postion does the axis cell start at? You may return <code>null</code> here and in that case the view manager handles this case. If you know this you should implement it because the implementation provided by the view manager is very general and therefore not too efficient.</td></tr><tr><td><code><a href="#getAxisCellStyle">getAxisCellStyle</a></code></td><td>This allows a custom CSS text to be applied to a axis header cell. This allows more detailed control over the rendering of the header cell.</td></tr><tr><td><code><a href="#getAxisCellText">getAxisCellText</a></code></td><td>This should return the text (HTML string) to show for the axis header cell</td></tr><tr><td><code><a href="#getAxisCellWidth">getAxisCellWidth</a></code></td><td>This is the number of positions the axis cell takes up.</td></tr><tr><td><code><a href="#getAxisContextMenu">getAxisContextMenu</a></code></td><td>This allows a context menu to be shown when the user invokes the context menu on one of the axis header cells</td></tr><tr><td><code><a href="#getAxisDimensionCount">getAxisDimensionCount</a></code></td><td>This returns the number of dimensions on the given axis</td></tr><tr><td><code><a href="#getAxisDimensionName">getAxisDimensionName</a></code></td><td>Returns the name of a dimension</td></tr><tr><td><code><a href="#getAxisDropDataTypes">getAxisDropDataTypes</a></code></td><td>Returns the supported data types for the axis header cell. Return <code>[]</code> or <code>null</code> if no drop is desired on the cell</td></tr><tr><td><code><a href="#getAxisPositionWidth">getAxisPositionWidth</a></code></td><td>This returns the number of positions the axis takes up</td></tr><tr><td><code><a href="#getAxisToolTip">getAxisToolTip</a></code></td><td>This should return the tool tip to use for an axis header cell</td></tr><tr><td><code><a href="#getCellStyle">getCellStyle</a></code></td><td>This allows a custom CSS text to be applied to a cell. This allows more detailed control over the rendering of the cell.</td></tr><tr><td><code><a href="#getCellText">getCellText</a></code></td><td>This should return the text (HTML string) to show for the cell at (x,y)</td></tr><tr><td><code><a href="#getContextMenu">getContextMenu</a></code></td><td>This allows a context menu to be shown when the user invokes the context menu on the cell</td></tr><tr><td><code><a href="#getDropDataTypes">getDropDataTypes</a></code></td><td>Returns the supported data types for the cell. Return <code>[]</code> or <code>null</code> if no drop is desired on the cell</td></tr><tr><td><code><a href="#getFillerCellStyle">getFillerCellStyle</a></code></td><td>This allows a custom CSS text to be applied to a filler cell. A filler cell is shown when the real cells do not fill the entire viewport.</td></tr><tr><td><code><a href="#getHasIcon">getHasIcon</a></code></td><td>Returns whether the cell should display an icon. If this is the case the actual image URI is returned using <code><a href="#getIcon">getIcon</a></code> </td></tr><tr><td><code><a href="#getIcon">getIcon</a></code></td><td>Returns the path to the image to show on the cell. This is only called for cells that should have an icon accordingly to <code><a href="#getHasIcon">getHasIcon</a></code> <br> <br> You should use an absolute URI here to make the application more flexible.</td></tr><tr><td><code><a href="#getIconStyle">getIconStyle</a></code></td><td>Use this to specify some custom CSS to use for the icon image.</td></tr><tr><td><code><a href="#getToolTip">getToolTip</a></code></td><td>This should return the tool tip to use for the cell</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="getAxisCellStartPosition"></a>getAxisCellStartPosition</h3><p>Given a position, at what postion does the axis cell start at? You may return <code>null</code> here and in that case the view manager handles this case. If you know this you should implement it because the implementation provided by the view manager is very general and therefore not too efficient.</p><h4>Syntax</h4><pre class="method-syntax">object.getAxisCellStartPosition(<span class="methodArgument">nAxis</span>, <span class="methodArgument">nDim</span>, <span class="methodArgument">nPos</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>nAxis</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The axis the cell is part of</td></tr><tr><td><code>nDim</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The dimension index</td></tr><tr><td><code>nPos</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>A position that the the axis cell covers</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">Number</code></p><h3><a name="getAxisCellStyle"></a>getAxisCellStyle</h3><p>This allows a custom CSS text to be applied to a axis header cell. This allows more detailed control over the rendering of the header cell.</p><h4>Syntax</h4><pre class="method-syntax">object.getAxisCellStyle(<span class="methodArgument">nAxis</span>, <span class="methodArgument">nDim</span>, <span class="methodArgument">nPos</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>nAxis</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The axis of the header cell</td></tr><tr><td><code>nDim</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The dimension index</td></tr><tr><td><code>nPos</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The start position for the header cell</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">String</code></p><h3><a name="getAxisCellText"></a>getAxisCellText</h3><p>This should return the text (HTML string) to show for the axis header cell</p><h4>Syntax</h4><pre class="method-syntax">object.getAxisCellText(<span class="methodArgument">nAxis</span>, <span class="methodArgument">nDim</span>, <span class="methodArgument">nPos</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>nAxis</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The axis of the cell</td></tr><tr><td><code>nDim</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The dimension for the cell</td></tr><tr><td><code>nPos</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The start position for the axis cell</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">String</code></p><h3><a name="getAxisCellWidth"></a>getAxisCellWidth</h3><p>This is the number of positions the axis cell takes up.</p><h4>Syntax</h4><pre class="method-syntax">object.getAxisCellWidth(<span class="methodArgument">nAxis</span>, <span class="methodArgument">nDim</span>, <span class="methodArgument">nPos</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>nAxis</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The axis of the cell</td></tr><tr><td><code>nDim</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The dimension for the cell</td></tr><tr><td><code>nPos</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The start position for the axis cell</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">Number</code></p><h3><a name="getAxisContextMenu"></a>getAxisContextMenu</h3><p>This allows a context menu to be shown when the user invokes the context menu on one of the axis header cells</p><h4>Syntax</h4><pre class="method-syntax">object.getAxisContextMenu(<span class="methodArgument">nAxis</span>, <span class="methodArgument">nDim</span>, <span class="methodArgument">nPos</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>nAxis</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The axis that we want the context menu for</td></tr><tr><td><code>nDim</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The dimension index</td></tr><tr><td><code>nPos</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The start position of the axis header cell</td></tr></tbody></table><h4>Return Type</h4><p><code class="type"> <code><a href="BiMenu.html">BiMenu</a></code> </code></p><h3><a name="getAxisDimensionCount"></a>getAxisDimensionCount</h3><p>This returns the number of dimensions on the given axis</p><h4>Syntax</h4><pre class="method-syntax">object.getAxisDimensionCount(<span class="methodArgument">nAxis</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>nAxis</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The axis to get the dimension count for</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">Number</code></p><h3><a name="getAxisDimensionName"></a>getAxisDimensionName</h3><p>Returns the name of a dimension</p><h4>Syntax</h4><pre class="method-syntax">object.getAxisDimensionName(<span class="methodArgument">nAxis</span>, <span class="methodArgument">nDim</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>nAxis</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The axis the dimension is part of</td></tr><tr><td><code>nDim</code></td><td><code class="type">Number</code></td><td class="optional-column"></td><td></td><td>The index of the dimension</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">String</code></p><h3><a name="getAxisDropDataTypes"></a>getAxisDropDataTypes</h3>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -