WbkPropertyBar

Namespace: PP.TS.Ui;

Inheritance Hierarchy

Object

Control

ProxyControl

Master

WbkPropertyBarView

WbkPropertyBar

Description

The WbkPropertyBar class enables the user to view and manage workbook properties using the navigation bar.

Comments

This class is intended for end use by application programmers.

Syntax

PP.initClass(PP.TS.Ui.WbkPropertyBar, PP.TS.Ui.WbkPropertyBarView, "WbkPropertyBar");

Constructor

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

Properties inherited from the WbkPropertyBarView class

	Property name	Brief description
	GridView	The GridView property determines a component that displays a table.
	Source	The Source property returns the workbook, which data is displayed in the component.
	Type	The Type property determines a property panel type.

Methods inherited from the WbkPropertyBarView class

	Method name	Brief description
	deleteExtraRevisionPanels	The deleteExtraRevisionPanels method removes from the property panel the tabs that correspond to sources (time series databases) not contained in the workbook.
	getChartMaster	The getChartMaster method returns chart wizard.
	getEquationAutoFitPanel	The getEquationAutoFitPanel method returns the exponential smoothing parameters autofit panel.
	getEquationPeriodPanel	The getEquationPeriodPanel method returns the Calculation Periods panel.
	getEquationProcessPanel	The getEquationProcessPanel method returns the Missing Data Treatment panel.
	getEquationSmoothingSlidingPanel	The getEquationSmoothingSlidingPanel method returns the Moving Average panel.
	getEquationWeightCoefficientsPanel	The getEquationWeightCoefficientsPanel method returns the Weight Coefficients panel.
	getGaugeMaster	The getGaugeMaster method returns speedometer setup wizard.
	getMainSeriesPanel	The getMainSeriesPanel method returns the Primary panel.
	getMapMaster	The getMapMaster method returns map wizard.
	getNavBreadcrumb	The getNavBreadcrumb method returns the component that is used to control workbook attributes.
	getObserveAttributesPanel	The getObserveAttributesPanel method returns the Observation Attributes panel.
	getParametersPanel	The getParametersPanel method returns the parameters panel.
	getPeriodSeriesViewPanel	The getPeriodSeriesViewPanel method returns the panel that is used to control workbook attributes.
	getSerieAttributesPanel	The getSerieAttributesPanel method returns the Series Attributes panel of the Series tab.
	getSerieRevisionsPanel	The getSerieRevisionsPanel method returns the Revisions panel of the Series tab.
	getSeriesAttributesPanel	The getSeriesAttributesPanel method returns the Data panel of the Format tab.
	getSerieValidationErrorsPanel	The getSerieValidationErrorsPanel method returns the Validation Errors panel of the Series tab.
	getTablePanel	The getTablePanel method returns the Data panel of the Data tab.
	getTableViewPanel	The getTableViewPanel method returns the View panel of the Format tab.
	getTitlePanel	The getTitlePanel method returns the Title panel of the Format tab.
	getValidationErrorsPanel	The getValidationErrorsPanel method returns the Validation Errors panel of the Observation tab.
	getValidationPanel	The getValidationPanel method returns the Validation Rules panel.
	hideAllMasters	The hideAllMasters method hides all wizards that belong to groups.
	loadFile	The loadFile method loads a file with the specified name.
	refreshAll	The refreshAll method refreshes the entire component.
	showChartMaster	The showChartMaster method displays chart setup wizard.
	showGaugeMaster	The showGaugeMaster method displays speedometer setup wizard.
	showGroup	The showGroup method displays a group of properties panel by identifier.
	showMapMaster	The showMapMaster method displays map setup wizard.
	showOnlyGroup	The showOnlyGroup method displays a group of properties panel by identifier and hides all the others.
	updateRevisionPanel	The updateRevisionPanel method recreates revisions panel.
	updateViewAsMenu	The updateViewAsMenu method refreshes the Apply Transformation drop-down list on the Primary panel.

Events inherited from the WbkPropertyBarView class

	Event name	Brief description
	PropertyChanged	The PropertyChanged event occurs when the user finishes changing workbook properties.
	PropertyChanging	The PropertyChanging event occurs when workbook properties start changing.
	RequestMetadata	The RequestMetadata event occurs on metadata request.

Methods inherited from the class ProxyControl

	Method name	Brief description
	getControl	The getControl method returns the basic control that inherits from PP.Ui.Control.

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:

PP.TS.Ui