Excel.Worksheet class

Ссылка

Пакет:: excel

Лист Excel представляет собой сетку ячеек. Он может содержать данные, таблицы, диаграммы и т. д. Дополнительные сведения об объектной модели листа см. в статье Работа с листами с помощью API JavaScript для Excel.

Extends: OfficeExtension.ClientObject

Свойства

charts	Возвращает коллекцию диаграмм, которые являются частью листа.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
id	Возвращает значение, однозначно идентифицирующее лист в данной книге. Значение идентификатора остается прежним, даже если переименовать или переместить лист.
name	Отображаемое имя листа. Имя должно содержать менее 32 символов.
names	Коллекция имен, относящих к текущему листу.
pivotTables	Коллекция сводных таблиц на листе.
position	Положение листа (начиная с нуля) в книге.
protection	Возвращает объект защиты листа для листа.
tables	Коллекция таблиц, имеющихся на листе.
visibility	Видимость листа.

Методы

activate()	Активация листа в пользовательском интерфейсе Excel.
delete()	Удаляет лист из книги. Обратите внимание, что если для видимости листа задано значение VeryHidden, операция удаления завершится ошибкой `InvalidOperation` с исключением. Сначала необходимо изменить видимость на скрытую или видимую перед удалением.
getCell(row, column)	Возвращает объект, `Range` содержащий одну ячейку на основе номеров строк и столбцов. Ячейка может находиться за пределами родительского диапазона, если она находится в сетке листа.
getNext(visibleOnly)	Возвращает лист, следующий за этим. Если после этого листа нет, этот метод вызовет ошибку.
getNextOrNullObject(visibleOnly)	Возвращает лист, следующий за этим. Если после этого листа нет, этот метод возвращает объект со свойством `isNullObjecttrue`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getPrevious(visibleOnly)	Возвращает лист, предшествующий этому листу. Если предыдущих листов нет, этот метод вызовет ошибку.
getPreviousOrNullObject(visibleOnly)	Возвращает лист, предшествующий этому листу. Если предыдущих листов нет, этот метод возвращает объект со свойством `isNullObjecttrue`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getRange(address)	`Range` Возвращает объект , представляющий один прямоугольный блок ячеек, заданный адресом или именем.
getUsedRange(valuesOnly)	Используемый диапазон — это наименьший диапазон, включающий в себя все ячейки с определенным значением или форматированием. Если весь лист пуст, эта функция вернет верхнюю левую ячейку (т. е. не вызовет ошибку).
getUsedRangeOrNullObject(valuesOnly)	Используемый диапазон — это наименьший диапазон, включающий в себя все ячейки с определенным значением или форматированием. Если весь лист пуст, то этот метод возвращает объект со свойством `isNullObjecttrue`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный объект Excel.Worksheet является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.WorksheetData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

charts

Возвращает коллекцию диаграмм, которые являются частью листа.

readonly charts: Excel.ChartCollection;

Значение свойства

Excel.ChartCollection

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

id

Возвращает значение, однозначно идентифицирующее лист в данной книге. Значение идентификатора остается прежним, даже если переименовать или переместить лист.

readonly id: string;

Значение свойства

string

name

Отображаемое имя листа. Имя должно содержать менее 32 символов.

name: string;

Значение свойства

string

names

Коллекция имен, относящих к текущему листу.

readonly names: Excel.NamedItemCollection;

Значение свойства

Excel.NamedItemCollection

pivotTables

Коллекция сводных таблиц на листе.

readonly pivotTables: Excel.PivotTableCollection;

Значение свойства

Excel.PivotTableCollection

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml

await Excel.run(async (context) => {
  // Get the names of all the PivotTables in the current worksheet.
  const pivotTables = context.workbook.worksheets.getActiveWorksheet().pivotTables;
  pivotTables.load("name");
  await context.sync();

  // Display the names in the console.
  console.log("PivotTables in the current worksheet:")
  pivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
});

position

Положение листа (начиная с нуля) в книге.

position: number;

Значение свойства

number

Примеры

// Set worksheet position.
await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.position = 2;
    await context.sync(); 
});

protection

Возвращает объект защиты листа для листа.

readonly protection: Excel.WorksheetProtection;

Значение свойства

Excel.WorksheetProtection

Примеры

