Module CellGroup

A collection of helper functions relating to merged cell groups

Index

Properties

c1
c2
r1
r2

Functions

Properties

c1

c1: number

c2

c2: number

r1

r1: number

r2

r2: number

Functions

areCellGroupsIntersecting

areCellGroupsIntersecting(group1: CellGroup, group2: CellGroup): boolean

- Defined in datagrid/src/cellgroup.ts:155
Checks if cell-groups are intersecting.

Parameters
- group1: CellGroup
- group2: CellGroup
Returns boolean

areCellGroupsIntersectingAtAxis

areCellGroupsIntersectingAtAxis(group1: CellGroup, group2: CellGroup, axis: "row" | "column"): boolean

- Defined in datagrid/src/cellgroup.ts:129
Checks if two cell-groups are intersecting in the given axis.

Parameters
- group1: CellGroup
- group2: CellGroup
- axis: "row" | "column"
Returns boolean

areCellsMerged

areCellsMerged(dataModel: DataModel, rgn: CellRegion, cell1: number[], cell2: number[]): boolean

- Defined in datagrid/src/cellgroup.ts:22
Parameters
- dataModel: DataModel
- rgn: CellRegion
- cell1: number[]
- cell2: number[]
Returns boolean

calculateMergeOffsets

calculateMergeOffsets(dataModel: DataModel, regions: CellRegion[], axis: "row" | "column", sectionList: SectionList, index: number): [number, number, CellGroup]

- Defined in datagrid/src/cellgroup.ts:60
Calculates the cell boundary offsets needed for a row or column at the given index by taking into account merged cell groups in the region.

Parameters
- dataModel: DataModel
- regions: CellRegion[]
- axis: "row" | "column"
- sectionList: SectionList
- index: number
Returns [number, number, CellGroup]

getCellGroupsAtColumn

getCellGroupsAtColumn(dataModel: DataModel, rgn: CellRegion, column: number): CellGroup[]

- Defined in datagrid/src/cellgroup.ts:325
Retrieves a list of cell groups intersecting at a given column.

Parameters
- dataModel: DataModel
  
  data model of the grid.
- rgn: CellRegion
  
  the cell region.
- column: number
  
  the target column to look for intersections at.
Returns CellGroup[]

all cell groups intersecting with the column.

getCellGroupsAtRegion

getCellGroupsAtRegion(dataModel: DataModel, rgn: CellRegion): CellGroup[]

- Defined in datagrid/src/cellgroup.ts:227
Returns all cell groups which belong to a given cell cell region.

Parameters
- dataModel: DataModel
- rgn: CellRegion
Returns CellGroup[]

getCellGroupsAtRow

getCellGroupsAtRow(dataModel: DataModel, rgn: CellRegion, row: number): CellGroup[]

- Defined in datagrid/src/cellgroup.ts:300
Retrieves a list of cell groups intersecting at a given row.

Parameters
- dataModel: DataModel
  
  data model of the grid.
- rgn: CellRegion
  
  the cell region.
- row: number
  
  the target row to look for intersections at.
Returns CellGroup[]

all cell groups intersecting with the row.

getGroup

getGroup(dataModel: DataModel, rgn: CellRegion, row: number, column: number): CellGroup | null

- Defined in datagrid/src/cellgroup.ts:207
Returns a cell-group for the given row/index coordinates.

Parameters
- dataModel: DataModel
- rgn: CellRegion
- row: number
- column: number
Returns CellGroup | null

getGroupIndex

getGroupIndex(dataModel: DataModel, rgn: CellRegion, row: number, column: number): number

- Defined in datagrid/src/cellgroup.ts:179
Retrieves the index of the cell-group to which the cell at the given row, column belongs.

Parameters
- dataModel: DataModel
- rgn: CellRegion
- row: number
- column: number
Returns number

isCellGroupAbove

isCellGroupAbove(group1: CellGroup, group2: CellGroup): boolean

- Defined in datagrid/src/cellgroup.ts:348
Checks if cell group 1 is above cell group 2.

Parameters
- group1: CellGroup
  
  cell group 1.
- group2: CellGroup
  
  cell group 2.
Returns boolean

boolean.

isCellGroupBelow

isCellGroupBelow(group1: CellGroup, group2: CellGroup): boolean

- Defined in datagrid/src/cellgroup.ts:358
Checks if cell group 1 is below cell group 2.

Parameters
- group1: CellGroup
- group2: CellGroup
Returns boolean

joinCellGroupWithMergedCellGroups

joinCellGroupWithMergedCellGroups(dataModel: DataModel, group: CellGroup, region: CellRegion): CellGroup

- Defined in datagrid/src/cellgroup.ts:270
Merges a cell group with other cells groups in the same region if they intersect.

Parameters
- dataModel: DataModel
  
  the data model of the grid.
- group: CellGroup
  
  the target cell group.
- region: CellRegion
  
  the region of the cell group.
Returns CellGroup

a new cell group after merging has happened.

joinCellGroups

joinCellGroups(groups: CellGroup[]): CellGroup

- Defined in datagrid/src/cellgroup.ts:246
Calculates and returns a merged cell-group from two cell-group objects.

Parameters
- groups: CellGroup[]
Returns CellGroup

joinCellGroupsIntersectingAtAxis

joinCellGroupsIntersectingAtAxis(dataModel: DataModel, regions: CellRegion[], axis: "row" | "column", group: CellGroup): CellGroup

- Defined in datagrid/src/cellgroup.ts:374
Merges a target cell group with any cell groups it intersects with at a given row or column.

Parameters
- dataModel: DataModel
  
  data model of the grid.
- regions: CellRegion[]
  
  list of cell regions.
- axis: "row" | "column"
  
  row or column.
- group: CellGroup
  
  the target cell group.
Returns CellGroup

a new merged cell group.

Generated using TypeDoc