Excel.ChartTitle class

Referência

Pacote:: excel

Representa um objeto ChartTitle de um gráfico.

Extends: OfficeExtension.ClientObject

Comentários

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
format	Representa a formatação de um título do gráfico, que inclui a formatação de fonte e de preenchimento.
height	Representa a altura, em pontos, do título do gráfico. O valor será `null` se o título do gráfico não estiver visível.
horizontalAlignment	Especifica o alinhamento horizontal para o título do gráfico.
left	Especifica a distância, em pontos, da borda esquerda do título do gráfico até a borda esquerda da área do gráfico. O valor será `null` se o título do gráfico não estiver visível.
overlay	Especifica se o título do gráfico sobreporá o gráfico.
position	Representa a posição de título do gráfico. Confira `Excel.ChartTitlePosition` detalhes.
showShadow	Representa um valor booliano que determina se o título do gráfico tiver uma sombra.
text	Especifica o texto do título do gráfico.
textOrientation	Especifica o ângulo para o qual o texto é orientado para o título do gráfico. O valor deve ser um inteiro de -90 a 90 ou o inteiro 180 para texto orientado verticalmente.
top	Especifica a distância, em pontos, da borda superior do título do gráfico até a parte superior da área do gráfico. O valor será `null` se o título do gráfico não estiver visível.
verticalAlignment	Especifica o alinhamento vertical do título do gráfico. Confira `Excel.ChartTextVerticalAlignment` detalhes.
visible	Especifica se o título do gráfico está visível.
width	Especifica a largura, em pontos, do título do gráfico. O valor será `null` se o título do gráfico não estiver visível.

Métodos

getSubstring(start, length)	Obtenha a substring de um título de gráfico. A quebra de linha '\n' conta um caractere.
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.
setFormula(formula)	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.
toJSON()	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 Excel.ChartTitle original é um objeto API, o `toJSON` método retorna um objeto JavaScript simples (digitado como `Excel.Interfaces.ChartTitleData`) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

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

format

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

Excel.ChartTitleFormat

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

height

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

readonly height: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

horizontalAlignment

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 ]

left

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

left: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

overlay

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

overlay: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

position

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

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

showShadow

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

showShadow: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

text

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

text: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

textOrientation

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

textOrientation: number;

Valor da propriedade

number

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

top

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

top: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

verticalAlignment

Especifica o alinhamento vertical do título do gráfico. Confira Excel.ChartTextVerticalAlignment detalhes.

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

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

visible

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

visible: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

width

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

readonly width: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Detalhes do método

getSubstring(start, length)

Obtenha a substring de um título de gráfico. A quebra de linha '\n' conta um caractere.

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

Parâmetros

start: number

Posição inicial da substring a ser recuperada. Indexados com zero.

length: number

Comprimento da substring a ser recuperada.

Retornos

Excel.ChartFormatString

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

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.ChartTitleLoadOptions): Excel.ChartTitle;

Parâmetros

options: Excel.Interfaces.ChartTitleLoadOptions

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

Retornos

Excel.ChartTitle

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

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

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

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

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

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.ChartTitleUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties: Excel.Interfaces.ChartTitleUpdateData

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

Parâmetros

properties: Excel.ChartTitle

Retornos

void

setFormula(formula)

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

formula: string

Uma cadeia de caracteres que representa a fórmula a ser definida.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

toJSON(): Excel.Interfaces.ChartTitleData;

Retornos

Excel.Interfaces.ChartTitleData

Excel.ChartTitle class

Comentários

Propriedades

Métodos

Detalhes da propriedade

context

Valor da propriedade

format

Valor da propriedade

Comentários

height

Valor da propriedade

Comentários

horizontalAlignment

Valor da propriedade

Comentários

left

Valor da propriedade

Comentários

overlay

Valor da propriedade

Comentários

position

Valor da propriedade

Comentários

showShadow

Valor da propriedade

Comentários

text

Valor da propriedade

Comentários

textOrientation

Valor da propriedade

Comentários

Exemplos

top

Valor da propriedade

Comentários

verticalAlignment

Valor da propriedade

Comentários

visible

Valor da propriedade

Comentários

width

Valor da propriedade

Comentários

Detalhes do método

getSubstring(start, length)

Parâmetros

Retornos

Comentários

Exemplos

load(options)

Parâmetros

Retornos

load(propertyNames)

Parâmetros

Retornos

Exemplos

load(propertyNamesAndPaths)

Parâmetros

Retornos

set(properties, options)

Parâmetros

Retornos

set(properties)

Parâmetros

Retornos

setFormula(formula)

Parâmetros

Retornos

Comentários

toJSON()

Retornos

Comentários

Recursos adicionais