Excel.Line class

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

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

readonly beginConnectedShape: Excel.Shape;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

readonly beginConnectedSite: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Representa o tipo de conector de linha.

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

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

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

readonly endConnectedShape: Excel.Shape;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

readonly endConnectedSite: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Especifica o identificador da forma.

readonly id: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

readonly isBeginConnected: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Especifica se o fim da linha especificada está ligado a uma forma.

readonly isEndConnected: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Devolve o Shape objeto associado à linha.

readonly shape: Excel.Shape;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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

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

Parâmetros

Retornos

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();
});

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

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

Parâmetros

Retornos

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();
});

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

disconnectBeginShape(): void;

Retornos

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();
});

Desconecta o final do conector especificado de uma forma.

disconnectEndShape(): void;

Retornos

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();
});

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

Retornos

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

Retornos

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

Retornos

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

Retornos

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

set(properties: Excel.Line): void;

Parâmetros

Retornos

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

toJSON(): Excel.Interfaces.LineData;

Retornos