Excel.ChartTitle class

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

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 APIs: ExcelApi 1.1

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

overlay: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

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

text: string;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

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

await Excel.run(async (context) => {
  let sheet = context.workbook.worksheets.getItem("Sample");
  let salesTable = sheet.tables.getItem("SalesTable");

  let dataRange = sheet.getRange("A1:E7");

  // Create an XY scatter chart.
  let chart = sheet.charts.add(Excel.ChartType.xyscatter, dataRange, "Auto");
  chart.title.text = "Bicycle Parts Quarterly Sales";
  chart.setPosition("A36", "F48");

  await context.sync();
});

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

visible: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

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. Você pode passar um objeto simples com as propriedades apropriadas 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 em um objeto carregado existente.

set(properties: Excel.ChartTitle): void;

Parâmetros

Retornos

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

toJSON(): Excel.Interfaces.ChartTitleData;

Retornos