Работа с таблицами

API Google Docs позволяет редактировать содержимое таблиц. Вы можете выполнять следующие операции:

  • Вставка и удаление строк, столбцов или целых таблиц.
  • Вставьте содержимое в ячейки таблицы.
  • Считывание содержимого из ячеек таблицы.
  • Измените свойства столбцов и стиль строк.

В документах Google Docs таблицы представлены в документе как структурные элементы (StructuralElement) . Каждая таблица содержит список строк , где каждая строка содержит список ячеек . Как и все структурные элементы, таблица имеет начальный и конечный индексы , указывающие на ее положение в документе. Дополнительную информацию об индексации см. в описании структуры . Свойства таблицы включают множество элементов стиля, таких как ширина столбцов и отступы.

Следующий фрагмент JSON отображает простую таблицу 2x2, из которой удалена большая часть деталей:

"table": {
    "columns": 2,
    "rows": 2,
    "tableRows": [
        { "tableCells": [
                {
                    "content": [ { "paragraph": { ...  }, } ],
                },
                {
                    "content": [ { "paragraph": { ... }, } ],
                }
            ],
        },
        {
            "tableCells": [
                {
                    "content": [ { "paragraph": { ... }, } ],
                },
                {
                    "content": [ { "paragraph": { ... }, } ],
                }
            ],
        }
    ]
}

Вставка и удаление таблиц

Для добавления новой таблицы в документ используйте объект InsertTableRequest . При вставке таблицы необходимо указать следующие параметры:

  • Размеры таблицы в строках и столбцах.
  • Место для вставки новой таблицы: это может быть индекс внутри сегмента или конец сегмента. В любом случае, он должен содержать идентификатор указанной вкладки.

Явного метода для удаления таблиц не существует. Чтобы удалить таблицу из документа, обработайте её так же, как и любое другое содержимое: используйте DeleteContentRangeRequest , указав диапазон, охватывающий всю таблицу.

В следующем примере в конец пустого документа вставляется таблица размером 3х3:

Java 

// 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(<var>TAB_ID</var>))
                .setRows(3)
                .setColumns(3)));

BatchUpdateDocumentRequest body =
    new BatchUpdateDocumentRequest().setRequests(requests);
BatchUpdateDocumentResponse response =
    docsService.documents().batchUpdate(<var>DOCUMENT_ID</var>, body).execute();

Python 

# 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': <var>TAB_ID</var>
        }
    },
}
]

result = service.documents().batchUpdate(documentId=<var>DOCUMENT_ID</var>, body={'requests': requests}).execute()

В этом примере показано, как удалить ранее созданную таблицу:

Java 

// 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(<var>DOCUMENT_ID</var>).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(<var>DOCUMENT_ID</var>, body).execute();

Python 

# 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=<var>DOCUMENT_ID</var>, body={'requests': requests}).execute()

Поскольку вы удаляете таблицу как обычное содержимое — указывая начальный и конечный индексы — вам необходимо откуда-то получить эти индексы. В примере показан один из способов извлечения этих индексов из содержимого документа.

Вставка и удаление строк

Если ваш документ уже содержит таблицу, API Google Docs позволяет вставлять и удалять строки таблицы. Используйте InsertTableRowRequest для вставки строк выше или ниже указанной ячейки таблицы, а DeleteTableRowRequest — для удаления строки, занимающей указанное место в ячейке.

В следующем примере текст вставляется в первую ячейку таблицы, а также добавляется строка в таблицу.

Java 

List<Request> requests = new ArrayList<>();
requests.add(new Request().setInsertText(new InsertTextRequest()
        .setText("Hello")
        .setLocation(new Location().setIndex(5).setTabId(<var>TAB_ID</var>))));
requests.add(new Request().setInsertTableRow(new InsertTableRowRequest()
        .setTableCellLocation(new TableCellLocation()
                .setTableStartLocation(new Location()
                        .setIndex(2).setTabId(<var>TAB_ID</var>))
                .setRowIndex(1)
                .setColumnIndex(1))
        .setInsertBelow(true)));

BatchUpdateDocumentRequest body =
    new BatchUpdateDocumentRequest().setRequests(requests);
BatchUpdateDocumentResponse response = docsService.documents()
        .batchUpdate(<var>DOCUMENT_ID</var>, body).execute();

Python 

requests = [{
      'insertText': {
        'location': {
          'index': 5,
          'tabId': <var>TAB_ID</var>
        },
        'text': 'Hello'
    }
  },
  {
    'insertTableRow': {
        'tableCellLocation': {
            'tableStartLocation': {
                'index': 2,
                'tabId': <var>TAB_ID</var>
            },
            'rowIndex': 1,
            'columnIndex': 1
        },
        'insertBelow': 'true'
    }
  }
]

result = service.documents().batchUpdate(documentId=<var>DOCUMENT_ID</var>, body={'requests': requests}).execute()

Вставка и удаление столбцов

Для вставки столбца в существующую таблицу используйте объект InsertTableColumnRequest . Необходимо указать следующее:

  • Ячейка, рядом с которой вы хотите вставить новый столбец.
  • С какой стороны (слева или справа) следует вставить новый столбец?

