WaveMaker - Widgets API Documentation
  1. Classes
  2. Panel

File

projects/components/widgets/containers/panel/src/panel.component.doc.ts

Description

The wmPanel component defines the Panel widget.

Index

Methods
Inputs

Methods

onActionsclick
onActionsclick($item: any)

Callback function is called when the actions item is clicked.

Parameters :
Name Type Optional Description
$item any No

The object used to construct the clicked dropdown item.
Returns : void
onClose
onClose($event: Event, widget: any)

Callback function which will be triggered when panel is closed.

Parameters :
Name Type Optional Description
$event Event No

DOM event on which call back is triggered
widget any No

Instance of the panel.
Returns : void
onCollapse
onCollapse($event: Event, widget: any)

Callback function which will be triggered when the panel is collapsed.

Parameters :
Name Type Optional Description
$event Event No

DOM event on which call back is triggered.
widget any No

Instance of the panel.
Returns : void
onExitfullscreen
onExitfullscreen($event: Event, widget: any)

Callback function is called on the exit from full screen mode of the panel.

Parameters :
Name Type Optional Description
$event Event No

DOM event on which call back is triggered.
widget any No

Instance of the panel.
Returns : void
onExpand
onExpand($event: Event, widget: any)

Callback function which will be triggered when the panel is expanded.

Parameters :
Name Type Optional Description
$event Event No

DOM event on which call back is triggered.
widget any No

Instance of the panel.
Returns : void
onFullscreen
onFullscreen($event: Event, widget: any)

Callback function is called on the full screen state of the panel.

Parameters :
Name Type Optional Description
$event Event No

DOM event on which call back is triggered.
widget any No

Instance of the panel.
Returns : void
onLoad
onLoad(widget: any)

Callback function which will be triggered when the panel content is loaded.

Parameters :
Name Type Optional Description
widget any No

Instance of the panel.
Returns : void
onMouseenter
onMouseenter($event: MouseEvent, widget: any)

Callback function which will be triggered when the mouse enters the widget.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the panel
Returns : void
onMouseleave
onMouseleave($event: MouseEvent, widget: any)

Callback function which will be triggered when the mouse leaves the widget.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the panel
Returns : void
onMouseout
onMouseout($event: MouseEvent, widget: any)

Callback function which will be triggered when the mouse moves away from this widget.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the panel
Returns : void
onMouseover
onMouseover($event: MouseEvent, widget: any)

Callback function which will be triggered when the mouse hovers over the widget.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered
widget any No

Instance of the panel
Returns : void
onPinchin
onPinchin($event: TouchEvent, widget: any)

Callback function which will be triggered when a pinchin event is triggered.

Parameters :
Name Type Optional Description
$event TouchEvent No

DOM event on which call back is triggered
widget any No

Instance of the panel
Returns : void
onPinchout
onPinchout($event: TouchEvent, widget: any)

Callback function which will be triggered when a pinchout event is triggered.

Parameters :
Name Type Optional Description
$event TouchEvent No

DOM event on which call back is triggered
widget any No

Instance of the panel
Returns : void
onSwipedown
onSwipedown($event: TouchEvent, widget: any)

Callback function which will be triggered when the widget is swiped down.

Parameters :
Name Type Optional Description
$event TouchEvent No

DOM event on which call back is triggered
widget any No

Instance of the panel
Returns : void
onSwipeleft
onSwipeleft($event: TouchEvent, widget: any)

Callback function which will be triggered when the widget is swiped left.

Parameters :
Name Type Optional Description
$event TouchEvent No

DOM event on which call back is triggered
widget any No

Instance of the panel
Returns : void
onSwiperight
onSwiperight($event: TouchEvent, widget: any)

Callback function which will be triggered when the widget is swiped right.

Parameters :
Name Type Optional Description
$event TouchEvent No

DOM event on which call back is triggered
widget any No

Instance of the panel
Returns : void
onSwipeup
onSwipeup($event: TouchEvent, widget: any)

Callback function which will be triggered when the widget is swiped up.

Parameters :
Name Type Optional Description
$event TouchEvent No

DOM event on which call back is triggered
widget any No

Instance of the panel
Returns : void

Inputs

actions
Type : Array<any>

Set this property to a data source to construct the menu on the panel header.

Bindable: true
badgetype
Type : string
Default value : 'default'

The property controls the state of the badge.

Bindable: true

Allowed Values: default, primary, success, info, warning, danger
badgevalue
Type : string

This property specifies the value to be displayed on the panel title.

Bindable: true
class
Type : string

Class of the widget.
closable
Type : boolean
Default value : false

This property allows user to access close action from panel header as well as enables close through ESC key press.
collapsible
Type : boolean
Default value : false

This property will enable control for collapsing and expanding the panel.
conditionalclass
Type : string

This property allows user to bind expression to class property.

Bindable: true
content
Type : string
Default value : 'Inline Content'

Sets content for the panel.

Bindable: true

Allowed Values: Inline Content or partials

Inline Content: To drag and drop any widget.

Partials: To select from available list of partials.
enablefullscreen
Type : boolean
Default value : false

This property will enable control for making the panel full screen.
expanded
Type : boolean
Default value : true

This property will set the default state of the panel as expanded or collapsed.
helptext
Type : string

If this property has a value, a "?" icon is added next to your editor.
If the user points the mouse at this icon, the text you put into this helpText property will popup for the user.

Bindable: true
iconclass
Type : string
Default value : 'wi wi-account-circle'

This property defines the class of the icon that is shown in the header of the panel.

Bindable: true
iconheight
Type : string

height of the icon.
iconmargin
Type : string

Margin of the icon.
iconurl
Type : string

Url of the icon.

Bindable: true
iconwidth
Type : string

width of the icon.
itemchildren
Type : string

Children for the dropdown menu item.

Bindable: true
itemicon
Type : string

Class for the icon in the dropdown menu item.

Bindable: true
itemlabel
Type : string

Label for the dropdown menu item.

Bindable: true
itemlink
Type : string

Link for the dropdown menu item.

Bindable: true
name
Type : string

Name of the Panel.
show
Type : boolean
Default value : true

This property will be used to show/hide the panel widget on the web page.

Bindable: true
subheading
Type : string

Subheading of the panel.

Bindable: true
title
Type : string
Default value : 'Title'

Title of the panel.

Bindable: true
userrole
Type : string

User role for the dropdown menu item.

Bindable: true

results matching ""

    No results matching ""