// Unprotecting a worksheet with unprotect() will remove all 
// WorksheetProtectionOptions options applied to a worksheet.
// To remove only a subset of WorksheetProtectionOptions use the 
// protect() method and set the options you wish to remove to true.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sheet1");
  sheet.protection.protect({
    allowInsertRows: false, // Protect row insertion
    allowDeleteRows: true // Unprotect row deletion
  });
});

tables

Коллекция таблиц, имеющихся на листе.

readonly tables: Excel.TableCollection;

Значение свойства

Excel.TableCollection

visibility

Видимость листа.

visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

Значение свойства

Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"

Сведения о методе

activate()

Активация листа в пользовательском интерфейсе Excel.

activate(): void;

Возвращаемое значение

void

Примеры

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.activate();
    await context.sync(); 
});

delete()

Удаляет лист из книги. Обратите внимание, что если для видимости листа задано значение VeryHidden, операция удаления завершится ошибкой InvalidOperation с исключением. Сначала необходимо изменить видимость на скрытую или видимую перед удалением.

delete(): void;

Возвращаемое значение

void

Примеры

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.delete();
    await context.sync(); 
});

getCell(row, column)

Возвращает объект, Range содержащий одну ячейку на основе номеров строк и столбцов. Ячейка может находиться за пределами родительского диапазона, если она находится в сетке листа.

getCell(row: number, column: number): Excel.Range;

Параметры

row: number

Номер строки ячейки, которую требуется извлечь. Используется нулевой индекс.

column: number

Номер столбца ячейки, которую требуется извлечь. Используется нулевой индекс.

Возвращаемое значение

Excel.Range

Примеры

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const cell = worksheet.getCell(0,0);
    cell.load('address');
    await context.sync();

    console.log(cell.address);
});

getNext(visibleOnly)

Возвращает лист, следующий за этим. Если после этого листа нет, этот метод вызовет ошибку.

getNext(visibleOnly?: boolean): Excel.Worksheet;

Параметры

visibleOnly: boolean

Необязательный параметр. Если trueзначение , учитывает только видимые листы, пропуская все скрытые листы.

Возвращаемое значение

Excel.Worksheet

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml

await Excel.run(async (context) => {
    const sheets = context.workbook.worksheets;

    // We don't want to include the default worksheet that was created
    // when the workbook was created, so our "firstSheet" will be the one
    // after the literal first. Note chaining of navigation methods.
    const firstSheet = sheets.getFirst().getNext();
    const lastSheet = sheets.getLast();
    const firstTaxRateRange = firstSheet.getRange("B2");
    const lastTaxRateRange = lastSheet.getRange("B2");

    firstSheet.load("name");
    lastSheet.load("name");
    firstTaxRateRange.load("text");
    lastTaxRateRange.load("text");

    await context.sync();

    let firstYear = firstSheet.name.substr(5, 4);
    let lastYear = lastSheet.name.substr(5, 4);
    console.log(`Tax Rate change from ${firstYear} to ${lastYear}`, `Tax rate for ${firstYear}: ${firstTaxRateRange.text[0][0]}\nTax rate for ${lastYear}: ${lastTaxRateRange.text[0][0]}`)

    await context.sync();
});

getNextOrNullObject(visibleOnly)

Возвращает лист, следующий за этим. Если после этого листа нет, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getNextOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Параметры

visibleOnly: boolean

Необязательный параметр. Если trueзначение , учитывает только видимые листы, пропуская все скрытые листы.

Возвращаемое значение

Excel.Worksheet

getPrevious(visibleOnly)

Возвращает лист, предшествующий этому листу. Если предыдущих листов нет, этот метод вызовет ошибку.

getPrevious(visibleOnly?: boolean): Excel.Worksheet;

Параметры

visibleOnly: boolean

Необязательный параметр. Если trueзначение , учитывает только видимые листы, пропуская все скрытые листы.

Возвращаемое значение

Excel.Worksheet

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml

await Excel.run(async (context) => {
    const sheets = context.workbook.worksheets;
    const currentSheet = sheets.getActiveWorksheet();
    const previousYearSheet = currentSheet.getPrevious();
    const currentTaxDueRange = currentSheet.getRange("C2");
    const previousTaxDueRange = previousYearSheet.getRange("C2");

    currentSheet.load("name");
    previousYearSheet.load("name");
    currentTaxDueRange.load("text");
    previousTaxDueRange.load("text");

    await context.sync();

    let currentYear = currentSheet.name.substr(5, 4);
    let previousYear = previousYearSheet.name.substr(5, 4);
    console.log("Two Year Tax Due Comparison", `Tax due for ${currentYear} was ${currentTaxDueRange.text[0][0]}\nTax due for ${previousYear} was ${previousTaxDueRange.text[0][0]}`)

    await context.sync();
});

