| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434 |
- import CellCoords from './../cell/coords';
- /**
- * A cell range is a set of exactly two CellCoords (that can be the same or different)
- *
- * @class CellRange
- */
- class CellRange {
- /**
- * @param {CellCoords} highlight Used to draw bold border around a cell where selection was
- * started and to edit the cell when you press Enter
- * @param {CellCoords} from Usually the same as highlight, but in Excel there is distinction - one can change
- * highlight within a selection
- * @param {CellCoords} to End selection
- */
- constructor(highlight, from, to) {
- this.highlight = highlight;
- this.from = from;
- this.to = to;
- }
- /**
- * Checks if given coords are valid in context of a given Walkontable instance
- *
- * @param {Walkontable} wotInstance
- * @returns {Boolean}
- */
- isValid(wotInstance) {
- return this.from.isValid(wotInstance) && this.to.isValid(wotInstance);
- }
- /**
- * Checks if this cell range is restricted to one cell
- *
- * @returns {Boolean}
- */
- isSingle() {
- return this.from.row === this.to.row && this.from.col === this.to.col;
- }
- /**
- * Returns selected range height (in number of rows)
- *
- * @returns {Number}
- */
- getHeight() {
- return Math.max(this.from.row, this.to.row) - Math.min(this.from.row, this.to.row) + 1;
- }
- /**
- * Returns selected range width (in number of columns)
- *
- * @returns {Number}
- */
- getWidth() {
- return Math.max(this.from.col, this.to.col) - Math.min(this.from.col, this.to.col) + 1;
- }
- /**
- * Checks if given cell coords is within `from` and `to` cell coords of this range
- *
- * @param {CellCoords} cellCoords
- * @returns {Boolean}
- */
- includes(cellCoords) {
- let {row, col} = cellCoords;
- let topLeft = this.getTopLeftCorner();
- let bottomRight = this.getBottomRightCorner();
- return topLeft.row <= row && bottomRight.row >= row &&
- topLeft.col <= col && bottomRight.col >= col;
- }
- /**
- * Checks if given range is within of this range
- *
- * @param {CellRange} testedRange
- * @returns {Boolean}
- */
- includesRange(testedRange) {
- return this.includes(testedRange.getTopLeftCorner()) && this.includes(testedRange.getBottomRightCorner());
- }
- /**
- * Checks if given range is equal to this range
- *
- * @param {CellRange} testedRange
- * @returns {Boolean}
- */
- isEqual(testedRange) {
- return (Math.min(this.from.row, this.to.row) == Math.min(testedRange.from.row, testedRange.to.row)) &&
- (Math.max(this.from.row, this.to.row) == Math.max(testedRange.from.row, testedRange.to.row)) &&
- (Math.min(this.from.col, this.to.col) == Math.min(testedRange.from.col, testedRange.to.col)) &&
- (Math.max(this.from.col, this.to.col) == Math.max(testedRange.from.col, testedRange.to.col));
- }
- /**
- * Checks if tested range overlaps with the range.
- * Range A is considered to to be overlapping with range B if intersection of A and B or B and A is not empty.
- *
- * @param {CellRange} testedRange
- * @returns {Boolean}
- */
- overlaps(testedRange) {
- return testedRange.isSouthEastOf(this.getTopLeftCorner()) && testedRange.isNorthWestOf(this.getBottomRightCorner());
- }
- /**
- * @param {CellRange} testedCoords
- * @returns {Boolean}
- */
- isSouthEastOf(testedCoords) {
- return this.getTopLeftCorner().isSouthEastOf(testedCoords) || this.getBottomRightCorner().isSouthEastOf(testedCoords);
- }
- /**
- * @param {CellRange} testedCoords
- * @returns {Boolean}
- */
- isNorthWestOf(testedCoords) {
- return this.getTopLeftCorner().isNorthWestOf(testedCoords) || this.getBottomRightCorner().isNorthWestOf(testedCoords);
- }
- /**
- * Adds a cell to a range (only if exceeds corners of the range). Returns information if range was expanded
- *
- * @param {CellCoords} cellCoords
- * @returns {Boolean}
- */
- expand(cellCoords) {
- let topLeft = this.getTopLeftCorner();
- let bottomRight = this.getBottomRightCorner();
- if (cellCoords.row < topLeft.row || cellCoords.col < topLeft.col ||
- cellCoords.row > bottomRight.row || cellCoords.col > bottomRight.col) {
- this.from = new CellCoords(Math.min(topLeft.row, cellCoords.row), Math.min(topLeft.col, cellCoords.col));
- this.to = new CellCoords(Math.max(bottomRight.row, cellCoords.row), Math.max(bottomRight.col, cellCoords.col));
- return true;
- }
- return false;
- }
- /**
- * @param {CellRange} expandingRange
- * @returns {Boolean}
- */
- expandByRange(expandingRange) {
- if (this.includesRange(expandingRange) || !this.overlaps(expandingRange)) {
- return false;
- }
- let topLeft = this.getTopLeftCorner();
- let bottomRight = this.getBottomRightCorner();
- let topRight = this.getTopRightCorner();
- let bottomLeft = this.getBottomLeftCorner();
- let expandingTopLeft = expandingRange.getTopLeftCorner();
- let expandingBottomRight = expandingRange.getBottomRightCorner();
- let resultTopRow = Math.min(topLeft.row, expandingTopLeft.row);
- let resultTopCol = Math.min(topLeft.col, expandingTopLeft.col);
- let resultBottomRow = Math.max(bottomRight.row, expandingBottomRight.row);
- let resultBottomCol = Math.max(bottomRight.col, expandingBottomRight.col);
- let finalFrom = new CellCoords(resultTopRow, resultTopCol),
- finalTo = new CellCoords(resultBottomRow, resultBottomCol);
- let isCorner = new CellRange(finalFrom, finalFrom, finalTo).isCorner(this.from, expandingRange),
- onlyMerge = expandingRange.isEqual(new CellRange(finalFrom, finalFrom, finalTo));
- if (isCorner && !onlyMerge) {
- if (this.from.col > finalFrom.col) {
- finalFrom.col = resultBottomCol;
- finalTo.col = resultTopCol;
- }
- if (this.from.row > finalFrom.row) {
- finalFrom.row = resultBottomRow;
- finalTo.row = resultTopRow;
- }
- }
- this.from = finalFrom;
- this.to = finalTo;
- return true;
- }
- /**
- * @returns {String}
- */
- getDirection() {
- if (this.from.isNorthWestOf(this.to)) { // NorthWest - SouthEast
- return 'NW-SE';
- } else if (this.from.isNorthEastOf(this.to)) { // NorthEast - SouthWest
- return 'NE-SW';
- } else if (this.from.isSouthEastOf(this.to)) { // SouthEast - NorthWest
- return 'SE-NW';
- } else if (this.from.isSouthWestOf(this.to)) { // SouthWest - NorthEast
- return 'SW-NE';
- }
- }
- /**
- * @param {String} direction
- */
- setDirection(direction) {
- switch (direction) {
- case 'NW-SE':
- [this.from, this.to] = [this.getTopLeftCorner(), this.getBottomRightCorner()];
- break;
- case 'NE-SW':
- [this.from, this.to] = [this.getTopRightCorner(), this.getBottomLeftCorner()];
- break;
- case 'SE-NW':
- [this.from, this.to] = [this.getBottomRightCorner(), this.getTopLeftCorner()];
- break;
- case 'SW-NE':
- [this.from, this.to] = [this.getBottomLeftCorner(), this.getTopRightCorner()];
- break;
- default:
- break;
- }
- }
- /**
- * Get top left corner of this range
- *
- * @returns {CellCoords}
- */
- getTopLeftCorner() {
- return new CellCoords(Math.min(this.from.row, this.to.row), Math.min(this.from.col, this.to.col));
- }
- /**
- * Get bottom right corner of this range
- *
- * @returns {CellCoords}
- */
- getBottomRightCorner() {
- return new CellCoords(Math.max(this.from.row, this.to.row), Math.max(this.from.col, this.to.col));
- }
- /**
- * Get top right corner of this range
- *
- * @returns {CellCoords}
- */
- getTopRightCorner() {
- return new CellCoords(Math.min(this.from.row, this.to.row), Math.max(this.from.col, this.to.col));
- }
- /**
- * Get bottom left corner of this range
- *
- * @returns {CellCoords}
- */
- getBottomLeftCorner() {
- return new CellCoords(Math.max(this.from.row, this.to.row), Math.min(this.from.col, this.to.col));
- }
- /**
- * @param {CellCoords} coords
- * @param {CellRange} expandedRange
- * @returns {*}
- */
- isCorner(coords, expandedRange) {
- if (expandedRange) {
- if (expandedRange.includes(coords)) {
- if (this.getTopLeftCorner().isEqual(new CellCoords(expandedRange.from.row, expandedRange.from.col)) ||
- this.getTopRightCorner().isEqual(new CellCoords(expandedRange.from.row, expandedRange.to.col)) ||
- this.getBottomLeftCorner().isEqual(new CellCoords(expandedRange.to.row, expandedRange.from.col)) ||
- this.getBottomRightCorner().isEqual(new CellCoords(expandedRange.to.row, expandedRange.to.col))) {
- return true;
- }
- }
- }
- return coords.isEqual(this.getTopLeftCorner()) || coords.isEqual(this.getTopRightCorner()) ||
- coords.isEqual(this.getBottomLeftCorner()) || coords.isEqual(this.getBottomRightCorner());
- }
- /**
- * @param {CellCoords} coords
- * @param {CellRange} expandedRange
- * @returns {CellCoords}
- */
- getOppositeCorner(coords, expandedRange) {
- if (!(coords instanceof CellCoords)) {
- return false;
- }
- if (expandedRange) {
- if (expandedRange.includes(coords)) {
- if (this.getTopLeftCorner().isEqual(new CellCoords(expandedRange.from.row, expandedRange.from.col))) {
- return this.getBottomRightCorner();
- }
- if (this.getTopRightCorner().isEqual(new CellCoords(expandedRange.from.row, expandedRange.to.col))) {
- return this.getBottomLeftCorner();
- }
- if (this.getBottomLeftCorner().isEqual(new CellCoords(expandedRange.to.row, expandedRange.from.col))) {
- return this.getTopRightCorner();
- }
- if (this.getBottomRightCorner().isEqual(new CellCoords(expandedRange.to.row, expandedRange.to.col))) {
- return this.getTopLeftCorner();
- }
- }
- }
- if (coords.isEqual(this.getBottomRightCorner())) {
- return this.getTopLeftCorner();
- } else if (coords.isEqual(this.getTopLeftCorner())) {
- return this.getBottomRightCorner();
- } else if (coords.isEqual(this.getTopRightCorner())) {
- return this.getBottomLeftCorner();
- } else if (coords.isEqual(this.getBottomLeftCorner())) {
- return this.getTopRightCorner();
- }
- }
- /**
- * @param {CellRange} range
- * @returns {Array}
- */
- getBordersSharedWith(range) {
- if (!this.includesRange(range)) {
- return [];
- }
- const thisBorders = {
- top: Math.min(this.from.row, this.to.row),
- bottom: Math.max(this.from.row, this.to.row),
- left: Math.min(this.from.col, this.to.col),
- right: Math.max(this.from.col, this.to.col)
- };
- const rangeBorders = {
- top: Math.min(range.from.row, range.to.row),
- bottom: Math.max(range.from.row, range.to.row),
- left: Math.min(range.from.col, range.to.col),
- right: Math.max(range.from.col, range.to.col)
- };
- const result = [];
- if (thisBorders.top == rangeBorders.top) {
- result.push('top');
- }
- if (thisBorders.right == rangeBorders.right) {
- result.push('right');
- }
- if (thisBorders.bottom == rangeBorders.bottom) {
- result.push('bottom');
- }
- if (thisBorders.left == rangeBorders.left) {
- result.push('left');
- }
- return result;
- }
- /**
- * Get inner selected cell coords defined by this range
- *
- * @returns {Array}
- */
- getInner() {
- let topLeft = this.getTopLeftCorner();
- let bottomRight = this.getBottomRightCorner();
- let out = [];
- for (let r = topLeft.row; r <= bottomRight.row; r++) {
- for (let c = topLeft.col; c <= bottomRight.col; c++) {
- if (!(this.from.row === r && this.from.col === c) && !(this.to.row === r && this.to.col === c)) {
- out.push(new CellCoords(r, c));
- }
- }
- }
- return out;
- }
- /**
- * Get all selected cell coords defined by this range
- *
- * @returns {Array}
- */
- getAll() {
- let topLeft = this.getTopLeftCorner();
- let bottomRight = this.getBottomRightCorner();
- let out = [];
- for (let r = topLeft.row; r <= bottomRight.row; r++) {
- for (let c = topLeft.col; c <= bottomRight.col; c++) {
- if (topLeft.row === r && topLeft.col === c) {
- out.push(topLeft);
- } else if (bottomRight.row === r && bottomRight.col === c) {
- out.push(bottomRight);
- } else {
- out.push(new CellCoords(r, c));
- }
- }
- }
- return out;
- }
- /**
- * Runs a callback function against all cells in the range. You can break the iteration by returning
- * `false` in the callback function
- *
- * @param callback {Function}
- */
- forAll(callback) {
- let topLeft = this.getTopLeftCorner();
- let bottomRight = this.getBottomRightCorner();
- for (let r = topLeft.row; r <= bottomRight.row; r++) {
- for (let c = topLeft.col; c <= bottomRight.col; c++) {
- let breakIteration = callback(r, c);
- if (breakIteration === false) {
- return;
- }
- }
- }
- }
- }
- export default CellRange;
|