ExcelScript.Chart interface

Представляет объект диаграммы в книге. Чтобы узнать больше об объектной модели диаграммы, ознакомьтесь со статьей работа с диаграммами с помощью API JavaScript для Excel.

Методы

activate()

Активирует диаграмму в пользовательском интерфейсе Excel.

addChartSeries(name, index)

Добавляет новый ряд в коллекцию. Новый добавленный ряд не виден, пока не будут заданы значения/оси x и размеры пузырьков (в зависимости от типа диаграммы).

delete()

Удаляет объект диаграммы.

getAxes()

Представляет оси диаграммы.

getCategoryLabelLevel()

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

getChartType()

Указывает тип диаграммы. Дополнительные сведения см. в статье Excel. ChartType.

getDataLabels()

Представляет метки данных на диаграмме.

getDisplayBlanksAs()

Задает способ отображения пустых ячеек на диаграмме.

getFormat()

Инкапсулирует свойства формата для области диаграммы.

getHeight()

Задает высоту объекта диаграммы (в пунктах).

getId()

Уникальный идентификатор диаграммы.

getImage(width, height, fittingMode)

Отрисовывает диаграмму в виде изображения с кодировкой base64, масштабируя ее в соответствии с указанным размером. Пропорции сохраняются в процессе изменения размера.

getLeft()

Расстояние в пунктах от левого края диаграммы до начала листа.

getLegend()

Представляет условные обозначения для диаграммы.

getName()

Задает имя объекта диаграммы.

getPivotOptions()

Объединяет параметры для сводной диаграммы.

getPlotArea()

Представляет plotArea для диаграммы.

getPlotBy()

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

getPlotVisibleOnly()

True, если отображаются только видимые ячейки. False, если отображаются как видимые, так и скрытые ячейки.

getSeries()

Представляет один ряд данных или коллекцию рядов данных в диаграмме.

getSeriesNameLevel()

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

getShowAllFieldButtons()

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

getShowDataLabelsOverMaximum()

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

getStyle()

Задает стиль диаграммы для диаграммы.

getTitle()

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

getTop()

Задает расстояние от верхнего края объекта до верха строки 1 (на рабочем листе) или в верхней части области диаграммы (на диаграмме).

getWidth()

Задает ширину объекта диаграммы (в пунктах).

getWorksheet()

Лист, содержащий текущую диаграмму.

setCategoryLabelLevel(categoryLabelLevel)

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

setChartType(chartType)

Указывает тип диаграммы. Дополнительные сведения см. в статье Excel. ChartType.

setData(sourceData, seriesBy)

Сбрасывает исходные данные для диаграммы.

setDisplayBlanksAs(displayBlanksAs)

Задает способ отображения пустых ячеек на диаграмме.

setHeight(height)

Задает высоту объекта диаграммы (в пунктах).

setLeft(left)

Расстояние в пунктах от левого края диаграммы до начала листа.

setName(name)

Задает имя объекта диаграммы.

setPlotBy(plotBy)

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

setPlotVisibleOnly(plotVisibleOnly)

True, если отображаются только видимые ячейки. False, если отображаются как видимые, так и скрытые ячейки.

setPosition(startCell, endCell)

Располагает диаграмму относительно ячеек на листе.

setSeriesNameLevel(seriesNameLevel)

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

setShowAllFieldButtons(showAllFieldButtons)

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

setShowDataLabelsOverMaximum(showDataLabelsOverMaximum)

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

setStyle(style)

Задает стиль диаграммы для диаграммы.

setTop(top)

Задает расстояние от верхнего края объекта до верха строки 1 (на рабочем листе) или в верхней части области диаграммы (на диаграмме).

setWidth(width)

Задает ширину объекта диаграммы (в пунктах).

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

activate()

Активирует диаграмму в пользовательском интерфейсе Excel.

activate(): void;

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

void

addChartSeries(name, index)

Добавляет новый ряд в коллекцию. Новый добавленный ряд не виден, пока не будут заданы значения/оси x и размеры пузырьков (в зависимости от типа диаграммы).

addChartSeries(name?: string, index?: number): ChartSeries;

Параметры

name
string

Необязательный параметр. Имя ряда.

index
number

Необязательный параметр. Значение индекса добавляемого ряда. Используется нулевой индекс.

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

delete()

Удаляет объект диаграммы.

delete(): void;

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

void

getAxes()

Представляет оси диаграммы.

getAxes(): ChartAxes;

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

getCategoryLabelLevel()

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

getCategoryLabelLevel(): number;

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

number

getChartType()

Указывает тип диаграммы. Дополнительные сведения см. в статье Excel. ChartType.

getChartType(): ChartType;

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

getDataLabels()

Представляет метки данных на диаграмме.

getDataLabels(): ChartDataLabels;

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

getDisplayBlanksAs()

Задает способ отображения пустых ячеек на диаграмме.

getDisplayBlanksAs(): ChartDisplayBlanksAs;

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

getFormat()

Инкапсулирует свойства формата для области диаграммы.

getFormat(): ChartAreaFormat;

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

getHeight()

Задает высоту объекта диаграммы (в пунктах).

getHeight(): number;

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

number

getId()

Уникальный идентификатор диаграммы.

getId(): string;

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

string

getImage(width, height, fittingMode)

Отрисовывает диаграмму в виде изображения с кодировкой base64, масштабируя ее в соответствии с указанным размером. Пропорции сохраняются в процессе изменения размера.

getImage(
            width?: number,
            height?: number,
            fittingMode?: ImageFittingMode
        ): string;

Параметры

width
number

