Represents the label of a specific [[DataPoint]].

Constructors

Section titled "Constructors"

DataLabel 

new DataLabel(): DataLabel

Returns DataLabel

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

border

Section titled "border"

Inherited from: ChartLabelBase

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

Returns void

chart

Section titled "chart"

Inherited from: ChartLabelBase

Returns the owning chart (read-only)

 
get chart(): WorksheetChart

Returns WorksheetChart

defaultFont

Section titled "defaultFont"

Inherited from: ChartLabelBase

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

Section titled "fill"

Inherited from: ChartLabelBase

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

Returns void

formula

Section titled "formula"

Inherited from: ChartLabelBase

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

height

Section titled "height"

Returns or sets a value that represents the height of the label, expressed as a ratio, relative to the size of the chart area.

 
get height(): number

Returns number 

set height(a: number): void

Parameters

  • a: number

Returns void

horizontalOverflow

Section titled "horizontalOverflow"

Inherited from: ChartLabelBase

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

Returns void

isDeleted

Section titled "isDeleted"

Returns or sets a boolean value indicating whether this label has been deleted.

 
get isDeleted(): boolean

Returns boolean 

set isDeleted(a: boolean): void

Parameters

  • a: boolean

Returns void

labelPosition

Section titled "labelPosition"

Returns or sets a value which determines the label's position as relative to the series bar/line.

 
get labelPosition(): DataLabelPosition

Returns DataLabelPosition 

set labelPosition(a: DataLabelPosition): void

Parameters

Returns void

left

Section titled "left"

Inherited from: ChartLabelBase

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

Section titled "numberFormat"

Inherited from: ChartLabelBase

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

Section titled "numberFormatLinked"

Inherited from: ChartLabelBase

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

Section titled "owner"

Inherited from: ChartLabelBase

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

Section titled "position"

Inherited from: ChartLabelBase

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

Returns void

readingOrder

Section titled "readingOrder"

Inherited from: ChartLabelBase

Determines the reading order

 
get readingOrder(): ReadingOrder

Returns ReadingOrder 

set readingOrder(a: ReadingOrder): void

Parameters

Returns void

rotation

Section titled "rotation"

Inherited from: ChartLabelBase

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

separator

Section titled "separator"

Returns or sets the separator used between multiple values in the label.

 
get separator(): string

Returns string 

set separator(a: string): void

Parameters

  • a: string

Returns void

sheet

Section titled "sheet"

Inherited from: ChartLabelBase

The owning sheet (read-only)

 
get sheet(): Sheet

Returns Sheet

showBubbleSize

Section titled "showBubbleSize"

Returns or sets if the bubble size is shown. Applies only to [[Series]] which are displayed within a bubble chart.

 
get showBubbleSize(): boolean | null

Returns boolean | null 

set showBubbleSize(a: boolean | null): void

Parameters

  • a: boolean | null

Returns void

showCategoryName

Section titled "showCategoryName"

Returns or sets a value indicating whether the category name is shown.

 
get showCategoryName(): boolean | null

Returns boolean | null 

set showCategoryName(a: boolean | null): void

Parameters

  • a: boolean | null

Returns void

showLegendKey

Section titled "showLegendKey"

Returns or sets if the [[Legend]] key is shown.

 
get showLegendKey(): boolean | null

Returns boolean | null 

set showLegendKey(a: boolean | null): void

Parameters

  • a: boolean | null

Returns void

showPercentage

Section titled "showPercentage"

Returns or sets a value indicating whether the percentage of the range is shown.

 
get showPercentage(): boolean | null

Returns boolean | null 

set showPercentage(a: boolean | null): void

Parameters

  • a: boolean | null

Returns void

showRange

Section titled "showRange"

Returns or sets a boolean value indicating whether the data label range is shown.

 
get showRange(): boolean | null

Returns boolean | null 

set showRange(a: boolean | null): void

Parameters

  • a: boolean | null

Returns void

showSeriesName

Section titled "showSeriesName"

Returns or sets a value indicating whether the series name is shown in the label.

 
get showSeriesName(): boolean | null

Returns boolean | null 

set showSeriesName(a: boolean | null): void

Parameters

  • a: boolean | null

Returns void

showValue

Section titled "showValue"

Returns or sets a value indicating whether the value is shown.

 
get showValue(): boolean | null

Returns boolean | null 

set showValue(a: boolean | null): void

Parameters

  • a: boolean | null

Returns void

text

Section titled "text"

Inherited from: ChartLabelBase

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

Returns void

textDirection

Section titled "textDirection"

Inherited from: ChartLabelBase

Determines the orientation and direction in which text flows.

 
get textDirection(): TextDirection

Returns TextDirection 

set textDirection(a: TextDirection): void

Parameters

Returns void

top

Section titled "top"

Inherited from: ChartLabelBase

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

Section titled "verticalAlignment"

Inherited from: ChartLabelBase

Determines the vertical alignment of the text area.

 
get verticalAlignment(): VerticalTitleAlignment

Returns VerticalTitleAlignment 

set verticalAlignment(a: VerticalTitleAlignment): void

Parameters

Returns void

verticalOverflow

Section titled "verticalOverflow"

Inherited from: ChartLabelBase

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

Returns void

width

Section titled "width"

Returns or sets a value that represents the width of the label, expressed as a ratio, relative to the size of the chart area.

 
get width(): number

Returns number 

set width(a: number): void

Parameters

  • a: number

Returns void

workbook

Section titled "workbook"

Inherited from: ChartLabelBase

The owning workbook (read-only)

 
get workbook(): Workbook

Returns Workbook

worksheet

Section titled "worksheet"

Inherited from: ChartLabelBase

The owning worksheet (read-only)

 
get worksheet(): Worksheet

Returns Worksheet

wrapText

Section titled "wrapText"

Inherited from: ChartLabelBase

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

Section titled "Methods"

setFormula

Section titled "setFormula"

Not supported.

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

Parameters

Returns void

staticInit

Section titled "staticInit" 
staticInit(): void

Returns void