ExcelScript.ChartAxis interface

Especifica o alinhamento para a legenda de escala do eixo especificado. Veja ExcelScript.ChartTextHorizontalAlignment para detalhes.

getAlignment(): ChartTickLabelAlignment;

Retornos

Especifica o grupo do eixo especificado. Consulte ExcelScript.ChartAxisGroup para obter detalhes.

getAxisGroup(): ChartAxisGroup;

Retornos

Especifica a unidade base para o eixo de categoria especificado.

getBaseTimeUnit(): ChartAxisTimeUnit;

Retornos

Especifica o tipo de eixo de categoria.

getCategoryType(): ChartAxisCategoryType;

Retornos

Especifica o valor da unidade de exibição do eixo personalizado. Para definir essa propriedade, use o SetCustomDisplayUnit(double) método.

getCustomDisplayUnit(): number;

Retornos

Representa a unidade de exibição de eixo. Consulte ExcelScript.ChartAxisDisplayUnit para obter detalhes.

getDisplayUnit(): ChartAxisDisplayUnit;

Retornos

Representa a formatação de um objeto Chart, que inclui formatação de linha e de fonte.

getFormat(): ChartAxisFormat;

Retornos

Especifica a altura, em pontos, do eixo do gráfico. Retorna null se o eixo não estiver visível.

getHeight(): number;

Retornos

Especifica se o eixo dos valores cruza o eixo de categoria entre categorias.

getIsBetweenCategories(): boolean;

Retornos

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.

getLeft(): number;

Retornos

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.

getLinkNumberFormat(): boolean;

Retornos

Especifica a base do logaritmo ao usar escalas logarítmicas.

getLogBase(): number;

Retornos

Retorna um objeto que representa as linhas de grade principais para o eixo especificado.

getMajorGridlines(): ChartGridlines;

Retornos

Exemplos

