LanerBox

Description

The LanerBox component is a visual component that displays workbook table.

Comments

The LanerBox component is implemented by the LanerBox class.

A workbook is the main functional area of a database; it is used to work with time series. Workbooks use tables that enable the users to perform various operations on time series, such as:

• Edit, add and remove data.

• Run calculations.

• Add new rows and columns to a workbook.

Example

This component looks as follows:

A data table contains opened data series. A series title shows values of its attributes separated with the | symbol. The next column shows color encoding for a data series in the chart.

The example of creating the LanerBox component is given on the LanerBox Constructor page.

Constructor

	Constructor name	Brief description
	LanerBox	The LanerBox constructor creates an instance of the LanerBox class

Properties inherited from the LanerBoxView class

	Property name	Brief description
	EnableTabSheetActions	The EnableTabSheetActions property determines whether table elements can be selected.

Methods inherited from the LanerBoxView class

	Method name	Brief description
	adjustSeriesSize	The adjustSeriesSize method adjusts series width and height according to tab structure.
	getCellHeaderText	The getCellHeaderText method returns text container in the table column header for the selected cell.
	getHistoryWindow	The getHistoryWindow method returns a view window of point history.
	getIndexOfSelectedPoints	The getIndexOfSelectedPoints method returns array of indexes of the points selected in the table.
	getIndexOfSelectedSeries	The getIndexOfSelectedSeries method returns array of indexes for the series selected in the table.
	insertSeries	The insertSeries method inserts a series to the table.
	isEditing	The isEditing method returns whether a table is in the cell edit mode.
	refreshTable	The refreshTable method refreshes the selected data range.
	removeSeries	The removeSeries method removes series.
	setDefaultWidth	The setDefaultWidth method sets default width for all cells.
	setNeedUpdateSelection	The setNeedUpdateSelection method determines whether selection is updated after table loading.

Events inherited from the LanerBoxView class

	Event name	Brief description
	RequestHistory	The RequestHistory event occurs on requesting value history for the specified cell in workbook table.
	ShowStatDialog	The ShowStatDialog event occurs on displaying the Summary Statistics dialog box.

Properties inherited from the class EaxGridView

	Property name	Brief description
	ContextMenu	The ContextMenu property sets context menu for the table.
	DeferSelectionChangedDelay	The DeferSelectionChangedDelay property determines a delay before table selection change.
	DisplayLegend	The DisplayLegend property determines table legend visibility in express report working area.
	EditMode	The EditMode property determines value of the Edit Mode checkbox for express report working area table.
	Selection	The Selection property selects the specified cells in the table shown in the express report working area.
	ShowContextButton	The ShowContextButton property controls visibility of table context menu button in express report working area.
	ShowSettingsMenuItem	The ShowSettingsMenuItem property controls visibility of the Settings item in table context menu of the express report working area.
	Source	The Source property determines a table data source for the express report working area.
	UseShiftDrillUp	The UseShiftDrillUp property allows for drilling selection on level up the hierarchy on pressing the SHIFT key.
	VisibleHeaders	The VisibleHeaders property indicates whether table row and column headers are visible in the express report working area.

Methods inherited from the class EaxGridView

	Method name	Brief description
	clearSelection	The clearSelection method removes selection in the table of express report working area.
	fireCMenuChanged	The fireCMenuChanged method handles events that occur on executing specific operations with context menu for the table of express report working area.
	firePropertyChanged	The firePropertyChanged method handles events that occur on changing properties of OLAP cube for the table of the express report working area.
	getCellCoords	The getCellCoords method returns coordinates of the top left corner cell in the selected range.
	getCellType	The getCellType method returns type of the table cell by its coordinate.
	getChangedData	The getChangedData method returns modified data in the cells of the table shown in the express report working area.
	getControl	The getControl method returns the parent control.
	getFocusedCell	The getFocusedCell method returns the focused table cell.
	getInstance	The getInstance method returns an instance of the PP.Ui.TabSheet class.
	getLegend	The getLegend method returns an interval legend object, which type corresponds with the metric type passed as a parameter.
	getRowsCount	The getRowsCount method returns the number of rows in the table of the express report working area.
	getSelectionType	The getSelectionType method returns type of the selected object.
	getTableSource	The getTableSource method returns data source for the table in the express report working area.
	getTabSheet	The getTabSheet method returns the sheet that contains table in the express report working area.
	getTabSheetViewMode	The getTabSheetViewState method returns properties of table view in JSON format.
	getViewMode	The getViewMode method returns value of the View Mode checkbox for express report working area table.
	isLoaded	The isLoaded method returns whether the table in the express report working area is loaded.
	refresh	The refresh method refreshes the specified elements of the table in the express report working area.
	refreshAll	The refreshAll method refreshes all contents in the table of the express report working area.
	setCellValue	The setCellValue method sets value for a cell in the table in the express report working area.
	setScroll	The setScroll method sets scrollbars for the table in the express report working area.
	undo	The undo method undoes the last operation executed with table in express report working area.
	updateLegendColumn	The updateLegendColumn method refreshes the column that contains the chart legend.

