ig.excel.Legend
Dependencies
-
ig.excel.Legend
Constructor- new $.ig.excel.Legend( );
Creates a new Legend instance.
-
border
- .border( );
- Return Type:
- ig.excel.ChartBorder
- Return Type Description:
- Returns a ChartBorder.
Determines the appearance of the border drawn around the text area, as well as whether a border appears.
See Also
-
border
- .border( value:ig.excel.ChartBorder );
- Return Type:
- ig.excel.ChartBorder
- Return Type Description:
- Returns a ChartBorder.
Determines the appearance of the border drawn around the text area, as well as whether a border appears.
- value
- Type:ig.excel.ChartBorder
See Also
-
chart
Inherited- .chart( );
- Return Type:
- ig.excel.WorksheetChart
- Return Type Description:
- Returns a WorksheetChart.
Returns the owning chart (read-only)
-
defaultFont
- .defaultFont( );
- Return Type:
- ig.excel.IWorkbookFont
- Return Type Description:
- Returns a IWorkbookFont.
Defines the font properties for legend entries which have no specific font settings. Read-only.
Remarks
To apply font settings to a specific legend entry, use the LegendEntry.font property.
Note: this property will return null until the Legend is set on the WorksheetChart.Legend property. -
defaultFontFill
- .defaultFontFill( );
- Return Type:
- ig.excel.ChartFillBase
- Return Type Description:
- Returns a ChartFillBase.
Returns a ChartFillBase derived object which defines the font color(s) for legend entries.
Remarks
Use this property to apply the same font color(s) to all legend entries.
Use the LegendEntry.fontFill property to apply font color(s) for a particular legend entry.
-
defaultFontFill
- .defaultFontFill( value:ig.excel.ChartFillBase );
- Return Type:
- ig.excel.ChartFillBase
- Return Type Description:
- Returns a ChartFillBase.
Sets a ChartFillBase derived object which defines the font color(s) for legend entries.
- value
- Type:ig.excel.ChartFillBase
Remarks
Use this property to apply the same font color(s) to all legend entries.
Use the LegendEntry.fontFill property to apply font color(s) for a particular legend entry.
-
fill
- .fill( );
- Return Type:
- ig.excel.ChartFillBase
- Return Type Description:
- Returns a ChartFillBase.
Returns a ChartFillBase derived object which defines the fill properties for the legend's text area.
Remarks
This property returns null by default, indicating that no fill is applied.
To apply a solid color fill, assign an instance of the ChartSolidFill class to this property.
To apply a gradient fill, assign an instance of the ChartGradientFill class to this property.
-
fill
- .fill( value:ig.excel.ChartFillBase );
- Return Type:
- ig.excel.ChartFillBase
- Return Type Description:
- Returns a ChartFillBase.
Sets a ChartFillBase derived object which defines the fill properties for the legend's text area.
- value
- Type:ig.excel.ChartFillBase
Remarks
This property returns null by default, indicating that no fill is applied.
To apply a solid color fill, assign an instance of the ChartSolidFill class to this property.
To apply a gradient fill, assign an instance of the ChartGradientFill class to this property.
-
height
- .height( );
Returns a value that represents the height of the legend area, expressed as a fraction of the chart area's height.
Remarks
Valid values for this property range between zero and one, with a value of one representing the total height of the chart area.
A value of .1 (for example) represents a height that is equal to one-tenth the height of the chart area.
See Also
-
height
- .height( value:number );
Sets a value that represents the height of the legend area, expressed as a fraction of the chart area's height.
- value
- Type:number
Remarks
Valid values for this property range between zero and one, with a value of one representing the total height of the chart area.
A value of .1 (for example) represents a height that is equal to one-tenth the height of the chart area.
See Also
-
left
- .left( );
Returns a value that represents the position of the left edge of the legend area, expressed as a fraction of the chart area's width.
Remarks
Valid values for this property range between zero and one, with a value of one representing the total width of the chart area.
See Also
-
left
- .left( value:number );
Sets a value that represents the position of the left edge of the legend area, expressed as a fraction of the chart area's width.
- value
- Type:number
Remarks
Valid values for this property range between zero and one, with a value of one representing the total width of the chart area.
See Also
-
legendEntries
- .legendEntries( );
- Return Type:
- ig.excel.LegendEntries
- Return Type Description:
- Returns a LegendEntries.
Returns a read only collection of legend entries.
Remarks
This collection contains one entry for each Series in the associated chart's WorksheetChart.seriesCollection.
This collection does not include legend entries for trendlines.
Use the Trendline.legendEntry property to obtain a reference to the legend entry associated with a trendline.
-
legendEntries
- .legendEntries( index:number );
- Return Type:
- ig.excel.LegendEntry
- Return Type Description:
Indexer (read-only)
- index
- Type:number
- A zero based index
See Also
-
overlay
- .overlay( );
Returns a boolean value indicating whether the legend can intersect with the chart's plot area.
-
overlay
- .overlay( value:boolean );
Sets a boolean value indicating whether the legend can intersect with the chart's plot area.
- value
- Type:boolean
-
owner
Inherited- .owner( );
- Return Type:
- ig.excel.ChartObject
- Return Type Description:
- The owner or null if this object is owned directly by the Chart
returns this object's owner. (read-only)
-
position
- .position( );
- Return Type:
- ig.excel.LegendPosition
- Return Type Description:
- Returns a LegendPosition.
Returns a value that represents the position of the legend on the chart.
See Also
-
position
- .position( value:ig.excel.LegendPosition );
- Return Type:
- ig.excel.LegendPosition
- Return Type Description:
- Returns a LegendPosition.
Sets a value that represents the position of the legend on the chart.
- value
- Type:ig.excel.LegendPosition
See Also
-
rotation
- .rotation( );
Determines the rotation of the legend's text area, expressed in degrees.
-
rotation
- .rotation( value:number );
Determines the rotation of the legend's text area, expressed in degrees.
- value
- Type:number
-
sheet
Inherited- .sheet( );
- Return Type:
- ig.excel.Sheet
- Return Type Description:
- Returns a Sheet.
Gets the owning sheet (read-only)
See Also
-
textDirection
- .textDirection( );
- Return Type:
- ig.excel.TextDirection
- Return Type Description:
- Returns a TextDirection.
Determines the orientation and direction in which text flows.
Remarks
Note that the Legend.rotation property is only applicable when this property is set to Horizontal.
-
textDirection
- .textDirection( value:ig.excel.TextDirection );
- Return Type:
- ig.excel.TextDirection
- Return Type Description:
- Returns a TextDirection.
Determines the orientation and direction in which text flows.
- value
- Type:ig.excel.TextDirection
Remarks
Note that the Legend.rotation property is only applicable when this property is set to Horizontal.
-
top
- .top( );
Returns a value that represents the position of the top edge of the legend area, expressed as a fraction of the chart area's height.
Remarks
Valid values for this property range between zero and one, with a value of one representing the total height of the chart area.
See Also
-
top
- .top( value:number );
Sets a value that represents the position of the top edge of the legend area, expressed as a fraction of the chart area's height.
- value
- Type:number
Remarks
Valid values for this property range between zero and one, with a value of one representing the total height of the chart area.
See Also
-
width
- .width( );
Returns a value that represents the width of the legend area, expressed as a fraction of the chart area's width.
Remarks
Valid values for this property range between zero and one, with a value of one representing the total width of the chart area.
See Also
-
width
- .width( value:number );
Sets a value that represents the width of the legend area, expressed as a fraction of the chart area's width.
- value
- Type:number
Remarks
Valid values for this property range between zero and one, with a value of one representing the total width of the chart area.
See Also
-
workbook
Inherited- .workbook( );
- Return Type:
- ig.excel.Workbook
- Return Type Description:
- Returns a Workbook.
Gets the owning workbook (read-only)
See Also
-
worksheet
Inherited- .worksheet( );
- Return Type:
- ig.excel.Worksheet
- Return Type Description:
- Returns a Worksheet.
Gets the owning worksheet (read-only)
See Also