Excel.ChartAxis class

Пакет:
excel

Представляет одну ось на диаграмме.

Extends
OfficeExtension.ClientObject

Комментарии

Набор API: ExcelApi 1.1

Используется

Свойства

alignment

Выравнивание заданной метки деления оси. Смотрите Excel.ChartTextHorizontalAlignment подробности.
axisGroup

Указывает группу для заданной оси. См. Excel.ChartAxisGroup дополнительные сведения.
baseTimeUnit

Задает базовую единицу для указанной оси категории.
categoryType

Определяет тип оси категорий.
context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
customDisplayUnit

Указывает значение единицы измерения пользовательской оси. Чтобы задать это свойство, используйте метод.SetCustomDisplayUnit(double)
displayUnit

Представляет отображаемую единицу измерения оси. См. Excel.ChartAxisDisplayUnit дополнительные сведения.
format

Представляет форматирование объекта диаграммы, в том числе форматирование линий и шрифта.
height

Указывает высоту оси диаграммы (в точках). Возвращает значение null , если ось не видна.
isBetweenCategories

Указывает, пересекает ли ось значений ось категорий между категориями.
left

Определяет расстояние (в точках) от левого края оси до левой области диаграммы. Возвращает значение null , если ось не видна.
linkNumberFormat

Указывает, связан ли числовой формат с ячейками. Если true, то числовой формат будет изменяться в метках при изменении в ячейках.
logBase

Определяет основание логарифма при использовании логарифмических шкал.
majorGridlines

Возвращает объект, представляющий основные линии сетки для указанной оси.
majorTickMark

Указывает тип основного деления для указанной оси. См. Excel.ChartAxisTickMark дополнительные сведения.
majorTimeUnitScale

Задает значение масштаба основной единицы для оси категории, если свойство categoryType имеет значение dateAxis.
majorUnit

Обозначает интервал между двумя основными делениями. Можно указать в виде числового значения или пустой строки. Возвращаемое значение всегда является числом.
maximum

Представляет максимальное значение на оси значений. Можно указать в виде числового значения или пустой строки (для автоматически заданных значений оси). Возвращаемое значение всегда является числом.
minimum

Представляет минимальное значение на оси значений. Ему можно присвоить числовое значение или пустую строку (для автоматически заданных значений оси). Возвращаемое значение всегда является числом.
minorGridlines

Возвращает объект, представляющий дополнительные линии сетки для указанной оси.
minorTickMark

Указывает тип малой деления для указанной оси. См. Excel.ChartAxisTickMark дополнительные сведения.
minorTimeUnitScale

Задает значение масштаба дополнительной единицы для оси категории, если свойство categoryType имеет значение dateAxis.
minorUnit

Представляет интервал между двумя промежуточными делениями. Его можно указать в виде числового значения или пустой строки (для автоматически заданных значений оси). Возвращаемое значение всегда является числом.
multiLevel

Указывает, является ли ось многоуровневой.
numberFormat

Задает код формата метки деления оси.
offset

Определяет расстояние между уровнями надписей, а также расстояние между первым уровнем и линией оси. Значение должно быть целым числом от 0 до 1000.
position

Задает заданное положение оси в месте пересечения другой оси. См. Excel.ChartAxisPosition дополнительные сведения.
positionAt

Определяет положение оси в месте пересечения другой оси. Для задания этого свойства следует использовать этот SetPositionAt(double) метод.
reversePlotOrder

Указывает, отображаются ли в Excel точки данных от последнего к первому.
scaleType

Определяет тип шкалы оси значений. См. Excel.ChartAxisScaleType дополнительные сведения.
showDisplayUnitLabel

Указывает, видна ли метка единицы отображения оси.
textOrientation

Угол ориентации текста для подписи делений оси диаграммы. Значение должно быть либо целым числом от -90 до 90, либо целым числом 180 для вертикально ориентированного текста.
tickLabelPosition

Задает положение меток делений относительно указанной оси. См. Excel.ChartAxisTickLabelPosition дополнительные сведения.
tickLabelSpacing

