Excel.ChartTitle class

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 a formatação de um título do gráfico, que inclui a formatação de fonte e de preenchimento.

readonly format: Excel.ChartTitleFormat;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Representa a altura, em pontos, do título do gráfico. O valor é null se o título do gráfico não estiver visível.

readonly height: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Especifica o alinhamento horizontal para o título do gráfico.

horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Especifica a distância, em pontos, desde a margem esquerda do título do gráfico até à margem esquerda da área do gráfico. O valor é null se o título do gráfico não estiver visível.

left: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Especifica se o título do gráfico irá sobrepor o gráfico.

overlay: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Representa a posição de título do gráfico. Veja Excel.ChartTitlePosition para obter detalhes.

position: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right";

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Representa um valor booliano que determina se o título do gráfico tiver uma sombra.

showShadow: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Especifica o texto do título do gráfico.

text: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Especifica o ângulo para o qual o texto é orientado para o título do gráfico. O valor deve ser um número inteiro de -90 a 90 ou o número inteiro 180 para texto orientado verticalmente.

textOrientation: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const title = sheet.charts.getItemAt(0).title;
    title.textOrientation = -45;

    await context.sync();
});

Especifica a distância, em pontos, desde a margem superior do título do gráfico até à parte superior da área do gráfico. O valor é null se o título do gráfico não estiver visível.

top: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Especifica o alinhamento vertical do título do gráfico. Veja Excel.ChartTextVerticalAlignment para obter detalhes.

verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Especifica se o título do gráfico está visível.

visible: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Especifica a largura, em pontos, do título do gráfico. O valor é null se o título do gráfico não estiver visível.

readonly width: number;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Obter a subcadeia de um título de gráfico. A quebra de linha '\n' conta um caráter.

getSubstring(start: number, length: number): Excel.ChartFormatString;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let chart = sheet.charts.getItemAt(0);

    // Get first seven characters of the title and color them green.
    chart.title.getSubstring(0, 7).font.color = "Yellow";
    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.ChartTitleLoadOptions): Excel.ChartTitle;

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.ChartTitle;

Parâmetros

Retornos

Exemplos

// Set the text of the chart title to "My Chart" and display it as an overlay on the chart.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    
    chart.title.text= "My Chart"; 
    chart.title.visible=true;
    chart.title.overlay=true;
    
    await context.sync();
    console.log("Char Title Changed");
});

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.ChartTitle;

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.ChartTitleUpdateData, 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.ChartTitle): void;

Parâmetros

Retornos

Define um valor de cadeia de caracteres que representa a fórmula do título do eixo do gráfico usando a notação no estilo A1.

setFormula(formula: string): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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.ChartTitle original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartTitleData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.ChartTitleData;

Retornos