Excel.ShapeFill class
Представляет форматирование заливки объекта-фигуры.
- Extends
Комментарии
Используется
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-fill-and-line-formatting.yaml
await Excel.run(async (context) => {
// Set fill color and transparency together.
const sheet = context.workbook.worksheets.getItem("Sample");
const badge = sheet.shapes.getItem("Badge");
const shapeFill: Excel.ShapeFill = badge.fill;
shapeFill.foregroundColor = "#C00000";
shapeFill.transparency = 0.25;
await context.sync();
});
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| foreground |
Представляет цвет заливки фигуры переднего плана в цветовом формате HTML, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый") |
| transparency | Определяет процент прозрачности заливки как значение от 0,0 (непрозрачный) до 1,0 (прозрачный). Возвращает значение |
| type | Возвращает тип заливки фигуры. См. |
Методы
| clear() | Очищает формат заливки фигуры. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| set |
Задает заливку одним цветом для фигуры. При этом тип заливки изменяется на сплошную. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
foregroundColor
Представляет цвет заливки фигуры переднего плана в цветовом формате HTML, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый")
foregroundColor: string;Значение свойства
string
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-create-and-delete.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Shapes");
const shape: Excel.Shape = sheet.shapes.addGeometricShape(Excel.GeometricShapeType.smileyFace);
shape.left = 300;
shape.top = 100;
shape.height = 100;
shape.width = 100;
shape.fill.foregroundColor = "yellow"
await context.sync();
});
transparency
Определяет процент прозрачности заливки как значение от 0,0 (непрозрачный) до 1,0 (прозрачный). Возвращает значение null , если тип фигуры не поддерживает прозрачность или заливка фигуры имеет неоднородную прозрачность, например, при градиентной заливке.
transparency: number;Значение свойства
number
Комментарии
type
Возвращает тип заливки фигуры. См. Excel.ShapeFillType дополнительные сведения.
readonly type: Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed";Значение свойства
Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed"
Комментарии
Сведения о методе
clear()
Очищает формат заливки фигуры.
clear(): void;Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-fill-and-line-formatting.yaml
await Excel.run(async (context) => {
// Remove the shape's fill formatting.
const sheet = context.workbook.worksheets.getItem("Sample");
const badge = sheet.shapes.getItem("Badge");
const shapeFill: Excel.ShapeFill = badge.fill;
shapeFill.clear();
await context.sync();
});
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.ShapeFillLoadOptions): Excel.ShapeFill;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.ShapeFill;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ShapeFill;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.ShapeFillUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Excel.ShapeFill): void;Параметры
- properties
- Excel.ShapeFill
Возвращаемое значение
void
setSolidColor(color)
Задает заливку одним цветом для фигуры. При этом тип заливки изменяется на сплошную.
setSolidColor(color: string): void;Параметры
- color
-
string
Строка, представляющая цвет заливки в формате HTML в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").
Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-fill-and-line-formatting.yaml
await Excel.run(async (context) => {
// Apply a solid fill color to the shape.
const sheet = context.workbook.worksheets.getItem("Sample");
const badge = sheet.shapes.getItem("Badge");
const shapeFill: Excel.ShapeFill = badge.fill;
shapeFill.setSolidColor("#FFE08A");
await context.sync();
});
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ShapeFill объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ShapeFillData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.ShapeFillData;