excel.interfaces.shapecollectionloadoptions.yml

### YamlMime:TSType
name: Excel.Interfaces.ShapeCollectionLoadOptions
uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.ShapeCollectionLoadOptions
summary: Represents a collection of all the shapes in the worksheet.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: $all
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#$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: altTextDescription
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#altTextDescription:member'
    package: excel!
    fullName: altTextDescription
    summary: 'For EACH ITEM in the collection: Specifies the alternative description text for a `Shape` object.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'altTextDescription?: boolean;'
      return:
        type: boolean
  - name: altTextTitle
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#altTextTitle:member'
    package: excel!
    fullName: altTextTitle
    summary: 'For EACH ITEM in the collection: Specifies the alternative title text for a `Shape` object.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'altTextTitle?: boolean;'
      return:
        type: boolean
  - name: connectionSiteCount
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#connectionSiteCount:member'
    package: excel!
    fullName: connectionSiteCount
    summary: 'For EACH ITEM in the collection: Returns the number of connection sites on this shape.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'connectionSiteCount?: boolean;'
      return:
        type: boolean
  - name: displayName
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#displayName:member'
    package: excel!
    fullName: displayName
    summary: >-
      For EACH ITEM in the collection: Gets the display name of the shape. A newly created shape has a generated name
      that is localized and may not match its `name`<!-- -->. In this scenario, you can use this API to get the name
      that is displayed in the UI.
    remarks: '\[ [API set: ExcelApi 1.15](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'displayName?: boolean;'
      return:
        type: boolean
  - name: fill
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#fill:member'
    package: excel!
    fullName: fill
    summary: 'For EACH ITEM in the collection: Returns the fill formatting of this shape.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'fill?: Excel.Interfaces.ShapeFillLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ShapeFillLoadOptions:interface" />'
  - name: geometricShape
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#geometricShape:member'
    package: excel!
    fullName: geometricShape
    summary: >-
      For EACH ITEM in the collection: Returns the geometric shape associated with the shape. An error will be thrown if
      the shape type is not "GeometricShape".
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'geometricShape?: Excel.Interfaces.GeometricShapeLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.GeometricShapeLoadOptions:interface" />'
  - name: geometricShapeType
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#geometricShapeType:member'
    package: excel!
    fullName: geometricShapeType
    summary: >-
      For EACH ITEM in the collection: Specifies the geometric shape type of this geometric shape. See
      `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape".
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'geometricShapeType?: boolean;'
      return:
        type: boolean
  - name: group
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#group:member'
    package: excel!
    fullName: group
    summary: >-
      For EACH ITEM in the collection: Returns the shape group associated with the shape. An error will be thrown if the
      shape type is not "GroupShape".
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'group?: Excel.Interfaces.ShapeGroupLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ShapeGroupLoadOptions:interface" />'
  - name: height
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#height:member'
    package: excel!
    fullName: height
    summary: >-
      For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument`
      exception when set with a negative value or zero as an input.
    remarks: '\[ [API set: ExcelApi 1.9](/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.ShapeCollectionLoadOptions#id:member'
    package: excel!
    fullName: id
    summary: 'For EACH ITEM in the collection: Specifies the shape identifier.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'id?: boolean;'
      return:
        type: boolean
  - name: image
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#image:member'
    package: excel!
    fullName: image
    summary: >-
      For EACH ITEM in the collection: Returns the image associated with the shape. An error will be thrown if the shape
      type is not "Image".
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'image?: Excel.Interfaces.ImageLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ImageLoadOptions:interface" />'
  - name: left
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#left:member'
    package: excel!
    fullName: left
    summary: >-
      For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the
      worksheet. Throws an `InvalidArgument` exception when set with a negative value as an input.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'left?: boolean;'
      return:
        type: boolean
  - name: level
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#level:member'
    package: excel!
    fullName: level
    summary: >-
      For EACH ITEM in the collection: Specifies the level of the specified shape. For example, a level of 0 means that
      the shape is not part of any groups, a level of 1 means the shape is part of a top-level group, and a level of 2
      means the shape is part of a sub-group of the top level.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'level?: boolean;'
      return:
        type: boolean
  - name: line
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#line:member'
    package: excel!
    fullName: line
    summary: >-
      For EACH ITEM in the collection: Returns the line associated with the shape. An error will be thrown if the shape
      type is not "Line".
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'line?: Excel.Interfaces.LineLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.LineLoadOptions:interface" />'
  - name: lineFormat
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#lineFormat:member'
    package: excel!
    fullName: lineFormat
    summary: 'For EACH ITEM in the collection: Returns the line formatting of this shape.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'lineFormat?: Excel.Interfaces.ShapeLineFormatLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ShapeLineFormatLoadOptions:interface" />'
  - name: lockAspectRatio
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#lockAspectRatio:member'
    package: excel!
    fullName: lockAspectRatio
    summary: 'For EACH ITEM in the collection: Specifies if the aspect ratio of this shape is locked.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'lockAspectRatio?: boolean;'
      return:
        type: boolean
  - name: name
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#name:member'
    package: excel!
    fullName: name
    summary: 'For EACH ITEM in the collection: Specifies the name of the shape.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'name?: boolean;'
      return:
        type: boolean
  - name: parentGroup
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#parentGroup:member'
    package: excel!
    fullName: parentGroup
    summary: 'For EACH ITEM in the collection: Specifies the parent group of this shape.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'parentGroup?: Excel.Interfaces.ShapeLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ShapeLoadOptions:interface" />'
  - name: placement
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#placement:member'
    package: excel!
    fullName: placement
    summary: 'For EACH ITEM in the collection: Represents how the object is attached to the cells below it.'
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'placement?: boolean;'
      return:
        type: boolean
  - name: rotation
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#rotation:member'
    package: excel!
    fullName: rotation
    summary: 'For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'rotation?: boolean;'
      return:
        type: boolean
  - name: textFrame
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#textFrame:member'
    package: excel!
    fullName: textFrame
    summary: 'For EACH ITEM in the collection: Returns the text frame object of this shape.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'textFrame?: Excel.Interfaces.TextFrameLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.TextFrameLoadOptions:interface" />'
  - name: top
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#top:member'
    package: excel!
    fullName: top
    summary: >-
      For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the
      worksheet. Throws an `InvalidArgument` exception when set with a negative value as an input.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'top?: boolean;'
      return:
        type: boolean
  - name: type
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#type:member'
    package: excel!
    fullName: type
    summary: 'For EACH ITEM in the collection: Returns the type of this shape. See `Excel.ShapeType` for details.'
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'type?: boolean;'
      return:
        type: boolean
  - name: visible
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#visible:member'
    package: excel!
    fullName: visible
    summary: 'For EACH ITEM in the collection: Specifies if the shape is visible.'
    remarks: '\[ [API set: ExcelApi 1.9](/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.ShapeCollectionLoadOptions#width:member'
    package: excel!
    fullName: width
    summary: >-
      For EACH ITEM in the collection: Specifies the width, in points, of the shape. Throws an `InvalidArgument`
      exception when set with a negative value or zero as an input.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'width?: boolean;'
      return:
        type: boolean
  - name: zOrderPosition
    uid: 'excel!Excel.Interfaces.ShapeCollectionLoadOptions#zOrderPosition:member'
    package: excel!
    fullName: zOrderPosition
    summary: >-
      For EACH ITEM in the collection: Returns the position of the specified shape in the z-order, with 0 representing
      the bottom of the order stack.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'zOrderPosition?: boolean;'
      return:
        type: boolean