Excel.RangeFill class
Представляет фон объекта диапазона.
- Extends
Свойства
| color | Цветовой код HTML, представляющий цвет фона, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый") |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| pattern | Шаблон диапазона. См. |
| pattern |
Цветовой код HTML, представляющий цвет шаблона диапазона в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый"). |
| pattern |
Указывает двойное значение, которое осветляет или затемняет цвет рисунка для заливки диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий), где 0 для исходного цвета. Значение |
| tint |
Указывает двойное значение, осветляющее или затемняющее цвет для заливки диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий), где 0 для исходного цвета. Значение |
Методы
| clear() | Сброс фона диапазона. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
color
Цветовой код HTML, представляющий цвет фона, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый")
color: string;Значение свойства
string
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml
await Excel.run(async (context) => {
const selectedRanges = context.workbook.getSelectedRanges();
selectedRanges.format.fill.color = "lightblue";
await context.sync();
})
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
pattern
Шаблон диапазона. См. Excel.FillPattern дополнительные сведения. LinearGradient и RectangularGradient не поддерживаются. Значение null указывает, что для всего диапазона не используется единый шаблон.
pattern: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient";Значение свойства
Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient"
Комментарии
patternColor
Цветовой код HTML, представляющий цвет шаблона диапазона в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").
patternColor: string;Значение свойства
string
Комментарии
patternTintAndShade
Указывает двойное значение, которое осветляет или затемняет цвет рисунка для заливки диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий), где 0 для исходного цвета. Значение null указывает, что диапазон не имеет единых patternTintAndShade параметров.
patternTintAndShade: number;Значение свойства
number
Комментарии
tintAndShade
Указывает двойное значение, осветляющее или затемняющее цвет для заливки диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий), где 0 для исходного цвета. Значение null указывает, что диапазон не имеет единых tintAndShade параметров.
tintAndShade: number;Значение свойства
number
Комментарии
Сведения о методе
clear()
Сброс фона диапазона.
clear(): void;Возвращаемое значение
void
Комментарии
Примеры
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "F:G";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
const rangeFill = range.format.fill;
rangeFill.clear();
await context.sync();
});
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.RangeFillLoadOptions): Excel.RangeFill;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.RangeFill;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
Примеры
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "F:G";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
const rangeFill = range.format.fill;
rangeFill.load('color');
await context.sync();
console.log(rangeFill.color);
});
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.RangeFill;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.RangeFillUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.RangeFillUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Excel.RangeFill): void;Параметры
- properties
- Excel.RangeFill
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.RangeFill объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.RangeFillData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.RangeFillData;