excel.chartlegend.yml

### YamlMime:TSType
name: Excel.ChartLegend
uid: 'excel!Excel.ChartLegend:class'
package: excel!
fullName: Excel.ChartLegend
summary: Represents the legend in a chart.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
  - name: context
    uid: 'excel!Excel.ChartLegend#context:member'
    package: excel!
    fullName: context
    summary: >-
      The request context associated with the object. This connects the add-in's process to the Office host
      application's process.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'context: RequestContext;'
      return:
        type: '<xref uid="excel!Excel.RequestContext:class" />'
  - name: format
    uid: 'excel!Excel.ChartLegend#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: 'readonly format: Excel.ChartLegendFormat;'
      return:
        type: '<xref uid="excel!Excel.ChartLegendFormat:class" />'
  - name: height
    uid: 'excel!Excel.ChartLegend#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.ChartLegend#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.ChartLegend#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: 'readonly legendEntries: Excel.ChartLegendEntryCollection;'
      return:
        type: '<xref uid="excel!Excel.ChartLegendEntryCollection:class" />'
  - name: overlay
    uid: 'excel!Excel.ChartLegend#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.ChartLegend#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.ChartLegend#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.ChartLegend#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.ChartLegend#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.ChartLegend#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
methods:
  - name: load(options)
    uid: 'excel!Excel.ChartLegend#load:member(1)'
    package: excel!
    fullName: load(options)
    summary: >-
      Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
      the properties.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'load(options?: Excel.Interfaces.ChartLegendLoadOptions): Excel.ChartLegend;'
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: '<xref uid="excel!Excel.Interfaces.ChartLegendLoadOptions:interface" />'
      return:
        type: '<xref uid="excel!Excel.ChartLegend:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'excel!Excel.ChartLegend#load:member(2)'
    package: excel!
    fullName: load(propertyNames)
    summary: >-
      Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
      the properties.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'load(propertyNames?: string | string[]): Excel.ChartLegend;'
      parameters:
        - id: propertyNames
          description: A comma-delimited string or an array of strings that specify the properties to load.
          type: 'string | string[]'
      return:
        type: '<xref uid="excel!Excel.ChartLegend:class" />'
        description: |-


          #### Examples

          ```TypeScript
          // Get the position of Chart Legend from Chart1.
          await Excel.run(async (context) => { 
              const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
              const legend = chart.legend;
              legend.load('position');
              await context.sync();

              console.log(legend.position);
          });
          ```
  - name: load(propertyNamesAndPaths)
    uid: 'excel!Excel.ChartLegend#load:member(3)'
    package: excel!
    fullName: load(propertyNamesAndPaths)
    summary: >-
      Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
      the properties.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: |-
        load(propertyNamesAndPaths?: {
                    select?: string;
                    expand?: string;
                }): Excel.ChartLegend;
      parameters:
        - id: propertyNamesAndPaths
          description: >-
            `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and
            `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
          type: |-
            {
                        select?: string;
                        expand?: string;
                    }
      return:
        type: '<xref uid="excel!Excel.ChartLegend:class" />'
        description: ''
  - name: 'set(properties, options)'
    uid: 'excel!Excel.ChartLegend#set:member(1)'
    package: excel!
    fullName: 'set(properties, options)'
    summary: >-
      Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate
      properties, or another API object of the same type.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'set(properties: Interfaces.ChartLegendUpdateData, options?: OfficeExtension.UpdateOptions): void;'
      parameters:
        - id: properties
          description: >-
            A JavaScript object with properties that are structured isomorphically to the properties of the object on
            which the method is called.
          type: '<xref uid="excel!Excel.Interfaces.ChartLegendUpdateData:interface" />'
        - id: options
          description: Provides an option to suppress errors if the properties object tries to set any read-only properties.
          type: '<xref uid="office!OfficeExtension.UpdateOptions:interface" />'
      return:
        type: void
        description: ''
  - name: set(properties)
    uid: 'excel!Excel.ChartLegend#set:member(2)'
    package: excel!
    fullName: set(properties)
    summary: 'Sets multiple properties on the object at the same time, based on an existing loaded object.'
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'set(properties: Excel.ChartLegend): void;'
      parameters:
        - id: properties
          description: ''
          type: '<xref uid="excel!Excel.ChartLegend:class" />'
      return:
        type: void
        description: ''
  - name: toJSON()
    uid: 'excel!Excel.ChartLegend#toJSON:member(1)'
    package: excel!
    fullName: toJSON()
    summary: >-
      Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to
      `JSON.stringify()`<!-- -->. (`JSON.stringify`<!-- -->, in turn, calls the `toJSON` method of the object that is
      passed to it.) Whereas the original Excel.ChartLegend object is an API object, the `toJSON` method returns a plain
      JavaScript object (typed as `Excel.Interfaces.ChartLegendData`<!-- -->) that contains shallow copies of any loaded
      child properties from the original object.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'toJSON(): Excel.Interfaces.ChartLegendData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartLegendData:interface" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'