Namespace: PP.TS.Ui;
SeriesAbstractCatView
The SeriesAbstractCatView class implements an abstract tab of workbook ribbon that contains buttons for time series management.
An abstract tab is a tab that is not displayed in the tool ribbon, but exists as an object, and enables the user to perform operation corresponding to abstract button objects of this tab.
The figure below shows buttons for managing time series. Functionality of these buttons corresponds to that of the buttons housed on the abstract tool ribbon tab under consideration:
PP.initClass(PP.TS.Ui.SeriesAbstractCatView, PP.TS.Ui.WbkCategoryView, "PP.TS.Ui.SeriesAbstractCatView");
Constructor name | Brief description | |
SeriesAbstractCatView | The SeriesAbstractCatView constructor creates an instance of the SeriesAbstractCatView class. |
Method name | Brief description | |
getGroupSeriesButton | The getGroupSeriesButton method returns the Group button of the workbook ribbon. | |
getInsertButton | The getInsertButton method returns the Add Series button of the workbook ribbon. | |
getRemoveButton | The getRemoveButton method returns the Remove button of the workbook ribbon. | |
getUngroupSeriesButton | The getUngroupSeriesButton method returns the Ungroup button of the workbook ribbon. |
Property name | Brief description | |
Source | The Source property returns the workbook, which data is displayed in the component. |
Method name | Brief description | |
getFilterButton | The getFilterButton method returns the Filter button. | |
getFilterButtonState | The getFilterButtonState method gets state for the Filter button. | |
getPeriodEndDataPicker | The getPeriodEndDataPicker method returns input component of end data in the Display Period panel. | |
getPeriodEndLabel | The getPeriodEndLabel method returns the End label on the Display Period panel. | |
getPeriodStartDataPicker | The getPeriodStartDataPicker method returns input component of start data on the Display Period panel. | |
getPeriodStartLabel | The getPeriodStartLabel method returns the Start label on the Display Period panel. | |
getPropPanelButton | The getPropPanelButton method returns the Side Panel button. | |
getRefreshButton | The getRefreshButton method returns the Refresh button. | |
getReverseCalendarButton | The getReverseCalendarButton method returns the Reverse Calendar button. | |
getTitleButton | The getTitleButton method returns the Title button. | |
getViewAsButton | The getViewAsButton method returns the View As button. | |
refreshAll | The refreshAll method refreshes the entire component. | |
refreshFilterButton | The refreshFilterButton method refreshes state of the Filter button. | |
refreshPeriodPanel | The refreshPeriodPanel method refreshes the Display Period panel. | |
refreshTitleButton | The refreshTitleButton method refreshes state of the Title button. | |
setEnabledEditingButtons | The setEnabledEditingButtons method determines whether edit buttons are available. | |
setPropertyValue | The setPropertyValue method sets values in View. | |
updateViewAsMenu | The updateViewAsMenu method refreshes state of the View As button. |
Event name | Brief description | |
PropertyChanged | The PropertyChanged event occurs after changing parameter in the ribbon. | |
RequestMetadata | The RequestMetadata event occurs on metadata request. |
Property name | Brief description | |
Caption | The Caption property sets tab header. | |
GroupName | The GroupName property sets a name for a group of context tabs. |
Method name | Brief description | |
addPanel | The addPanel method adds a panel to the tab. | |
getGroupName | The getGroupName method returns the name of tabs' group. | |
getPanels | The getPanels method returns the array of tab panels. |
Property name | Brief description | |
Caption | The Caption property sets tab header. | |
ImageUrl | The ImageUrl property sets the path to the tab image. | |
Position | The Position property sets tab position. |
Method name | Brief description | |
getContentNodes | The getContentNodes method returns the collection of DOM nodes from tab contents. | |
getOrderNumber | The getOrderNumber method returns sequence number of the tab. | |
getParent | The getParent method returns the TabControlcomponent that is a parent one relative to the tab. |
Property name | Brief description | |
Anchors | The Anchors property determines position of the component placed within container. | |
Animation | The Animation property determines component animation parameters. | |
Bottom | The Bottom property determines a bottom margin if a component is placed inside LayoutPanel. | |
Content | The Content property determines component contents. | |
ContextMenu | The ContextMenu property determines a component's context menu. | |
Data | The Data property is used to store any custom data. | |
Enabled | The Enabled property determines whether a component can be used. | |
Height | The Height property determines component height. | |
IsRTL | The IsRTL property determines whether component elements are aligned to the right. | |
IsVisible | The IsVisible property determines whether a component is displayed. | |
Left | The Left property determines a left margin if a component is placed inside GridPanel. | |
Opacity | The Opacity property determines component transparency. | |
Parent | The Parent property determines a parent component of a control. | |
ParentNode | The ParentNode property determines a parent DOM node. | |
ResourceKey | The ResourceKey property determines a component resource key. | |
Right | The Right property determines a right margin if a component is placed inside LayoutPanel. | |
Rotate | The Rotate property determines a component rotation angle. | |
ShowToolTip | The ShowToolTip property determines whether a tooltip of the component can be displayed. | |
Style | The Style property determines a component style. | |
TabIndex | The TabIndex property determines the order of the control element passing inside the container. | |
Tag | The Tag property determines a JSON object associated with the component. | |
ToolTip | The ToolTip property determines text of component tooltip. | |
Top | The Top property determines a top margin if a component is placed inside GridPanel. | |
Value | The Value property determines a component value. | |
Width | The Width property determines component width. |
Method name | Brief description | |
The addClass method adds a CSS class to the component. | ||
addEventHandler | The addEventHandler method adds an event handler to a DOM node. | |
The addStateClass method adds a CSS class to the component and removes the previous CSS class. | ||
The addToNode method adds a component to the specified node. | ||
bindEvents | The bindEvents method subscribes an element to all available events. | |
The getAnchorFlags method returns JSON object that contains settings of the current component's position. | ||
The getClass method returns the current CSS classes of the component. | ||
The getCssStyle method returns style for the specified node. | ||
The getDomNode method returns main DOM node of the component. | ||
The getFocused method determines whether the component is focused. | ||
getIsBinded | The getIsBinded method returns whether an element is subscribed to all DOM node events. | |
The hide method hides a control. | ||
The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown. | ||
refreshStyle | The refreshStyle method refreshes element CSS styles. | |
The removeClass method removes CSS class from the component. | ||
removeEventHandler | The removeEventHandler method removes event handler from DOM node. | |
removeFromDOM | The removeFromDOM method removes node from the DOM structure. | |
The removeStateClasses method removes CSS classes of the component. | ||
The setDraggable method determines whether a component can be dragged on the HTML page. | ||
The setFocus method sets the component focus. | ||
The setIsHovered method sets up component displaying only on mouseover. | ||
The setSize method establishes the sizes of the component. | ||
The show method displays a control. | ||
unBindEvents | The unBindEvents method unsubscribes an element from all standard events. | |
The updatePosition method updates size and position when absolute positioning based on the current parameters is used. | ||
The updateSize method updates the component size on changing the size of the container that contains the component. |
Event name | Brief description | |
Drag | The Drag event occurs on clicking and holding the 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. |
Property name | Brief description | |
The Id property determines a repository object identifier. |
Method name | Brief description | |
clone | The clone method creates an object copy. | |
dispose | The dispose method deletes the component. | |
getHashCode | The getHashCode method returns hash code of repository object. | |
getId | The getId method returns repository object identifier. | |
getSettings | The getSettings method returns repository object settings. | |
getTypeName | The getTypeName method returns the name of the object type without the namespace, to which it belongs. | |
isEqual | The isEqual method determines whether the specified object is equal to the current repository object. | |
isLive | The isLive method determines validity of repository object. | |
removeAllEvents | The removeAllEvents method removes all object event handlers by the specified context. | |
setId | The setId method determines a repository object identifier. | |
setSettings | The setSettings method determines repository object settings. | |
defineProps | The defineProps method creates get and set methods from name array for the specified class. | |
keys | The keys method returns array of methods and properties names for the specified object. |
See also: