Options
All
  • Public
  • Public/Protected
  • All
Menu

Grid

<style>
#page {
  position: absolute;
  z-index: 10;
  left: 0;
  top: 0;
  bottom: 0;
  right: 0;
}
</style>
<link rel="stylesheet" href="./grid.css" />
<div id="page" class="grid"></div>
let grid = new ipushpull.Grid('page');

Hierarchy

  • Grid

Implements

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

  • Parameters

    • ref: string | HTMLDivElement
    • Optional options: IGridOptions

    Returns Grid

Properties

Events

Events: IGridEvents

Private _editing

_editing: boolean = false

Private _gridlines

_gridlines: boolean = false

Private _hasFocus

_hasFocus: boolean = false

Private _headings

_headings: boolean = false

Private accessRanges

accessRanges: any = []

Private arrowKeyDown

arrowKeyDown: boolean = false

Private boxEl

boxEl: HTMLDivElement

Private buttonPopper

buttonPopper: any

Private buttons

buttons: IGridButtonIndexes = []

canEdit

canEdit: boolean = true

Private cellsOffsetX

cellsOffsetX: number = 0

Private cellsOffsetY

cellsOffsetY: number = 0

Private clickedAt

clickedAt: number = 0

Private columnCells

columnCells: IGridCells = [[]]

Private columnsCellsEl

columnsCellsEl: HTMLDivElement

Private columnsEl

columnsEl: HTMLDivElement

Private commonCells

commonCells: IGridCells = [[]]

Private commonCellsEl

commonCellsEl: HTMLDivElement

Private commonEl

commonEl: HTMLDivElement

Private content

content: IGridPageContent = []

contrast

contrast: string = "light"

Private ctrlDown

ctrlDown: boolean = false

Private dirty

dirty: boolean = false

disallowSelection

disallowSelection: boolean = false

Private doubleClicked

doubleClicked: boolean = false

Private editEl

editEl: HTMLDivElement

Private editingCell

editingCell: IGridCell | undefined

fit

fit: string = "scroll"

Private found

found: IPageContent = []

freezeCol

freezeCol: number = 0

Private freezeHeight

freezeHeight: number = 0

freezeRow

freezeRow: number = 0

Private freezeWidth

freezeWidth: number = 0

Private gridCells

gridCells: IGridCells = [[]]

Private gridColumnHeadingCells

gridColumnHeadingCells: IGridHeadingCell[] = []

Private gridRowHeadingCells

gridRowHeadingCells: IGridHeadingCell[] = []

Private headingsColumnsCellsEl

headingsColumnsCellsEl: HTMLDivElement

Private headingsColumnsEl

headingsColumnsEl: HTMLDivElement

Private headingsCommonCellsEl

headingsCommonCellsEl: HTMLDivElement

Private headingsCommonEl

headingsCommonEl: HTMLDivElement

Private headingsEl

headingsEl: HTMLDivElement

Private headingsRowsCellsEl

headingsRowsCellsEl: HTMLDivElement

Private headingsRowsEl

headingsRowsEl: HTMLDivElement

Private headingsTimer

headingsTimer: any

Private height

height: number = 0

Private hiddenColumns

hiddenColumns: number[] = []

highlights

highlights: boolean = false

Private historyClick

historyClick: boolean = false

Private initialized

initialized: boolean = false

Private keyValue

keyValue: string | undefined

Private mainBoxEl

mainBoxEl: HTMLDivElement

Private mainCellsEl

mainCellsEl: HTMLDivElement

Private mainEl

mainEl: HTMLDivElement

Private mainElRect

mainElRect: ClientRect

Private mergeEl

mergeEl: HTMLDivElement

Private offsetX

offsetX: number = 0

Private offsetY

offsetY: number = 0

Private originalContent

originalContent: IPageContent = []

Private pageEl

pageEl: HTMLDivElement

Private pageElRect

pageElRect: ClientRect

Private popperEl

popperEl: HTMLDivElement

Private ps

ref

ref: string | HTMLDivElement

Private rendering

rendering: boolean = false

Private resizing

resizing: boolean = false

Private rightClick

rightClick: boolean = false

Private rowCells

rowCells: HTMLDivElement[] = []

Private rows

rows: IGridRow[] = []

Private rowsCellsEl

rowsCellsEl: HTMLDivElement

Private rowsColumns

rowsColumns: IGridRow[] = []

Private rowsEl

rowsEl: HTMLDivElement

Private rowsRows

rowsRows: IGridRow[] = []

Private rowsToHide

rowsToHide: number[] = []

Private scale

scale: number = 1

Private scaleEl

scaleEl: HTMLDivElement

Private scrollEl

scrollEl: HTMLDivElement

Private scrollTimer

scrollTimer: any = null

Private selectorColumns

selectorColumns: HTMLDivElement

Private selectorColumnsContainer

selectorColumnsContainer: HTMLDivElement

