Edit

Share via

Excel.Interfaces.ChartTitleData interface

  • Reference
Package:
excel

Warning

This API is now deprecated.

An interface describing the data returned by calling chartTitle.toJSON().

Properties

format

Represents the formatting of a chart title, which includes fill and font formatting.
height

Returns the height, in points, of the chart title. Value is null if the chart title is not visible.
horizontalAlignment

Specifies the horizontal alignment for chart title.
left

Specifies the distance, in points, from the left edge of chart title to the left edge of chart area. Value is null if the chart title is not visible.
overlay

Specifies if the chart title will overlay the chart.
position

Represents the position of chart title. See Excel.ChartTitlePosition for details.
showShadow

Represents a boolean value that determines if the chart title has a shadow.
text

Specifies the chart's title text.
textOrientation

Specifies the angle to which the text is oriented for the chart title. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.
top

Specifies the distance, in points, from the top edge of chart title to the top of chart area. Value is null if the chart title is not visible.
verticalAlignment

Specifies the vertical alignment of chart title. See Excel.ChartTextVerticalAlignment for details.
visible

Specifies if the chart title is visible.
width

Specifies the width, in points, of the chart title. Value is null if the chart title is not visible.

Property Details

format

Warning

This API is now deprecated.

Represents the formatting of a chart title, which includes fill and font formatting.

format?: Excel.Interfaces.ChartTitleFormatData;

Property Value

Excel.Interfaces.ChartTitleFormatData

Remarks

[ API set: ExcelApi 1.1 ]

height

Warning

This API is now deprecated.

Returns the height, in points, of the chart title. Value is null if the chart title is not visible.

height?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

horizontalAlignment

Warning

This API is now deprecated.

Specifies the horizontal alignment for chart title.

horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";

Property Value

Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"

Remarks

[ API set: ExcelApi 1.7 ]

left

Warning

This API is now deprecated.

Specifies the distance, in points, from the left edge of chart title to the left edge of chart area. Value is null if the chart title is not visible.

left?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

overlay

Warning

This API is now deprecated.

Specifies if the chart title will overlay the chart.

overlay?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

position

Warning

This API is now deprecated.

Represents the position of chart title. See Excel.ChartTitlePosition for details.

position?: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right";

Property Value

Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right"

Remarks

[ API set: ExcelApi 1.7 ]

showShadow

Warning

This API is now deprecated.

Represents a boolean value that determines if the chart title has a shadow.

showShadow?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

text

Warning

This API is now deprecated.

Specifies the chart's title text.

text?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.1 ]

textOrientation

Warning

This API is now deprecated.

Specifies the angle to which the text is oriented for the chart title. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.

textOrientation?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

top

Warning

This API is now deprecated.

Specifies the distance, in points, from the top edge of chart title to the top of chart area. Value is null if the chart title is not visible.

top?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

verticalAlignment

Warning

This API is now deprecated.

Specifies the vertical alignment of chart title. See Excel.ChartTextVerticalAlignment for details.

verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";

Property Value

Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"

Remarks

[ API set: ExcelApi 1.7 ]

visible

Warning

This API is now deprecated.

Specifies if the chart title is visible.

visible?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

width

Warning

This API is now deprecated.

Specifies the width, in points, of the chart title. Value is null if the chart title is not visible.

width?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]