FancyGrid API

Docs

API

Config
- barHeight
- bbar
  - allowToggle
  - cls
  - data
  - disabled
  - displayKey
  - editable
  - emptyText
  - enableToggle
  - events
  - format
  - handler
  - hidden
  - id
  - imageCls
  - inputHeight
  - itemCheckBox
  - leftTpl
  - leftWidth
  - max
  - menu
  - min
  - minListWidth
  - multiSelect
  - multiToggle
  - pressed
  - spin
  - step
  - subSearch
  - text
  - tip
  - toggleGroup
  - type
  - valueKey
  - value
  - vtype
  - width
- bbarHeight
- bbarHidden
- buttons
  - allowToggle
  - cls
  - data
  - disabled
  - displayKey
  - editable
  - emptyText
  - enableToggle
  - events
  - format
  - handler
  - hidden
  - id
  - imageCls
  - inputHeight
  - itemCheckBox
  - leftTpl
  - leftWidth
  - max
  - menu
  - min
  - minListWidth
  - multiSelect
  - multiToggle
  - pressed
  - spin
  - step
  - subSearch
  - text
  - tip
  - toggleGroup
  - type
  - valueKey
  - vtype
  - width
- buttonsHeight
- buttonsHidden
- cellHeaderHeight
- cellHeight
- cellStylingCls
- cellTrackOver
- cellWrapper
- clicksToEdit
- cls
- columnClickData
- columnLines
- columns
  - autoWidth
  - align
  - autoHeight
  - cellAlign
  - cellTip
  - cls
  - columns
  - data
    proxy
    
    method
    
    params
    
    reader
    
    root
    
    url
  - disallowAfterDrop
  - displayKey
  - draggable
  - editable
  - ellipsis
  - exportFn
  - exportable
  - filter
    emptyText
    
    fn
    
    header
    
    operator
    
    tip
  - flex
  - format
  - headerCheckBox
  - headerClickSort
  - headerCls
  - headerCellTip
  - headerLImageCls
  - hidden
  - id
  - index
  - itemCheckBox
  - items
    action
    
    cls
    
    handler
    
    text
  - leftTpl
  - leftWidth
  - listItemTpl
  - lockable
  - locked
  - maxWidth
  - menu
  - minEditorWidth
  - minListWidth
  - minWidth
  - multiSelect
  - precision
  - render
  - resizable
  - rightLocked
  - rowdrag
  - searchable
  - select
  - selectable
  - smartIndexFn
  - sortable
  - sorter
  - sparkConfig
  - spin
  - step
  - subSearch
  - summary
  - title
  - titleEditable
  - type
  - valueKey
  - values
  - vtype
  - width
- controllers
- columnTrackOver
- contextmenu
- data
  - chart
    bind
    
    action
    
    event
    
    series
    
    fields
    
    id
    
    maxToShow
    
    sortBind
    
    type
  - fields
  - items
  - proxy
    afterRequest
    
    api
    
    create
    
    destroy
    
    read
    
    update
    
    autoLoad
    
    autoSave
    
    batch
    
    beforeRequest
    
    headers
    
    methods
    
    create
    
    destroy
    
    read
    
    update
    
    params
    
    reader
    
    root
    
    type
    
    url
    
    wrapper
    
    words
    
    direction
    
    filter
    
    key
    
    limit
    
    page
    
    start
    
    sort
    
    value
    
    writer
    
    allFields
    
    type
  - pageSize
  - remoteFilter
  - remotePage
  - remoteSort
- defaults
- dirtyEnabled
- draggable
- droppable
- dropZone
- dropZoneFn
- doubleHorizontalScroll
- emptyText
- events
  - activate
  - beforeedit
  - beforeendedit
  - cellclick
  - celldblclick
  - cellenter
  - cellleave
  - change
  - changepage
  - changepagesize
  - columnclick
  - columndblclick
  - columndrag
  - columnenter
  - columnhide
  - columnleave
  - columnshow
  - columnresize
  - columntitlechange
  - deactivate
  - delay
  - deselectrow
  - dragrows
  - dropitems
  - endedit
  - filter
  - init
  - insert
  - headercellclick
  - headercellenter
  - headercellleave
  - load
  - lockcolumn
  - remove
  - rowclick
  - rowdblclick
  - rowenter
  - rowleave
  - select
  - selectrow
  - servererror
  - set
  - scope
  - sort
  - startedit
  - unlockcolumn
  - update
- expander
  - dataFn
  - expanded
  - render
  - tpl
- exporter
- filter
  - autoEnterDelay
  - caseSensitive
- flexScrollSensitive
- footer
  - status
  - source
    link
    
    sourceText
    
    text
- gridToGrid
  - dragGroup
  - droppable
  - dropGroup
  - dropNotOkCls
  - dropOkCls
  - dropZoneCls
  - onDrop
- grouping
  - by
  - collapsed
  - order
  - sortGroups
  - tpl
- height
- id
- infinite
- i18n
- lang
  - autoSizeColumn
  - autoSizeColumns
  - cancel
  - columns
  - date
    read
    
    write
    
    edit
    
    today
    
    startDay
    
    days
    
    months
    
    am
    
    pm
    
    AM
    
    PM
    
    ok
    
    cancel
  - decimalSeparator
  - dragText
  - loadingText
  - lock
  - no
  - paging
    info
    
    of
    
    page
  - rightLock
  - sortAsc
  - sortDesc
  - sourceText
  - thousandSeparator
  - update
  - unlock
  - yes