Задает количество категорий или рядов между подписями делений. Может иметь значение от 1 до 31 999 или пустую строку для автоматической настройки. Возвращаемое значение всегда является числом.
tickMarkSpacing

Задает количество категорий или рядов между делениями.
title

Обозначает название оси.
top

Указывает расстояние (в точках) от верхнего края оси до вершины области диаграммы. Возвращает значение null , если ось не видна.
type

Задает тип оси. См. Excel.ChartAxisType дополнительные сведения.
visible

Указывает, видна ли ось.
width

Ширина оси диаграммы (в точках). Возвращает значение null , если ось не видна.

Методы

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)

Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
setCategoryNames(sourceData)

Устанавливает все имена категорий для указанной оси.
setCustomDisplayUnit(value)

Задает отображаемую единицу измерения оси в виде настраиваемого значения.
setPositionAt(value)

Задает заданное положение оси в месте пересечения другой оси.
toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ChartAxis объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ChartAxisData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

Сведения о свойстве

alignment

Выравнивание заданной метки деления оси. Смотрите Excel.ChartTextHorizontalAlignment подробности.

alignment: Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right";

Значение свойства

Excel.ChartTickLabelAlignment | "Center" | "Left" | "Right"

Комментарии

Набор API: ExcelApi 1.8

axisGroup

Указывает группу для заданной оси. См. Excel.ChartAxisGroup дополнительные сведения.

readonly axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";

Значение свойства

Excel.ChartAxisGroup | "Primary" | "Secondary"

Комментарии

Набор API: ExcelApi 1.7

baseTimeUnit

Задает базовую единицу для указанной оси категории.

baseTimeUnit: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

Значение свойства

Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"

Комментарии

Набор API: ExcelApi 1.7

categoryType

Определяет тип оси категорий.

categoryType: Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis";

Значение свойства

Excel.ChartAxisCategoryType | "Automatic" | "TextAxis" | "DateAxis"

Комментарии

Набор API: ExcelApi 1.7

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

customDisplayUnit

Указывает значение единицы измерения пользовательской оси. Чтобы задать это свойство, используйте метод.SetCustomDisplayUnit(double)

readonly customDisplayUnit: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi 1.7

displayUnit

Представляет отображаемую единицу измерения оси. См. Excel.ChartAxisDisplayUnit дополнительные сведения.

displayUnit: Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom";

Значение свойства

Excel.ChartAxisDisplayUnit | "None" | "Hundreds" | "Thousands" | "TenThousands" | "HundredThousands" | "Millions" | "TenMillions" | "HundredMillions" | "Billions" | "Trillions" | "Custom"

Комментарии

Набор API: ExcelApi 1.7

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-axis.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    let chart = sheet.charts.getItemAt(0);
    let categoryAxis = chart.axes.categoryAxis;
    let valueAxis = chart.axes.valueAxis;

    // Load to get display unit.
    valueAxis.load("displayUnit");

    await context.sync();

    console.log("The vertical axis display unit is: " + valueAxis.displayUnit);
});

format

Представляет форматирование объекта диаграммы, в том числе форматирование линий и шрифта.

readonly format: Excel.ChartAxisFormat;

Значение свойства

Excel.ChartAxisFormat

Комментарии

Набор API: ExcelApi 1.1

height

Указывает высоту оси диаграммы (в точках). Возвращает значение null , если ось не видна.

readonly height: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi 1.7

isBetweenCategories

Указывает, пересекает ли ось значений ось категорий между категориями.

isBetweenCategories: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.8

left

Определяет расстояние (в точках) от левого края оси до левой области диаграммы. Возвращает значение null , если ось не видна.

readonly left: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi 1.7

linkNumberFormat

Указывает, связан ли числовой формат с ячейками. Если true, то числовой формат будет изменяться в метках при изменении в ячейках.

linkNumberFormat: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.9

logBase

Определяет основание логарифма при использовании логарифмических шкал.

logBase: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi 1.7

majorGridlines

Возвращает объект, представляющий основные линии сетки для указанной оси.

readonly majorGridlines: Excel.ChartGridlines;

Значение свойства

Excel.ChartGridlines

Комментарии

Набор API: ExcelApi 1.1

majorTickMark