getPreviousOrNullObject(visibleOnly)

Возвращает лист, предшествующий этому листу. Если предыдущих листов нет, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getPreviousOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Параметры

visibleOnly: boolean

Необязательный параметр. Если trueзначение , учитывает только видимые листы, пропуская все скрытые листы.

Возвращаемое значение

Excel.Worksheet

getRange(address)

Range Возвращает объект , представляющий один прямоугольный блок ячеек, заданный адресом или именем.

getRange(address?: string): Excel.Range;

Параметры

address: string

Необязательный параметр. Строка, представляющая адрес или имя диапазона. Например, "A1:B2". Если аргумент не указан, возвращается весь диапазон листа.

Возвращаемое значение

Excel.Range

Примеры

// Use the range address to get the range object.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    range.load('cellCount');
    await context.sync();
    
    console.log(range.cellCount);
});

getUsedRange(valuesOnly)

Используемый диапазон — это наименьший диапазон, включающий в себя все ячейки с определенным значением или форматированием. Если весь лист пуст, эта функция вернет верхнюю левую ячейку (т. е. не вызовет ошибку).

getUsedRange(valuesOnly?: boolean): Excel.Range;

Параметры

valuesOnly: boolean

Необязательный параметр. Если trueзадано значение , то в качестве используемых ячеек учитываются только ячейки со значениями (игнорируется форматирование). [Набор API: ExcelApi 1.2]

Возвращаемое значение

Excel.Range

Примеры

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    const usedRange = worksheet.getUsedRange();
    usedRange.load('address');
    await context.sync();
    
    console.log(usedRange.address);
});

getUsedRangeOrNullObject(valuesOnly)

Используемый диапазон — это наименьший диапазон, включающий в себя все ячейки с определенным значением или форматированием. Если весь лист пуст, то этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

Параметры

valuesOnly: boolean

Необязательный параметр. Учитывает только ячейки со значениями.

Возвращаемое значение

Excel.Range

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.WorksheetLoadOptions): Excel.Worksheet;

Параметры

options: Excel.Interfaces.WorksheetLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

Excel.Worksheet

load(propertyNames)

load(propertyNames?: string | string[]): Excel.Worksheet;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Excel.Worksheet

Примеры

// Get worksheet properties based on sheet name.
await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.load('position')
    await context.sync();
    
    console.log(worksheet.position);
});

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Worksheet;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Excel.Worksheet

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.WorksheetUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Excel.Interfaces.WorksheetUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

Примеры

// Set the color and name of the current worksheet.
await Excel.run(async (context) => {
  const activeSheet = context.workbook.worksheets.getActiveWorksheet();
  activeSheet.set({
    tabColor: "yellow",
    name: "MySheet"
  });

  await context.sync();
});

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.Worksheet): void;

Параметры

properties: Excel.Worksheet

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.Worksheet является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.WorksheetData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.WorksheetData;

Возвращаемое значение

Excel.Interfaces.WorksheetData

Поделиться через

Excel.Worksheet class

Комментарии

Примеры

Свойства

Методы

Сведения о свойстве

charts

Значение свойства

Комментарии

context

Значение свойства

id

Значение свойства

Комментарии

name

Значение свойства

Комментарии

names

Значение свойства

Комментарии

pivotTables

Значение свойства

Комментарии

Примеры

position

Значение свойства

Комментарии

Примеры

protection

Значение свойства

Комментарии

Примеры

tables

Значение свойства

Комментарии

visibility

Значение свойства

Комментарии

Сведения о методе

activate()

Возвращаемое значение

Комментарии

Примеры

delete()

Возвращаемое значение

Комментарии

Примеры

getCell(row, column)

Параметры

Возвращаемое значение

Комментарии

Примеры

getNext(visibleOnly)

Параметры

Возвращаемое значение

Комментарии

Примеры

getNextOrNullObject(visibleOnly)

Параметры

Возвращаемое значение

Комментарии

getPrevious(visibleOnly)

Параметры

Возвращаемое значение

Комментарии

Примеры

getPreviousOrNullObject(visibleOnly)

Параметры

Возвращаемое значение

Комментарии

getRange(address)

Параметры

Возвращаемое значение

Комментарии

Примеры

getUsedRange(valuesOnly)

Параметры

Возвращаемое значение

Комментарии