Excel.Interfaces.ChartTitleLoadOptions interface

Package:

excel

Represents a chart title object of a chart.

Remarks

[ API set: ExcelApi 1.1 ]

Properties

$all	Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
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

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

TypeScript

$all?: boolean;

Property Value

boolean

format

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

TypeScript

format?: Excel.Interfaces.ChartTitleFormatLoadOptions;

Property Value

Excel.Interfaces.ChartTitleFormatLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

height

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

TypeScript

height?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

horizontalAlignment

Specifies the horizontal alignment for chart title.

TypeScript

horizontalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

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.

TypeScript

left?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

overlay

Specifies if the chart title will overlay the chart.

TypeScript

overlay?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

position

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

TypeScript

position?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

showShadow

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

TypeScript

showShadow?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

text

Specifies the chart's title text.

TypeScript

text?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

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.

TypeScript

textOrientation?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

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.

TypeScript

top?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

verticalAlignment

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

TypeScript

verticalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

visible

Specifies if the chart title is visible.

TypeScript

visible?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

width

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

TypeScript

width?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]