Private selectorColumnsContainerPosition

selectorColumnsContainerPosition: HTMLDivElement

Private selectorCommon

selectorCommon: HTMLDivElement

Private selectorCommonContainer

selectorCommonContainer: HTMLDivElement

Private selectorCommonContainerPosition

selectorCommonContainerPosition: HTMLDivElement

Private selectorMain

selectorMain: HTMLDivElement

Private selectorMainContainer

selectorMainContainer: HTMLDivElement

Private selectorMainContainerPosition

selectorMainContainerPosition: HTMLDivElement

Private selectorRows

selectorRows: HTMLDivElement

Private selectorRowsContainer

selectorRowsContainer: HTMLDivElement

Private selectorRowsContainerPosition

selectorRowsContainerPosition: HTMLDivElement

Private selectorWrapper

selectorWrapper: HTMLDivElement

Private shiftDown

shiftDown: boolean = false

Private styles

styles: IGridContentStyles = []

touch

touch: boolean = false

tracking

tracking: boolean = false

trackingData

trackingData: ITrackingData[] | undefined

Private trackingUsers

trackingUsers: number[] = []

Private unshift

unshift: boolean = false

userId

userId: number = 0

Private width

width: number = 0

Private wrapperEl

wrapperEl: HTMLDivElement

Private wrapperElRect

wrapperElRect: ClientRect

Accessors

Private editing

  • get editing(): boolean
  • set editing(n: boolean): void
  • Returns boolean

  • Parameters

    • n: boolean

    Returns void

gridlines

  • get gridlines(): boolean
  • set gridlines(n: boolean): void
  • Returns boolean

  • Parameters

    • n: boolean

    Returns void

hasFocus

  • get hasFocus(): boolean
  • set hasFocus(n: boolean): void
  • Returns boolean

  • Parameters

    • n: boolean

    Returns void

headings

  • get headings(): boolean
  • set headings(n: boolean): void
  • Returns boolean

  • Parameters

    • n: boolean

    Returns void

Methods

Private applyButtons

  • applyButtons(): void
  • Returns void

Private applyCellUpdate

  • applyCellUpdate(rowIndex: number, colIndex: number, which: string, value: any): void
  • Parameters

    • rowIndex: number
    • colIndex: number
    • which: string
    • value: any

    Returns void

Private applyFilters

  • applyFilters(): void
  • Returns void

Private applyHeadingCellsFreeze

  • applyHeadingCellsFreeze(): void
  • Returns void

Private applyRanges

  • applyRanges(): void
  • Returns void

Private applyScale

  • applyScale(): void
  • Returns void

Private applySorting

  • applySorting(): void
  • Returns void

Private applyState

  • applyState(update?: boolean): void
  • Parameters

    • Default value update: boolean = false

    Returns void

Private applyStyles

  • applyStyles(): void
  • Returns void

Private cancelCellEdit

  • cancelCellEdit(restore?: undefined | false | true): void
  • Parameters

    • Optional restore: undefined | false | true

    Returns void

clearFound

  • clearFound(): void
  • Returns void

clearSelector

  • clearSelector(): void
  • Returns void

clearTrackingData

  • clearTrackingData(): void
  • Returns void

Private createListeners

  • createListeners(): void
  • Returns void

destroy

  • destroy(): void
  • Returns void

Private destroyListeners

  • destroyListeners(): void
  • Returns void

Private destroyPopper

  • destroyPopper(): void
  • Returns void

Private dom

  • dom(): void
  • Returns void

Private domHeadings

  • domHeadings(): void
  • Returns void

Private emitSelected

  • emitSelected(evt: any, type?: undefined | string): void
  • Parameters

    • evt: any
    • Optional type: undefined | string

    Returns void

find

  • find(query: string): void
  • Parameters

    • query: string

    Returns void

Private getCell

  • getCell(evtTarget: any): any
  • Parameters

    • evtTarget: any

    Returns any

getContentHtml

  • getContentHtml(): string

getGridCell

  • getGridCell(rowIndex: number, colIndex: number, original?: undefined | false | true): IGridCell | null
  • Parameters

    • rowIndex: number
    • colIndex: number
    • Optional original: undefined | false | true

    Returns IGridCell | null

Private getGridCellByTarget

Private getTrackingUser

  • getTrackingUser(userId: number): number
  • Parameters

    • userId: number

    Returns number

init

  • init(): void
  • Returns void

Private isFullyVisible

  • isFullyVisible(cell: IGridCell, axis?: undefined | string): boolean
  • Parameters

    • cell: IGridCell
    • Optional axis: undefined | string

    Returns boolean

Private isInsideSelection

Private isRightClick

  • isRightClick(evt: any): boolean
  • Parameters

    • evt: any

    Returns boolean

Private isTarget

  • isTarget(evtTarget: any, element: HTMLElement): boolean
  • Parameters

    • evtTarget: any
    • element: HTMLElement

    Returns boolean

