ig.excel.LegendEntry
Remarks
NOTE: Legend entries are not supported for the following chart types:
- Box and Whisker
- Histogram
- Pareto
- Sunburst
- Treemap
- Waterfall
Dependencies
-
chart
Inherited- .chart( );
- Return Type:
- ig.excel.WorksheetChart
- Return Type Description:
- Returns a WorksheetChart.
Returns the owning chart (read-only)
-
delete
- .delete( );
Marks the entry as being deleted.
-
font
- .font( );
- Return Type:
- ig.excel.IWorkbookFont
- Return Type Description:
- Returns a IWorkbookFont.
Returns the font for this legend entry. Read-only.
Remarks
This property provides a way to specify font settings for a particular legend entry; to apply font settings to all legend entries, use the Legend.defaultFont property.
-
fontFill
- .fontFill( );
- Return Type:
- ig.excel.ChartFillBase
- Return Type Description:
- Returns a ChartFillBase.
Returns a ChartFillBase derived object which defines the font color(s) for this legend entry.
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.
-
fontFill
- .fontFill( 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 this legend entry.
- 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.
-
isDeleted
- .isDeleted( );
Returns a boolean value indicating whether this entry has been removed from the WorksheetChart.legend
Remarks
Deletion does not remove the entry from the Legend.legendEntries collection, but rather marks it as deleted, so that it does not appear in the legend.
-
isDeleted
- .isDeleted( value:boolean );
Sets a boolean value indicating whether this entry has been removed from the WorksheetChart.legend
- value
- Type:boolean
Remarks
Deletion does not remove the entry from the Legend.legendEntries collection, but rather marks it as deleted, so that it does not appear in the legend.
-
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)
-
sheet
Inherited- .sheet( );
- Return Type:
- ig.excel.Sheet
- Return Type Description:
- Returns a Sheet.
Gets the owning sheet (read-only)
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