ExcelScript.ChartTitle interface
表示图表的图表标题对象。
注解
示例
/**
* 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);
}
方法
| get |
表示图表标题的格式,包括填充和字体格式。 |
| get |
返回图表标题的高度,以磅为单位。
|
| get |
指定图表标题的水平对齐方式。 |
| get |
指定从图表标题的左边缘到图表区左边缘的距离(以磅为单位)。
|
| get |
指定图表标题是否将覆盖图表。 |
| get |
表示图表标题的位置。 有关详细信息,请参阅 |
| get |
表示一个布尔值,用于确定图表标题是否具有阴影。 |
| get |
获取图表标题的子字符串。 换行符“n”\计数为一个字符。 |
| get |
指定图表的标题文本。 |
| get |
为图表标题指定文本的方向。 对于垂直方向文本,该值应为 -90 到 90 的整数或整数 180。 |
| get |
指定从图表标题的上边缘到图表区顶部的距离(以磅为单位)。
|
| get |
指定图表标题的垂直对齐方式。 有关详细信息,请参阅 |
| get |
指定图表标题是否可见。 |
| get |
指定图表标题的宽度(以磅为单位)。
|
| set |
设置一个字符串值,用于表示采用 A1 表示法的图表标题的公式。 |
| set |
指定图表标题的水平对齐方式。 |
| set |
指定从图表标题的左边缘到图表区左边缘的距离(以磅为单位)。
|
| set |
指定图表标题是否将覆盖图表。 |
| set |
表示图表标题的位置。 有关详细信息,请参阅 |
| set |
表示一个布尔值,用于确定图表标题是否具有阴影。 |
| set |
指定图表的标题文本。 |
| set |
为图表标题指定文本的方向。 对于垂直方向文本,该值应为 -90 到 90 的整数或整数 180。 |
| set |
指定从图表标题的上边缘到图表区顶部的距离(以磅为单位)。
|
| set |
指定图表标题的垂直对齐方式。 有关详细信息,请参阅 |
| set |
指定图表标题是否可见。 |
方法详细信息
getFormat()
getHeight()
返回图表标题的高度,以磅为单位。
null如果图表标题不可见,则值为 。
getHeight(): number;
返回
number
getHorizontalAlignment()
指定图表标题的水平对齐方式。
getHorizontalAlignment(): ChartTextHorizontalAlignment;
返回
getLeft()
指定从图表标题的左边缘到图表区左边缘的距离(以磅为单位)。
null如果图表标题不可见,则值为 。
getLeft(): number;
返回
number
getOverlay()
指定图表标题是否将覆盖图表。
getOverlay(): boolean;
返回
boolean
getPosition()
表示图表标题的位置。 有关详细信息,请参阅 ExcelScript.ChartTitlePosition。
getPosition(): ChartTitlePosition;
返回
getShowShadow()
表示一个布尔值,用于确定图表标题是否具有阴影。
getShowShadow(): boolean;
返回
boolean
getSubstring(start, length)
获取图表标题的子字符串。 换行符“n”\计数为一个字符。
getSubstring(start: number, length: number): ChartFormatString;
参数
- start
-
number
要检索的子字符串的起始位置。 从零开始编制索引。
- length
-
number
要检索的子字符串的长度。
返回
getText()
指定图表的标题文本。
getText(): string;
返回
string
getTextOrientation()
为图表标题指定文本的方向。 对于垂直方向文本,该值应为 -90 到 90 的整数或整数 180。
getTextOrientation(): number;
返回
number
getTop()
指定从图表标题的上边缘到图表区顶部的距离(以磅为单位)。
null如果图表标题不可见,则值为 。
getTop(): number;
返回
number
getVerticalAlignment()
指定图表标题的垂直对齐方式。 有关详细信息,请参阅 ExcelScript.ChartTextVerticalAlignment。
getVerticalAlignment(): 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