Excel.ChartAxis class
Representa um único eixo em um gráfico.
- Extends
Comentários
[Conjunto de apis: ExcelApi 1.1]
Propriedades
| alignment | Especifica o alinhamento para a legenda de escala do eixo especificado. Veja |
| axis |
Especifica o grupo do eixo especificado. Consulte |
| base |
Especifica a unidade base para o eixo de categoria especificado. |
| category |
Especifica o tipo de eixo de categoria. |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| custom |
Especifica o valor da unidade de exibição do eixo personalizado. Para definir essa propriedade, use o |
| display |
Representa a unidade de exibição de eixo. Consulte |
| format | Representa a formatação de um objeto Chart, que inclui formatação de linha e de fonte. |
| height | Especifica a altura, em pontos, do eixo do gráfico. Retorna |
| is |
Especifica se o eixo dos valores cruza o eixo de categoria entre categorias. |
| left | Especifica a distância, em pontos, da borda esquerda do eixo à esquerda da área do gráfico. Retorna |
| link |
Especifica se o formato de número está vinculado às células. Se |
| log |
Especifica a base do logaritmo ao usar escalas logarítmicas. |
| major |
Retorna um objeto que representa as linhas de grade principais para o eixo especificado. |
| major |
Especifica o tipo de marca de escala principal para o eixo especificado. Consulte |
| major |
Especifica o valor da escala da unidade principal para o eixo da categoria quando a |
| major |
Representa o intervalo entre as duas principais marcas de escala. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia. O valor retornado sempre é um número. |
| maximum | Representa o valor máximo no eixo dos valores. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número. |
| minimum | Representa o valor mínimo no eixo dos valores. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número. |
| minor |
Retorna um objeto que representa as linhas de grade secundárias para o eixo especificado. |
| minor |
Especifica o tipo de marca de escala secundária para o eixo especificado. Consulte |
| minor |
Especifica o valor da escala da unidade secundária para o eixo da categoria quando a |
| minor |
Representa o intervalo entre as duas marcas de escala secundárias. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número. |
| multi |
Especifica se um eixo é multinível. |
| number |
Especifica o código de formato para a legenda de escala do eixo. |
| offset | Especifica a distância entre os níveis de legendas e a distância entre o primeiro nível e a linha do eixo. O valor deve ser um inteiro de 0 a 1000. |
| position | Especifica a posição do eixo especificada onde o outro eixo se cruza. Consulte |
| position |
Especifica a posição do eixo onde o outro eixo se cruza. Você deve usar o |
| reverse |
Especifica se o Excel plota pontos de dados do último para o primeiro. |
| scale |
Especifica o tipo de escala do eixo dos valores. Consulte |
| show |
Especifica se o rótulo da unidade de exibição do eixo está visível. |
| text |
Especifica o ângulo no qual o texto é orientado para o rótulo de escala do eixo do gráfico. O valor deve ser um inteiro de -90 a 90 ou o inteiro 180 para texto orientado verticalmente. |
| tick |
Especifica a posição dos rótulos de marcas de escala no eixo especificado. Consulte |
| tick |
Especifica o número de categorias ou séries entre rótulos de marcas de escala. Pode ser um valor de 1 a 31999 ou uma cadeia de caracteres vazia para configuração automática. O valor retornado sempre é um número. |
| tick |
Especifica o número de categorias ou séries entre as marcas de escala. |
| title | Representa o título do eixo. |
| top | Especifica a distância, em pontos, da borda superior do eixo até a parte superior da área do gráfico. Retorna |
| type | Especifica o tipo de eixo. Consulte |
| visible | Especifica se o eixo é visível. |
| width | Especifica a largura, em pontos, do eixo do gráfico. Retorna |
Métodos
| 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. 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. |
| set |
Define todos os nomes de categoria para o eixo especificado. |
| set |
Definirá a unidade de exibição de eixo a um valor personalizado. |
| set |
Define a posição do eixo especificada onde o outro eixo se cruza. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
alignment
Especifica o alinhamento para a legenda de escala do eixo especificado. Veja Excel.ChartTextHorizontalAlignment para detalhes.
alignment: Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right";
Valor da propriedade
Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right"
Comentários
[Conjunto de apis: ExcelApi 1.8]
axisGroup
Especifica o grupo do eixo especificado. Consulte Excel.ChartAxisGroup para obter detalhes.
readonly axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";
Valor da propriedade
Excel.ChartAxisGroup | "Primary" | "Secondary"
Comentários
[Conjunto de apis: ExcelApi 1.7]
baseTimeUnit
Especifica a unidade base para o eixo de categoria especificado.
baseTimeUnit: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";
Valor da propriedade
Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"
Comentários
[Conjunto de apis: ExcelApi 1.7]
categoryType
Especifica o tipo de eixo de categoria.
categoryType: Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis";
Valor da propriedade
Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis"
Comentários
[Conjunto de apis: ExcelApi 1.7]
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
customDisplayUnit
Especifica o valor da unidade de exibição do eixo personalizado. Para definir essa propriedade, use o SetCustomDisplayUnit(double) método.
readonly customDisplayUnit: number;
Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.7]
displayUnit
Representa a unidade de exibição de eixo. Consulte Excel.ChartAxisDisplayUnit para obter detalhes.
displayUnit: Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom";
Valor da propriedade
Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom"
Comentários
[Conjunto de apis: ExcelApi 1.7]
format
Representa a formatação de um objeto Chart, que inclui formatação de linha e de fonte.
readonly format: Excel.ChartAxisFormat;
Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.1]
height
Especifica a altura, em pontos, do eixo do gráfico. Retorna null se o eixo não estiver visível.
readonly height: number;
Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.7]
isBetweenCategories
Especifica se o eixo dos valores cruza o eixo de categoria entre categorias.
isBetweenCategories: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.8]
left
Especifica a distância, em pontos, da borda esquerda do eixo à esquerda da área do gráfico. Retorna null se o eixo não estiver visível.
readonly left: number;
Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.7]
linkNumberFormat
Especifica se o formato de número está vinculado às células. Se true, o formato do número mudará nos rótulos quando mudar nas células.
linkNumberFormat: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.9]
logBase
Especifica a base do logaritmo ao usar escalas logarítmicas.
logBase: number;
Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.7]
majorGridlines
Retorna um objeto que representa as linhas de grade principais para o eixo especificado.
readonly majorGridlines: Excel.ChartGridlines;
Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.1]
majorTickMark
Especifica o tipo de marca de escala principal para o eixo especificado. Consulte Excel.ChartAxisTickMark para obter detalhes.
majorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside";
Valor da propriedade
Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"
Comentários
[Conjunto de apis: ExcelApi 1.7]
majorTimeUnitScale
Especifica o valor da escala da unidade principal para o eixo da categoria quando a categoryType propriedade é definida como dateAxis.
majorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";
Valor da propriedade
Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"
Comentários
[Conjunto de apis: ExcelApi 1.7]
majorUnit
Representa o intervalo entre as duas principais marcas de escala. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia. O valor retornado sempre é um número.
majorUnit: any;
Valor da propriedade
any
Comentários
[Conjunto de apis: ExcelApi 1.1]
maximum
Representa o valor máximo no eixo dos valores. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número.
maximum: any;
Valor da propriedade
any
Comentários
[Conjunto de apis: ExcelApi 1.1]
minimum
Representa o valor mínimo no eixo dos valores. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número.
minimum: any;
Valor da propriedade
any
Comentários
[Conjunto de apis: ExcelApi 1.1]
minorGridlines
Retorna um objeto que representa as linhas de grade secundárias para o eixo especificado.
readonly minorGridlines: Excel.ChartGridlines;
Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.1]
minorTickMark
Especifica o tipo de marca de escala secundária para o eixo especificado. Consulte Excel.ChartAxisTickMark para obter detalhes.
minorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside";
Valor da propriedade
Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"
Comentários
[Conjunto de apis: ExcelApi 1.7]
minorTimeUnitScale
Especifica o valor da escala da unidade secundária para o eixo da categoria quando a categoryType propriedade é definida como dateAxis.
minorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";
Valor da propriedade
Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"
Comentários
[Conjunto de apis: ExcelApi 1.7]
minorUnit
Representa o intervalo entre as duas marcas de escala secundárias. Pode ser definido como um valor numérico ou uma cadeia de caracteres vazia (para valores automáticos de eixo). O valor retornado sempre é um número.
minorUnit: any;
Valor da propriedade
any
Comentários
[Conjunto de apis: ExcelApi 1.1]
multiLevel
Especifica se um eixo é multinível.
multiLevel: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.8]
numberFormat
Especifica o código de formato para a legenda de escala do eixo.
numberFormat: string;
Valor da propriedade
string
Comentários
[Conjunto de apis: ExcelApi 1.8]
offset
Especifica a distância entre os níveis de legendas e a distância entre o primeiro nível e a linha do eixo. O valor deve ser um inteiro de 0 a 1000.
offset: number;
Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.8]
position
Especifica a posição do eixo especificada onde o outro eixo se cruza. Consulte Excel.ChartAxisPosition para obter detalhes.
position: Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom";
Valor da propriedade
Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom"
Comentários
[Conjunto de apis: ExcelApi 1.8]
positionAt
Especifica a posição do eixo onde o outro eixo se cruza. Você deve usar o SetPositionAt(double) método para definir essa propriedade.
readonly positionAt: number;
Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.8]
reversePlotOrder
Especifica se o Excel plota pontos de dados do último para o primeiro.
reversePlotOrder: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
scaleType
Especifica o tipo de escala do eixo dos valores. Consulte Excel.ChartAxisScaleType para obter detalhes.
scaleType: Excel.ChartAxisScaleType | "Linear" | "Logarithmic";
Valor da propriedade
Excel.ChartAxisScaleType | "Linear" | "Logarithmic"
Comentários
[Conjunto de apis: ExcelApi 1.7]
showDisplayUnitLabel
Especifica se o rótulo da unidade de exibição do eixo está visível.
showDisplayUnitLabel: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
textOrientation
Especifica o ângulo no qual o texto é orientado para o rótulo de escala do eixo do gráfico. O valor deve ser um inteiro de -90 a 90 ou o inteiro 180 para texto orientado verticalmente.
textOrientation: any;
Valor da propriedade
any
Comentários
[Conjunto de apis: ExcelApi 1.8]
tickLabelPosition
Especifica a posição dos rótulos de marcas de escala no eixo especificado. Consulte Excel.ChartAxisTickLabelPosition para obter detalhes.
tickLabelPosition: Excel.ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None";
Valor da propriedade
Excel.ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None"
Comentários
[Conjunto de apis: ExcelApi 1.7]
tickLabelSpacing
Especifica o número de categorias ou séries entre rótulos de marcas de escala. Pode ser um valor de 1 a 31999 ou uma cadeia de caracteres vazia para configuração automática. O valor retornado sempre é um número.
tickLabelSpacing: any;
Valor da propriedade
any
Comentários
[Conjunto de apis: ExcelApi 1.7]
tickMarkSpacing
Especifica o número de categorias ou séries entre as marcas de escala.
tickMarkSpacing: number;
Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.7]
title
Representa o título do eixo.
readonly title: Excel.ChartAxisTitle;
Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.1]
top
Especifica a distância, em pontos, da borda superior do eixo até a parte superior da área do gráfico. Retorna null se o eixo não estiver visível.
readonly top: number;
Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.7]
type
Especifica o tipo de eixo. Consulte Excel.ChartAxisType para obter detalhes.
readonly type: Excel.ChartAxisType | "Invalid" | "Category" | "Value" | "Series";
Valor da propriedade
Excel.ChartAxisType | "Invalid" | "Category" | "Value" | "Series"
Comentários
[Conjunto de apis: ExcelApi 1.7]
visible
Especifica se o eixo é visível.
visible: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
width
Especifica a largura, em pontos, do eixo do gráfico. Retorna null se o eixo não estiver visível.
readonly width: number;
Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.7]
Detalhes do método
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.ChartAxisLoadOptions): Excel.ChartAxis;
Parâmetros
Fornece opções para quais propriedades do objeto devem ser carregadas.
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.ChartAxis;
Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
Retornos
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.ChartAxis;
Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.
Retornos
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.ChartAxisUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Excel.Interfaces.ChartAxisUpdateData
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 de propriedades tentar definir 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.ChartAxis): void;
Parâmetros
- properties
- Excel.ChartAxis
Retornos
void
setCategoryNames(sourceData)
Define todos os nomes de categoria para o eixo especificado.
setCategoryNames(sourceData: Range): void;
Parâmetros
- sourceData
- Excel.Range
O Range objeto correspondente aos dados de origem.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.7]
setCustomDisplayUnit(value)
Definirá a unidade de exibição de eixo a um valor personalizado.
setCustomDisplayUnit(value: number): void;
Parâmetros
- value
-
number
Valor personalizado da unidade de exibição.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.7]
setPositionAt(value)
Define a posição do eixo especificada onde o outro eixo se cruza.
setPositionAt(value: number): void;
Parâmetros
- value
-
number
Valor personalizado do ponto de passagem.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.8]
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 original Excel.ChartAxis é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartAxisData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.ChartAxisData;