ChartLabelBase

Base class for chart elements which behave as a label.

Constructors

new ChartLabelBase(a: IChartObject): ChartLabelBase

Returns ChartLabelBase

Properties

$t

$t: Type

Accessors

border

Inherited from: ChartTextAreaBase

Determines the appearance of the border drawn around the text area, as well as whether a border appears.

get border(): ChartBorder

Returns ChartBorder

set border(a: ChartBorder): void

Parameters

a: ChartBorder

Returns void

chart

Inherited from: ChartTextAreaBase

Returns the owning chart (read-only)

get chart(): WorksheetChart

Returns WorksheetChart

defaultFont

Inherited from: ChartTextAreaBase

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

get defaultFont(): IWorkbookFont

Returns IWorkbookFont

fill

Inherited from: ChartTextAreaBase

Returns or sets a [[ChartFillBase]] derived object which defines the fill properties for the text area.

get fill(): ChartFillBase

Returns ChartFillBase

set fill(a: ChartFillBase): void

Parameters

a: ChartFillBase

Returns void

formula

Inherited from: ChartTextAreaBase

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

horizontalOverflow

Inherited from: ChartTextAreaBase

Determines whether text is allowed to continue horizontally outside the bounds of the containing element.

get horizontalOverflow(): TextHorizontalOverflow

Returns TextHorizontalOverflow

set horizontalOverflow(a: TextHorizontalOverflow): void

Parameters

a: TextHorizontalOverflow

Returns void

left

Inherited from: ChartTextAreaBase

The left position of the text area (ignored unless [[position]] is set to 'Custom').

get left(): number

Returns number

set left(a: number): void

Parameters

a: number

Returns void

numberFormat

Returns or sets the format to use for numbers.

get numberFormat(): string

Returns string

set numberFormat(a: string): void

Parameters

a: string

Returns void

numberFormatLinked

True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).

get numberFormatLinked(): boolean

Returns boolean

set numberFormatLinked(a: boolean): void

Parameters

a: boolean

Returns void

owner

Inherited from: ChartTextAreaBase

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

position

Inherited from: ChartTextAreaBase

Determines whether the position of the text area is automatic or custom as specified by the [[left]] and [[top]] properties.

get position(): ElementPosition

Returns ElementPosition

set position(a: ElementPosition): void

Parameters

a: ElementPosition

Returns void

readingOrder

Inherited from: ChartTextAreaBase

Determines the reading order

get readingOrder(): ReadingOrder

Returns ReadingOrder

set readingOrder(a: ReadingOrder): void

Parameters

a: ReadingOrder

Returns void

rotation

Inherited from: ChartTextAreaBase

Determines the rotation of the text area, expressed in degrees.

get rotation(): number

Returns number

set rotation(a: number): void

Parameters

a: number

Returns void

sheet

Inherited from: ChartTextAreaBase

The owning sheet (read-only)

get sheet(): Sheet

Returns Sheet

text

Inherited from: ChartTextAreaBase

Returns or sets a [[FormattedString]] object which defines the text to be displayed by the associated chart element.

get text(): FormattedString

Returns FormattedString

set text(a: FormattedString): void

Parameters

a: FormattedString

Returns void

textDirection

Inherited from: ChartTextAreaBase

Determines the orientation and direction in which text flows.

get textDirection(): TextDirection

Returns TextDirection

set textDirection(a: TextDirection): void

Parameters

a: TextDirection

Returns void

top

Inherited from: ChartTextAreaBase

The top position of the text area (ignored unless [[position]] is set to 'Custom').

get top(): number

Returns number

set top(a: number): void

Parameters

a: number

Returns void

verticalAlignment

Inherited from: ChartTextAreaBase

Determines the vertical alignment of the text area.

get verticalAlignment(): VerticalTitleAlignment

Returns VerticalTitleAlignment

set verticalAlignment(a: VerticalTitleAlignment): void

Parameters

a: VerticalTitleAlignment

Returns void

verticalOverflow

Inherited from: ChartTextAreaBase

Determines whether text is allowed to continue vertically outside the bounds of the containing element.

get verticalOverflow(): TextVerticalOverflow

Returns TextVerticalOverflow

set verticalOverflow(a: TextVerticalOverflow): void

Parameters

a: TextVerticalOverflow

Returns void

workbook

Inherited from: ChartTextAreaBase

The owning workbook (read-only)

get workbook(): Workbook

Returns Workbook

worksheet

Inherited from: ChartTextAreaBase

The owning worksheet (read-only)

get worksheet(): Worksheet

Returns Worksheet

wrapText

Inherited from: ChartTextAreaBase

Determines whether text is wrapped when it would exceed the bounds of the containing element.

get wrapText(): boolean

Returns boolean

set wrapText(a: boolean): void

Parameters

a: boolean

Returns void

Methods

setFormula

Inherited from: ChartTextAreaBase

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

staticInit(): void