"helpers" | react-konva-grid

Index

Enumerations

Interfaces

Type aliases

TimeoutID

Variables

Functions

Type aliases

TimeoutID

TimeoutID: { id: number }

Type declaration

id: number

Variables

Const hasNativePerformanceNow

hasNativePerformanceNow: boolean = typeof performance === "object" && typeof performance.now === "function"

Const now

now: (Anonymous function) = hasNativePerformanceNow? () => performance.now(): () => Date.now()

Functions

cancelTimeout

cancelTimeout(timeoutID: TimeoutID): void

- Defined in src/helpers.ts:615
Parameters
- timeoutID: TimeoutID
Returns void

Const cellIndentifier

cellIndentifier(rowIndex: number, columnIndex: number): string

- Defined in src/helpers.ts:449
Parameters
- rowIndex: number
- columnIndex: number
Returns string

debounce

debounce<T>(cb: T, wait?: number): T

- Defined in src/helpers.ts:474
Type parameters
- T: Function
Parameters
- cb: T
- Default value wait: number = 20
Returns T

Const findNearestItem

findNearestItem(__namedParameters: { columnCount: number; columnWidth: (index: number) => number; instanceProps: InstanceInterface; itemType: ItemType; offset: number; rowCount: number; rowHeight: (index: number) => number }): number

- Defined in src/helpers.ts:273
Parameters
- __namedParameters: { columnCount: number; columnWidth: (index: number) => number; instanceProps: InstanceInterface; itemType: ItemType; offset: number; rowCount: number; rowHeight: (index: number) => number }
  - columnCount: number
  - columnWidth: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
  - instanceProps: InstanceInterface
  - itemType: ItemType
  - offset: number
  - rowCount: number
  - rowHeight: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
Returns number

Const findNearestItemBinarySearch

findNearestItemBinarySearch(__namedParameters: { columnWidth: (index: number) => number; high: number; instanceProps: InstanceInterface; itemType: ItemType; low: number; offset: number; rowHeight: (index: number) => number }): number

- Defined in src/helpers.ts:326
Parameters
- __namedParameters: { columnWidth: (index: number) => number; high: number; instanceProps: InstanceInterface; itemType: ItemType; low: number; offset: number; rowHeight: (index: number) => number }
  - columnWidth: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
  - high: number
  - instanceProps: InstanceInterface
  - itemType: ItemType
  - low: number
  - offset: number
  - rowHeight: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
Returns number

Const findNearestItemExponentialSearch

findNearestItemExponentialSearch(__namedParameters: { columnCount: number; columnWidth: (index: number) => number; index: number; instanceProps: InstanceInterface; itemType: ItemType; offset: number; rowCount: number; rowHeight: (index: number) => number }): number

- Defined in src/helpers.ts:361
Parameters
- __namedParameters: { columnCount: number; columnWidth: (index: number) => number; index: number; instanceProps: InstanceInterface; itemType: ItemType; offset: number; rowCount: number; rowHeight: (index: number) => number }
  - columnCount: number
  - columnWidth: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
  - index: number
  - instanceProps: InstanceInterface
  - itemType: ItemType
  - offset: number
  - rowCount: number
  - rowHeight: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
Returns number

Const findNextCellWithinBounds

findNextCellWithinBounds(activeCellBounds: AreaProps, selectionBounds: AreaProps, direction?: Movement): CellInterface | null

- Defined in src/helpers.ts:696
Cycles active cell within selecton bounds

Parameters
- activeCellBounds: AreaProps
- selectionBounds: AreaProps
- Default value direction: Movement = Movement.forwards
Returns CellInterface | null

Const getBoundedCells

getBoundedCells(area: AreaProps | null | undefined): Set<unknown>

- Defined in src/helpers.ts:156
Parameters
- area: AreaProps | null | undefined
Returns Set<unknown>

Const getColumnOffset

getColumnOffset(__namedParameters: { columnWidth: (index: number) => number; index: number; instanceProps: InstanceInterface; rowHeight: (index: number) => number }): number

- Defined in src/helpers.ts:186
Parameters
- __namedParameters: { columnWidth: (index: number) => number; index: number; instanceProps: InstanceInterface; rowHeight: (index: number) => number }
  - columnWidth: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
  - index: number
  - instanceProps: InstanceInterface
  - rowHeight: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
Returns number

Const getColumnStartIndexForOffset

getColumnStartIndexForOffset(__namedParameters: { columnCount: number; columnWidth: (index: number) => number; instanceProps: InstanceInterface; offset: number; rowCount: number; rowHeight: (index: number) => number }): number

- Defined in src/helpers.ts:96
Parameters
- __namedParameters: { columnCount: number; columnWidth: (index: number) => number; instanceProps: InstanceInterface; offset: number; rowCount: number; rowHeight: (index: number) => number }
  - columnCount: number
  - columnWidth: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
  - instanceProps: InstanceInterface
  - offset: number
  - rowCount: number
  - rowHeight: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
