Undocumented

Hierarchy

Constructors

Properties

__preDataSource: any

Undocumented

__preSource: any

Undocumented

__preSourceFiltered: any

Undocumented

_adjustSizeNeeded: boolean

Undocumented

_canBeLongTouch: any

Undocumented

_captureListeners: any

Undocumented

_cleanFuncs: any

Undocumented

_cleanUpCalled: boolean

Undocumented

_collapseSupport: boolean

Undocumented

_contextMenu: any

Undocumented

_contextMenuAddons: any

Undocumented

_contextMenuHandler: any

Undocumented

_contextMenuPromises: any[]

Undocumented

_controlTitle: string

Undocumented

_dataSource: any

Undocumented

_dataSourceListenFuncts: (() => void)[]

Undocumented

_dataSourceOrig: any

Undocumented

_dataSourcePromises: any

Undocumented

_disablePredraw: boolean

Undocumented

_disabled: boolean

Undocumented

_dockMenuItems: any

Undocumented

_dockable: boolean

Undocumented

_fastObject: any

Undocumented

_fieldDefs: any

Undocumented

_frameIDs: any

Undocumented

_frameMMIDs: any

Undocumented

_groupShiftFocusedID: undefined

Undocumented

_groupsRefresh: boolean

Undocumented

_hasSplitters: boolean

Undocumented

_headerFillPaddingSet: any

Undocumented

_idleCallIDs: any

Undocumented

_ignoreDefaultLookup: any

Undocumented

_incrementalSearchEnabled: boolean

Undocumented

_interactionTimeout: number

Undocumented

_isDock: boolean

Undocumented

_isFiltered: boolean

Undocumented

_isLongTouch: any

Undocumented

_isTreeView: boolean

Undocumented

_isresizable: boolean

Undocumented

_itemToShow: any

Undocumented

_lassoRangeEnd: number

Undocumented

_lassoRangeStart: number

Undocumented

_lassoSelectionStart: {
    direction: number;
    headerHeight: number;
    itemIndex: any;
    lvpos: any;
    offset: number;
    startingItemIndex: any;
    x: number;
    y: number;
}

Undocumented

Type declaration

  • direction: number

    Undocumented

  • headerHeight: number

    Undocumented

  • itemIndex: any

    Undocumented

  • lvpos: any

    Undocumented

  • offset: number

    Undocumented

  • startingItemIndex: any

    Undocumented

  • x: number

    Undocumented

  • y: number

    Undocumented

_lastFocusChangingPromise: undefined

Undocumented

_lastKey?: string

Undocumented

_lastLassoUsageTm: number

Undocumented

_lastMousePos: {
    x: any;
    y: any;
}

Undocumented

Type declaration

  • x: any

    Undocumented

  • y: any

    Undocumented

_layoutChangeHandler?: ((evt) => void)

Type declaration

    • (evt): void
    • Undocumented

      Parameters

      Returns void

_listeners: any

Undocumented

_localPromises: Promise<any>[]

Undocumented

_menuArray: Action[]

Undocumented

_mouseMoveHandler: ((evt) => void)

Type declaration

    • (evt): void
    • Undocumented

      Parameters

      Returns void

_mouseOutHandler: ((evt) => void)

Type declaration

    • (evt): void
    • Undocumented

      Parameters

      Returns void

_multiselect: boolean

Undocumented

_needsFullRecalculation?: boolean

Undocumented

_openingPopupTimer: number

Undocumented

_originalHeight: number

Undocumented

_originalWidth: number

Undocumented

_parentView: ViewData

Undocumented

_pointerAtPos: any

Undocumented

_reComputeViewport: boolean

Undocumented

_refreshItemBoxProperties: boolean

Undocumented

_requestedFocAndSelectIdx: any

Undocumented

_resizeStartX: number

Undocumented

_resizeStartY: number

Undocumented

_resizing: boolean

Undocumented

_searchable: boolean

Undocumented

_setFilteredSourceTm: any

Undocumented

_shiftFocusedItem: number

Undocumented

_showHeader: boolean

Undocumented

_showInline: boolean

Undocumented

_statusBarPromises: any

Undocumented

_statusBarSources: any

Undocumented

_statusParams: AnyDict

Undocumented

_tabIndex: number

Undocumented

_targetScrollOffset: number

Undocumented

_timeoutIDs: any

Undocumented

_touchDownTime: any

Undocumented

_updatesSuspended: any

Undocumented

_useMouseHover: boolean

Undocumented

_userInteractivePriority: boolean

Undocumented

activatedHandler: ((active) => void)

Type declaration

    • (active): void
    • Undocumented

      Parameters

      • active: boolean

      Returns void

addArtworkRules: any

Undocumented

alwaysShowTooltips: boolean

Undocumented

animateNextDraw: boolean

Undocumented

autoScrollInt: any

Undocumented

autoScrollStep: number

Undocumented

automaticSelectionMode: boolean

Undocumented

bindFn: any

Undocumented

body: HTMLDivElement

Undocumented

canBeUsedAsSource: boolean

Undocumented

canvas?: HTMLDivElement

Undocumented

canvasHeight: number

Undocumented

canvasScrollLeft: number

Undocumented

canvasScrollTop: number

Undocumented

canvasWidth: number

Undocumented

cellSetups: any

Undocumented

checkGroups: boolean

Undocumented

checkboxes: boolean

Undocumented

closediv?: HTMLDivElement

Undocumented

colDimension: number

Undocumented

colGroupDimension: number