/**
 * This sample customizes the gridline color on a chart's value axis.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set the gridline color to gray.
  chart.getAxes().getValueAxis().getMajorGridlines().getFormat().getLine().setColor("gray");
}

Especifica o tipo de marca de escala principal para o eixo especificado. Consulte ExcelScript.ChartAxisTickMark para obter detalhes.

getMajorTickMark(): ChartAxisTickMark;

Retornos

Especifica o valor da escala da unidade principal para o eixo da categoria quando a categoryType propriedade é definida como dateAxis.

getMajorTimeUnitScale(): ChartAxisTimeUnit;

Retornos

Especifica o intervalo entre duas marcas de escala principais.

getMajorUnit(): number;

Retornos

Especifica o valor máximo no eixo do valor.

getMaximum(): number;

Retornos

Especifica o valor mínimo no eixo de valores.

getMinimum(): number;

Retornos

Retorna um objeto que representa as linhas de grade secundárias para o eixo especificado.

getMinorGridlines(): ChartGridlines;

Retornos

Especifica o tipo de marca de escala secundária para o eixo especificado. Consulte ExcelScript.ChartAxisTickMark para obter detalhes.

getMinorTickMark(): ChartAxisTickMark;

Retornos

Especifica o valor da escala da unidade secundária para o eixo da categoria quando a categoryType propriedade é definida como dateAxis.

getMinorTimeUnitScale(): ChartAxisTimeUnit;

Retornos

Especifica o intervalo entre duas marcas de escala secundárias.

getMinorUnit(): number;

Retornos

Especifica se um eixo é multinível.

getMultiLevel(): boolean;

Retornos

Especifica o código de formato para a legenda de escala do eixo.

getNumberFormat(): string;

Retornos

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.

getOffset(): number;

Retornos

Especifica a posição do eixo especificada onde o outro eixo se cruza. Consulte ExcelScript.ChartAxisPosition para obter detalhes.

getPosition(): ChartAxisPosition;

Retornos

Especifica a posição do eixo onde o outro eixo se cruza. Você deve usar o SetPositionAt(double) método para definir essa propriedade.

getPositionAt(): number;

Retornos

Especifica se o Excel plota pontos de dados do último para o primeiro.

getReversePlotOrder(): boolean;

Retornos

Especifica o tipo de escala do eixo dos valores. Consulte ExcelScript.ChartAxisScaleType para obter detalhes.

getScaleType(): ChartAxisScaleType;

Retornos

Especifica se o rótulo da unidade de exibição do eixo está visível.

getShowDisplayUnitLabel(): boolean;

Retornos

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.

getTextOrientation(): number;

Retornos

Especifica a posição dos rótulos de marcas de escala no eixo especificado. Consulte ExcelScript.ChartAxisTickLabelPosition para obter detalhes.

getTickLabelPosition(): ChartAxisTickLabelPosition;

Retornos

Especifica o número de categorias ou séries entre rótulos de marcas de escala. Pode ter um valor de 1 a 31999.

getTickLabelSpacing(): number;

Retornos

Especifica o número de categorias ou séries entre as marcas de escala.

getTickMarkSpacing(): number;

Retornos

Representa o título do eixo.

getTitle(): ChartAxisTitle;

Retornos

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.

getTop(): number;

Retornos

Especifica o tipo de eixo. Consulte ExcelScript.ChartAxisType para obter detalhes.

getType(): ChartAxisType;

Retornos

Especifica se o eixo é visível.

getVisible(): boolean;

Retornos

Especifica a largura, em pontos, do eixo do gráfico. Retorna null se o eixo não estiver visível.

getWidth(): number;

Retornos

Especifica o alinhamento para a legenda de escala do eixo especificado. Veja ExcelScript.ChartTextHorizontalAlignment para detalhes.

setAlignment(alignment: ChartTickLabelAlignment): void;

Parâmetros

Retornos

Especifica a unidade base para o eixo de categoria especificado.

setBaseTimeUnit(baseTimeUnit: ChartAxisTimeUnit): void;

Parâmetros

Retornos

Define todos os nomes de categoria para o eixo especificado.

setCategoryNames(sourceData: Range): void;

Parâmetros

Retornos

Especifica o tipo de eixo de categoria.

setCategoryType(categoryType: ChartAxisCategoryType): void;

Parâmetros

Retornos

Definirá a unidade de exibição de eixo a um valor personalizado.

setCustomDisplayUnit(value: number): void;

Parâmetros

Retornos

Representa a unidade de exibição de eixo. Consulte ExcelScript.ChartAxisDisplayUnit para obter detalhes.

setDisplayUnit(displayUnit: ChartAxisDisplayUnit): void;

Parâmetros

Retornos

Exemplos

/**
 * This sample sets the display unit of the value axis to thousands.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set the value axis to display in thousands.
  chart.getAxes().getValueAxis().setDisplayUnit(ExcelScript.ChartAxisDisplayUnit.thousands);
}

Especifica se o eixo dos valores cruza o eixo de categoria entre categorias.

setIsBetweenCategories(isBetweenCategories: boolean): void;

Parâmetros

Retornos

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.

setLinkNumberFormat(linkNumberFormat: boolean): void;

Parâmetros

Retornos

Especifica a base do logaritmo ao usar escalas logarítmicas.

setLogBase(logBase: number): void;

Parâmetros

Retornos

Especifica o tipo de marca de escala principal para o eixo especificado. Consulte ExcelScript.ChartAxisTickMark para obter detalhes.

setMajorTickMark(majorTickMark: ChartAxisTickMark): void;

Parâmetros

Retornos

Especifica o valor da escala da unidade principal para o eixo da categoria quando a categoryType propriedade é definida como dateAxis.

setMajorTimeUnitScale(majorTimeUnitScale: ChartAxisTimeUnit): void;

Parâmetros

Retornos

Especifica o intervalo entre duas marcas de escala principais.

setMajorUnit(majorUnit: number): void;

Parâmetros

Retornos

Especifica o valor máximo no eixo do valor.

setMaximum(maximum: number): void;

Parâmetros

Retornos

Exemplos

/**
 * This sample sets the maximum value on the value axis.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set the maximum value to 10.
  chart.getAxes().getValueAxis().setMaximum(10);
}

Especifica o valor mínimo no eixo de valores.

setMinimum(minimum: number): void;

Parâmetros

Retornos

Exemplos

/**
 * This sample sets the minimum value on the value axis.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set the minimum value to 145.
  chart.getAxes().getValueAxis().setMinimum(145);
}

Especifica o tipo de marca de escala secundária para o eixo especificado. Consulte ExcelScript.ChartAxisTickMark para obter detalhes.

setMinorTickMark(minorTickMark: ChartAxisTickMark): void;

Parâmetros

Retornos

Especifica o valor da escala da unidade secundária para o eixo da categoria quando a categoryType propriedade é definida como dateAxis.

setMinorTimeUnitScale(minorTimeUnitScale: ChartAxisTimeUnit): void;

Parâmetros

Retornos

Especifica o intervalo entre duas marcas de escala secundárias.

setMinorUnit(minorUnit: number): void;

Parâmetros

Retornos

Especifica se um eixo é multinível.

setMultiLevel(multiLevel: boolean): void;

Parâmetros

Retornos

Especifica o código de formato para a legenda de escala do eixo.

setNumberFormat(numberFormat: string): void;

Parâmetros

Retornos

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.

setOffset(offset: number): void;

Parâmetros

Retornos

Especifica a posição do eixo especificada onde o outro eixo se cruza. Consulte ExcelScript.ChartAxisPosition para obter detalhes.

setPosition(position: ChartAxisPosition): void;

Parâmetros

Retornos

Define a posição do eixo especificada onde o outro eixo se cruza.

setPositionAt(value: number): void;

Parâmetros

Retornos

Especifica se o Excel plota pontos de dados do último para o primeiro.

setReversePlotOrder(reversePlotOrder: boolean): void;

Parâmetros

Retornos

Exemplos

/**
 * This sample reverses the plot order of the category axis.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set the category axis to reverse the plot order.
  chart.getAxes().getCategoryAxis().setReversePlotOrder(true);
}

Especifica o tipo de escala do eixo dos valores. Consulte ExcelScript.ChartAxisScaleType para obter detalhes.

setScaleType(scaleType: ChartAxisScaleType): void;

Parâmetros

Retornos

Especifica se o rótulo da unidade de exibição do eixo está visível.

setShowDisplayUnitLabel(showDisplayUnitLabel: boolean): void;

Parâmetros

Retornos

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.

setTextOrientation(textOrientation: number): void;

Parâmetros

Retornos

Especifica a posição dos rótulos de marcas de escala no eixo especificado. Consulte ExcelScript.ChartAxisTickLabelPosition para obter detalhes.

setTickLabelPosition(
            tickLabelPosition: ChartAxisTickLabelPosition
        ): void;

Parâmetros

Retornos

Exemplos

/**
 * This sample sets the tick label position on the category axis.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Set the tick label position to low.
  chart.getAxes().getCategoryAxis().setTickLabelPosition(
    ExcelScript.ChartAxisTickLabelPosition.low
  );
}

Especifica o número de categorias ou séries entre rótulos de marcas de escala. Pode ter um valor de 1 a 31999.

setTickLabelSpacing(tickLabelSpacing: number): void;

Parâmetros

Retornos

Especifica o número de categorias ou séries entre as marcas de escala.

setTickMarkSpacing(tickMarkSpacing: number): void;

Parâmetros

Retornos

Especifica se o eixo é visível.

setVisible(visible: boolean): void;

Parâmetros

Retornos