Excel.ChartTitle interface

Representa um objeto ChartTitle de um gráfico.

Propriedades

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. NULL se o título do gráfico não estiver visível.

horizontalAlignment

Especifica o alinhamento horizontal do 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. NULL se o título do gráfico não estiver visível.

overlay

Especifica se o título do gráfico será sobreposto ao gráfico.

position

Representa a posição de título do gráfico. Consulte Excel. ChartTitlePosition para obter 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 no 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. NULL se o título do gráfico não estiver visível.

verticalAlignment

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

visible

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

width

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

Métodos

getSubstring(start, length)

Obter a subcadeia de caracteres de um título de gráfico. Quebra de linha '\n ' também conta um caractere.

load(propertyNames)

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

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.

Detalhes da propriedade

format

Representa a formatação de um título do gráfico, que inclui a formatação de fonte e de preenchimento.

readonly format: ChartTitleFormat;

Valor da propriedade

height

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

readonly height: number;

Valor da propriedade

number

horizontalAlignment

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

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

Valor da propriedade

| ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"

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. NULL se o título do gráfico não estiver visível.

left: number;

Valor da propriedade

number

overlay

Especifica se o título do gráfico será sobreposto ao gráfico.

overlay: boolean;

Valor da propriedade

boolean

position

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

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

Valor da propriedade

| ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right"

showShadow

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

showShadow: boolean;

Valor da propriedade

boolean

text

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

text: string;

Valor da propriedade

string

textOrientation

Especifica o ângulo no 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

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let 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. NULL se o título do gráfico não estiver visível.

top: number;

Valor da propriedade

number

verticalAlignment

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

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

Valor da propriedade

| ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"

visible

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

visible: boolean;

Valor da propriedade

boolean

width

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

readonly width: number;

Valor da propriedade

number

Detalhes do método

getSubstring(start, length)

Obter a subcadeia de caracteres de um título de gráfico. Quebra de linha '\n ' também conta um caractere.

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

Parâmetros

start
number

Posição inicial da subcadeia de caracteres a ser recuperada. Posição inicial com 0.

length
number

Comprimento da subcadeia de caracteres a ser recuperada.

Retornos

Exemplos

async function main(context: Excel.RequestContext) {
    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(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[]): void;

Parâmetros

propertyNames
string | string[]

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

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