Undocumented

columnMinWidth: any

Undocumented

columns: any[]

Undocumented

container: HTMLElement

Undocumented

contextMenuPromise: any

Undocumented

currentMode: any

Undocumented

debugMenuItemsCreated: any

Undocumented

defaultBinds: {
    bindCheckboxCell: ((div, item, index) => void);
    bindCheckboxCell_HideOdd: ((div, item, index) => void);
}

Undocumented

Type declaration

  • bindCheckboxCell: ((div, item, index) => void)
      • (div, item, index): void
      • Undocumented

        Parameters

        • div: any
        • item: any
        • index: any

        Returns void

  • bindCheckboxCell_HideOdd: ((div, item, index) => void)
      • (div, item, index): void
      • Undocumented

        Parameters

        • div: any
        • item: any
        • index: any

        Returns void

defaultBtn: HTMLElement

Undocumented

defaultColumns: any[]

Undocumented

delayBeforeFirstUpdate: number

Undocumented

delayBeforePredraw: number

Undocumented

disableStateStoring: boolean

Undocumented

disableStatusbar: boolean

Undocumented

disabledClearingSelection: boolean

Undocumented

disabledCounter: number

Undocumented

disabledSelectionIconsPositionHandling: boolean

Undocumented

distributeEmptySpace: boolean

Undocumented

divs: HTMLDivElement[]

Undocumented

divsPerScreen: number

Undocumented

dndEventsRegistered: boolean

Undocumented

dontEmitFocusChange: any

Undocumented

dontResetState: any

Undocumented

dragEnterHandler: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

dragFinishedHandler: ((e?) => void)

Type declaration

    • (e?): void
    • Undocumented

      Parameters

      Returns void

dragLeaveHandler: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

dragOverHandler: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

dragStartHandler: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

dragging: boolean

Undocumented

drawQueued: boolean

Undocumented

dropHandler: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      • e: any

      Returns void

dummy: any

Undocumented

editSupported: boolean

Undocumented

excludeFromGlobalContextualSearch: boolean

Undocumented

fill: HTMLDivElement

Undocumented

findDNDHandler: ((e) => any)

Type declaration

    • (e): any
    • Undocumented

      Parameters

      Returns any

firstCachedItem: number

Undocumented

firstVisibleItem: number

Undocumented

focusChanged: ((newIdx, oldIdx) => void)

Type declaration

    • (newIdx, oldIdx): void
    • Undocumented

      Parameters

      • newIdx: any
      • oldIdx: any

      Returns void

focusEventsRegistered?: boolean

Undocumented

focusVisible: boolean

Undocumented

focusedAlsoSelected: boolean

Undocumented

focusedShiftItem: number

Undocumented

forbiddenWhenLoadedCancel: any

Undocumented

forceCanvasHeight: number

Undocumented

forceDisabled?: boolean

Undocumented

forceItemCountUpdate: boolean

Undocumented

forceRebindAll: boolean

Undocumented

forceRebindSelection: boolean

Undocumented

forceRestoreFocus: any

Undocumented

getCloseButtonAction: (() => any)

Type declaration

    • (): any
    • Undocumented

      Returns any

getDefaultSortString: (() => string) = ...

Type declaration

    • (): string
    • Undocumented

      Returns string

gridPopupDelay: any

Undocumented

groupDivs: HTMLDivElement[]

Undocumented

groupHeaders: boolean

Undocumented

groupHeight: number

Undocumented

groupSepDivs: HTMLDivElement[]

Undocumented

groupSepHeight: number

Undocumented

groupSeparators: boolean

Undocumented

groupSpacing: number

Undocumented

hasMediaContent: boolean

Undocumented

header: any

Undocumented

headerCheckTipChecked: string

Undocumented

headerCheckTipIndeterminate: string

Undocumented

headerCheckTipUnchanged: string

Undocumented

headerFill: any

Undocumented

headerItems: HTMLDivElement

Undocumented

headerRenderers: {
    renderCheck: ((div, column) => void);
    renderDefault: ((div, column) => void);
}

Undocumented

Type declaration

  • renderCheck: ((div, column) => void)
      • (div, column): void
      • Undocumented

        Parameters

        • div: any
        • column: any

        Returns void

  • renderDefault: ((div, column) => void)
      • (div, column): void
      • Undocumented

        Parameters

        • div: any
        • column: any

        Returns void

hideOdd: any

Undocumented

highlightPlayingTrack: boolean

Undocumented

highlightSupported: boolean

Undocumented

horLineSepDiv: HTMLDivElement

Undocumented

horizontalSeparator: any

Undocumented

ignoreMouseOnGroup: any

Undocumented

ignoreReflowOptimizations: any

Undocumented

ignoreShiftFocusChange: boolean

Undocumented

inEdit: AnyDict

Undocumented

invalidateNeeded: boolean

Undocumented

invalidateScrollPos: boolean

Undocumented

isCheckboxInHeader: boolean

Undocumented

isColMovable: boolean

Undocumented

isColResizable: boolean

Undocumented

isGrid: boolean

Undocumented

isGrouped: boolean

Undocumented

isHorizontal: boolean

Undocumented

isSortable: boolean

Undocumented

itemBoxProperties: {
    height: number;
    paddingLeft: number;
    paddingRight: number;
    width: number;
}

Undocumented

Type declaration

  • height: number

    Undocumented

  • paddingLeft: number

    Undocumented

  • paddingRight: number

    Undocumented

  • width: number

    Undocumented

