Share via

PowerPoint.ShapeFill class

  • Ссылка
Пакет:
powerpoint

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

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: PowerPointApi 1.4 ]

Свойства

context

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

Представляет цвет переднего плана заливки фигуры в формате HTML в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").
transparency

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

Возвращает тип заливки фигуры. Дополнительные сведения см. в разделе PowerPoint.ShapeFillType .

Методы

clear()

Очищает формат заливки фигуры.
load(options)

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

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

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

Задает заливку одним цветом для фигуры. При этом тип заполнения изменится на Solid.
toJSON()

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

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

context

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

context: RequestContext;

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

PowerPoint.RequestContext

foregroundColor

Представляет цвет переднего плана заливки фигуры в формате HTML в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").

foregroundColor: string;

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

string

Комментарии

[ Набор API: PowerPointApi 1.4 ]

transparency

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

transparency: number;

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

number

Комментарии

[ Набор API: PowerPointApi 1.4 ]

type

Возвращает тип заливки фигуры. Дополнительные сведения см. в разделе PowerPoint.ShapeFillType .

readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";

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

PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground"

Комментарии

[ Набор API: PowerPointApi 1.4 ]

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

clear()

Очищает формат заливки фигуры.

clear(): void;

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

void

Комментарии

[ Набор API: PowerPointApi 1.4 ]

load(options)

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

load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill;

Параметры

options
PowerPoint.Interfaces.ShapeFillLoadOptions

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

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

PowerPoint.ShapeFill

load(propertyNames)

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

load(propertyNames?: string | string[]): PowerPoint.ShapeFill;

Параметры

propertyNames

string | string[]

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

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

PowerPoint.ShapeFill

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.ShapeFill;

Параметры

propertyNamesAndPaths

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

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

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

PowerPoint.ShapeFill

setSolidColor(color)

Задает заливку одним цветом для фигуры. При этом тип заполнения изменится на Solid.

setSolidColor(color: string): void;

Параметры

color

string

Строка, указывающая цвет заливки в формате HTML, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").

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

void

Комментарии

[ Набор API: PowerPointApi 1.4 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml

// Changes the selected shapes fill color to red.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  shapes.items.map((shape) => {
    shape.fill.setSolidColor("red");
  });
  await context.sync();
});

toJSON()

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

toJSON(): PowerPoint.Interfaces.ShapeFillData;

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

PowerPoint.Interfaces.ShapeFillData