ui.segmented

A holistic panel that contains multiple buttons (two or more).

The component can be used to build a multi-item menu for navigating between views. Check segmented documentation for more detailed description.

Constructor

var segmented = webix.ui({
    view:"segmented", 
    value:1, options:[
        { "id":"1", "value":"Section A" }, 
        { "id":"2", "value":"Section B" }, 
        { "id":"3", "value":"Section C" }
    ]
});

Where to start

Methods
addOption adds a new option to the control
adjust adjusts the component to the size of the parent HTML container
attachEvent attaches the handler to an inner event of the component
bind binds components
blockEvent temporarily blocks triggering of ALL events of the calling object
blur removes the focus from the control
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)
disableOption disables an option of the control
enable enables the calling view that was disabled by the 'disable' method
enableOption enables a disabled option of the control
focus sets focus to the control
getChildViews returns child views of the calling component
getFormView returns master form for the input
getInputNode gets the HTML element related to the component
getNode returns the main HTML container for the calling object
getOption returns the option of a radio, a segmented button or a tabbar
getParentView returns the parent view of the component
getTopParentView returns the top parent view
getValue returns the current value of the control
hasEvent checks whether the component has the specified event handler
hide hides the view
hideOption hides an option of the control
isEnabled checks whether the view is enabled
isVisible checks whether the view is visible
mapEvent routes events from one object to another
optionIndex index of the option with specified ID
queryView returns inner element/elements of a widget that correspond(s) to the defined parameters
refresh repaints the component
removeOption removes the option of a control
render renders the specified item or the whole component
resize adjusts the view to a new size
setBottomText sets the input label at the bottom of it
setValue sets a new value for the component
setValueHere sets a new value for the component
show makes the component visible
showOption shows a hidden option of the control
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 events blocking that was enabled by the 'blockEvent' command
validate validates value of input
Events
onAfterRender occurs immediately after the component has been rendered.
onAfterScroll occurs when some webix view has been scrolled
onAfterTabClick fires after a segment has been clicked
onBeforeRender occurs immediately before the component has been rendered
onBeforeTabClick fires before a segment is clicked
onBindRequest fires when the component is ready to receive data from the master component
onBlur fires when focus is moved out of the view
onChange fires when the value of the control is changed
onDestruct occurs when component destroyed
onEnter fires when the Enter key has been pressed
onFocus fires when a view gets focus
onItemClick fires after the control has been clicked
onKeyPress occurs when keyboard key is pressed for the control in focus
onLongTouch fires on holding finger in some position for a certain period of time
onOptionAdd fires after the option (tab, segment, radio) has been added
onOptionRemove fires after the option (tab, segment, radio) has been removed
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 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
align the alignment of the control within the parent container
animate defines the type of animation, with which the view is shown, if it is a Multiview cell
attributes sets a object with HTML input attributes that will be parsed for the Webix input control
borderless used to hide the component borders
bottomLabel sets a label under a control
bottomPadding sets the bottom offset of the control input
click click action handler
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
format a number format that should be applied to a text input
gravity sets the view gravity
height sets the height of the component
hidden defines whether the view will be hidden initially
hotkey sets a hotkey that triggers button clicking
id the ID of a widget
inputAlign the alignment of an input inside its container
inputHeight the height of the input area, or a button's text value area.
inputWidth the width of the input area, or a button's text value area.
invalidMessage sets the text of a validation message
keyPressTimeout a delay between the key press and the action
label sets the text of the label
labelAlign the alignment of a label inside its container
labelPosition positions a label in relation to the control
labelWidth the width of the label
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
multiview enables switching between multiview cells
name name of the control
on allows attaching custom handlers to inner events of the component
optionWidth sets the width of each view option
options defines options for Radio, Segmented, and Tabbar
popup allows to attach pop-up menu to the button
relatedAction the action to call when the value of a control changes
relatedView the ID of the view that will be affected by the relatedAction operation
required marks field as required
suggest links suggest list to the input
tooltip sets a popup message next to the item when the cursor points to it
validate adds validation to the field
validateEvent on which event validation fires
value sets the ID of the necessary option from the options collection
width sets the width of a widget
Other
$allowsClear a flag that defines whether the input can be cleared
$compareValue compares the old value of the control with the one that is going to be set
$getSize returns the current size of the component
$getValue called each time when component need to get value from related html input
$height the current height of the view
$prepareValue adjusts the value that is going to be set to the format expected by the control
$render code called after rending control
$renderIcon renders icon for the control
$renderInput called each time when component need to paint control input
$renderLabel renders html for the label
$scope scope for resolving event and method names
$setNode defines HTML element for the component
$setSize sets the component size
$setValue called each time when component need to set value in related html input
$skin the method which will be called when skin is defined
$tooltipIn shows a tooltip
$tooltipMove defines the tooltip while the cursor moves over a view or an HTML area
$tooltipOut defines the behavior of a tooltip when the cursor is out of the target widget or HTML area
$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)
on_click attaches a click behavior for component items with the specified CSS class.
touchable flag, which force touch reaction on touch screen devices
Back to top