itemCloningAllowed: boolean

Undocumented

itemCount: number

Undocumented

itemHeight: number

Undocumented

itemHeightReset: boolean

Undocumented

itemHorzSpacing: number

Undocumented

itemRedistSpacing: number

Undocumented

itemRowSpacing: number

Undocumented

itemSizes: any[]

Undocumented

itemWidth: number

Undocumented

itemsPerRow: number

Undocumented

lassoAutoScrollOffset: number

Undocumented

lassoParentElement: boolean

Undocumented

lassoSelectionEnabled: boolean

Undocumented

lastBindTimestamp: number

Undocumented

lastCheckedScrollLeft: number

Undocumented

lastHoveredDiv: HTMLDivElement

Undocumented

lastMouseDiv: any

Undocumented

lastMouseDownDiv: HTMLElement

Undocumented

lastMouseDragEvent: any

Undocumented

lastRefresh: number

Undocumented

lastVisibleItem: number

Undocumented

listCheckTipChecked: string

Undocumented

listCheckTipIndeterminate: string

Undocumented

listCheckTipUnchanged: string

Undocumented

loadShortcutIcon: ((colDiv) => void)

Type declaration

    • (colDiv): void
    • Undocumented

      Parameters

      • colDiv: any

      Returns void

maxCachedDivs: number

Undocumented

mergeParentContextMenu: any

Undocumented

minCachedDivs: number

Undocumented

minTimeBetweenUpdates: number

Undocumented

moveFirstGroupHeader: boolean

Undocumented

movingOnGroups: boolean

Undocumented

noFocusOnClick: any

Undocumented

noItemOverstrike: any

Undocumented

noScroll: boolean

Undocumented

oldDropAfter: any

Undocumented

oldDropBefore: HTMLDivElement

Undocumented

oldHeight: number

Undocumented

oldLeft: number

Undocumented

oldTop: any

Undocumented

oldVisible: boolean

Undocumented

oldWidth: number

Undocumented

orderColumnSupport: boolean

Undocumented

organizedPathColumnSupported: boolean

Undocumented

popupCache: any[]

Undocumented

popupCounter: number

Undocumented

popupDiv: HTMLDivElement

Undocumented

popupIndicator: any

Undocumented

popupSupport: boolean

Undocumented

preDraw: boolean

Undocumented

preDrawAmount: number

Undocumented

preDrawnScreens: number

Undocumented

recalcLayoutNeeded: any

Undocumented

recentlyUsedColumns: any[]

Undocumented

reorderOnly: boolean

Undocumented

reportStatus: boolean

Undocumented

resizediv: HTMLDivElement

Undocumented

rowDimension: number

Undocumented

savedScrollOffset: {
    origScroll: any;
    topItem: any;
}

Undocumented

Type declaration

  • origScroll: any

    Undocumented

  • topItem: any

    Undocumented

scrollUpdateNeeded: boolean

Undocumented

scrollingCanvas: HTMLDivElement

Undocumented

scrollingCaption: HTMLDivElement

Undocumented

selectingRange: boolean

Undocumented

setCloseButtonAction: ((action) => void)

Type declaration

    • (action): void
    • Undocumented

      Parameters

      Returns void

showCaptionOnScroll: boolean

Undocumented

showEllipsisTooltip: boolean

Undocumented

showRowCount: number

Undocumented

showSaveCalled: boolean

Undocumented

singleClickEdit: boolean

Undocumented

skips: any[]

Undocumented

smoothScroll: any

Undocumented

smoothScrollAdjust: number

Undocumented

smoothScrollOrigin: any

Undocumented

smoothScrollTarget: number

Undocumented

smoothScrollTime: number

Undocumented

smoothScrollTimeLimit: number

Undocumented

sortColumns: any[]

Undocumented

startEdit?: procedure

Undocumented

statusInfo: any

Undocumented

supressIncrementalSearchToasts: boolean

Undocumented

topCheckboxPromise: any

Undocumented

touchEnd: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

touchEventsRegistered?: boolean

Undocumented

touchMove: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

touchStart: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

uniqueID: string

Undocumented

unlisteners: undefined

Undocumented

updateTopCheckbox: (() => void)

Type declaration

    • (): void
    • Undocumented

      Returns void

useFastBinding: boolean

Undocumented

viewport: HTMLDivElement

Undocumented

viewportSize: number

Undocumented

viewportSizeY: any

Undocumented

visColIndexFirst: number

Undocumented

visColIndexLast: number

Undocumented

visibleColumns: any[]

Undocumented

