ui.property

A structured table of 2 columns that presents 'name:value' pairs for a list of properties.

The component can be used for creating various on-page editors. The value field can be presented by any control - a text field, a checkbox, a drop-down list box etc. Check property documentation for more detailed description.

Constructor

var property = webix.ui({
    view:"property",  
    id:"sets", 
    width:300,
    elements:[
       { label:"Layout", type:"label"},
       { label:"Data url", type:"text", id:"url"},
       { label:"Data type", type:"select", options:["json","xml","csv"], id:"type"},
       { label:"Use JSONP", type:"checkbox", id:"jsonp"}
    ]
});

Where to start

Methods
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
customize redefines the 'type' property
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)
edit enables the edit mode for the specified item
editCancel cancels the edit mode and closes all opened editors. The component is still editable
editNext closes the current editor and opens one in the next cell of the row
editStop stops the edit mode and closes all opened editors. The component is still editable
enable enables the calling view that was disabled by the 'disable' method
focusEditor moves focus to the active editor
getChildViews returns child views of the calling component
getEditState returns info about active editor object
getEditor returns editor object
getEditorValue returns the value of the active (currently open) editor
getFormView returns master form for the input
getItem gets the data object for related property
getItemNode returns HTML element of the item
getNode returns the main HTML container for the calling object
getParentView returns the parent view of the component
getScrollState returns the scroll position
getTopParentView returns top parent view
getValues derives values from the property sheet (like with form)
hasEvent checks whether the component has the specified event
hide hides the view
isEnabled checks whether the view is enabled
isVisible checks whether the view is visible
load loads data from an external data source.
locate gets the id of an item from the specified HTML event
mapEvent routes events from one object to another
parse loads data to the component from an inline data source
refresh repaints the whole view or a certain item
registerType registeres a new type for property sheet elements
render renders the specified item or the whole component
resize adjusts the view to a new size
scrollTo scrolls the data container to a certain position
setValues sets values into the inputs of a form/toolbar/property sheet control
show makes the component visible
showItem 'scrolls' the table to make the specified row visible
sync allows you to sync two copies of data (all or just a part of it) from one DataCollection to another
unbind breaks "bind" link
unblockEvent cancels blocking events that was enabled by the 'blockEvent' command
updateItem alias for refresh, repaints property view
validateEditor validates data in currently active editor
Events
onAfterContextMenu fires after the context menu was called in the item area
onAfterEditStart fires after edit operation was initiated, editor opened and ready for input
onAfterEditStop fires after edit operation finished
onAfterLoad fires after data loading is complete
onAfterRender occurs immediately after the component has been rendered.
onAfterScroll occurs when some webix view has been scrolled
onBeforeContextMenu fires before the context menu is called in the item area
onBeforeEditStart fires before edit operation is initiated
onBeforeEditStop fires before stop edit command is received
onBeforeLoad occurs immediately before data loading has been started
onBeforeRender occurs immediately before the component has been rendered
onBindRequest fires when the component is ready to receive data from the master component
onBlur fires when focus is moved out of the view
onDestruct occurs when component destroyed
onFocus fires when a view gets focus
onItemClick fires when a component item was clicked
onItemDblClick fires when a component item was double-clicked
onKeyPress occurs when keyboard key is pressed for the control in focus
onLiveEdit occurs when data was changed in the editor
onLoadError fires when an error occurs during data loading ( invalid server side response )
onLongTouch fires on holding finger in some position for a certain period of time
onMouseMove fires when the mouse was moved over the specified component
onMouseMoving fires when the mouse was moved over the component
onMouseOut fires when the mouse was moved out from the specified item
onSwipeX occurs on a horizontal swipe movement
onSwipeY occurs on a vertical swipe movement
onTimedKeyPress fires after typing has been finished in the field
onTouchEnd occurs when the touch event is ended
onTouchMove occurs during touch movement
onTouchStart when some webix view has been touched
onViewResize view size was changed by resizer
Properties
animate defines or disables view change animation.
autoheight auto height mode for property view
borderless used to hide the component borders
complexData enables complex data parsing mode
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
data JavaScript array containing data for the component
datatype the type of loaded data
disabled indicates whether an item is enabled
editValue defines which data item is editable (in case of several data item in the cell/line)
editable allows/denies editing in the view
editaction defines the action on which editors will be opened
elements an array of property items
form linked form
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
map defines data mapping
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
mouseEventDelay the delay between a real mouse action and invoking the related events
nameWidth width of first column ( property names )
on allows attaching custom handlers to inner events of the component
onClick attaches a click behavior for component items with the specified CSS class.
onContext a property used to define custom context-click (right click) handlers for elements in the DataTable cells
onDblClick attaches a dblclick behavior for component items with the specified CSS class.
onMouseMove attaches a mousemove behaviour for component items with the specified CSS class.
scroll enables/disables the scroll bar
scrollSpeed the time during which the component is scrolled to the specified position (in milliseconds)
template the component template
tooltip sets a popup message appearing on pointing a mouse cursor over the dedicated item
url the URL which the component will use to load data after its initialization
width sets the width of the component
Other
$getSize returns the current size of the component
$height current height of the view
$scope scope for resolving event and method names
$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)
on_click redefines default click behavior for component items.
on_context a property used to define custom context-click (right click) handlers for elements in the DataTable cells
on_dblclick attaches a dblclick behavior for component items with the specified CSS class
on_edit set of flags, defines which types are editable
on_mouse_move attaches a mouse move behavior for component items with the specified CSS class
on_render set of functions, for custom property types
type currently used set of helpers for view rendering
Back to top