Excel.Line class

Referencia

Paquete:: excel

Representa una línea dentro de una hoja de cálculo. Para obtener el objeto correspondiente Shape , use Line.shape.

Extends: OfficeExtension.ClientObject

Comentarios

Propiedades

beginArrowheadLength	Representa la longitud de la punta de flecha al comienzo de la línea especificada.
beginArrowheadStyle	Representa el estilo de la punta de flecha al principio de la línea especificada.
beginArrowheadWidth	Representa el ancho de la punta de flecha al comienzo de la línea especificada.
beginConnectedShape	Representa la forma a la que está unido el principio de la línea especificada.
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.
connectorType	Indica el tipo de conector de la línea.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
endArrowheadLength	Representa la longitud de la punta de flecha al final de la línea especificada.
endArrowheadStyle	Representa el estilo de la punta de flecha al final de la línea especificada.
endArrowheadWidth	Representa el ancho de la punta de flecha al final de la línea especificada.
endConnectedShape	Representa la forma a la que está unido el final de la línea especificada.
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.
id	Especifica el identificador de forma.
isBeginConnected	Especifica si el principio de la línea especificada está conectado a una forma.
isEndConnected	Especifica si el final de la línea especificada está conectado a una forma.
shape	Devuelve el `Shape` objeto asociado a la línea.

Métodos

connectBeginShape(shape, connectionSite)	Une el principio del conector especificado a una forma específica.
connectEndShape(shape, connectionSite)	Une el final del conector especificado a una forma específica.
disconnectBeginShape()	Separa el principio del conector especificado de una forma.
disconnectEndShape()	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 `context.sync()` antes de leer las propiedades.
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(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
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 de API del mismo tipo.
set(properties)	Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
toJSON()	Invalida el método JavaScript `toJSON()` para proporcionar una salida más útil cuando se pasa un objeto de API a `JSON.stringify()`. (`JSON.stringify`a su vez, llama al `toJSON` método del objeto que se le pasa). Mientras que el objeto Excel.Line original es un objeto de API, el `toJSON` método devuelve un objeto JavaScript sin formato (escrito como `Excel.Interfaces.LineData`) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

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

[ Conjunto de API: ExcelApi 1.9 ]

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

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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

[ Conjunto de API: ExcelApi 1.9 ]

beginConnectedShape

Representa la forma a la que está unido el principio de la línea especificada.

readonly beginConnectedShape: Excel.Shape;

Valor de propiedad

Excel.Shape

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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

[ Conjunto de API: ExcelApi 1.9 ]

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

[ Conjunto de API: ExcelApi 1.9 ]

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

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

[ Conjunto de API: ExcelApi 1.9 ]

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

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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

[ Conjunto de API: ExcelApi 1.9 ]

endConnectedShape

Representa la forma a la que está unido el final de la línea especificada.

readonly endConnectedShape: Excel.Shape;

Valor de propiedad

Excel.Shape

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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

[ Conjunto de API: ExcelApi 1.9 ]

id

Especifica el identificador de forma.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

isBeginConnected

Especifica si el principio de la línea especificada está conectado a una forma.

readonly isBeginConnected: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

isEndConnected

Especifica si el final de la línea especificada está conectado a una forma.

readonly isEndConnected: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

shape

Devuelve el Shape objeto asociado a la línea.

readonly shape: Excel.Shape;

Valor de propiedad

Excel.Shape

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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

Forma que se va a conectar.

connectionSite: number

Sitio de conexión en la forma a la que está conectado el principio del conector. Debe ser un entero entre 0 (inclusivo) y el recuento de sitio de conexión de la forma especificada (exclusiva).

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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

Forma que se va a conectar.

connectionSite: number

Sitio de conexión en la forma a la que está conectado el final del conector. Debe ser un entero entre 0 (inclusivo) y el recuento de sitio de conexión de la forma especificada (exclusiva).

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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

[ Conjunto de API: ExcelApi 1.9 ]

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

[ Conjunto de API: ExcelApi 1.9 ]

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

Excel.Line

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

Excel.Line

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

Excel.Line

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 de API del mismo tipo.

set(properties: Interfaces.LineUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties: Excel.Interfaces.LineUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al 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, en función de un objeto cargado existente.

set(properties: Excel.Line): void;

Parámetros

properties: Excel.Line

Devoluciones

void

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.Line original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.LineData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.LineData;

Devoluciones

Excel.Interfaces.LineData