Accessors

  • get adaptColumnsWidth(): boolean
  • Returns boolean

  • set adaptColumnsWidth(value): void
  • Parameters

    • value: boolean

    Returns void

  • get autoSortString(): string
  • Returns string

  • set autoSortString(value): void
  • Parameters

    • value: string

    Returns void

  • get autoSortSupported(): boolean
  • Returns boolean

  • get canScrollHoriz(): boolean
  • Returns boolean

  • set canScrollHoriz(value): void
  • Parameters

    • value: boolean

    Returns void

  • get collapseSupport(): boolean
  • Returns boolean

  • set collapseSupport(value): void
  • Parameters

    • value: boolean

    Returns void

  • get contextMenu(): any
  • Gets/sets context menu of the control. It could be also a function returning Menu object.

    Returns any

  • set contextMenu(value): void
  • Parameters

    • value: any

    Returns void

  • get dataSource(): any
  • Gets/sets the datasource which is/will be shown

    Returns any

  • set dataSource(ds): void
  • Parameters

    • ds: any

    Returns void

  • get disabled(): boolean
  • Gets/sets data-disabled attribute of the control and his childs

    Returns boolean

  • set disabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get dockMenuItems(): any
  • Gets/sets dock menu of the control. It could be also a function returning Menu object.

    Returns any

  • set dockMenuItems(value): void
  • Parameters

    • value: any

    Returns void

  • get dockTitle(): string
  • Gets/sets dock title.

    Returns string

  • set dockTitle(value): void
  • Parameters

    • value: string

    Returns void

  • get dockable(): boolean
  • Gets/sets dockable status of the control.

    Returns boolean

  • set dockable(value): void
  • Parameters

    • value: boolean

    Returns void

  • get dynamicSize(): boolean
  • Returns boolean

  • set dynamicSize(value): void
  • Parameters

    • value: boolean

    Returns void

  • get enableIncrementalSearch(): boolean
  • Returns boolean

  • set enableIncrementalSearch(value): void
  • Parameters

    • value: boolean

    Returns void

  • get fieldDefs(): any
  • Returns any

  • set fieldDefs(value): void
  • Parameters

    • value: any

    Returns void

  • get fieldGroups(): any
  • Returns any

  • get focusedColumn(): any
  • Gets/sets of the focused Column object.

    Returns any

  • set focusedColumn(value): void
  • Parameters

    • value: any

    Returns void

  • get focusedColumnIndex(): number
  • Gets/sets index of the focused column, based on all columns array

    Returns number

  • set focusedColumnIndex(value): void
  • Parameters

    • value: number

    Returns void

  • get focusedIndex(): number
  • Gets/sets index of the focused item. In case there's a datasource, its focusedIndex property is modified.

    Returns number

  • set focusedIndex(value): void
  • Parameters

    • value: number

    Returns void

  • get focusedItem(): any
  • Gets the focused item/object according to the current focusedIndex

    Returns any

  • get hasSplitters(): boolean
  • Returns boolean

  • set hasSplitters(value): void
  • Parameters

    • value: boolean

    Returns void

  • get headerContextMenu(): any
  • Gets/sets context menu of the header.

    Returns any

  • set headerContextMenu(value): void
  • Parameters

    • value: any

    Returns void

  • get headerTitle(): string
  • Header title to be shown (in case 'showHeader' property is set).

    Returns string

  • set headerTitle(value): void
  • Parameters

    • value: string

    Returns void

  • get helpContext(): string
  • Returns string

  • set helpContext(value): void
  • Parameters

    • value: string

    Returns void

  • get isDock(): boolean
  • Gets/sets isDock status of the control.

    Returns boolean

  • set isDock(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isSearchable(): boolean
  • Get/set whether this control is searchable (e.g. via search bar)

    Returns boolean

  • set isSearchable(value): void
  • Parameters

    • value: boolean

    Returns void

  • Returns any[]

  • Parameters

    • value: any[]

    Returns void

  • get minHeight(): number
  • Returns number

  • set minHeight(value): void
  • Parameters

    • value: number

    Returns void

  • get minWidth(): number
  • Returns number

  • set minWidth(value): void
  • Parameters

    • value: number

    Returns void

  • get multiselect(): boolean
  • Returns boolean

  • set multiselect(value): void
  • Parameters

    • value: boolean

    Returns void

  • get oneRow(): any
  • Returns any

  • set oneRow(value): void
  • Parameters

    • value: any

    Returns void

  • get parentView(): ViewData
  • Gets/sets view data.

    Returns ViewData

  • set parentView(value): void
  • Parameters

    Returns void

  • get resizable(): boolean
  • Returns boolean

  • set resizable(val): void
  • Parameters

    • val: boolean

    Returns void

  • get scrollingParent(): any
  • Returns any

  • get selectionMode(): boolean
  • Returns boolean

  • set selectionMode(value): void
  • Parameters

    • value: boolean

    Returns void

  • get showHeader(): boolean
  • Whether to show header.

    Returns boolean

  • set showHeader(value): void
  • Parameters

    • value: boolean

    Returns void

  • get showInline(): boolean
  • Returns boolean

  • set showInline(value): void
  • Parameters

    • value: boolean

    Returns void

  • get sortString(): string
  • Returns string

  • set sortString(value): void
  • Parameters

    • value: string

    Returns void

  • get statusParams(): AnyDict
  • Gets/sets params for statusbar.

    Returns AnyDict

  • set statusParams(value): void
  • Parameters

    Returns void

  • get tabIndex(): number
  • Gets/sets tabIndex property. Use instead of tabIndex in HTMLElement for correct handling of disabled state.

    Returns number

  • set tabIndex(value): void
  • Parameters

    • value: number

    Returns void

  • get visible(): boolean
  • Gets/sets visibility state of the control.

    Returns boolean

Methods

  • Undocumented

    Returns boolean

  • Undocumented

    Parameters

    • adaptableArray: any
    • nonAdaptableArray: any
    • total: any

    Returns any

  • Undocumented

    Parameters

    • letter: string
    • Optional reverseOrder: boolean
    • Optional nextOccurence: boolean

    Returns void

  • Undocumented

    Parameters

    • resizedCol: any
    • doLock: any

    Returns void

  • Undocumented

    Parameters

    • orig: any
    • filtered: any
    • phrase: any

    Returns void

  • Undocumented

    Parameters

    • sortStr: string

    Returns void

  • Undocumented

    Parameters

    • redraw: boolean

    Returns void

  • Undocumented

    Parameters

    • x: number
    • y: number

    Returns void

  • Add function to be called once during Control cleanUp

    Method

    addCleanFunc

    Parameters

    • func: any

      Function to add

    Returns void

  • Undocumented

    Parameters

    • columnType: any

    Returns void

  • Creates a new sub-control.

    Method

    addControl

    Parameters

    • controlClass: string

      Class of the new control.

    • Optional initParams: AnyDict

      Initialization parameters.

    Returns HTMLDivElement

    The new control.

  • Undocumented

    Parameters

    • event: any
    • func: any
    • capture: any

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement

    Returns void

  • Undocumented

    Parameters

    • row: any

    Returns any

  • Adds item(s) to control context menu.

    Method

    addToContextMenu

    Parameters

    • items: any

    Returns void

  • Undocumented

    Parameters

    • value: any

    Returns void

  • Undocumented

    Parameters

    • adjustItems: boolean

    Returns void

  • Undocumented

    Parameters

    • div: any

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • skip: any
    • counter: any

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement
    • index: number
    • item: any

    Returns void

  • Undocumented

    Parameters

    • itemCount: number

    Returns number

  • Undocumented

    Returns boolean

  • Undocumented

    Parameters

    • e: any

    Returns any

  • Undocumented

    Returns boolean

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement
    • attribute: any

    Returns void

  • Undocumented

    Parameters

    • skip: any

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Returns HTMLDivElement

  • Undocumented

    Returns HTMLDivElement

  • Undocumented

    Returns HTMLDivElement

  • Undocumented

    Parameters

    • object: any
    • event: any
    • func: any
    • Optional capture: boolean

    Returns ((...args) => any)

      • (...args): any
      • Parameters

        • Rest ...args: any[]

        Returns any

  • Undocumented

    Parameters

    • pr: any

    Returns any

  • Undocumented

    Parameters

    • itemIndex: number

    Returns HTMLDivElement

  • Handle drag enter operation

    Method

    dragEnter

    Parameters

    Returns void

  • Undocumented

    Parameters

    • e: any

    Returns void

  • Undocumented

    Parameters

    • e: DragEvent

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • scrollTop: number

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • e: any
    • isSameControl: boolean

    Returns void

  • Undocumented

    Parameters

    • targetItemIndex: any

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • continueEdit: any
    • newItemSelected: any

    Returns void

  • Undocumented

    Returns void

  • Filters dataSource based on given criteria (used when searching/filtering items within, e.g. via search bar)

    Method

    filterSource

    Parameters

    • phrase: any

      string phrase to filter

    Returns void

    String message or object with detailed data

  • Undocumented

    Parameters

    • element: HTMLElement
    • newState: any

    Returns boolean

  • Undocumented

    Parameters

    • newFocusState: any

    Returns void

  • Undocumented

    Returns boolean

  • Undocumented

    Parameters

    • data: any

    Returns any

  • Undocumented

    Parameters

    • div: HTMLDivElement

    Returns HTMLCollection

  • Undocumented

    Parameters

    • cached: any

    Returns {
        h: number;
        l: number;
        t: number;
        w: number;
    }

    • h: number

      Undocumented

    • l: number

      Undocumented

    • t: number

      Undocumented

    • w: number

      Undocumented

  • Undocumented

    Parameters

    • col: any

    Returns string[]

  • Undocumented

    Returns {
        allColumns: any[];
    }

    • allColumns: any[]

      Undocumented

  • Returns the div at the corresponding item index, or null if no div contains the item.

    Method

    getDiv

    Parameters

    • itemIndex: number

    Returns HTMLDivElement

    HTMLElement|null Div at the corresponding item index if it exists.

  • Undocumented

    Parameters

    • firstitem: any
    • itemindex: number

    Returns HTMLDivElement

  • Undocumented

    Parameters

    • e: DragEvent

    Returns any

  • Undocumented

    Parameters

    • index: number

    Returns any

  • Undocumented

    Parameters

    • div: HTMLDivElement

    Returns HTMLDivElement

  • Undocumented

    Returns HTMLDivElement

  • Undocumented

    Parameters

    • column: any

    Returns number

  • Undocumented

    Parameters

    • fcol: any

    Returns number

  • Undocumented

    Parameters

    • index: number

    Returns any

  • Undocumented

    Parameters

    • itemIndex: any
    • column: any

    Returns number

  • Undocumented

    Parameters

    • itemIndex: any

    Returns number

  • Undocumented

    Parameters

    • row: any
    • col: any

    Returns any

  • Undocumented

    Parameters

    • index: any

    Returns any

  • Undocumented

    Parameters

    • x: number
    • y: number
    • Optional approxResults: boolean

    Returns any

  • Undocumented

    Parameters

    • x: number
    • y: number
    • Optional approxResults: boolean

    Returns number

  • Undocumented

    Parameters

    • itemIndex: number
    • Optional usePositionIndex: boolean

    Returns any

  • Undocumented

    Parameters

    • itemIndex: any

    Returns number

  • Undocumented

    Parameters

    • itemIndex: any

    Returns {
        height: number;
        left: number;
        top: any;
        width: number;
    }

    • height: number

      Undocumented

    • left: number

      Undocumented

    • top: any

      Undocumented

    • width: number

      Undocumented

  • Undocumented

    Parameters

    • itemIndex: any

    Returns any

  • Undocumented

    Parameters

    • itemIndex: any

    Returns any

  • Undocumented

    Parameters

    • itemIndex: any

    Returns any

  • Undocumented

    Parameters

    • itemIndex: any

    Returns number

  • Undocumented

    Parameters

    • group: any

    Returns any

  • Undocumented

    Parameters

    • item: any

    Returns number

  • Returns the next visible column (to the right), or undefined if there isn't any.

    Method

    getNextVisibleColumn

    Parameters

    • column: any

      Starting column

    • Optional editable: boolean

      Must be editable

    Returns any

    The resulting column or undefined if none.

  • Undocumented

    Parameters

    • offset: any

    Returns any

  • Returns the first ancestor in the HTML DOM tree, that has controlClass and data-id. Searching is stopped on topParentCtrl, if defined.

    Method

    getParentControl

    Parameters

    • topParentCtrl: any

      ControlClass of the top parent, where to stop searching.

    Returns Control

    Parent Control or undefined if there's no parent.

  • Returns control to decide which subcontrols should be stored e.g. Multiview component overrides this as it stores states only for the active control/view

    Method

    getPersistentStateRootControl

    Returns HTMLElement

    control

  • Returns root key string under which the values are stored in persistent.JSON file on the disk.

    Method

    getPersistentStateRootKey

    Returns string

    store key id

  • Undocumented

    Parameters

    • popupDiv: any

    Returns any

  • Undocumented

    Parameters

    • group: any

    Returns any

  • Returns the previous visible column (to the left), or undefined if there isn't any.

    Method

    getPrevVisibleColumn

    Parameters

    • column: any

      Starting column

    • Optional editable: boolean

      Must be editable

    Returns any

    The resulting column or undefined if none.

  • Returns the top scrolled item information/offset, so that it can be restored in case LV formatting/size is changed (and thus scroll offset of the canvas wouldn't match).

    Method

    getRealScrollOffset

    Returns {
        origScroll: any;
        topItem: number;
    }

    Object Information about the scrolled position

    • origScroll: any

      Undocumented

    • topItem: number

      Undocumented

  • Undocumented

    Parameters

    • id: any
    • Optional canAdd: any

    Returns any

  • Undocumented

    Returns {
        footerHeight: number;
        headerHeight: number;
        totalHeight: number;
    }

    • footerHeight: number

      Undocumented

    • headerHeight: number

      Undocumented

    • totalHeight: number

      Undocumented

  • Returns a visible column that's 'offset' columns to the right (if offset is positive).

    Method

    getVisibleColumnOffset

    Parameters

    • column: any

      Starting column

    • offset: any

      Distance of the column

    • editable: any

      Must be editable

    Returns any

    The resulting column or undefined if none.

  • Undocumented

    Returns {
        height: number;
        top: number;
        width: any;
    } | {
        height: number;
        top: any;
        width: number;
    }

  • Undocumented

    Parameters

    • reGroup: boolean
    • Optional reComputeViewport: boolean
    • Optional invalidateItemHeight: boolean

    Returns Promise<unknown>

  • Undocumented

    Parameters

    • div: HTMLDivElement
    • index: number

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement
    • index: number

    Returns void

  • Undocumented

    Parameters

    • newIndex: any
    • oldIndex: any

    Returns void

  • Undocumented

    Parameters

    • eventType: any
    • itemIndex: any
    • obj: any
    • flags: any
    • flagData: any
    • flagValue: any

    Returns void

  • Undocumented

    Parameters

    • div: any
    • e: any

    Returns void

  • Undocumented

    Parameters

    • div: any
    • e: any

    Returns void

  • Undocumented

    Parameters

    • itemIndex: any
    • obj: any

    Returns void

  • Undocumented

    Parameters

    • itemIndex: any
    • obj: any

    Returns void

  • Undocumented

    Parameters

    • itemIndex: any
    • obj: any

    Returns void

  • Undocumented

    Parameters

    • div: any
    • e: any

    Returns void

  • Undocumented

    Parameters

    • div: any
    • e: any

    Returns void

  • Undocumented

    Parameters

    • div: any
    • e: any

    Returns void

  • Undocumented

    Parameters

    • div: any
    • e: any

    Returns void

  • Undocumented

    Parameters

    • _itemObjectToShow: any

    Returns void

  • Undocumented

    Parameters

    • e: any

    Returns void

  • Undocumented

    Parameters

    • e: any

    Returns void

  • Hides column

    Method

    hideColumn

    Parameters

    • columnVIdx: any

      A column index to be removed. Order in visibleColumns array.

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement

    Returns void

  • Undocumented

    Parameters

    • hotkey: any

    Returns boolean

  • Undocumented

    Parameters

    • searchPhrase: any
    • reverseOrder: any
    • nextOccurence: any

    Returns number

  • Undocumented

    Parameters

    • rootelem: any
    • params: any

    Returns void

  • Undocumented

    Returns boolean

  • Undocumented

    Parameters

    • itemIndex: any

    Returns boolean

  • Undocumented

    Returns boolean

  • Undocumented

    Returns boolean

  • This method is pretty similar as app.listen(), but app.unlisten() is called automatically in Control.cleanUp()

    Method

    localListen

    Parameters

    • object: any

      Object where to set listener

    • event: string

      Event of the listener

    • func: AnyCallback

      Method for callback dispatch

    • Optional capture: boolean

    Returns ((...args) => any)

      • (...args): any
      • Parameters

        • Rest ...args: any[]

        Returns any

  • This method is supposed to automatically cancel running promises when component is going to destroy.

    Method

    localPromise

    Parameters

    • promise: any

    Returns any

  • Undocumented

    Parameters

    • Optional coldiv: HTMLDivElement

    Returns void

  • Control is allow drag object

    Method

    makeDraggable

    Parameters

    • element: any
    • Optional canBeDragged: boolean

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement
    • focused: boolean

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement
    • selected: boolean

    Returns void

  • Undocumented

    Parameters

    • e: WheelEvent

    Returns void

  • Change order of the column. Indexes are order in visibleColumns array.

    Method

    moveColumn

    Parameters

    • oldVIdx: any

      Original index of the column to be moved

    • newVIdx: any

      New index of the column

    Returns void

  • Moves focus one column to the left.

    Method

    moveFocusLeft

    Parameters

    • Optional editable: boolean

      Must be editable

    Returns boolean

  • Moves focus one column to the right.

    Method

    moveFocusRight

    Parameters

    • Optional editable: boolean

      Must be editable

    Returns boolean

  • Undocumented

    Parameters

    • columnIdx: any

    Returns number

  • Undocumented

    Parameters

    • Optional columnClass: any
    • Optional visible: any

    Returns void

  • Undocumented

    Parameters

    • Optional newfocusedIndex: number

    Returns void

  • Undocumented

    Parameters

    • newsize: any

    Returns void

  • Undocumented

    Parameters

    • div: any
    • tip: any

    Returns any

  • Undocumented

    Parameters

    • nodeDataSource: any
    • nodeHandlerID: any
    • clickedArea: any
    • Optional newTab: boolean

    Returns void

  • Undocumented

    Parameters

    • searchPhrase: string
    • Optional reverseOrder: boolean
    • Optional nextOccurence: boolean

    Returns boolean

  • Undocumented

    Parameters

    • div: any
    • index: any
    • fastObject: any

    Returns void

  • Undocumented

    Parameters

    • reGroup: any

    Returns Promise<unknown>

  • Undocumented

    Parameters

    • columns: any

    Returns void

  • Undocumented

    Parameters

    • id: string

    Returns any

  • Raise the event on the Control

    Example

    if (!this.raiseEvent('selecting', {
    tabIndex: value,
    oldTabIndex: oldSelected
    }, true))
    return; // canceled, do not change selection

    Parameters

    • eventName: any

      Name of the event

    • Optional details: AnyDict

      Custom parameters to be sent with the event

    • Optional isCancelable: boolean

      Whether the event can be canceled.

    • Optional canBubble: boolean

      Whether the event can bubble.

    • Optional sender: EventTarget

      of the event. Container by default.

    Returns boolean

    Success. If 'false', the event was canceled.

  • Undocumented

    Parameters

    • Optional doForce: boolean

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • Optional redraw: boolean

    Returns void

  • Undocumented

    Parameters

    • newState: any

    Returns void

  • Undocumented

    Parameters

    • event: any
    • Optional capture: boolean

    Returns void

  • Undocumented

    Parameters

    • event: any
    • func: any
    • capture: any

    Returns void

  • Undocumented

    Parameters

    • id: any

    Returns any

  • Undocumented

    Parameters

    • div: HTMLElement
    • group: any

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement
    • group: any
    • forceRebind: any

    Returns void

  • Undocumented

    Parameters

    • div: any
    • group: any
    • offset: any

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement
    • group: any

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement
    • Optional item: any

    Returns boolean

  • Undocumented

    Parameters

    • state: string

    Returns void

  • Request an animation frame in the control context. If the control has been cleaned up, then the callback will not execute.

    Example

    this.requestFrame(function () {
    // this callback will be executed at a maximum of your monitor's natural refresh rate.
    }, "myUniqueFrameCallbackName");

    Parameters

    • callback: (() => void)

      Callback to run.

        • (): void
        • Returns void

    • Optional callbackID: string

      Optional ID for callback, so that multiple instances of the callback do not execute at the same time.

    Returns void

  • Request an animation frame in the control context, with the same features as requestAnimationFrameMM(). If the control has been cleaned up, then the callback will not execute.

    Example

    this.requestFrame(function () {
    // this callback will be executed at a maximum of your monitor's natural refresh rate when focused, maximum of 30 fps when not focused, and maximum of 2 fps when window is not visible.
    }, "myUniqueFrameCallbackName");

    Method

    requestFrameMM

    Parameters

    • callback: (() => void)

      Callback to run.

        • (): void
        • Returns void

    • Optional callbackID: string

      Optional ID for callback, so that multiple instances of the callback do not execute at the same time.

    Returns void

  • Calls requestIdleCallback, cancels the previous sheduled callback on cleanup or multiple calls

    Method

    requestIdle

    Parameters

    • callback: any

      Callback, which should be called when idle

    • Optional callbackID: string

      String name, which identifies the callback. If present, it cancels the previous sheduled callback

    • Optional useFirst: boolean

      Valid only if callbackID is present, if true, previous unfinished timer is finished and the last is revoked

    Returns number

  • Calls setTimeout, cancels the previous sheduled callback on cleanup or multiple calls

    Method

    requestTimeout

    Parameters

    • callback: (() => void)

      Callback, which should be called after timeout

        • (): void
        • Returns void

    • timeMS: number

      Timeout, in ms

    • Optional callbackID: string

      String name, which identifies the callback. If present, it cancels the previous sheduled callback

    • Optional useFirst: boolean

      Valid only if callbackID is present, if true, previous unfinished timer is finished and the last is revoked

    Returns number

  • Undocumented

    Parameters

    • Optional visibleWidth: number

    Returns number

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    Returns void

  • Undocumented

    Parameters

    • w: number
    • h: number

    Returns void

  • Undocumented

    Parameters

    • div: any

    Returns void

  • Sets list of columns as were shown (configured by user)

    Method

    restoreColumns

    Parameters

    • columns: any
    • Optional ignoreNewColumns: boolean

      Ignore new columns and add just these defined in columns variable

    Returns void

  • Undocumented

    Parameters

    • state: any

    Returns void

  • Restores persistent (class) states for the control class and all subcontrols, this stores global (class) state (is same for all instances of the control)

    Method

    restorePersistentStates

    Returns void

  • Undocumented

    Parameters

    • Optional sc: any

    Returns void

  • Undocumented

    Parameters

    • state: any

    Returns void

  • Undocumented

    Parameters

    • newSortString: string

    Returns void

  • Undocumented

    Returns {
        origScroll: any;
        topItem: any;
    }

    • origScroll: any

      Undocumented

    • topItem: any

      Undocumented

  • Undocumented

    Parameters

    • headingHeight: any

    Returns void

  • Undocumented

    Parameters

    • top: number
    • bottom: number
    • Optional aboveShift: number

    Returns void

  • Undocumented

    Returns boolean

  • Undocumented

    Parameters

    • message: any

    Returns void

  • Undocumented

    Parameters

    • el: any
    • val: any
    • effectiveVal: any

    Returns void

  • Shows/Hides column based on type

    Method

    setColumnVisibility

    Parameters

    • columnType: string

      A column type to be shown/hidden.

    • value: boolean

      show/hide.

    Returns void

  • Set new list of columns to be shown

    Method

    setColums

    Parameters

    • newColumns: any

    Returns void

  • Sets the datasource and persist parameters of the previous view (i.e. the same selection, focused item, etc.)

    Methods

    setDataSourceSameView

    Parameters

    • ds: any
    • Optional forceRestoreFocus: any

      If false, does not force re-setting focusedIndex after copying selection. Default true.

    Returns any

  • Undocumented

    Parameters

    • element: any
    • e: any

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • cnt: number

    Returns void

  • Undocumented

    Parameters

    • itemIndex: number
    • Optional immediately: boolean

    Returns void

  • Undocumented

    Parameters

    • value: string

    Returns void

  • Restores the top scrolled item according to the saved position.

    Method

    setRealScrollOffset

    Parameters

    • position: any

    Returns void

  • Undocumented

    Parameters

    • newValue: any

    Returns void

  • Undocumented

    Parameters

    • itemIndex: any
    • dontClearSelection: any

    Returns any

  • Undocumented

    Parameters

    • newValue: number
    • Optional canScrollBeyond: boolean

    Returns void

  • Undocumented

    Parameters

    • sortString: string

    Returns void

  • Undocumented

    Parameters

    • data: any

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement

    Returns void

  • Undocumented

    Parameters

    • header: any

    Returns void

  • Undocumented

    Parameters

    • div: HTMLDivElement
    • attribute: string
    • Optional finishCallback: callback

    Returns void

  • Undocumented

    Parameters

    • size: any
    • sizeY: any

    Returns void

  • Make column visible

    Method

    showColumn

    Parameters

    • columnIdx: any

      A column index to be visible

    Returns void

  • Undocumented

    Parameters

    • idx: any

    Returns void

  • Undocumented

    Parameters

    • index: any

    Returns void

  • Undocumented

    Parameters

    • message: any

    Returns void

  • Undocumented

    Returns void

  • Gets list of columns as are actualy shown (configured by user)

    Method

    storeColumns

    Parameters

    • Optional defColumns: any

      List of columns to store. Default is this.columns array

    Returns any[]

    Columns List of columns

  • Undocumented

    Parameters

    • state: any

    Returns any

  • Stores persistent (class) states for the control class and all subcontrols, this stores global (class) state (is same for all instances of the control)

    Method

    storePersistentStates

    Returns void

  • Undocumented

    Parameters

    • div: any

    Returns boolean

  • Method for handling Promise with delayed progress.

    Method

    thenWithProgress

    Parameters

    • pPromise: any

      Passed promise

    • Optional params: any

      Object with possible parameters:

      • thenFunc - function called after resolving promise
      • errorFunc - function called after rejecting promise
      • delayedFunc - function called after given delay
      • delayMS - progress delay, default 100ms. Progress is displayed after this time, in case promise was not resolved yet
      • progressText - text displayed in delayed progress, default string is "Getting data"
      • progress - SimpleTasksController object, used for progress. If not present, use global progress.

    Returns void

  • Undocumented

    Parameters

    • event: string
    • Optional capture: boolean

    Returns void

  • Undocumented

    Parameters

    • itemIndex: any

    Returns void

  • Undocumented

    Parameters

    • Optional x: number
    • Optional y: number

    Returns void

  • Undocumented

    Parameters

    • currentMouseInfo: any

    Returns void

  • Undocumented

    Parameters

    • fromX: number
    • fromY: number
    • toX: number
    • toY: number

    Returns void

  • Undocumented

    Parameters

    • counter: any

    Returns void

  • Undocumented

    Parameters

    • div: any
    • defer: any

    Returns void

  • Undocumented

    Parameters

    • Optional forceRefresh: boolean
    • Optional initialCall: boolean

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Returns void