excel.interfaces.chartcollectionloadoptions.yml

### YamlMime:TSType
name: Excel.Interfaces.ChartCollectionLoadOptions
uid: 'excel!Excel.Interfaces.ChartCollectionLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.ChartCollectionLoadOptions
summary: A collection of all the chart objects on a worksheet.
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.ChartCollectionLoadOptions#$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.ChartCollectionLoadOptions#axes:member'
    package: excel!
    fullName: axes
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#categoryLabelLevel:member'
    package: excel!
    fullName: categoryLabelLevel
    summary: >-
      For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#chartType:member'
    package: excel!
    fullName: chartType
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#dataLabels:member'
    package: excel!
    fullName: dataLabels
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#displayBlanksAs:member'
    package: excel!
    fullName: displayBlanksAs
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#format:member'
    package: excel!
    fullName: format
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#height:member'
    package: excel!
    fullName: height
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#id:member'
    package: excel!
    fullName: id
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#left:member'
    package: excel!
    fullName: left
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#legend:member'
    package: excel!
    fullName: legend
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#name:member'
    package: excel!
    fullName: name
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#pivotOptions:member'
    package: excel!
    fullName: pivotOptions
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#plotArea:member'
    package: excel!
    fullName: plotArea
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#plotBy:member'
    package: excel!
    fullName: plotBy
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#plotVisibleOnly:member'
    package: excel!
    fullName: plotVisibleOnly
    summary: >-
      For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#series:member'
    package: excel!
    fullName: series
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#seriesNameLevel:member'
    package: excel!
    fullName: seriesNameLevel
    summary: >-
      For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#showAllFieldButtons:member'
    package: excel!
    fullName: showAllFieldButtons
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#showDataLabelsOverMaximum:member'
    package: excel!
    fullName: showDataLabelsOverMaximum
    summary: >-
      For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#style:member'
    package: excel!
    fullName: style
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#title:member'
    package: excel!
    fullName: title
    summary: >-
      For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#top:member'
    package: excel!
    fullName: top
    summary: >-
      For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#width:member'
    package: excel!
    fullName: width
    summary: 'For EACH ITEM in the collection: 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.ChartCollectionLoadOptions#worksheet:member'
    package: excel!
    fullName: worksheet
    summary: 'For EACH ITEM in the collection: 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" />'