excel.interfaces.chartlegenddata.yml

### YamlMime:TSType
name: Excel.Interfaces.ChartLegendData
uid: 'excel!Excel.Interfaces.ChartLegendData:interface'
package: excel!
fullName: Excel.Interfaces.ChartLegendData
summary: An interface describing the data returned by calling `chartLegend.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: format
    uid: 'excel!Excel.Interfaces.ChartLegendData#format:member'
    package: excel!
    fullName: format
    summary: 'Represents the formatting of a chart legend, which includes fill and font formatting.'
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'format?: Excel.Interfaces.ChartLegendFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartLegendFormatData:interface" />'
  - name: height
    uid: 'excel!Excel.Interfaces.ChartLegendData#height:member'
    package: excel!
    fullName: height
    summary: 'Specifies the height, in points, of the legend on the chart. Value is `null` if the legend is not visible.'
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'height?: number;'
      return:
        type: number
  - name: left
    uid: 'excel!Excel.Interfaces.ChartLegendData#left:member'
    package: excel!
    fullName: left
    summary: 'Specifies the left value, in points, of the legend on the chart. Value is `null` if the legend is not visible.'
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'left?: number;'
      return:
        type: number
  - name: legendEntries
    uid: 'excel!Excel.Interfaces.ChartLegendData#legendEntries:member'
    package: excel!
    fullName: legendEntries
    summary: Represents a collection of legendEntries in the legend.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'legendEntries?: Excel.Interfaces.ChartLegendEntryData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartLegendEntryData:interface" />[]'
  - name: overlay
    uid: 'excel!Excel.Interfaces.ChartLegendData#overlay:member'
    package: excel!
    fullName: overlay
    summary: Specifies if the chart legend should overlap with the main body of the chart.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'overlay?: boolean;'
      return:
        type: boolean
  - name: position
    uid: 'excel!Excel.Interfaces.ChartLegendData#position:member'
    package: excel!
    fullName: position
    summary: Specifies the position of the legend on the chart. See `Excel.ChartLegendPosition` for details.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'position?: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom";'
      return:
        type: >-
          <xref uid="excel!Excel.ChartLegendPosition:enum" /> | "Invalid" | "Top" | "Bottom" | "Left" | "Right" |
          "Corner" | "Custom"
  - name: showShadow
    uid: 'excel!Excel.Interfaces.ChartLegendData#showShadow:member'
    package: excel!
    fullName: showShadow
    summary: Specifies if the legend has a shadow on the chart.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showShadow?: boolean;'
      return:
        type: boolean
  - name: top
    uid: 'excel!Excel.Interfaces.ChartLegendData#top:member'
    package: excel!
    fullName: top
    summary: Specifies the top of a chart legend.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'top?: number;'
      return:
        type: number
  - name: visible
    uid: 'excel!Excel.Interfaces.ChartLegendData#visible:member'
    package: excel!
    fullName: visible
    summary: Specifies if the chart legend is visible.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'visible?: boolean;'
      return:
        type: boolean
  - name: width
    uid: 'excel!Excel.Interfaces.ChartLegendData#width:member'
    package: excel!
    fullName: width
    summary: 'Specifies the width, in points, of the legend on the chart. Value is `null` if the legend is not visible.'
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'width?: number;'
      return:
        type: number