(Необязательно) Нужная ширина создаваемого изображения.

height
number

(Необязательно) Нужная высота создаваемого изображения.

fittingMode
ImageFittingMode

Необязательно Метод, используемый для масштабирования диаграммы в соответствии с указанными размерами (если заданы и высота, и ширина).

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

string

getLeft()

Расстояние в пунктах от левого края диаграммы до начала листа.

getLeft(): number;

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

number

getLegend()

Представляет условные обозначения для диаграммы.

getLegend(): ChartLegend;

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

getName()

Задает имя объекта диаграммы.

getName(): string;

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

string

getPivotOptions()

Объединяет параметры для сводной диаграммы.

getPivotOptions(): ChartPivotOptions;

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

getPlotArea()

Представляет plotArea для диаграммы.

getPlotArea(): ChartPlotArea;

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

getPlotBy()

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

getPlotBy(): ChartPlotBy;

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

getPlotVisibleOnly()

True, если отображаются только видимые ячейки. False, если отображаются как видимые, так и скрытые ячейки.

getPlotVisibleOnly(): boolean;

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

boolean

getSeries()

Представляет один ряд данных или коллекцию рядов данных в диаграмме.

getSeries(): ChartSeries[];

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

getSeriesNameLevel()

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

getSeriesNameLevel(): number;

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

number

getShowAllFieldButtons()

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

getShowAllFieldButtons(): boolean;

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

boolean

getShowDataLabelsOverMaximum()

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

getShowDataLabelsOverMaximum(): boolean;

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

boolean

getStyle()

Задает стиль диаграммы для диаграммы.

getStyle(): number;

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

number

getTitle()

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

getTitle(): ChartTitle;

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

getTop()

Задает расстояние от верхнего края объекта до верха строки 1 (на рабочем листе) или в верхней части области диаграммы (на диаграмме).

getTop(): number;

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

number

getWidth()

Задает ширину объекта диаграммы (в пунктах).

getWidth(): number;

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

number

getWorksheet()

Лист, содержащий текущую диаграмму.

getWorksheet(): Worksheet;

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

setCategoryLabelLevel(categoryLabelLevel)

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

setCategoryLabelLevel(categoryLabelLevel: number): void;

Параметры

categoryLabelLevel
number

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

void

setChartType(chartType)

Указывает тип диаграммы. Дополнительные сведения см. в статье Excel. ChartType.

setChartType(chartType: ChartType): void;

Параметры

chartType
ChartType

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

void

setData(sourceData, seriesBy)

Сбрасывает исходные данные для диаграммы.

setData(sourceData: Range, seriesBy?: ChartSeriesBy): void;

Параметры

sourceData
Range

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

seriesBy
ChartSeriesBy

Определяет способ использования столбцов или строк в качестве рядов данных на диаграмме. Может иметь одно из следующих значений: Auto (по умолчанию), Rows и Columns. Дополнительные сведения см. в статье Excel. Чартсериесби.

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

void

setDisplayBlanksAs(displayBlanksAs)

Задает способ отображения пустых ячеек на диаграмме.

setDisplayBlanksAs(displayBlanksAs: ChartDisplayBlanksAs): void;

Параметры

displayBlanksAs
ChartDisplayBlanksAs

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

void

setHeight(height)

Задает высоту объекта диаграммы (в пунктах).

setHeight(height: number): void;

Параметры

height
number

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

void

setLeft(left)

Расстояние в пунктах от левого края диаграммы до начала листа.

setLeft(left: number): void;

Параметры

left
number

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

void

setName(name)

Задает имя объекта диаграммы.

setName(name: string): void;

Параметры

name
string

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

void

setPlotBy(plotBy)

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

setPlotBy(plotBy: ChartPlotBy): void;

Параметры

plotBy
ChartPlotBy

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

void

setPlotVisibleOnly(plotVisibleOnly)

True, если отображаются только видимые ячейки. False, если отображаются как видимые, так и скрытые ячейки.

setPlotVisibleOnly(plotVisibleOnly: boolean): void;

Параметры

plotVisibleOnly
boolean

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

void

setPosition(startCell, endCell)

Располагает диаграмму относительно ячеек на листе.

setPosition(startCell: Range | string, endCell?: Range | string): void;

Параметры

startCell
Range | string

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

endCell
Range | string

Конечная ячейка (необязательно указывать). Если указан данный параметр, значения ширины и высоты диаграммы будут установлены так, чтобы полностью покрыть эту ячейку или диапазон.

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

void

setSeriesNameLevel(seriesNameLevel)

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

setSeriesNameLevel(seriesNameLevel: number): void;

Параметры

seriesNameLevel
number

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

void

setShowAllFieldButtons(showAllFieldButtons)

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

setShowAllFieldButtons(showAllFieldButtons: boolean): void;

Параметры

showAllFieldButtons
boolean

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

void

setShowDataLabelsOverMaximum(showDataLabelsOverMaximum)

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

setShowDataLabelsOverMaximum(showDataLabelsOverMaximum: boolean): void;

Параметры

showDataLabelsOverMaximum
boolean

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

void

setStyle(style)

Задает стиль диаграммы для диаграммы.

setStyle(style: number): void;

Параметры

style
number

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

void

setTop(top)

Задает расстояние от верхнего края объекта до верха строки 1 (на рабочем листе) или в верхней части области диаграммы (на диаграмме).

setTop(top: number): void;

Параметры

top
number

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

void

setWidth(width)

Задает ширину объекта диаграммы (в пунктах).

setWidth(width: number): void;

Параметры

width
number

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

void