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 , если ось не видна.
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 ]

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

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

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

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 ]

toJSON()

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

toJSON(): Excel.Interfaces.ChartAxisData;

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

Excel.Interfaces.ChartAxisData