Указывает тип основного деления для указанной оси. См. Excel.ChartAxisTickMark дополнительные сведения.

majorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside";

Значение свойства

Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"

Комментарии

Набор API: ExcelApi 1.7

majorTimeUnitScale

Задает значение масштаба основной единицы для оси категории, если свойство categoryType имеет значение dateAxis.

majorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

Значение свойства

Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"

Комментарии

Набор API: ExcelApi 1.7

majorUnit

Обозначает интервал между двумя основными делениями. Можно указать в виде числового значения или пустой строки. Возвращаемое значение всегда является числом.

majorUnit: any;

Значение свойства

any

Комментарии

Набор API: ExcelApi 1.1

maximum

Представляет максимальное значение на оси значений. Можно указать в виде числового значения или пустой строки (для автоматически заданных значений оси). Возвращаемое значение всегда является числом.

maximum: any;

Значение свойства

any

Комментарии

Набор API: ExcelApi 1.1

minimum

Представляет минимальное значение на оси значений. Ему можно присвоить числовое значение или пустую строку (для автоматически заданных значений оси). Возвращаемое значение всегда является числом.

minimum: any;

Значение свойства

any

Комментарии

Набор API: ExcelApi 1.1

minorGridlines

Возвращает объект, представляющий дополнительные линии сетки для указанной оси.

readonly minorGridlines: Excel.ChartGridlines;

Значение свойства

Excel.ChartGridlines

Комментарии

Набор API: ExcelApi 1.1

minorTickMark

Указывает тип малой деления для указанной оси. См. Excel.ChartAxisTickMark дополнительные сведения.

minorTickMark: Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside";

Значение свойства

Excel.ChartAxisTickMark | "None" | "Cross" | "Inside" | "Outside"

Комментарии

Набор API: ExcelApi 1.7

minorTimeUnitScale

Задает значение масштаба дополнительной единицы для оси категории, если свойство categoryType имеет значение dateAxis.

minorTimeUnitScale: Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years";

Значение свойства

Excel.ChartAxisTimeUnit | "Days" | "Months" | "Years"

Комментарии

Набор API: ExcelApi 1.7

minorUnit

Представляет интервал между двумя промежуточными делениями. Его можно указать в виде числового значения или пустой строки (для автоматически заданных значений оси). Возвращаемое значение всегда является числом.

minorUnit: any;

Значение свойства

any

Комментарии

Набор API: ExcelApi 1.1

multiLevel

Указывает, является ли ось многоуровневой.

multiLevel: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.8

numberFormat

Задает код формата метки деления оси.

numberFormat: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.8

offset

Определяет расстояние между уровнями надписей, а также расстояние между первым уровнем и линией оси. Значение должно быть целым числом от 0 до 1000.

offset: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi 1.8

position

Задает заданное положение оси в месте пересечения другой оси. См. Excel.ChartAxisPosition дополнительные сведения.

position: Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom";

Значение свойства

Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom"

Комментарии

Набор API: ExcelApi 1.8

positionAt

Определяет положение оси в месте пересечения другой оси. Для задания этого свойства следует использовать этот SetPositionAt(double) метод.

readonly positionAt: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi 1.8

reversePlotOrder

Указывает, отображаются ли в Excel точки данных от последнего к первому.

reversePlotOrder: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.7

scaleType

Определяет тип шкалы оси значений. См. Excel.ChartAxisScaleType дополнительные сведения.

scaleType: Excel.ChartAxisScaleType | "Linear" | "Logarithmic";

Значение свойства

Excel.ChartAxisScaleType | "Linear" | "Logarithmic"

Комментарии

Набор API: ExcelApi 1.7

showDisplayUnitLabel

Указывает, видна ли метка единицы отображения оси.

showDisplayUnitLabel: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.7

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-axis.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    let chart = sheet.charts.getItemAt(0);
    let axis = chart.axes.valueAxis;

    // Remove display unit.
    axis.showDisplayUnitLabel = false;

    await context.sync();
});

textOrientation

Угол ориентации текста для подписи делений оси диаграммы. Значение должно быть либо целым числом от -90 до 90, либо целым числом 180 для вертикально ориентированного текста.

textOrientation: any;