Returns number

Const getColumnStopIndexForStartIndex

getColumnStopIndexForStartIndex(__namedParameters: { columnCount: number; columnWidth: (index: number) => number; containerWidth: number; instanceProps: InstanceInterface; rowHeight: (index: number) => number; scrollLeft: number; startIndex: number }): number

- Defined in src/helpers.ts:121
Parameters
- __namedParameters: { columnCount: number; columnWidth: (index: number) => number; containerWidth: number; instanceProps: InstanceInterface; rowHeight: (index: number) => number; scrollLeft: number; startIndex: number }
  - columnCount: number
  - columnWidth: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
  - containerWidth: number
  - instanceProps: InstanceInterface
  - rowHeight: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
  - scrollLeft: number
  - startIndex: number
Returns number

Const getColumnWidth

getColumnWidth(index: number, instanceProps: InstanceInterface): number

- Defined in src/helpers.ts:208
Parameters
- index: number
- instanceProps: InstanceInterface
Returns number

Const getEstimatedTotalHeight

getEstimatedTotalHeight(rowCount: number, instanceProps: InstanceInterface): number

- Defined in src/helpers.ts:399
Parameters
- rowCount: number
- instanceProps: InstanceInterface
Returns number

Const getEstimatedTotalWidth

getEstimatedTotalWidth(columnCount: number, instanceProps: InstanceInterface): number

- Defined in src/helpers.ts:424
Parameters
- columnCount: number
- instanceProps: InstanceInterface
Returns number

Const getItemMetadata

getItemMetadata(__namedParameters: { columnWidth: (index: number) => number; index: number; instanceProps: InstanceInterface; itemType: ItemType; rowHeight: (index: number) => number }): CellMetaData

- Defined in src/helpers.ts:220
Parameters
- __namedParameters: { columnWidth: (index: number) => number; index: number; instanceProps: InstanceInterface; itemType: ItemType; rowHeight: (index: number) => number }
  - columnWidth: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
  - index: number
  - instanceProps: InstanceInterface
  - itemType: ItemType
  - rowHeight: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
Returns CellMetaData

Const getOffsetForColumnAndAlignment

getOffsetForColumnAndAlignment(props: Omit<AlignmentProps, "itemType">): number

- Defined in src/helpers.ts:583
Parameters
- props: Omit<AlignmentProps, "itemType">
Returns number

Const getOffsetForIndexAndAlignment

getOffsetForIndexAndAlignment(__namedParameters: { align: Align; columnCount: number; columnWidth: (index: number) => number; containerHeight: number; containerWidth: number; frozenOffset: number; index: number; instanceProps: InstanceInterface; itemType: ItemType; rowCount: number; rowHeight: (index: number) => number; scrollOffset: number; scrollbarSize: number }): number

- Defined in src/helpers.ts:512
Parameters
- __namedParameters: { align: Align; columnCount: number; columnWidth: (index: number) => number; containerHeight: number; containerWidth: number; frozenOffset: number; index: number; instanceProps: InstanceInterface; itemType: ItemType; rowCount: number; rowHeight: (index: number) => number; scrollOffset: number; scrollbarSize: number }
  - align: Align
  - columnCount: number
  - columnWidth: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
  - containerHeight: number
  - containerWidth: number
  - frozenOffset: number
  - index: number
  - instanceProps: InstanceInterface
  - itemType: ItemType
  - rowCount: number
  - rowHeight: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
  - scrollOffset: number
  - scrollbarSize: number
Returns number

Const getOffsetForRowAndAlignment

getOffsetForRowAndAlignment(props: Omit<AlignmentProps, "itemType">): number

- Defined in src/helpers.ts:592
Parameters
- props: Omit<AlignmentProps, "itemType">
Returns number

Const getRowHeight

getRowHeight(index: number, instanceProps: InstanceInterface): number

- Defined in src/helpers.ts:201
Parameters
- index: number
- instanceProps: InstanceInterface
Returns number

Const getRowOffset

getRowOffset(__namedParameters: { columnWidth: (index: number) => number; index: number; instanceProps: InstanceInterface; rowHeight: (index: number) => number }): number

- Defined in src/helpers.ts:171
Parameters
- __namedParameters: { columnWidth: (index: number) => number; index: number; instanceProps: InstanceInterface; rowHeight: (index: number) => number }
  - columnWidth: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
  - index: number
  - instanceProps: InstanceInterface
  - rowHeight: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
Returns number

Const getRowStartIndexForOffset

getRowStartIndexForOffset(__namedParameters: { columnCount: number; columnWidth: (index: number) => number; instanceProps: InstanceInterface; offset: number; rowCount: number; rowHeight: (index: number) => number }): number

- Defined in src/helpers.ts:36
Parameters
- __namedParameters: { columnCount: number; columnWidth: (index: number) => number; instanceProps: InstanceInterface; offset: number; rowCount: number; rowHeight: (index: number) => number }
  - columnCount: number
  - columnWidth: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
  - instanceProps: InstanceInterface
  - offset: number
  - rowCount: number
  - rowHeight: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
