Excel.Line class
Представляет строку внутри листа. Чтобы получить соответствующий Shape объект, используйте .Line.shape
- Extends
Комментарии
Свойства
| begin |
Представляет длину наконечника в начале указанной линии. |
| begin |
Представляет стиль наконечника в начале указанной линии. |
| begin |
Представляет ширину наконечника в начале указанной линии. |
| begin |
Представляет фигуру, к которой привязано начало указанной линии. |
| begin |
Представляет точку соединения, к которой привязано начало соединительной линии. Возвращает, |
| connector |
Представляет тип соединительной линии. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| end |
Представляет длину наконечника в конце указанной линии. |
| end |
Представляет стиль наконечника в конце указанной линии. |
| end |
Представляет ширину наконечника в конце указанной линии. |
| end |
Представляет фигуру, к которой привязан конец указанной линии. |
| end |
Представляет точку соединения, к которой привязан конец соединительной линии. Возвращает, |
| id | Указывает идентификатор фигуры. |
| is |
Указывает, соединено ли начало указанной линии с фигурой. |
| is |
Указывает, связан ли конец указанной линии с фигурой. |
| shape | Возвращает объект, |
Методы
| connect |
Привязывает начало указанного соединителя к указанной фигуре. |
| connect |
Привязывает конец указанного соединителя к указанной фигуре. |
| disconnect |
Отвязывает начало указанного соединителя от фигуры. |
| disconnect |
Отвязывает конец указанного соединителя от фигуры. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
beginArrowheadLength
Представляет длину наконечника в начале указанной линии.
beginArrowheadLength: Excel.ArrowheadLength | "Short" | "Medium" | "Long";Значение свойства
Excel.ArrowheadLength | "Short" | "Medium" | "Long"
Комментарии
beginArrowheadStyle
Представляет стиль наконечника в начале указанной линии.
beginArrowheadStyle: Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open";Значение свойства
Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open"
Комментарии
beginArrowheadWidth
Представляет ширину наконечника в начале указанной линии.
beginArrowheadWidth: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide";Значение свойства
Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide"
Комментарии
beginConnectedShape
Представляет фигуру, к которой привязано начало указанной линии.
readonly beginConnectedShape: Excel.Shape;Значение свойства
Комментарии
beginConnectedSite
Представляет точку соединения, к которой привязано начало соединительной линии. Возвращает, null если начало линии не присоединено ни к одной фигуре.
readonly beginConnectedSite: number;Значение свойства
number
Комментарии
connectorType
Представляет тип соединительной линии.
connectorType: Excel.ConnectorType | "Straight" | "Elbow" | "Curve";Значение свойства
Excel.ConnectorType | "Straight" | "Elbow" | "Curve"
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
endArrowheadLength
Представляет длину наконечника в конце указанной линии.
endArrowheadLength: Excel.ArrowheadLength | "Short" | "Medium" | "Long";Значение свойства
Excel.ArrowheadLength | "Short" | "Medium" | "Long"
Комментарии
endArrowheadStyle
Представляет стиль наконечника в конце указанной линии.
endArrowheadStyle: Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open";Значение свойства
Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open"
Комментарии
endArrowheadWidth
Представляет ширину наконечника в конце указанной линии.
endArrowheadWidth: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide";Значение свойства
Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide"
Комментарии
endConnectedShape
Представляет фигуру, к которой привязан конец указанной линии.
readonly endConnectedShape: Excel.Shape;Значение свойства
Комментарии
endConnectedSite
Представляет точку соединения, к которой привязан конец соединительной линии. Возвращает, null если конец линии не присоединен ни к одной фигуре.
readonly endConnectedSite: number;Значение свойства
number
Комментарии
id
Указывает идентификатор фигуры.
readonly id: string;Значение свойства
string
Комментарии
isBeginConnected
Указывает, соединено ли начало указанной линии с фигурой.
readonly isBeginConnected: boolean;Значение свойства
boolean
Комментарии
isEndConnected
Указывает, связан ли конец указанной линии с фигурой.
readonly isEndConnected: boolean;Значение свойства
boolean
Комментарии
shape
Возвращает объект, Shape связанный со строкой.
readonly shape: Excel.Shape;Значение свойства
Комментарии
Сведения о методе
connectBeginShape(shape, connectionSite)
Привязывает начало указанного соединителя к указанной фигуре.
connectBeginShape(shape: Excel.Shape, connectionSite: number): void;Параметры
- shape
- Excel.Shape
Фигура для подключения.
- connectionSite
-
number
Сайт подключения на фигуре, к которой присоединено начало соединителя. Должно быть целым числом от 0 (включительно) и числом сайтов подключения указанной фигуры (монопольной).
Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml
await Excel.run(async (context) => {
const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
const line = shapes.getItem("StraightLine").line;
line.connectBeginShape(shapes.getItem("Left"), 2);
line.connectEndShape(shapes.getItem("Right"), 0);
await context.sync();
});
connectEndShape(shape, connectionSite)
Привязывает конец указанного соединителя к указанной фигуре.
connectEndShape(shape: Excel.Shape, connectionSite: number): void;Параметры
- shape
- Excel.Shape
Фигура для подключения.
- connectionSite
-
number
Сайт подключения на фигуре, к которой присоединен конец соединителя. Должно быть целым числом от 0 (включительно) и числом сайтов подключения указанной фигуры (монопольной).
Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml
await Excel.run(async (context) => {
const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
const line = shapes.getItem("StraightLine").line;
line.connectBeginShape(shapes.getItem("Left"), 2);
line.connectEndShape(shapes.getItem("Right"), 0);
await context.sync();
});
disconnectBeginShape()
Отвязывает начало указанного соединителя от фигуры.
disconnectBeginShape(): void;Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml
await Excel.run(async (context) => {
const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
const line = shapes.getItem("StraightLine").line;
line.disconnectBeginShape();
line.disconnectEndShape();
await context.sync();
});
disconnectEndShape()
Отвязывает конец указанного соединителя от фигуры.
disconnectEndShape(): void;Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml
await Excel.run(async (context) => {
const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
const line = shapes.getItem("StraightLine").line;
line.disconnectBeginShape();
line.disconnectEndShape();
await context.sync();
});
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.LineLoadOptions): Excel.Line;Параметры
- options
- Excel.Interfaces.LineLoadOptions
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.Line;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Line;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.LineUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.LineUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Excel.Line): void;Параметры
- properties
- Excel.Line
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.Line объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.LineData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Excel.Interfaces.LineData;