ui.colorboard

A color palette.

The component presents a div that contains a set of color swatches. Used as a part of the ui.colorpicker component. Check colorboard documentation for more detailed description.

Constructor

var colorboard = webix.ui({
    view:"colorboard",
    cols:20,
    rows:20,
    width:300,
    height:300
});

Where to start

• Overview of the Colorboard Widget
• Samples

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
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
getTopParentView	returns the top parent view
getValue	returns the current value of the component
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
moveSelection	moves selection in the specified direction
queryView	returns inner element/elements of a widget that correspond(s) to the defined parameters
refresh	repaints the component
render	renders the specified item or the whole component
resize	adjusts the view to a new size
setValue	sets a new value for the component
show	makes the component visible
unbind	breaks "bind" link
unblockEvent	cancels events blocking that was enabled by the 'blockEvent' command

onAfterRender	occurs immediately after the component has been rendered
onAfterScroll	occurs when some webix view has been scrolled
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
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
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
onSelect	fires when a user selects a color
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

animate	defines the type of animation, with which the view is shown, if it is a Multiview cell
borderless	used to hide the component borders
cols	sets the number of columns in the palette
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
grayScale	used to add a row with a set of colors from black to white
height	sets the height of the component
hidden	defines whether the view will be hidden initially
id	the ID of a widget
keyPressTimeout	a delay between the key press and the action
maxHeight	sets the maximum height for the view
maxLightness	sets the end value of lightness for the default color palette
maxWidth	sets the maximum width for the view
minHeight	sets the minimal height for the view
minLightness	sets the start value of lightness for the default color palette
minWidth	sets the minimal width for the view
navigation	activates the selection keyboard navigation
on	allows attaching custom handlers to inner events of the component
palette	sets palette colors
rows	sets the number of rows in the palette
template	sets the way of color presentation
type	type of the Colorboard
value	currently selected color
width	sets the width of a widget

$getSize	returns the current size of the component
$height	the current height of the view
$prepareValue	prepares control value for setting into an input
$scope	scope for resolving event and method names
$setNode	defines HTML element for the component
$setSize	sets the component size
$setValue	highlights the color with the specified value in the colorboard
$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)

Back to top