API Документов Google позволяет редактировать содержимое таблиц. Операции, которые вы можете выполнить, включают следующее:
- Вставляйте и удаляйте строки, столбцы или целые таблицы.
- Вставьте содержимое в ячейки таблицы.
- Чтение содержимого ячеек таблицы.
- Измените свойства столбца и стиль строк.
Таблицы в Документах Google представлены в документе как тип StructuralElement . Каждая таблица содержит список строк таблицы , где каждая строка содержит список ячеек таблицы . Как и все структурные элементы, таблица имеет начальный и конечный индексы , указывающие положение таблицы в документе. См. структуру для получения дополнительной информации об индексировании. Свойства таблицы включают множество элементов стиля, таких как ширина столбцов и отступы.
Следующий фрагмент JSON показывает простую таблицу 2x2, из которой удалена большая часть деталей:
"table": {
"columns": 2,
"rows": 2,
"tableRows": [
{ "tableCells": [
{
"content": [ { "paragraph": { ... }, } ],
},
{
"content": [ { "paragraph": { ... }, } ],
}
],
},
{
"tableCells": [
{
"content": [ { "paragraph": { ... }, } ],
},
{
"content": [ { "paragraph": { ... }, } ],
}
],
}
]
}
Вставка и удаление таблиц
Чтобы добавить новую таблицу в документ, используйте InsertTableRequest . При вставке таблицы необходимо указать следующее:
- Размеры таблицы в строках и столбцах.
- Место для вставки новой таблицы: это может быть индекс внутри сегмента или конец сегмента. Любой из них должен включать идентификатор указанной вкладки.
Не существует явного метода удаления таблиц. Чтобы удалить таблицу из документа, обращайтесь с ней так же, как с любым другим содержимым: используйте DeleteContentRangeRequest , указав диапазон, охватывающий всю таблицу.
В следующем примере таблица 3x3 вставляется в конец пустого документа:
Ява
// Insert a table at the end of the body.
// (An empty or unspecified segmentId field indicates the document's body.)
List<Request> requests = new ArrayList<>();
requests.add(
new Request()
.setInsertTable(
new InsertTableRequest()
.setEndOfSegmentLocation(
new EndOfSegmentLocation().setTabId(TAB_ID))
.setRows(3)
.setColumns(3)));
BatchUpdateDocumentRequest body =
new BatchUpdateDocumentRequest().setRequests(requests);
BatchUpdateDocumentResponse response =
docsService.documents().batchUpdate(DOCUMENT_ID, body).execute();
Питон
# Insert a table at the end of the body.
# (An empty or unspecified segmentId field indicates the document's body.)
requests = [{
'insertTable': {
'rows': 3,
'columns': 3,
'endOfSegmentLocation': {
'segmentId': '',
'tabId': TAB_ID
}
},
}
]
result = service.documents().batchUpdate(documentId=DOCUMENT_ID, body={'requests': requests}).execute()
В этом соответствующем примере показано, как удалить ранее вставленную таблицу:
Ява
// Delete a table that was inserted at the start of the body of the first tab.
// (The table is the second element in the body:
// documentTab.getBody().getContent().get(2).)
Document document = docsService.documents().get(DOCUMENT_ID).setIncludeTabsContent(true).execute();
String tabId = document.getTabs()[0].getTabProperties().getTabId();
DocumentTab documentTab = document.getTabs()[0].getDocumentTab();
StructuralElement table = documentTab.getBody().getContent().get(2);
List<Request> requests = new ArrayList<>();
requests.add(
new Request()
.setDeleteContentRange(
new DeleteContentRangeRequest()
.setRange(
new Range()
.setStartIndex(table.getStartIndex())
.setEndIndex(table.getEndIndex())
.setTabId(tabId))));
BatchUpdateDocumentRequest body =
new BatchUpdateDocumentRequest().setRequests(requests);
BatchUpdateDocumentResponse response =
docsService.documents().batchUpdate(DOCUMENT_ID, body).execute();
Питон
# Delete a table that was inserted at the start of the body of the first tab.
# (The table is the second element in the body: ['body']['content'][2].)
document = service.documents().get(documentId=DOCUMENT_ID, includeTabsContent=True).execute()
tab_id = document['tabs'][0]['tabProperties']['tabId']
document_tab = document['tabs'][0]['documentTab']
table = document_tab['body']['content'][2]
requests = [{
'deleteContentRange': {
'range': {
'segmentId': '',
'startIndex': table['startIndex'],
'endIndex': table['endIndex'],
'tabId': tab_id
}
},
}
]
result = service.documents().batchUpdate(documentId=DOCUMENT_ID, body={'requests': requests}).execute()
Поскольку вы удаляете таблицу как обычное содержимое (путем указания начального и конечного индексов), вам необходимо откуда-то получить эти индексы. В примере показан один из способов извлечения этих индексов из содержимого документа.
Вставка и удаление строк
Если ваш документ уже содержит таблицу, API Документов Google позволяет вам вставлять и удалять строки таблицы. Используйте InsertTableRowRequest , чтобы вставить строки выше или ниже указанной ячейки таблицы, и DeleteTableRowRequest , чтобы удалить строку, охватывающую указанное расположение ячейки.
В следующем примере текст вставляется в первую ячейку таблицы и добавляется строка таблицы.
Ява
List<Request> requests = new ArrayList<>();
requests.add(new Request().setInsertText(new InsertTextRequest()
.setText("Hello")
.setLocation(new Location().setIndex(5).setTabId(TAB_ID))));
requests.add(new Request().setInsertTableRow(new InsertTableRowRequest()
.setTableCellLocation(new TableCellLocation()
.setTableStartLocation(new Location()
.setIndex(2).setTabId(TAB_ID))
.setRowIndex(1)
.setColumnIndex(1))
.setInsertBelow(true)));
BatchUpdateDocumentRequest body =
new BatchUpdateDocumentRequest().setRequests(requests);
BatchUpdateDocumentResponse response = docsService.documents()
.batchUpdate(DOCUMENT_ID, body).execute();
Питон
requests = [{
'insertText': {
'location': {
'index': 5,
'tabId': TAB_ID
},
'text': 'Hello'
}
},
{
'insertTableRow': {
'tableCellLocation': {
'tableStartLocation': {
'index': 2,
'tabId': TAB_ID
},
'rowIndex': 1,
'columnIndex': 1
},
'insertBelow': 'true'
}
}
]
result = service.documents().batchUpdate(documentId=DOCUMENT_ID, body={'requests': requests}).execute()
Вставка и удаление столбцов
Чтобы вставить столбец в существующую таблицу, используйте InsertTableColumnRequest . Вы должны указать следующее:
- Ячейка, рядом с которой вы хотите вставить новый столбец.
- С какой стороны (слева или справа) вставить новый столбец.
В следующем примере показано, как можно вставить столбец в таблицу 2x2, показанную ранее:
Ява
List<Request> requests = new ArrayList<>();
requests.add(
new Request()
.setInsertTableColumn(
new InsertTableColumnRequest()
.setTableCellLocation(
new TableCellLocation()
.setTableStartLocation(
new Location().setIndex(2).setTabId(TAB_ID))
.setRowIndex(0)
.setColumnIndex(0))
.setInsertRight(true)));
BatchUpdateDocumentRequest body =
new BatchUpdateDocumentRequest().setRequests(requests);
BatchUpdateDocumentResponse response =
docsService.documents().batchUpdate(DOCUMENT_ID, body).execute();
Питон
requests = [{
'insertTableColumn': {
'tableCellLocation': {
'tableStartLocation': {
'segmentId': '',
'index': 2,
'tabId': TAB_ID
},
'rowIndex': 0,
'columnIndex': 0
},
'insertRight': True
},
}
]
result = service.documents().batchUpdate(documentId=DOCUMENT_ID, body={'requests': requests}).execute()
Чтобы удалить столбец, используйте DeleteTableColumnRequest . Вы указываете расположение ячейки в целевом столбце так же, как показано ранее для вставки столбца.
Чтение содержимого из ячеек таблицы
Ячейка таблицы содержит список структурных элементов ; каждый из этих структурных элементов может представлять собой абзац с текстом или структуру другого типа — даже другую таблицу. Чтобы прочитать содержимое таблицы, вы можете рекурсивно проверить каждый элемент, как показано в разделе «Извлечение текста» .
Вставка содержимого в ячейки таблицы
Чтобы выполнить запись в ячейку таблицы, используйте InsertTextRequest для индекса внутри ячейки, которую вы хотите обновить. Индексы таблицы корректируются с учетом обновленного текста. То же самое относится и к удалению текста ячейки с помощью DeleteContentRangeRequest .
Изменение свойств столбца
UpdateTableColumnPropertiesRequest позволяет изменять свойства одного или нескольких столбцов таблицы.
Вы должны предоставить начальный индекс таблицы вместе с объектом TableColumnProperties . Чтобы изменить только выбранные столбцы, включите в запрос список номеров столбцов; чтобы изменить все столбцы в таблице, предоставьте пустой список.
В следующем примере обновляется ширина столбцов таблицы, устанавливая ширину всех столбцов на 100 пунктов, а затем ширину первого столбца на 200 пунктов:
Ява
List<Request> requests = new ArrayList<>();
requests.add(
new Request()
.setUpdateTableColumnProperties(
new UpdateTableColumnPropertiesRequest()
.setTableStartLocation(
new Location()
.setIndex(2)
.setTabId(TAB_ID))
.setColumnIndices(null)
.setTableColumnProperties(
new TableColumnProperties()
.setWidthType("FIXED_WIDTH")
.setWidth(
new Dimension().setMagnitude(100d).setUnit("PT")))
.setFields("*")));
List<Integer> columnIndices = new ArrayList<>();
columnIndices.add(0);
requests.add(
new Request()
.setUpdateTableColumnProperties(
new UpdateTableColumnPropertiesRequest()
.setTableStartLocation(
new Location()
.setIndex(2)
.setTabId(TAB_ID))
.setColumnIndices(columnIndices)
.setTableColumnProperties(
new TableColumnProperties()
.setWidthType("FIXED_WIDTH")
.setWidth(
new Dimension().setMagnitude(200d).setUnit("PT")))
.setFields("*")));
BatchUpdateDocumentRequest body =
new BatchUpdateDocumentRequest().setRequests(requests);
BatchUpdateDocumentResponse response =
docsService.documents().batchUpdate(DOCUMENT_ID, body).execute();
Питон
requests = [{
'updateTableColumnProperties': {
'tableStartLocation': {'index': 2, 'tabId': TAB_ID},
'columnIndices': [],
'tableColumnProperties': {
'widthType': 'FIXED_WIDTH',
'width': {
'magnitude': 100,
'unit': 'PT'
}
},
'fields': '*'
},
'updateTableColumnProperties': {
'tableStartLocation': {'index': 2, 'tabId': TAB_ID},
'columnIndices': [0],
'tableColumnProperties': {
'widthType': 'FIXED_WIDTH',
'width': {
'magnitude': 200,
'unit': 'PT'
}
},
'fields': '*'
},
}
]
result = service.documents().batchUpdate(documentId=DOCUMENT_ID, body={'requests': requests}).execute()
Изменение стилей строк
UpdateTableRowsStyleRequest позволяет изменить стиль одной или нескольких строк в таблице.
Вы должны предоставить начальный индекс таблицы вместе с объектом TableRowStyle . Чтобы изменить только выбранные строки, включите в запрос список номеров строк; чтобы изменить все строки в таблице, предоставьте пустой список.
В следующем примере задается минимальная высота строки 3 таблицы:
Ява
List<Integer> rowIndices = new ArrayList<>();
rowIndices.add(3);
List<Request> requests = new ArrayList<>();
requests.add(
new Request()
.setUpdateTableRowStyle(
new UpdateTableRowStyleRequest()
.setTableStartLocation(
new Location()
.setIndex(2)
.setTabId(TAB_ID))
.setRowIndices(rowIndices)
.setTableRowStyle(
new TableRowStyle()
.setMinRowHeight(
new Dimension().setMagnitude(18d).setUnit("PT")))
.setFields("*")));
BatchUpdateDocumentRequest body =
new BatchUpdateDocumentRequest().setRequests(requests);
BatchUpdateDocumentResponse response =
docsService.documents().batchUpdate(DOCUMENT_ID, body).execute();
Питон
requests = [{
'updateTableRowStyle': {
'tableStartLocation': {'index': 2, 'tabId': TAB_ID},
'rowIndices': [3],
'tableRowStyle': {
'minRowHeight': {
'magnitude': 18,
'unit': 'PT'
}
},
'fields': '*'
},
}
]
result = service.documents().batchUpdate(documentId=DOCUMENT_ID, body={'requests': requests}).execute()