Compartilhar via

Excel.Line class

  • Referência
Pacote:
excel

Representa uma linha dentro de uma planilha. Para obter o objeto correspondente Shape , use Line.shape.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Propriedades

beginArrowheadLength

Representa o comprimento da ponta da seta no início da linha especificada.
beginArrowheadStyle

Representa o estilo da ponta de seta no início da linha especificada.
beginArrowheadWidth

Representa a largura da ponta da seta no início da linha especificada.
beginConnectedShape

Representa a forma na qual o início da linha especificada está conectado.
beginConnectedSite

Representa o site de conexão ao qual o início de um conector está conectado. Retorna null quando o início da linha não é anexado a nenhuma forma.
connectorType

Representa o tipo de conector de linha.
context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
endArrowheadLength

Representa o comprimento da ponta de seta no final da linha especificada.
endArrowheadStyle

Representa o estilo da ponta de seta no final da linha especificada.
endArrowheadWidth

Representa a largura da ponta de seta no final da linha especificada.
endConnectedShape

Representa a forma na qual o final da linha especificada está conectado.
endConnectedSite

Representa o site de conexão ao qual o final de um conector está conectado. Retorna null quando o final da linha não é anexado a nenhuma forma.
id

Especifica o identificador de forma.
isBeginConnected

Especifica se o início da linha especificada está conectado a uma forma.
isEndConnected

Especifica se o final da linha especificada está conectado a uma forma.
shape

Retorna o Shape objeto associado à linha.

Métodos

connectBeginShape(shape, connectionSite)

Conecta o início do conector especificado a uma forma específica.
connectEndShape(shape, connectionSite)

Anexa o final do conector especificado a uma forma específica.
disconnectBeginShape()

Desconecta o início do conector especificado de uma forma.
disconnectEndShape()

Desconecta o final do conector especificado de uma forma.
load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.Line original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.LineData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

beginArrowheadLength

Representa o comprimento da ponta da seta no início da linha especificada.

beginArrowheadLength: Excel.ArrowheadLength | "Short" | "Medium" | "Long";

Valor da propriedade

Excel.ArrowheadLength | "Short" | "Medium" | "Long"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

beginArrowheadStyle

Representa o estilo da ponta de seta no início da linha especificada.

beginArrowheadStyle: Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open";

Valor da propriedade

Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

beginArrowheadWidth

Representa a largura da ponta da seta no início da linha especificada.

beginArrowheadWidth: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide";

Valor da propriedade

Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

beginConnectedShape

Representa a forma na qual o início da linha especificada está conectado.

readonly beginConnectedShape: Excel.Shape;

Valor da propriedade

Excel.Shape

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

beginConnectedSite

Representa o site de conexão ao qual o início de um conector está conectado. Retorna null quando o início da linha não é anexado a nenhuma forma.

readonly beginConnectedSite: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

connectorType

Representa o tipo de conector de linha.

connectorType: Excel.ConnectorType | "Straight" | "Elbow" | "Curve";

Valor da propriedade

Excel.ConnectorType | "Straight" | "Elbow" | "Curve"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

endArrowheadLength

Representa o comprimento da ponta de seta no final da linha especificada.

endArrowheadLength: Excel.ArrowheadLength | "Short" | "Medium" | "Long";

Valor da propriedade

Excel.ArrowheadLength | "Short" | "Medium" | "Long"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

endArrowheadStyle

Representa o estilo da ponta de seta no final da linha especificada.

endArrowheadStyle: Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open";

Valor da propriedade

Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

endArrowheadWidth

Representa a largura da ponta de seta no final da linha especificada.

endArrowheadWidth: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide";

Valor da propriedade

Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

endConnectedShape

Representa a forma na qual o final da linha especificada está conectado.

readonly endConnectedShape: Excel.Shape;

Valor da propriedade

Excel.Shape

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

endConnectedSite

Representa o site de conexão ao qual o final de um conector está conectado. Retorna null quando o final da linha não é anexado a nenhuma forma.

readonly endConnectedSite: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

id

Especifica o identificador de forma.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

isBeginConnected

Especifica se o início da linha especificada está conectado a uma forma.

readonly isBeginConnected: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

isEndConnected

Especifica se o final da linha especificada está conectado a uma forma.

readonly isEndConnected: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

shape

Retorna o Shape objeto associado à linha.

readonly shape: Excel.Shape;

Valor da propriedade

Excel.Shape

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Detalhes do método

connectBeginShape(shape, connectionSite)

Conecta o início do conector especificado a uma forma específica.

connectBeginShape(shape: Excel.Shape, connectionSite: number): void;

Parâmetros

shape
Excel.Shape

A forma a ser conectada.

connectionSite

number

O site de conexão na forma à qual o início do conector está anexado. Deve ser um inteiro entre 0 (inclusivo) e a contagem de site de conexão da forma especificada (exclusiva).

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Exemplos

// 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)

Anexa o final do conector especificado a uma forma específica.

connectEndShape(shape: Excel.Shape, connectionSite: number): void;

Parâmetros

shape
Excel.Shape

A forma a ser conectada.

connectionSite

number

O site de conexão na forma à qual a extremidade do conector está anexada. Deve ser um inteiro entre 0 (inclusivo) e a contagem de site de conexão da forma especificada (exclusiva).

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Exemplos

// 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()

Desconecta o início do conector especificado de uma forma.

disconnectBeginShape(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Exemplos

// 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()

Desconecta o final do conector especificado de uma forma.

disconnectEndShape(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Exemplos

// 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)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Excel.Interfaces.LineLoadOptions): Excel.Line;

Parâmetros

options
Excel.Interfaces.LineLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.Line

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): Excel.Line;

Parâmetros

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Excel.Line

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Line;

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.Line

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

properties
Excel.Interfaces.LineUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Excel.Line): void;

Parâmetros

properties
Excel.Line

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.Line original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.LineData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.LineData;

Retornos

Excel.Interfaces.LineData