Excel.ChartTitle class
Representa um objeto ChartTitle de um gráfico.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã 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 é |
| horizontal |
Especifica o alinhamento horizontal para o título do gráfico. |
| left | 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 é |
| overlay | Especifica se o título do gráfico irá sobrepor o gráfico. |
| position | Representa a posição de título do gráfico. Veja |
| show |
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. |
| text |
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. |
| top | 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 é |
| vertical |
Especifica o alinhamento vertical do título do gráfico. Veja |
| 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 é |
Métodos
| get |
Obter a subcadeia de um título de gráfico. A quebra de linha '\n' conta um caráter. |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | 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) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
| set |
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 |
Detalhes da propriedade
context
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
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
Comentários
height
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
number
Comentários
horizontalAlignment
Especifica o alinhamento horizontal para o título do gráfico.
horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";Valor da propriedade
Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"
Comentários
left
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
number
Comentários
overlay
Especifica se o título do gráfico irá sobrepor o gráfico.
overlay: boolean;Valor da propriedade
boolean
Comentários
position
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
Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right"
Comentários
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
text
Especifica o texto do título do gráfico.
text: string;Valor da propriedade
string
Comentários
textOrientation
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
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, 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
number
Comentários
verticalAlignment
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
Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"
Comentários
visible
Especifica se o título do gráfico está visível.
visible: boolean;Valor da propriedade
boolean
Comentários
width
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
number
Comentários
Detalhes do método
getSubstring(start, length)
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
- start
-
number
Iniciar a posição da subcadeia a obter. Indexados com zero.
- length
-
number
Comprimento da subcadeia a obter.
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();
});
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
Fornece opções para as propriedades do objeto a carregar.
Retornos
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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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");
});
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 delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
set(properties, options)
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
- properties
- Excel.Interfaces.ChartTitleUpdateData
Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num 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 que representa a fórmula a definir.
Retornos
void
Comentários
toJSON()
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 original Excel.ChartTitle é 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;