PowerPoint.ShapeLineFormat class

Пакет:: powerpoint

Представляет форматирование линий для объекта фигуры. Для изображений и геометрических фигур форматирование линий представляет границу фигуры.

Extends: OfficeExtension.ClientObject

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

// Changes the dash style of every line in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the dash style for shapes of the type `line`.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.line) {
      shape.lineFormat.style = PowerPoint.ShapeLineStyle.thickThin;
      shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
    }
  });
  await context.sync();
});

Свойства

color	Представляет цвет линии в цветовом формате HTML в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
dashStyle	Представляет стиль тире линии. Возвращает значение NULL, если линия не видна или есть несогласованные стили дефисов. Дополнительные сведения см. в статье PowerPoint.ShapeLineDashStyle .
style	Представляет тип линии фигуры. Возвращает значение NULL, если строка не видна или есть несогласованные стили. Дополнительные сведения см. в статье PowerPoint.ShapeLineStyle .
transparency	Указывает процент прозрачности строки в виде значения от 0,0 (непрозрачный) до 1,0 (очистить). Возвращает значение null, если в фигуре используются несогласованные параметры прозрачности.
visible	Указывает, отображается ли форматирование линий элемента фигуры. Возвращает, `null` когда фигура имеет несогласованную видимость.
weight	Представляет толщину линии (в пунктах). Возвращает, `null` если линия не видна или имеется несогласованный вес линии.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `PowerPoint.ShapeLineFormat` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `PowerPoint.Interfaces.ShapeLineFormatData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

color

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

color: string;

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

string

context

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

context: RequestContext;

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

PowerPoint.RequestContext

dashStyle

Представляет стиль тире линии. Возвращает значение NULL, если линия не видна или есть несогласованные стили дефисов. Дополнительные сведения см. в статье PowerPoint.ShapeLineDashStyle .

dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";

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

Примеры

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

// Changes the dash style of every line in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the dash style for shapes of the type `line`.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.line) {
      shape.lineFormat.style = PowerPoint.ShapeLineStyle.thickThin;
      shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
    }
  });
  await context.sync();
});

style

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

style: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";

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

transparency

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

transparency: number;

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

number

visible

Указывает, отображается ли форматирование линий элемента фигуры. Возвращает, null когда фигура имеет несогласованную видимость.

visible: boolean;

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

boolean

weight

Представляет толщину линии (в пунктах). Возвращает, null если линия не видна или имеется несогласованный вес линии.

weight: number;

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

number

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

load(options)

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

load(options?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions): PowerPoint.ShapeLineFormat;

Параметры

options: PowerPoint.Interfaces.ShapeLineFormatLoadOptions

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

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

PowerPoint.ShapeLineFormat

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

PowerPoint.ShapeLineFormat

load(propertyNamesAndPaths)

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

Параметры

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

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

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

PowerPoint.ShapeLineFormat

toJSON()

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

toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;

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

PowerPoint.Interfaces.ShapeLineFormatData

Обратная связь

Были ли сведения на этой странице полезными?

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

Комментарии

Примеры

Свойства

Методы

color

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

Комментарии

context

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

dashStyle

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

Комментарии

Примеры

style

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

Комментарии

transparency

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

Комментарии

visible

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

Комментарии

weight

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

toJSON()

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