Represents the text area of a chart element.

Constructors

Section titled "Constructors"

ChartTextAreaBase

new ChartTextAreaBase(a: IChartObject): ChartTextAreaBase

Returns ChartTextAreaBase

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

border

Section titled "border" 
border: ChartBorder

fill

Section titled "fill" 
fill: ChartFillBase

horizontalOverflow

Section titled "horizontalOverflow" 
horizontalOverflow: TextHorizontalOverflow

left

Section titled "left" 
left: number

position

Section titled "position" 
position: ElementPosition

readingOrder

Section titled "readingOrder" 
readingOrder: ReadingOrder

rotation

Section titled "rotation" 
rotation: number

text

Section titled "text" 
text: FormattedString

textDirection

Section titled "textDirection" 
textDirection: TextDirection

top

Section titled "top" 
top: number

verticalAlignment

Section titled "verticalAlignment" 
verticalAlignment: VerticalTitleAlignment

verticalOverflow

Section titled "verticalOverflow" 
verticalOverflow: TextVerticalOverflow

wrapText

Section titled "wrapText" 
wrapText: boolean

Accessors

Section titled "Accessors"

chart

Section titled "chart"

Inherited from: ChartObject

Returns the owning chart (read-only)

get chart(): WorksheetChart

Returns WorksheetChart

defaultFont

Section titled "defaultFont"

Defines the font properties for each formatted run in the [[text]] that has no more specific setting. Read-only.

get defaultFont(): IWorkbookFont

Returns IWorkbookFont

formula

Section titled "formula"

The formula used to get the text displayed within the text area. (read-only). To set this property call the SetFormula method. 

get formula(): Formula

Returns Formula

owner

Section titled "owner"

Inherited from: ChartObject

returns this object's owner. (read-only) The owner or null if this object is owned directly by the Chart

get owner(): ChartObject

Returns ChartObject

sheet

Section titled "sheet"

Inherited from: ChartObject

The owning sheet (read-only)

get sheet(): Sheet

Returns Sheet

workbook

Section titled "workbook"

Inherited from: ChartObject

The owning workbook (read-only)

get workbook(): Workbook

Returns Workbook

worksheet

Section titled "worksheet"

Inherited from: ChartObject

The owning worksheet (read-only)

get worksheet(): Worksheet

Returns Worksheet

Methods

Section titled "Methods"

setFormula

Section titled "setFormula"

Assigns a new [[Formula]] to this instance.

setFormula(formula: string, cellReferenceMode: CellReferenceMode): void

Parameters

  • formula: string

    The string representation of the formula used to get the [[text]].
  • cellReferenceMode: CellReferenceMode

    A [[CellReferenceMode]] value which specifies whether the 'formula' parameter should be interpreted as an A1 or R1C1 expression. This parameter is optional and defaults to null, in which case the [[Workbook.cellReferenceMode]] property is used.

Returns void

staticInit

Section titled "staticInit" 
staticInit(): void

Returns void