Returns number

Const getRowStopIndexForStartIndex

getRowStopIndexForStartIndex(__namedParameters: { columnWidth: (index: number) => number; containerHeight: number; instanceProps: InstanceInterface; rowCount: number; rowHeight: (index: number) => number; scrollTop: number; startIndex: number }): number

- Defined in src/helpers.ts:61
Parameters
- __namedParameters: { columnWidth: (index: number) => number; containerHeight: number; instanceProps: InstanceInterface; rowCount: number; rowHeight: (index: number) => number; scrollTop: number; startIndex: number }
  - columnWidth: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
  - containerHeight: number
  - instanceProps: InstanceInterface
  - rowCount: number
  - rowHeight: (index: number) => number
    - - (index: number): number
      - Parameters
        
        index: number
        
        Returns number
  - scrollTop: number
  - startIndex: number
Returns number

Const itemKey

itemKey(__namedParameters: { columnIndex: number; rowIndex: number }): string

- Defined in src/helpers.ts:168
Parameters
- __namedParameters: { columnIndex: number; rowIndex: number }
  - columnIndex: number
  - rowIndex: number
Returns string

Const mergedCellBounds

mergedCellBounds(area: AreaProps, boundGetter: (coords: CellInterface) => AreaProps): AreaProps

- Defined in src/helpers.ts:749
Get maximum bound of an area, caters to merged cells

Parameters
- area: AreaProps
- boundGetter: (coords: CellInterface) => AreaProps
  - - (coords: CellInterface): AreaProps
    - Parameters
      - coords: CellInterface
      Returns AreaProps
Returns AreaProps

Const numberToAlphabet

numberToAlphabet(i: number): string

- Defined in src/helpers.ts:662
Converts a number to alphabet

Parameters
- i: number
Returns string

Const prepareClipboardData

prepareClipboardData(rows: string[][]): [string, string]

- Defined in src/helpers.ts:673
Convert selections to html and csv data

Parameters
- rows: string[][]
Returns [string, string]

rafThrottle

rafThrottle(callback: Function): handleEvent

- Defined in src/helpers.ts:483
Parameters
- callback: Function
Returns handleEvent

requestTimeout

requestTimeout(callback: Function, delay: number): TimeoutID

- Defined in src/helpers.ts:624
Create a throttler based on RAF

Parameters
- callback: Function
- delay: number
Returns TimeoutID

Const selectionFromActiveCell

selectionFromActiveCell(activeCell: CellInterface | null): SelectionArea[]

- Defined in src/helpers.ts:642
Parameters
- activeCell: CellInterface | null
Returns SelectionArea[]

throttle

throttle(func: Function, limit: number): Function

- Defined in src/helpers.ts:459
desc

Throttle fn

Parameters
- func: Function
  
  function
- limit: number
  
  Delay in milliseconds
Returns Function

Index

Enumerations

Interfaces

Type aliases

Variables

Functions

Type aliases

TimeoutID

Type declaration

id: number

Variables

Const hasNativePerformanceNow

Const now

Functions

cancelTimeout

Parameters

timeoutID: TimeoutID

Returns void

Const cellIndentifier

Parameters

rowIndex: number

columnIndex: number

Returns string

debounce

Type parameters

T: Function

Parameters

cb: T

Default value wait: number = 20

Returns T

Const findNearestItem

Parameters

__namedParameters: { columnCount: number; columnWidth: (index: number) => number; instanceProps: InstanceInterface; itemType: ItemType; offset: number; rowCount: number; rowHeight: (index: number) => number }

columnCount: number

columnWidth: (index: number) => number

Parameters

index: number

Returns number

instanceProps: InstanceInterface

itemType: ItemType

offset: number

rowCount: number

rowHeight: (index: number) => number

Parameters

index: number

Returns number

Returns number

Const findNearestItemBinarySearch

Parameters

__namedParameters: { columnWidth: (index: number) => number; high: number; instanceProps: InstanceInterface; itemType: ItemType; low: number; offset: number; rowHeight: (index: number) => number }

columnWidth: (index: number) => number

Parameters

index: number

Returns number

high: number

instanceProps: InstanceInterface

itemType: ItemType

low: number

offset: number

rowHeight: (index: number) => number

Parameters

index: number

Returns number

Returns number

Const findNearestItemExponentialSearch

Parameters

__namedParameters: { columnCount: number; columnWidth: (index: number) => number; index: number; instanceProps: InstanceInterface; itemType: ItemType; offset: number; rowCount: number; rowHeight: (index: number) => number }

columnCount: number

columnWidth: (index: number) => number

Parameters

index: number

Returns number

index: number

instanceProps: InstanceInterface

itemType: ItemType

offset: number

rowCount: number

rowHeight: (index: number) => number

Parameters

index: number