ui.portlet

A movable layout component that can contain other components inside.

Portlet can include any content and be dragged to any position. It allows placing several components on the page at once. Check portlet documentation for more detailed description.

Constructor

var portlet = webix.ui({  
    type:"space",
    rows:[
        { view:"portlet", body:{
            template:"row 1"
        . }},
        { view:"portlet", body:{
            template:"row 2"
        . }},
        { view:"portlet", body:{
            template:"row 3"
        . }}
    ]
});

Where to start

Methods
addView adds a new view to a layout-like component
adjust adjusts the component to the size of the parent HTML container
attachEvent attaches the handler to an inner event of the component (allows behavior customizations)
bind binds components
blockEvent temporarily blocks triggering of ALL events of the calling object
callEvent calls an inner event
define redefines a single configuration property (or a hash of properties)
destructor destructs the calling object
detachEvent detaches a handler from an event (which was attached before by the attachEvent method)
disable disables the calling view (makes it dimmed and unclickable)
enable enables the calling view that was disabled by the 'disable' method
getChildViews returns child views of the calling component
getFormView returns master form for the input
getNode returns the main HTML container for the calling object
getParentView returns the parent view of the component
getTopParentView returns top parent view
hasEvent checks whether the component has the specified event
hide hides the view
index returns the cell index in the layout collection
isEnabled checks whether the view is enabled
isVisible checks whether the view is visible
mapEvent routes events from one object to another
markDropArea renders marker on the area where a portlet can be dropped during drag-n-drop
movePortlet moves portlet to the marked area
reconstruct rebuilds the layout
removeView removes view from layout-like component
resize adjusts the view to a new size
resizeChildren resizes all children of the called component
show makes the component visible
showBatch makes visible those elements which parameter 'batch' is set to the specified name
unbind breaks "bind" link
unblockEvent cancels blocking events that was enabled by the 'blockEvent' command
Events
onAfterPortletMove fires after a portlet has been moved
onBeforePortletMove fires before a portlet is moved
onBindRequest fires when the component is ready to receive data from the master component
onDestruct occurs when component destroyed
Properties
animate defines or disables view change animation.
body defines the portlet content (a view or some HTML)
borderless used to hide the component borders
cols array of views objects arranged horizontally
container an HTML container (or its id) where the component should be initialized
css the name of a css class that will be applied to the view container
disabled indicates whether an item is enabled
gravity sets the view gravity (1 by default)
height sets the height of the component
hidden defines whether the view will be hidden initially
id the component ID
isolate masks IDs of all inner elements
layoutType defines the borders of layout that will be created after drag-n-drop operation is finished
margin defines the space around elements (applies the specified value to all elements)
maxHeight sets the maximum height for the view
maxWidth sets the maximum width for the view
minHeight sets the minimal height for the view
minWidth sets the minimal width for the view
mode defines the mode of moving portlets
on allows attaching custom handlers to inner events of the component
padding defines the space between the element borders and content (applies the specified value to all sides).
paddingX sets the right and left padding (applies the specified value to both sides)
paddingY sets the top and bottom padding (applies the specified value to both sides)
responsive enables responsive mode for horizontal layout
rows array of views objects arranged vertically
type defines the layout borders
visibleBatch sets the batch that will be shown initially
width sets the width of the component
Other
$drag method called when drag operation initiated
$getSize returns the current size of the component
$height current height of the view
$setSize sets the component size
$skin the method which will be called when skin is defined
$view reference to top html element of the view
$width current width of the view
config all options from initial component configuration
name indicates the name of the component (a read-only property)
Back to top
If you have not checked yet, be sure to visit site of our main product Webix best ui framework
and page of ui draggable product.