В следующем примере показано, как можно вставить столбец в таблицу 2x2, показанную ранее:

Java 

List<Request> requests = new ArrayList<>();
requests.add(
    new Request()
        .setInsertTableColumn(
            new InsertTableColumnRequest()
                .setTableCellLocation(
                    new TableCellLocation()
                        .setTableStartLocation(
                            new Location().setIndex(2).setTabId(<var>TAB_ID</var>))
                        .setRowIndex(0)
                        .setColumnIndex(0))
                .setInsertRight(true)));

BatchUpdateDocumentRequest body =
    new BatchUpdateDocumentRequest().setRequests(requests);
BatchUpdateDocumentResponse response =
    docsService.documents().batchUpdate(<var>DOCUMENT_ID</var>, body).execute();

Python 

requests = [{
    'insertTableColumn': {
      'tableCellLocation': {
        'tableStartLocation': {
          'segmentId': '',
          'index': 2,
          'tabId': <var>TAB_ID</var>
        },
        'rowIndex': 0,
        'columnIndex': 0
      },
      'insertRight': True
    },
}
]

result = service.documents().batchUpdate(documentId=<var>DOCUMENT_ID</var>, body={'requests': requests}).execute()

Для удаления столбца используйте функцию DeleteTableColumnRequest . Местоположение ячейки в целевом столбце указывается так же, как и при вставке столбца.

Чтение содержимого из ячеек таблицы

Ячейка таблицы содержит список структурных элементов ; каждый из этих структурных элементов может представлять собой абзац с текстом или другой тип структуры — даже другую таблицу. Для чтения содержимого таблицы можно рекурсивно просмотреть каждый элемент, как показано в разделе «Извлечение текста» .

Вставка содержимого в ячейки таблицы

Для записи в ячейку таблицы используйте InsertTextRequest , указав индекс внутри ячейки, которую вы хотите обновить. Индексы таблицы корректируются с учетом обновленного текста. То же самое относится и к удалению текста из ячейки с помощью DeleteContentRangeRequest .

Изменение свойств столбца

Метод UpdateTableColumnPropertiesRequest позволяет изменять свойства одного или нескольких столбцов в таблице.

Необходимо указать начальный индекс таблицы, а также объект TableColumnProperties . Чтобы изменить только выбранные столбцы, включите в запрос список номеров столбцов; чтобы изменить все столбцы в таблице, укажите пустой список.

В следующем примере изменяется ширина столбцов таблицы: сначала для всех столбцов устанавливается ширина 100 пунктов, а затем для первого столбца — 200 пунктов.

Java 

List<Request> requests = new ArrayList<>();
requests.add(
    new Request()
        .setUpdateTableColumnProperties(
            new UpdateTableColumnPropertiesRequest()
                .setTableStartLocation(
                    new Location()
                        .setIndex(2)
                        .setTabId(<var>TAB_ID</var>))
                .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(<var>TAB_ID</var>))
                .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(<var>DOCUMENT_ID</var>, body).execute();

Python 

requests = [{
  'updateTableColumnProperties': {
    'tableStartLocation': {'index': 2, 'tabId': <var>TAB_ID</var>},
    'columnIndices': [],
    'tableColumnProperties': {
      'widthType': 'FIXED_WIDTH',
      'width': {
        'magnitude': 100,
        'unit': 'PT'
      }
    },
    'fields': '*'
  },
  'updateTableColumnProperties': {
    'tableStartLocation': {'index': 2, 'tabId': <var>TAB_ID</var>},
    'columnIndices': [0],
    'tableColumnProperties': {
      'widthType': 'FIXED_WIDTH',
      'width': {
        'magnitude': 200,
        'unit': 'PT'
      }
    },
    'fields': '*'
  },
}
]

result = service.documents().batchUpdate(documentId=<var>DOCUMENT_ID</var>, body={'requests': requests}).execute()

Изменение стилей строк

Метод UpdateTableRowsStyleRequest позволяет изменять стиль одной или нескольких строк в таблице.

Необходимо указать начальный индекс таблицы, а также объект TableRowStyle . Чтобы изменить только выбранные строки, включите в запрос список номеров строк; чтобы изменить все строки в таблице, укажите пустой список.

В следующем примере задается минимальная высота третьей строки таблицы:

Java 

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(<var>TAB_ID</var>))
                .setRowIndices(rowIndices)
                .setTableRowStyle(
                    new TableRowStyle()
                        .setMinRowHeight(
                            new Dimension().setMagnitude(18d).setUnit("PT")))
                .setFields("*")));

BatchUpdateDocumentRequest body =
    new BatchUpdateDocumentRequest().setRequests(requests);
BatchUpdateDocumentResponse response =
    docsService.documents().batchUpdate(<var>DOCUMENT_ID</var>, body).execute();

Python 

requests = [{
    'updateTableRowStyle': {
        'tableStartLocation': {'index': 2, 'tabId': <var>TAB_ID</var>},
        'rowIndices': [3],
        'tableRowStyle': {
            'minRowHeight': {
              'magnitude': 18,
              'unit': 'PT'
            }
        },
        'fields': '*'
    },
}
]

result = service.documents().batchUpdate(documentId=<var>DOCUMENT_ID</var>, body={'requests': requests}).execute()