Значение свойства

any

Комментарии

Набор API: ExcelApi 1.8

tickLabelPosition

Задает положение меток делений относительно указанной оси. См. Excel.ChartAxisTickLabelPosition дополнительные сведения.

tickLabelPosition: Excel.ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None";

Значение свойства

Excel.ChartAxisTickLabelPosition | "NextToAxis" | "High" | "Low" | "None"

Комментарии

Набор API: ExcelApi 1.7

tickLabelSpacing

Задает количество категорий или рядов между подписями делений. Может иметь значение от 1 до 31 999 или пустую строку для автоматической настройки. Возвращаемое значение всегда является числом.

tickLabelSpacing: any;

Значение свойства

any

Комментарии

Набор API: ExcelApi 1.7

tickMarkSpacing

Задает количество категорий или рядов между делениями.

tickMarkSpacing: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi 1.7

title

Обозначает название оси.

readonly title: Excel.ChartAxisTitle;

Значение свойства

Excel.ChartAxisTitle

Комментарии

Набор API: ExcelApi 1.1

top

Указывает расстояние (в точках) от верхнего края оси до вершины области диаграммы. Возвращает значение null , если ось не видна.

readonly top: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi 1.7

type

Задает тип оси. См. Excel.ChartAxisType дополнительные сведения.

readonly type: Excel.ChartAxisType | "Invalid" | "Category" | "Value" | "Series";

Значение свойства

Excel.ChartAxisType | "Invalid" | "Category" | "Value" | "Series"

Комментарии

Набор API: ExcelApi 1.7

visible

Указывает, видна ли ось.

visible: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.7

width

Ширина оси диаграммы (в точках). Возвращает значение null , если ось не видна.

readonly width: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi 1.7

Сведения о методе

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.ChartAxisLoadOptions): Excel.ChartAxis;

Параметры

options
Excel.Interfaces.ChartAxisLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

Возвращаемое значение

Excel.ChartAxis

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.ChartAxis;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

Возвращаемое значение

Excel.ChartAxis

Примеры

// Get the maximum of Chart Axis from Chart1.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    const axis = chart.axes.valueAxis;
    axis.load('maximum');
    await context.sync();

    console.log(axis.maximum);
});

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ChartAxis;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

Возвращаемое значение

Excel.ChartAxis

set(properties, options)

Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.

set(properties: Interfaces.ChartAxisUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties
Excel.Interfaces.ChartAxisUpdateData

Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.

options
OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.

Возвращаемое значение

void

set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Excel.ChartAxis): void;

Параметры

properties
Excel.ChartAxis

Возвращаемое значение

void

setCategoryNames(sourceData)

Устанавливает все имена категорий для указанной оси.

setCategoryNames(sourceData: Range): void;

Параметры

sourceData
Excel.Range

Объект Range , соответствующий исходным данным.

Возвращаемое значение

void

Комментарии

Набор API: ExcelApi 1.7

setCustomDisplayUnit(value)

Задает отображаемую единицу измерения оси в виде настраиваемого значения.

setCustomDisplayUnit(value: number): void;

Параметры

value

number

Пользовательское значение единицы отображения.

Возвращаемое значение

void

Комментарии

Набор API: ExcelApi 1.7

setPositionAt(value)

Задает заданное положение оси в месте пересечения другой оси.

setPositionAt(value: number): void;

Параметры

value

number

Пользовательское значение точки пересечения.

Возвращаемое значение

void

Комментарии

Набор API: ExcelApi 1.8

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-axis-formatting.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getActiveWorksheet();

    let chart = sheet.charts.getItem("SalesChart");
    const axis: Excel.ChartAxis = chart.axes.valueAxis;

    axis.displayUnit = "None";
    axis.scaleType = "Logarithmic";
    axis.logBase = 100;
    axis.majorTickMark = "Cross";
    
    // Set the product name label location.
    // In this case, the location is at 100 units.
    axis.setPositionAt(100);

    await context.sync();
});

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ChartAxis объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ChartAxisData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

toJSON(): Excel.Interfaces.ChartAxisData;

Возвращаемое значение

Excel.Interfaces.ChartAxisData