Events inherited from the class EaxGridView

	Event name	Brief description
	DataChanged	The DataChanged event occurs after changing data in cells of the table shown in the working area of the express report.
	ExpanderAction	The ExpanderAction event occurs on expanding an expander in the table of the express report working area.
	HyperlinkMouseDown	The HyperlinkMouseDown event occurs on clicking a hyperlink in the table of the express report working area.
	PictureMouseDown	The PictureMouseDown event occurs on clicking an icon in a cell of the table shown in the express report working area.
	PropertyChanged	The PropertyChanged event occurs after selecting an item in the context menu of the express report properties panel.
	Rendered	The Rendered event occurs after the first rendering of the table in the express report working area.
	RequestMetadata	The RequestMetadata event is generated when the table source contains no metadata.
	SelectionChanged	The SelectionChanged event occurs after changing selection in the table of the express report working area.
	SelectionChanging	The SelectionChanging event occurs in the process of changing selection in the table of the express report working area, before he user releases the mouse button.
	StructureChanged	The StructureChanged event occurs on changing the table structure: on resizing rows and columns.

Properties inherited from PP.Mb.Ui.GridView

	Property name	Brief description
	EditMode	The EditMode property determines whether a table can be edited.
	Selection	The Selection property determines the current selection in a table.
	IsAsync	The IsAsync property determines whether table data asynchronous loading is used.
	Service	The Service property determines a service that is used to work with an express report.
	SyncLoadClipboardData	The SyncLoadClipboardData property determines whether data should be uploaded synchronously if there are unloaded cells on copying.
	TableSource	The TableSource property determines a table data source.

Methods inherited from PP.Mb.Ui.GridView

	Method name	Brief description
	clearSelection	The clearSelection method clears selection in a table.
	getChangedData	The getChangedData method returns changed data.
	getFocusedCell	The getFocusedCell method returns coordinates of focused table cell.
	getInstance	The getInstance method returns a table instance.
	getRowsCount	The getRowsCount method returns the number of rows in an express report table.
	getSelectionType	The getSelectionType method returns type of the current selection in a table.
	getTabSheet	The getTabSheet method returns data table.
	setScroll	The setScroll method determines visibility of horizontal and vertical scrollbars in a table.
	undo	The undo method cancels all changes in a table.

Events inherited from PP.Mb.Ui.GridView

	Event name	Brief description
	Edited	The Edited event occurs after table data is edited.
	ExpanderAction	The ExpanderAction event occurs on expanding an expander in a table.
	HyperlinkMouseDown	The HyperlinkMouseDown event occurs on clicking a hyperlink in a table.
	PictureMouseDown	The PictureMouseDown event occurs on clicking the image inside the table cell.
	Rendered	The Rendered event occurs after the table is rendered for the first time.
	SelectionChanged	The SelectionChanged event occurs after changing selection in a table.
	SelectionChanging	The SelectionChanging event occurs on changing selection in a table.
	StructureChanged	The StructureChanged event occurs after changing table structure.

Methods inherited from the class SourceView

	Method name	Brief description
	getSource	The getSource method returns the current document of the express report.
	getSrv	The getSrv method returns the service that is used to work with express report.
	loadFile	The loadFile method loads a file with the specified name.
	loadFiles	The loadFiles method loads a script and style files based on table internal parameters.
	refresh	The refresh method refreshes specified elements of express report table.
	refreshAll	The refreshAll method refreshes all elements of express report table.

Events inherited from the class SourceView

	Event name	Brief description
	MetadataChanged	The MetadataChanged event occurs on changing express report settings.
	PropertyChanged	The PropertyChanged event occurs after changing property value.