- loadMask
- minHeight
- minWidth
- modal
- multiSort
- multiSortLimit
- nativeScroller
- paging
- renderOuter
- renderTo
- resizable
- rowEdit
- rowLines
- searching
  - items
- selModel
- shadow
- singleExpand
- state
  - filters
  - page
  - sorters
- startEditByTyping
- stateful
- stateId
- striped
- subTBar
  - allowToggle
  - action
  - cls
  - data
  - disabled
  - displayKey
  - editable
  - emptyText
  - enableToggle
  - events
  - format
  - handler
  - hidden
  - id
  - imageCls
  - inputHeight
  - itemCheckBox
  - leftTpl
  - leftWidth
  - max
  - menu
  - minListWidth
  - multiSelect
  - multiToggle
  - paramsMenu
  - paramsText
  - pressed
  - spin
  - step
  - subSearch
  - text
  - tip
  - toggleGroup
  - type
  - valueKey
  - vtype
  - width
- subTBarHeight
- subTBarHidden
- subHeaderFilter
- subTitle
  - cls
  - style
  - text
- summary
  - options
  - position
  - striped
  - sumDisplayed
- tabScrollStep
- tbar
  - action
  - allowToggle
  - cls
  - data
  - disabled
  - displayKey
  - editable
  - emptyText
  - enableToggle
  - events
  - format
  - handler
  - hidden
  - id
  - imageCls
  - inputHeight
  - itemCheckBox
  - leftTpl
  - leftWidth
  - max
  - menu
  - min
  - minListWidth
  - multiSelect
  - multiToggle
  - paramsMenu
  - paramsText
  - pressed
  - spin
  - step
  - subSearch
  - text
  - tip
  - toggleGroup
  - type
  - valueKey
  - vtype
  - width
- tbarHeight
- tbarHidden
- textSelection
- theme
  - name
  - config
    barHeight
    
    bottomScrollHeight
    
    cellHeaderHeight
    
    cellHeight
    
    gridBorders
    
    minCellWidth
    
    panelBodyBorders
    
    titleHeight
- title
  - cls
  - style
  - text
  - tools
    handler
    
    text
- titleHeight
- trackOver
- width
- window
Columns
- action
- checkbox
- color
- combo
- currency
- date
- expand
- grossloss
- hbar
- image
- number
- order
- progressbar
- progressdonut
- rowdrag
- select
- sparklinebar
- sparklinebox
- sparklinebullet
- sparklinediscrete
- sparklineline
- sparklinepie
- sparklinetristate
- string
- switcher
- text
- tree
Events
- activate
- beforeedit
- beforeendedit
- cellclick
- celldblclick
- cellenter
- cellleave
- change
- changepage
- changepagesize
- columnclick
- columndblclick
- columndrag
- columnenter
- columnhide
- columnleave
- columnshow
- columnresize
- columntitlechange
- contextmenu
- deactivate
- deselectrow
- dragrows
- dropitems
- endedit
- filter
- init
- insert
- headercellclick
- headercellenter
- headercellleave
- load
- lockcolumn
- remove
- rowclick
- rowdblclick
- rowenter
- rowleave
- select
- selectrow
- servererror
- set
- sort
- startedit
- statechange
- unlockcolumn
- update
Methods
- add
- addChild
- addColumn
- addEvent
- addFilter
- addGroup
- autoSizeColumns
- clearData
- clearDirty
- clearFilter
- clearGroup
- clearSelection
- collapse
- collapseAll
- collapseGroup
- copy
- deSelectRow
- destroy
- disableSelection
- each
- editCell
- enableSelection
- expand
- expandAll
- expandGroup
- exportToCSV
- exportToExcel
- find
- findItem
- fire
- firstPage
- flashCell
- flashRow
- get
- getById
- getCell
- getChanges
- getColumn
- getColumnById
- getColumns
- getData
- getDataAsCSV
- getDataFiltered
- getDataView
- getFilter
- getHeaderCell
- getHeight
- getPage
- getPages
- getPageSize
- getRowById
- getSelection
- getSorter
- getSubTitle
- getTitle
- getTotal
- getViewTotal
- getWidth
- hide
- hideBar
- hideColumn
- hideLoadMask
- isDirty
- isLoading
- insert
- lastPage
- load
- lockColumn
- nextPage
- on
- once
- prevPage
- redo
- remove
- removeAll
- removeAt
- removeColumn
- removeRow
- removeRowById
- rightLockColumn
- save
- scroll
- scrollToRow
- search
- selectCell
- selectCellDown
- selectCellLeft
- selectCellRight
- selectCellUp
- selectColumn
- selectRow
- set
- setById
- setColumnComboData
- setColumns
- setColumnTitle
- setColumnWidth
- setData
- setHeight
- setPage
- setPageSize
- setParams
- setSelModel
- setSubTitle
- setTitle
- setTrackOver
- setUrl
- setWidth
- show
- showAt
- showBar
- showColumn
- showLoadMask
- sort
- stopEditor
- stopSelection
- toggleCollapse
- toggleExpand
- un
- undo
- undoAll
- unLockColumn
- update
- updateFilters

keyNavigation

Boolean

Enable/disable selection navigation over keyboard keys: LEFT/RIGHT/UP/DOWN.

Example


var grid = new FancyGrid({
  selModel: {
	type: 'rows',
	keyVigation: false
  },
  ...

Default


true