EaxRibbon

Description

The EaxRibbon component implements express report tool ribbon.

Comments

The getControl method can be used to change properties of the PP.Ui Ribbon.

If EaxRibbon and EaxDataBox components are used together, to be able to manage data views from the tool ribbon, you need to specify corresponding data views of the EaxDataBox component as values of the EaxRibbonView.getChartDataView and EaxRibbonView.getMapDataView properties (see Example of Joint Use of the EaxRibbon and EaxDataBox Components).

Example

The EaxRibbon component can look as follows:

Example of Creating the EaxRibbon Component

Example of Joint Use of the EaxRibbon and EaxDataBox Components

Constructor

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

Properties inherited from EaxRibbonView class

	Property name	Brief description
	Source	The Source property determines a data source for the express report ribbon.

Methods inherited from EaxRibbonView class

	Method name	Brief description
	bindDataView	The bindDataView method binds data view to the express report ribbon.
	getAnalyticsCategory	The getAnalyticsCategory method returns view of the Advanced Analytics tab on the express report ribbon.
	getChartCategory	The getChartCategory method returns view of the Chart tab on the express report ribbon.
	getDataRibbonCategory	The getDataRibbonCategory method returns view of the Data tab on the express report ribbon.
	getMainButton	The getMainButton method returns application button on the express report ribbon.
	getMainCategory	The getMainCategory method returns view of the Home tab on the express report ribbon.
	getServiceRibbonControl	The getServiceRibbonControl method returns the Tools button in the main menu.
	getTableCategory	The getTableCategory method returns view of the Table tab on the express report ribbon.
	getTitleCategory	The getTitleCategory method returns view of the Title tab on the express report ribbon.
	getViewRibbonCategory	The getViewRibbonCategory method returns view of the View tab on the express report ribbon.
	refresh	The refresh method refreshes the specified control on the express report ribbon.
	refreshAll	The refreshAll method refreshes all the contents of the express report ribbon.
	setPropertyValue	The setPropertyValue method sets property value for the express report ribbon.
	showPrintPreview	The showPrintPreview method opens the page to preview printed version of the express report.

Events inherited from EaxRibbonView class

	Event name	Brief description
	Closed	The Closed event occurs when the user selects the Close main menu item.
	Collapsed	The Collapsed event occurs on collapsing the express report ribbon.
	CreatedCopy	The CreatedCopy event occurs on selecting the Save As main menu item.
	CreatedReport	The CreatedReport event occurs on selecting the Save main menu item.
	Discuss	The Discuss event occurs on selecting the Discuss in SharePoint or Share main menu items.
	DiscussMenuOpened	The DiscussMenuOpened event occurs on opening the Discuss in SharePoint or Share menus.
	Exited	The Exited event occurs on selecting the Exit main menu item.
	Expanded	The Expanded event occurs on expanding the express report ribbon.
	Exported	The Exported event occurs on selecting the Export main menu item.
	MetadataChanged	The MetadataChanged event occurs after changing data for express report ribbon.
	NewReport	The NewReport event occurs on selecting the New Report main menu item.
	Opened	The Opened event occurs on selecting the Open main menu item.
	Printing	The Printing event occurs on selecting the Print main menu item.
	PropertyChanged	The PropertyChanged event occurs after changing properties of express report ribbon.
	RequestMetadata	The RequestMetadata event occurs when no metadata is contained in the source of express report ribbon.
	SaveAs	The SaveAs event occurs on selecting the Save As main menu item.
	Saved	The Saved event occurs on selecting the Save main menu item.

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:

DHTML Components