Properties inherited from the class Control

	Property name	Brief description
	Anchors	The Anchors property determines position of the component placed within container.
	Animation	The Animation property sets animation parameters for component.
	Bottom	The Bottom property sets bottom offset on placing the component within the LayoutPanel.
	Content	The Content property sets the component contents.
	ContextMenu	The ContextMenu property sets the context menu for the component.
	Data	The Data property is used to store any custom data.
	DataContext	The DataContext property contains an object with data.
	Enabled	The Enabled property sets whether the component is enabled.
	Height	The Height property determines the component height.
	IsResizable	The IsResizable property determines whether the component can be resized.
	IsRTL	The lsRTL property sets right to left text direction.
	IsVisible	The IsVisible property determines whether the component is displayed.
	Left	The Left property sets left offset on placing the component within the GridPanel.
	Offset	The Offset property determines coordinates of root DOM node of a control.
	Opacity	The Opacity property determines component transparency.
	Parent	The Parent property determines a parent component of a control.
	ParentNode	The ParentNode property sets parent DOM node.
	ResourceKey	The ResourceKey property sets the resource key for the component.
	Right	The Right property sets right offset on placing the component within the LayoutPanel.
	Rotate	The Rotate property sets component rotation angle.
	ShowToolTip	The ShowToolTip property determines whether the tooltip of the component can be displayed.
	Style	The Style property sets component style.
	TabIndex	The TabIndex property sets the order of the control element passing inside the container.
	Tag	The Tag property sets JSON object associated with the component.
	ToolTip	The ToolTip property determines text of component tooltip.
	Top	The Top property sets top offset on placing the component within the GridPanel.
	Value	The Value property sets the value to the component.
	Width	The Width property sets the component width.

Methods inherited from the class Control

	Method name	Brief description
	addClass	The addClass method adds a CSS class to the component.
	addEvent	The addEvent method adds an event handler to a DOM node.
	addEventHandler	The addEventHandler method adds an event handler to a DOM node.
	addEvents	The addEvents method adds an array of event handlers to a DOM node.
	addStateClass	The addStateClass method adds a CSS class to the component and removes the previous CSS class.
	addStyleBySelector	The addStyleBySelector method creates a block that contains a style with the specified CSS selector.
	addToNode	The addToNode method adds a component to the specified node.
	bindEvents	The bindEvents method subscribes an element to all available events.
	clearStylesCache	The clearStylesCache method clears cache of component styles.
	getAnchorFlags	The getAnchorFlags method returns JSON object that contains settings of the current component's position.
	getClass	The getClass method returns the current CSS classes of the component.
	getCssStyle	The getCssStyle method returns style for the specified node.
	getDomNode	The getDomNode method returns main DOM node of the component.
	getFocused	The getFocused method determines whether the component is focused.
	getFunctionByName	The getFunctionByName method returns function by name.
	getIsBinded	The getIsBinded method returns whether an element is subscribed to all DOM node events.
	hasClass	The hasClass method determines whether the specified CSS class is set for root DOM node of the control.
	hide	The hide method hides a control.
	hideToolTip	The hideToolTip method clears tooltip timeout and hides the tooltip if it is displayed.
	isResingNow	The isResingNow method determines whether the component is being resized.
	refreshBindingProperty	The refreshBindingProperty method refreshes the bound property by name.
	refreshItemsStyle	The refreshItemsStyle method refreshes CSS styles of child elements.
	refreshStyle	The refreshStyle method refreshes element CSS styles.
	removeClass	The removeClass method removes CSS class from the component.
	removeEvent	The removeEvent method removes event handler from DOM node.
	removeEventHandler	The removeEventHandler method removes event handler from DOM node.
	removeFromDOM	The removeFromDOM method removes node from the DOM structure.
	removeStateClasses	The removeStateClasses method removes CSS classes of the component.
	setDraggable	The setDraggable method determines whether it is possible to drag component on the HTML page.
	setFocus	The setFocus method sets the component focus.
	setIsHovered	The setIsHovered method displays the component as on hover.
	setIsPressed	The setIsPressed method displays the component as if clicked upon.
	setOpacityIE8	The setOpacityIE8 method sets component transparency value in Internet Explorer 8.
	setSize	The setSize method establishes the sizes of the component.
	show	The show method displays a control.
	unBindEvents	The unBindEvents method unsubscribes an element from all standard events.
	updatePosition	The updatePosition method updates size and position when absolute positioning based on the current parameters is used.
	updateSize	The updateSize method updates the component size on changing the size of the container that contains the component.

Events inherited from the class Control

	Event name	Brief description
	Drag	The Drag event occurs on clicking and holding the left mouse button.
	DragEnd	The DragEnd event occurs when dragging the component finishes.
	DragStart	The DragStart event occurs when dragging the component starts.
	OnContextMenu	The OnContextMenu event occurs on calling context menu of the component.
	SizeChanged	The SizeChanged event occurs after the component is resized.
	SizeChanging	The SizeChanging event occurs during component resize.

Properties inherited from the class Object

	Property name	Brief description
	Data	The Data property associates a random object with this component.
	Id	The Id property sets component identifier.
	Settings	The Settings property sets the component parameters.

Methods inherited from the class Object

	Method name	Brief description
	clone	The clone method creates a copy of object. It is not implemented in PP.Ui.Control.
	dispose	The dispose method deletes the component.
	getTypeName	The getTypeName method returns the name of the object type without the namespace, to which it belongs.

See also:

DHTML Components