Excel.Line class
Representa una línea dentro de una hoja de cálculo. Para obtener el objeto correspondiente Shape , use Line.shape.
- Extends
Propiedades
| begin |
Representa la longitud de la punta de flecha al comienzo de la línea especificada. |
| begin |
Representa el estilo de la punta de flecha al principio de la línea especificada. |
| begin |
Representa el ancho de la punta de flecha al comienzo de la línea especificada. |
| begin |
Representa la forma a la que está unido el principio de la línea especificada. |
| begin |
Representa el sitio de conexión al que está conectado el principio de un conector. Devuelve |
| connector |
Indica el tipo de conector de la línea. |
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| end |
Representa la longitud de la punta de flecha al final de la línea especificada. |
| end |
Representa el estilo de la punta de flecha al final de la línea especificada. |
| end |
Representa el ancho de la punta de flecha al final de la línea especificada. |
| end |
Representa la forma a la que está unido el final de la línea especificada. |
| end |
Representa el sitio de conexión al que está conectado el extremo de un conector. Devuelve |
| id | Especifica el identificador de la forma. |
| is |
Especifica si el principio de la línea especificada está conectado a una forma. |
| is |
Especifica si el final de la línea especificada está conectado a una forma. |
| shape | Devuelve el |
Métodos
| connect |
Une el principio del conector especificado a una forma específica. |
| connect |
Une el final del conector especificado a una forma específica. |
| disconnect |
Separa el principio del conector especificado de una forma. |
| disconnect |
Separa el final del conector especificado de una forma. |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| set(properties, options) | Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente. |
| toJSON() | Reemplaza el método JavaScript |
Detalles de las propiedades
beginArrowheadLength
Representa la longitud de la punta de flecha al comienzo de la línea especificada.
beginArrowheadLength: Excel.ArrowheadLength | "Short" | "Medium" | "Long";Valor de propiedad
Excel.ArrowheadLength | "Short" | "Medium" | "Long"
Comentarios
beginArrowheadStyle
Representa el estilo de la punta de flecha al principio de la línea especificada.
beginArrowheadStyle: Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open";Valor de propiedad
Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open"
Comentarios
beginArrowheadWidth
Representa el ancho de la punta de flecha al comienzo de la línea especificada.
beginArrowheadWidth: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide";Valor de propiedad
Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide"
Comentarios
beginConnectedShape
Representa la forma a la que está unido el principio de la línea especificada.
readonly beginConnectedShape: Excel.Shape;Valor de propiedad
Comentarios
beginConnectedSite
Representa el sitio de conexión al que está conectado el principio de un conector. Devuelve null cuando el principio de la línea no está asociado a ninguna forma.
readonly beginConnectedSite: number;Valor de propiedad
number
Comentarios
connectorType
Indica el tipo de conector de la línea.
connectorType: Excel.ConnectorType | "Straight" | "Elbow" | "Curve";Valor de propiedad
Excel.ConnectorType | "Straight" | "Elbow" | "Curve"
Comentarios
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
endArrowheadLength
Representa la longitud de la punta de flecha al final de la línea especificada.
endArrowheadLength: Excel.ArrowheadLength | "Short" | "Medium" | "Long";Valor de propiedad
Excel.ArrowheadLength | "Short" | "Medium" | "Long"
Comentarios
endArrowheadStyle
Representa el estilo de la punta de flecha al final de la línea especificada.
endArrowheadStyle: Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open";Valor de propiedad
Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open"
Comentarios
endArrowheadWidth
Representa el ancho de la punta de flecha al final de la línea especificada.
endArrowheadWidth: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide";Valor de propiedad
Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide"
Comentarios
endConnectedShape
Representa la forma a la que está unido el final de la línea especificada.
readonly endConnectedShape: Excel.Shape;Valor de propiedad
Comentarios
endConnectedSite
Representa el sitio de conexión al que está conectado el extremo de un conector. Devuelve null cuando el final de la línea no está asociado a ninguna forma.
readonly endConnectedSite: number;Valor de propiedad
number
Comentarios
id
Especifica el identificador de la forma.
readonly id: string;Valor de propiedad
string
Comentarios
isBeginConnected
Especifica si el principio de la línea especificada está conectado a una forma.
readonly isBeginConnected: boolean;Valor de propiedad
boolean
Comentarios
isEndConnected
Especifica si el final de la línea especificada está conectado a una forma.
readonly isEndConnected: boolean;Valor de propiedad
boolean
Comentarios
shape
Devuelve el Shape objeto asociado a la línea.
readonly shape: Excel.Shape;Valor de propiedad
Comentarios
Detalles del método
connectBeginShape(shape, connectionSite)
Une el principio del conector especificado a una forma específica.
connectBeginShape(shape: Excel.Shape, connectionSite: number): void;Parámetros
- shape
- Excel.Shape
La forma que se va a conectar.
- connectionSite
-
number
El sitio de conexión en la forma a la que está conectado el principio del conector. Debe ser un entero entre 0 (incluido) y el recuento de sitios de conexión de la forma especificada (exclusivo).
Devoluciones
void
Comentarios
Ejemplos
// 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)
Une el final del conector especificado a una forma específica.
connectEndShape(shape: Excel.Shape, connectionSite: number): void;Parámetros
- shape
- Excel.Shape
La forma que se va a conectar.
- connectionSite
-
number
El sitio de conexión en la forma a la que está unido el extremo del conector. Debe ser un entero entre 0 (incluido) y el recuento de sitios de conexión de la forma especificada (exclusivo).
Devoluciones
void
Comentarios
Ejemplos
// 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()
Separa el principio del conector especificado de una forma.
disconnectBeginShape(): void;Devoluciones
void
Comentarios
Ejemplos
// 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()
Separa el final del conector especificado de una forma.
disconnectEndShape(): void;Devoluciones
void
Comentarios
Ejemplos
// 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)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(options?: Excel.Interfaces.LineLoadOptions): Excel.Line;Parámetros
- options
- Excel.Interfaces.LineLoadOptions
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames?: string | string[]): Excel.Line;Parámetros
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
Devoluciones
load(propertyNamesAndPaths)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Line;Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
set(properties, options)
Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.
set(properties: Interfaces.LineUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.LineUpdateData
Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el que se llama al método.
- options
- OfficeExtension.UpdateOptions
Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.
Devoluciones
void
set(properties)
Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.
set(properties: Excel.Line): void;Parámetros
- properties
- Excel.Line
Devoluciones
void
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.Line es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.LineData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Excel.Interfaces.LineData;