Represents the legend in a chart. Each chart can have only one legend.

Constructors

Section titled "Constructors"

Legend

new Legend(): Legend

Returns Legend

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

border

Section titled "border" 
border: ChartBorder

defaultFontFill

Section titled "defaultFontFill" 
defaultFontFill: ChartFillBase

fill

Section titled "fill" 
fill: ChartFillBase

height

Section titled "height" 
height: number

left

Section titled "left" 
left: number

overlay

Section titled "overlay" 
overlay: boolean

position

Section titled "position" 
position: LegendPosition

rotation

Section titled "rotation" 
rotation: number

textDirection

Section titled "textDirection" 
textDirection: TextDirection

top

Section titled "top" 
top: number

width

Section titled "width" 
width: number

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 legend entries which have no specific font settings. Read-only.

get defaultFont(): IWorkbookFont

Returns IWorkbookFont

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"

legendEntries

Section titled "legendEntries"

Indexer (read-only)

legendEntries(index: number): LegendEntry

Parameters

  • index: number

    A zero based index

Returns LegendEntry