ExcelScript.ChartTitle interface

Пакет:

ExcelScript

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

Замечания

Примеры

/**
 * This sample accesses and customizes the chart title.
 * 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];
  
  // Customize the title.
  const title = chart.getTitle();
  title.setText("Quarterly Sales by Product");
  title.setVisible(true);
}

Методика

getFormat()	Представляет форматирование названия диаграммы, включая формат заливки и шрифта.
getHeight()	Возвращает высоту заголовка диаграммы (в пунктах). Значение имеет значение , null если название диаграммы не отображается.
getHorizontalAlignment()	Задает горизонтальное выравнивание заголовка диаграммы.
getLeft()	Указывает расстояние (в точках) от левого края заголовка диаграммы до левого края области диаграммы. Значение имеет значение , null если название диаграммы не отображается.
getOverlay()	Указывает, будет ли заголовок диаграммы перекрывать диаграмму.
getPosition()	Представляет положение заголовка диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartTitlePosition статье.
getShowShadow()	Представляет логическое значение, которое определяет, имеет ли заголовок диаграммы тень.
getSubstring(start, length)	Получение подстроки заголовка диаграммы. Разрыв строки "\n" имеет значение одного символа.
getText()	Указывает текст заголовка диаграммы.
getTextOrientation()	Указывает угол, на который текст ориентирован для заголовка диаграммы. Значение должно быть целым числом от -90 до 90 или целым числом 180 для вертикально ориентированного текста.
getTop()	Указывает расстояние (в точках) от верхнего края заголовка диаграммы до верхней части области диаграммы. Значение имеет значение , null если название диаграммы не отображается.
getVerticalAlignment()	Задает вертикальное выравнивание заголовка диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartTextVerticalAlignment статье.
getVisible()	Указывает, отображается ли название диаграммы.
getWidth()	Задает ширину (в точках) заголовка диаграммы. Значение имеет значение , null если название диаграммы не отображается.
setFormula(formula)	Задает строковое значение, представляющее формулу заголовка диаграммы с использованием нотации стиля A1.
setHorizontalAlignment(horizontalAlignment)	Задает горизонтальное выравнивание заголовка диаграммы.
setLeft(left)	Указывает расстояние (в точках) от левого края заголовка диаграммы до левого края области диаграммы. Значение имеет значение , null если название диаграммы не отображается.
setOverlay(overlay)	Указывает, будет ли заголовок диаграммы перекрывать диаграмму.
setPosition(position)	Представляет положение заголовка диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartTitlePosition статье.
setShowShadow(showShadow)	Представляет логическое значение, которое определяет, имеет ли заголовок диаграммы тень.
setText(text)	Указывает текст заголовка диаграммы.
setTextOrientation(textOrientation)	Указывает угол, на который текст ориентирован для заголовка диаграммы. Значение должно быть целым числом от -90 до 90 или целым числом 180 для вертикально ориентированного текста.
setTop(top)	Указывает расстояние (в точках) от верхнего края заголовка диаграммы до верхней части области диаграммы. Значение имеет значение , null если название диаграммы не отображается.
setVerticalAlignment(verticalAlignment)	Задает вертикальное выравнивание заголовка диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartTextVerticalAlignment статье.
setVisible(visible)	Указывает, отображается ли название диаграммы.

Подробнее о методе

getFormat()

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

getFormat(): ChartTitleFormat;

Возвращает

ExcelScript.ChartTitleFormat

getHeight()

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

getHeight(): number;

Возвращает

number

getHorizontalAlignment()

Задает горизонтальное выравнивание заголовка диаграммы.

getHorizontalAlignment(): ChartTextHorizontalAlignment;

Возвращает

ExcelScript.ChartTextHorizontalAlignment

getLeft()

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

getLeft(): number;

Возвращает

number

getOverlay()

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

getOverlay(): boolean;

Возвращает

boolean

getPosition()

Представляет положение заголовка диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartTitlePosition статье.

getPosition(): ChartTitlePosition;

Возвращает

ExcelScript.ChartTitlePosition

getShowShadow()

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

getShowShadow(): boolean;

Возвращает

boolean

getSubstring(start, length)

Получение подстроки заголовка диаграммы. Разрыв строки "\n" имеет значение одного символа.

getSubstring(start: number, length: number): ChartFormatString;

Параметры

start

number

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

length

number

Длина извлекаемой подстроки.

Возвращает

ExcelScript.ChartFormatString

getText()

Указывает текст заголовка диаграммы.

getText(): string;

Возвращает

string

getTextOrientation()

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

getTextOrientation(): number;

Возвращает

number

getTop()

Указывает расстояние (в точках) от верхнего края заголовка диаграммы до верхней части области диаграммы. Значение имеет значение , null если название диаграммы не отображается.

getTop(): number;

Возвращает

number

getVerticalAlignment()

Задает вертикальное выравнивание заголовка диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartTextVerticalAlignment статье.

getVerticalAlignment(): ChartTextVerticalAlignment;

Возвращает

ExcelScript.ChartTextVerticalAlignment

getVisible()

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

getVisible(): boolean;

Возвращает

boolean

getWidth()

Задает ширину (в точках) заголовка диаграммы. Значение имеет значение , null если название диаграммы не отображается.

getWidth(): number;

Возвращает

number

setFormula(formula)

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

setFormula(formula: string): void;

Параметры

formula

string

Строка, представляющая заданную формулу.

Возвращает

void

setHorizontalAlignment(horizontalAlignment)

Задает горизонтальное выравнивание заголовка диаграммы.

setHorizontalAlignment(
            horizontalAlignment: ChartTextHorizontalAlignment
        ): void;

Параметры

horizontalAlignment

ExcelScript.ChartTextHorizontalAlignment

Возвращает

void

setLeft(left)

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

setLeft(left: number): void;

Параметры

left

number

Возвращает

void

setOverlay(overlay)

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

setOverlay(overlay: boolean): void;

Параметры

overlay

boolean

Возвращает

void

setPosition(position)

Представляет положение заголовка диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartTitlePosition статье.

setPosition(position: ChartTitlePosition): void;

Параметры

position

ExcelScript.ChartTitlePosition

Возвращает

void

setShowShadow(showShadow)

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

setShowShadow(showShadow: boolean): void;

Параметры

showShadow

boolean

Возвращает

void

setText(text)

Указывает текст заголовка диаграммы.

setText(text: string): void;

Параметры

text

string

Возвращает

void

Примеры

/**
 * This sample sets the chart title text.
 * 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 chart title.
  chart.getTitle().setText("Quarterly Sales by Product");
}

setTextOrientation(textOrientation)

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

setTextOrientation(textOrientation: number): void;

Параметры

textOrientation

number

Возвращает

void

setTop(top)

Указывает расстояние (в точках) от верхнего края заголовка диаграммы до верхней части области диаграммы. Значение имеет значение , null если название диаграммы не отображается.

setTop(top: number): void;

Параметры

top

number

Возвращает

void

setVerticalAlignment(verticalAlignment)

Задает вертикальное выравнивание заголовка диаграммы. Дополнительные сведения см. в этой ExcelScript.ChartTextVerticalAlignment статье.

setVerticalAlignment(
            verticalAlignment: ChartTextVerticalAlignment
        ): void;

Параметры

verticalAlignment

ExcelScript.ChartTextVerticalAlignment

Возвращает

void

setVisible(visible)

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

setVisible(visible: boolean): void;

Параметры

visible

boolean

Возвращает

void