Excel.ShapeLineFormat class
Представляет форматирование линии для объекта-фигуры. Для изображений и геометрических фигур форматирование линий представляет собой границу фигуры.
- Extends
Свойства
| color | Представляет цвет линии в цветовом формате HTML, в виде #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый"). |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| dash |
Представляет тип линии фигуры. Возвращается |
| style | Представляет тип линии фигуры. Возвращается |
| transparency | Представляет степень прозрачности указанной линии как значение от 0,0 (непрозрачная) до 1,0 (полностью прозрачная). Возвращает значение |
| visible | Указывает, отображается ли форматирование линий элемента фигуры. Возвращается |
| weight | Представляет толщину линии (в пунктах). Возвращается |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
color
Представляет цвет линии в цветовом формате HTML, в виде #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый").
color: string;Значение свойства
string
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
dashStyle
Представляет тип линии фигуры. Возвращается null , когда линия не отображается или имеются несогласованные стили тире. См. Excel.ShapeLineDashStyle дополнительные сведения.
dashStyle: Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";Значение свойства
Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"
Комментарии
style
Представляет тип линии фигуры. Возвращается null , когда линия не отображается или имеются несогласованные стили. См. Excel.ShapeLineStyle дополнительные сведения.
style: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";Значение свойства
Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"
Комментарии
transparency
Представляет степень прозрачности указанной линии как значение от 0,0 (непрозрачная) до 1,0 (полностью прозрачная). Возвращает значение null формы, если она имеет несогласованные прозрачные пленки.
transparency: number;Значение свойства
number
Комментарии
visible
Указывает, отображается ли форматирование линий элемента фигуры. Возвращается null , когда фигура имеет несогласованные видимости.
visible: boolean;Значение свойства
boolean
Комментарии
Примеры
// 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) => {
// Hide the shape's outline.
const sheet = context.workbook.worksheets.getItem("Sample");
const badge = sheet.shapes.getItem("Badge");
const lineFormat: Excel.ShapeLineFormat = badge.lineFormat;
lineFormat.visible = false;
await context.sync();
});
weight
Представляет толщину линии (в пунктах). Возвращается null , если линия не отображается или при наличии несогласованной толщины строк.
weight: number;Значение свойства
number
Комментарии
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.ShapeLineFormatLoadOptions): Excel.ShapeLineFormat;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.ShapeLineFormat;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ShapeLineFormat;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.ShapeLineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.ShapeLineFormatUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Excel.ShapeLineFormat): void;Параметры
- properties
- Excel.ShapeLineFormat
Возвращаемое значение
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 outline formatting to the shape.
const sheet = context.workbook.worksheets.getItem("Sample");
const badge = sheet.shapes.getItem("Badge");
const lineFormat: Excel.ShapeLineFormat = badge.lineFormat;
lineFormat.set({
color: "#C55A11",
dashStyle: Excel.ShapeLineDashStyle.dashDotDot,
style: Excel.ShapeLineStyle.thinThick,
transparency: 0.2,
visible: true,
weight: 4
});
await context.sync();
});
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ShapeLineFormat объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ShapeLineFormatData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.ShapeLineFormatData;