excel.interfaces.chartloadoptions.yml

### YamlMime:TSType
name: Excel.Interfaces.ChartLoadOptions
uid: 'excel!Excel.Interfaces.ChartLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.ChartLoadOptions
summary: >-
  Represents a chart object in a workbook. To learn more about the chart object model, see [Work with charts using the
  Excel JavaScript API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-charts)<!-- -->.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: $all
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#$all:member'
    package: excel!
    fullName: $all
    summary: >-
      Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`<!-- -->) but not the
      navigational properties (e.g.: `Range.format.fill.color`<!-- -->).
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: '$all?: boolean;'
      return:
        type: boolean
  - name: axes
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#axes:member'
    package: excel!
    fullName: axes
    summary: Represents chart axes.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'axes?: Excel.Interfaces.ChartAxesLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartAxesLoadOptions:interface" />'
  - name: categoryLabelLevel
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#categoryLabelLevel:member'
    package: excel!
    fullName: categoryLabelLevel
    summary: 'Specifies a chart category label level enumeration constant, referring to the level of the source category labels.'
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'categoryLabelLevel?: boolean;'
      return:
        type: boolean
  - name: chartType
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#chartType:member'
    package: excel!
    fullName: chartType
    summary: Specifies the type of the chart. See `Excel.ChartType` for details.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'chartType?: boolean;'
      return:
        type: boolean
  - name: dataLabels
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#dataLabels:member'
    package: excel!
    fullName: dataLabels
    summary: Represents the data labels on the chart.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'dataLabels?: Excel.Interfaces.ChartDataLabelsLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartDataLabelsLoadOptions:interface" />'
  - name: displayBlanksAs
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#displayBlanksAs:member'
    package: excel!
    fullName: displayBlanksAs
    summary: Specifies the way that blank cells are plotted on a chart.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'displayBlanksAs?: boolean;'
      return:
        type: boolean
  - name: format
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#format:member'
    package: excel!
    fullName: format
    summary: Encapsulates the format properties for the chart area.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'format?: Excel.Interfaces.ChartAreaFormatLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartAreaFormatLoadOptions:interface" />'
  - name: height
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#height:member'
    package: excel!
    fullName: height
    summary: 'Specifies the height, in points, of the chart object.'
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'height?: boolean;'
      return:
        type: boolean
  - name: id
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#id:member'
    package: excel!
    fullName: id
    summary: The unique ID of chart.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'id?: boolean;'
      return:
        type: boolean
  - name: left
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#left:member'
    package: excel!
    fullName: left
    summary: 'The distance, in points, from the left side of the chart to the worksheet origin.'
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'left?: boolean;'
      return:
        type: boolean
  - name: legend
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#legend:member'
    package: excel!
    fullName: legend
    summary: Represents the legend for the chart.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'legend?: Excel.Interfaces.ChartLegendLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartLegendLoadOptions:interface" />'
  - name: name
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#name:member'
    package: excel!
    fullName: name
    summary: Specifies the name of a chart object.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'name?: boolean;'
      return:
        type: boolean
  - name: pivotOptions
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#pivotOptions:member'
    package: excel!
    fullName: pivotOptions
    summary: Encapsulates the options for a pivot chart.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'pivotOptions?: Excel.Interfaces.ChartPivotOptionsLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartPivotOptionsLoadOptions:interface" />'
  - name: plotArea
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#plotArea:member'
    package: excel!
    fullName: plotArea
    summary: Represents the plot area for the chart.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'plotArea?: Excel.Interfaces.ChartPlotAreaLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartPlotAreaLoadOptions:interface" />'
  - name: plotBy
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#plotBy:member'
    package: excel!
    fullName: plotBy
    summary: Specifies the way columns or rows are used as data series on the chart.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'plotBy?: boolean;'
      return:
        type: boolean
  - name: plotVisibleOnly
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#plotVisibleOnly:member'
    package: excel!
    fullName: plotVisibleOnly
    summary: True if only visible cells are plotted. False if both visible and hidden cells are plotted.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'plotVisibleOnly?: boolean;'
      return:
        type: boolean
  - name: series
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#series:member'
    package: excel!
    fullName: series
    summary: Represents either a single series or collection of series in the chart.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'series?: Excel.Interfaces.ChartSeriesCollectionLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartSeriesCollectionLoadOptions:interface" />'
  - name: seriesNameLevel
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#seriesNameLevel:member'
    package: excel!
    fullName: seriesNameLevel
    summary: 'Specifies a chart series name level enumeration constant, referring to the level of the source series names.'
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'seriesNameLevel?: boolean;'
      return:
        type: boolean
  - name: showAllFieldButtons
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#showAllFieldButtons:member'
    package: excel!
    fullName: showAllFieldButtons
    summary: Specifies whether to display all field buttons on a PivotChart.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showAllFieldButtons?: boolean;'
      return:
        type: boolean
  - name: showDataLabelsOverMaximum
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#showDataLabelsOverMaximum:member'
    package: excel!
    fullName: showDataLabelsOverMaximum
    summary: >-
      Specifies whether to show the data labels when the value is greater than the maximum value on the value axis. If
      the value axis becomes smaller than the size of the data points, you can use this property to set whether to show
      the data labels. This property applies to 2-D charts only.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showDataLabelsOverMaximum?: boolean;'
      return:
        type: boolean
  - name: style
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#style:member'
    package: excel!
    fullName: style
    summary: Specifies the chart style for the chart.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'style?: boolean;'
      return:
        type: boolean
  - name: title
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#title:member'
    package: excel!
    fullName: title
    summary: >-
      Represents the title of the specified chart, including the text, visibility, position, and formatting of the
      title.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'title?: Excel.Interfaces.ChartTitleLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartTitleLoadOptions:interface" />'
  - name: top
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#top:member'
    package: excel!
    fullName: top
    summary: >-
      Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top
      of the chart area (on a chart).
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'top?: boolean;'
      return:
        type: boolean
  - name: width
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#width:member'
    package: excel!
    fullName: width
    summary: 'Specifies the width, in points, of the chart object.'
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'width?: boolean;'
      return:
        type: boolean
  - name: worksheet
    uid: 'excel!Excel.Interfaces.ChartLoadOptions#worksheet:member'
    package: excel!
    fullName: worksheet
    summary: The worksheet containing the current chart.
    remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'worksheet?: Excel.Interfaces.WorksheetLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.WorksheetLoadOptions:interface" />'