PowerPoint.ShapeLineFormat class
Представляет форматирование линии для объекта-фигуры. Для изображений и геометрических фигур форматирование линий представляет собой границу фигуры.
- Extends
Комментарии
Используется
Примеры
// 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. |
| dash |
Представляет стиль штриха линии. Возвращает значение NULL, если линия не отображается или если есть несогласованные стили пунктира. Дополнительные сведения см. в разделе PowerPoint.ShapeLineDashStyle . |
| style | Представляет тип линии фигуры. Возвращает значение NULL, если линия не отображается или если есть несогласованные стили. Дополнительные сведения см. в разделе PowerPoint.ShapeLineStyle . |
| transparency | Определяет процент прозрачности линии как значение от 0,0 (непрозрачный) до 1,0 (прозрачный). Возвращает значение null, если в фигуре используются несогласованные параметры прозрачности. |
| visible | Указывает, отображается ли форматирование линий элемента фигуры. Возвращается |
| weight | Представляет толщину линии (в пунктах). Возвращает значение |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
color
Представляет цвет линии в цветовом формате HTML, в виде #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").
color: string;Значение свойства
string
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
dashStyle
Представляет стиль штриха линии. Возвращает значение NULL, если линия не отображается или если есть несогласованные стили пунктира. Дополнительные сведения см. в разделе PowerPoint.ShapeLineDashStyle .
dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";Значение свойства
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";Значение свойства
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;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): PowerPoint.ShapeLineFormat;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.ShapeLineFormat;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.ShapeLineFormat объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как PowerPoint.Interfaces.ShapeLineFormatData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;