ui.desktop

Since 10.0

A modern solution for creating remote desktops.

Desktop is a cutting edge tool for creating remote desktops. Users can add Webix complex widgets as apps or add their own custom apps to a desktop. Customization of this widget helps to meet different requirements for each desktop you need to create.

Constructor

webix.ui({
    view: "desktop",
    systemParams: user,
    apps: [{
            name: "spreadsheet",
            icon: "imgs/spreadsheet.png",
            pin: ["bar", "desktop"],
            launch: sParams => {
                ...
            },
        },
        ...
    ]
});

Where to start

Methods
addApp adds a new app
adjust adjusts the component to the size of the parent HTML container
app sets the Jet App class for the widget
attachEvent attaches the handler to an inner event of the component
blockEvent temporarily blocks triggering of ALL events of the calling object
callEvent calls an inner event
define redefines a single configuration property (or a object with 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
getService returns a service available for Desktop
getState returns the reactive state object of Desktop
getStateData returns current state of the apps
getTopParentView returns the top parent view
hasEvent checks whether the component has the specified event handler
hide hides the view
isEnabled checks whether the view is enabled
isVisible checks whether the view is visible
mapEvent routes events from one object to another
queryView returns inner element/elements of a widget that correspond(s) to the defined parameters
resize adjusts the view to a new size
setStateData updates state properties of the apps
show makes the component visible
unblockEvent cancels events blocking that was enabled by the 'blockEvent' command
Events
onAfterScroll occurs when some webix view has been scrolled
onBlur fires when focus is moved out of the view
onDestruct occurs when component destroyed
onEnter fires when the Enter key has been pressed
onFocus fires when a view gets focus
onInit fires on view initialization
onLongTouch fires on holding finger in some position for a certain period of time
onSwipeX occurs on a horizontal swipe movement
onSwipeY occurs on a vertical swipe movement
onTouchEnd occurs when the touch event is ended
onTouchMove occurs during touch movement
onTouchStart fires when some webix view has been touched
onViewResize fires when the size of a view has been changed by resizer
onViewShow fires when any hidden view is shown
Properties
animate defines the type of animation, with which the view is shown, if it is a Multiview cell
appIconPath a path to the folder containing icons for apps
apps an array of apps
barPosition defines the position of the taskbar
borderless used to hide the component borders
container an HTML container (or its ID) where the component should be initialized
css the name of the CSS class or the object with styles that will be applied to the view container
disabled indicates whether an item is enabled
gravity sets the view gravity
grid defines whether the tile position is set with respect to the grid during the drag-and-drop
height sets the height of the component
hidden defines whether the view will be hidden initially
id the ID of a widget
locale sets object with locale structure
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
on allows attaching custom handlers to inner events of the component
override used to override default classes with new ones
systemParams contains custom parameters to be passed to the launch method
tileAlign defines tiles alignments
tileLayout defines the direction of the layout of apps to a row or a column
width sets the width of a widget
Other
$app returns Jet App instance of the widget
$getSize returns the current size of the component
$height the current height of the view
$scope scope for resolving event and method names
$setNode defines HTML element for the component
$setSize sets the component size
$skin the method which will be called when skin is defined
$view reference to the top HTML element of the view
$width the current width of the view
config all options from the initial component configuration
name indicates the name of the component (a read-only property)
Наверх