Private isVisible

Private onCellUpdates

  • onCellUpdates(): void
  • Returns void

Private onCtrlNavigate

  • onCtrlNavigate(which: string): boolean
  • Parameters

    • which: string

    Returns boolean

Private onKeydown

  • onKeydown(evt: KeyboardEvent): void
  • Parameters

    • evt: KeyboardEvent

    Returns void

Private onKeyup

  • onKeyup(evt: KeyboardEvent): void
  • Parameters

    • evt: KeyboardEvent

    Returns void

Private onMouseDown

  • onMouseDown(evt: any): void
  • Parameters

    • evt: any

    Returns void

Private onMouseMove

  • onMouseMove(e: MouseEvent): void
  • Parameters

    • e: MouseEvent

    Returns void

Private onMouseUp

  • onMouseUp(evt: any): void
  • Parameters

    • evt: any

    Returns void

Private onResize

  • onResize(): void
  • Returns void

Private onResizeHandle

  • Parameters

    Returns void

Private render

  • render(): void
  • Returns void

reset

  • reset(): void
  • Returns void

Private scaleDimension

  • scaleDimension(n: number): number
  • Parameters

    • n: number

    Returns number

Private selectNextCell

  • selectNextCell(direction: string, key?: string): void
  • Parameters

    • direction: string
    • Default value key: string = ""

    Returns void

Private setCellSelection

setContent

  • Set grid content from Page. Resets grid state and settings then create all new grid cell references. Use when first loading a Page or the Page size has changed.

    Parameters

    Returns void

setContrast

  • setContrast(which: string): void
  • Parameters

    • which: string

    Returns void

setDeltaContent

  • Update grid cell values. Use when there is new content from a Page.

    Parameters

    Returns void

Private setElementSizes

  • setElementSizes(which: string, size: number): void
  • Parameters

    • which: string
    • size: number

    Returns void

setFreeze

  • setFreeze(row: number, col: number, headings?: undefined | false | true): void
  • Freeze rows/columns. Use when a Page is ready and only after setContent() has been applied.

    Parameters

    • row: number
    • col: number
    • Optional headings: undefined | false | true

    Returns void

Private setFreezeSizes

  • setFreezeSizes(): void
  • Returns void

setHiddenColumns

  • setHiddenColumns(columns: number[]): void
  • Parameters

    • columns: number[]

    Returns void

setOption

  • setOption(key: string, value: any): void
  • Parameters

    • key: string
    • value: any

    Returns void

Private setPositions

setSelector

setSelectorByRef

  • setSelectorByRef(str: string): void
  • Parameters

    • str: string

    Returns void

Private setSize

update

  • update(scale?: undefined | number): void
  • Display the grid. Use after setContent().

    Parameters

    • Optional scale: undefined | number

    Returns void

updateButtons

updateFit

  • updateFit(fit: string): void
  • Parameters

    • fit: string

    Returns void

updateFreeze

  • updateFreeze(row: number, col: number, headings?: undefined | false | true): void
  • Parameters

    • row: number
    • col: number
    • Optional headings: undefined | false | true

    Returns void

updateHeadings

  • updateHeadings(headings: boolean): void
  • Parameters

    • headings: boolean

    Returns void

Private updateHistoryCells

  • updateHistoryCells(): void
  • Returns void

updateRanges

  • updateRanges(ranges: any, userId?: number): void
  • Parameters

    • ranges: any
    • Default value userId: number = 0

    Returns void

Private updateSelector

  • updateSelector(set?: string, type?: string): void
  • Parameters

    • Default value set: string = ""
    • Default value type: string = ""

    Returns void

updateSize

  • updateSize(): void
  • Returns void

Private updateSoftMerges

  • updateSoftMerges(rows?: any[]): void
  • Parameters

    • Default value rows: any[] = []

    Returns void

updateSorting

  • updateSorting(sorting?: any): void
  • Parameters

    • Optional sorting: any

    Returns void

updateState

  • Sort, Filter and/or show/hide Columns.

    Parameters

    Returns void

updateStyles

updateTrackingData

Object literals

Private selection

selection: object

colFrom

colFrom: number = 0

colLast

colLast: number = 0

colTo

colTo: number = 0

heading

heading: false = false

inside

inside: false = false

keyboard

keyboard: false = false

reference

reference: string = ""

rowEnd

rowEnd: number = 0

rowFrom

rowFrom: number = 0

rowLast

rowLast: number = 0

rowStart

rowStart: number = 0

rowTo

rowTo: number = 0

selected

selected: false = false

type

type: string = "cell"

state

state: object

filters

filters: never[] = []

hiddenColumns

hiddenColumns: never[] = []

sorting

sorting: object

col

col: number = -1

direction

direction: ASC = IGridSortDirection.ASC

enabled

enabled: false = false

field

field: string = ""

type

type: STRING = IGridFieldType.STRING

Generated using TypeDoc