Skip to content

Delete Dimension #650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions src/lib/GoogleSpreadsheetWorksheet.ts
Original file line number Diff line number Diff line change
Expand Up @@ -677,9 +677,29 @@ export class GoogleSpreadsheetWorksheet {
// https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#ClearBasicFilterRequest
}

async deleteDimension() {
// Request type = `deleteDimension`
// https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#DeleteDimensionRequest
/**
* Delete rows or columns at a particular index
* @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/request#DeleteDimensionRequest
*/

async deleteDimension(
columnsOrRows: WorksheetDimension,
rangeIndexes: DimensionRangeIndexes
) {
if (!columnsOrRows) throw new Error('You need to specify a dimension. i.e. COLUMNS|ROWS');
if (!_.isObject(rangeIndexes)) throw new Error('`rangeIndexes` must be an object containing `startIndex` and `endIndex`');
if (!_.isInteger(rangeIndexes.startIndex) || rangeIndexes.startIndex < 0) throw new Error('rangeIndexes.startIndex must be an integer >= 0');
if (!_.isInteger(rangeIndexes.endIndex) || rangeIndexes.endIndex < 0) throw new Error('rangeIndexes.endIndex must be an integer >= 0');
if (rangeIndexes.endIndex <= rangeIndexes.startIndex) throw new Error('rangeIndexes.endIndex must be greater than rangeIndexes.startIndex');

return this._makeSingleUpdateRequest('deleteDimension', {
range: {
sheetId: this.sheetId,
dimension: columnsOrRows,
startIndex: rangeIndexes.startIndex,
endIndex: rangeIndexes.endIndex,
},
});
}

async deleteEmbeddedObject() {
Expand Down