@types/office-js-preview 1.0.276 → 1.0.277

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Thu, 16 Dec 2021 21:01:27 GMT
11
+ * Last updated: Mon, 03 Jan 2022 21:01:38 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
@@ -19739,6 +19739,12 @@ declare namespace Excel {
19739
19739
  */
19740
19740
  formattedNumber = "FormattedNumber",
19741
19741
  /**
19742
+ * Represents a `LinkedEntityCellValue`.
19743
+ *
19744
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19745
+ */
19746
+ linkedEntity = "LinkedEntity",
19747
+ /**
19742
19748
  * Represents a `StringCellValue`.
19743
19749
  *
19744
19750
  * @remarks
@@ -19770,7 +19776,7 @@ declare namespace Excel {
19770
19776
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19771
19777
  * @beta
19772
19778
  */
19773
- type CellValue = ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue | string | number | boolean & {
19779
+ type CellValue = ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue & {
19774
19780
  /**
19775
19781
  * Represents whether this `CellValue` will be used to overwrite a cell.
19776
19782
  * When false, APIs which would use this `CellValue` to overwrite a cell will instead ignore this value without throwing an error.
@@ -20030,7 +20036,7 @@ declare namespace Excel {
20030
20036
  */
20031
20037
  requestThrottle = "RequestThrottle",
20032
20038
  /**
20033
- * An error caused by external linkes failing to refresh. Displays as error type #CONNECT! in Excel.
20039
+ * An error caused by external links failing to refresh. Displays as error type #CONNECT! in Excel.
20034
20040
  *
20035
20041
  * @remarks
20036
20042
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -20639,6 +20645,91 @@ declare namespace Excel {
20639
20645
  errorType?: ErrorCellValueType.gettingData | "GettingData";
20640
20646
  }
20641
20647
  /**
20648
+ * The linked entity ID object represents a set of properties that describes a service and culture for locating this service defined value.
20649
+ *
20650
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20651
+ */
20652
+ interface LinkedEntityId {
20653
+ /**
20654
+ * Represents which service was used to create the `CellValue`.
20655
+ *
20656
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20657
+ */
20658
+ serviceId: number;
20659
+ /**
20660
+ * Represents a domain specific to a service used to create the `CellValue`.
20661
+ *
20662
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20663
+ */
20664
+ domainId?: string;
20665
+ /**
20666
+ * Represents an identifier specific to a service used to create the `CellValue`.
20667
+ *
20668
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20669
+ */
20670
+ entityId: string;
20671
+ /**
20672
+ * Represents which language culture was used to create this `CellValue`.
20673
+ *
20674
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20675
+ */
20676
+ culture: string;
20677
+ }
20678
+ /**
20679
+ * Represents a value whose properties derive from a service.
20680
+ *
20681
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20682
+ */
20683
+ interface LinkedEntityCellValue {
20684
+ /**
20685
+ * Represents the type of this cell value.
20686
+ *
20687
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20688
+ */
20689
+ type: CellValueType.linkedEntity | "LinkedEntity";
20690
+ /**
20691
+ * Represents the value that would be returned by `Range.values` for a cell with this value.
20692
+ *
20693
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20694
+ */
20695
+ basicValue?: "#VALUE!";
20696
+ /**
20697
+ * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20698
+ *
20699
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20700
+ */
20701
+ basicType?: RangeValueType.error | "Error";
20702
+ /**
20703
+ * Represents the service source that provided the information in this value.
20704
+ *
20705
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20706
+ */
20707
+ id: LinkedEntityId;
20708
+ /**
20709
+ * Represents the text shown when a cell with this value is rendered.
20710
+ *
20711
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20712
+ */
20713
+ text?: string;
20714
+ /**
20715
+ * Represents the properties of this entity and their metadata.
20716
+ *
20717
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20718
+ */
20719
+ properties?: {
20720
+ [key: string]: CellValue & {
20721
+ propertyMetadata?: CellValuePropertyMetadata;
20722
+ };
20723
+ };
20724
+ /**
20725
+ * Represents information that describes the service which provided the image.
20726
+ * This information can be used for branding in entity cards.
20727
+ *
20728
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20729
+ */
20730
+ provider?: CellValueProviderAttributes;
20731
+ }
20732
+ /**
20642
20733
  * Represents the value of a cell containing a #N/A! error.
20643
20734
  *
20644
20735
  * @remarks
@@ -20889,7 +20980,19 @@ declare namespace Excel {
20889
20980
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20890
20981
  * @beta
20891
20982
  */
20892
- subArrayEndColumnPrecedesStartColumn = "SubArrayEndColumnPrecedesStartColumn"
20983
+ subArrayEndColumnPrecedesStartColumn = "SubArrayEndColumnPrecedesStartColumn",
20984
+ /**
20985
+ * An error caused by structured references from the linked workbook. Displays as error type #REF! in Excel.
20986
+ *
20987
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20988
+ */
20989
+ externalLinksStructuredRef = "ExternalLinksStructuredRef",
20990
+ /**
20991
+ * An error caused by dynamic array references from the linked workbook. Displays as error type #REF! in Excel.
20992
+ *
20993
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20994
+ */
20995
+ externalLinksArrayRef = "ExternalLinksArrayRef"
20893
20996
  }
20894
20997
  /**
20895
20998
  * Represents the value of a cell containing a #REF! error.
@@ -20938,7 +21041,7 @@ declare namespace Excel {
20938
21041
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20939
21042
  * @beta
20940
21043
  */
20941
- errorSubType?: RefErrorCellValueSubType | "Unknown" | "VlookupColumnIndexGreaterThanNumColumns" | "HlookupRowIndexGreaterThanNumRows" | "ExternalLinksRefNotExist" | "SubArrayStartRowOutOfBounds" | "SubArrayStartColumnOutOfBounds" | "SubArrayEndRowOutOfBounds" | "SubArrayEndColumnOutOfBounds" | "SubArrayEndRowPrecedesStartRow" | "SubArrayEndColumnPrecedesStartColumn";
21044
+ errorSubType?: RefErrorCellValueSubType | "Unknown" | "VlookupColumnIndexGreaterThanNumColumns" | "HlookupRowIndexGreaterThanNumRows" | "ExternalLinksRefNotExist" | "SubArrayStartRowOutOfBounds" | "SubArrayStartColumnOutOfBounds" | "SubArrayEndRowOutOfBounds" | "SubArrayEndColumnOutOfBounds" | "SubArrayEndRowPrecedesStartRow" | "SubArrayEndColumnPrecedesStartColumn" | "ExternalLinksStructuredRef" | "ExternalLinksArrayRef";
20942
21045
  }
20943
21046
  /**
20944
21047
  * Represents types of #SPILL! errors.
@@ -21168,7 +21271,7 @@ declare namespace Excel {
21168
21271
  */
21169
21272
  coerceStringToBoolInvalid = "CoerceStringToBoolInvalid",
21170
21273
  /**
21171
- * An error caused by coersion of a string to a type other than a boolean or number. Displays as error type #VALUE! in Excel.
21274
+ * An error caused by conversion of a string to a type other than a boolean or number. Displays as error type #VALUE! in Excel.
21172
21275
  *
21173
21276
  * @remarks
21174
21277
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -27425,6 +27528,16 @@ declare namespace Excel {
27425
27528
  * [Api set: ExcelApi 1.9]
27426
27529
  */
27427
27530
  getIsActiveCollabSession(): OfficeExtension.ClientResult<boolean>;
27531
+ /**
27532
+ * Returns a `LinkedEntityCellValue` based on the provided `LinkedEntityId`.
27533
+ *
27534
+ * @remarks
27535
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
27536
+ * @beta
27537
+ *
27538
+ * @param linkedEntityCellValueId An identifier that specifies an individual `LinkedEntityCellValue`.
27539
+ */
27540
+ getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId): OfficeExtension.ClientResult<LinkedEntityCellValue>;
27428
27541
  /**
27429
27542
  * Gets the currently selected single range from the workbook. If there are multiple ranges selected, this method will throw an error.
27430
27543
  *
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.276",
3
+ "version": "1.0.277",
4
4
  "description": "TypeScript definitions for Office.js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -40,6 +40,6 @@
40
40
  },
41
41
  "scripts": {},
42
42
  "dependencies": {},
43
- "typesPublisherContentHash": "2f116cba25b96ababc54ae23a314a8476c0b32b4b12e4ceb2525b9f8ecf04d5d",
43
+ "typesPublisherContentHash": "48047cad490905a3955f7ba347135403a11e79dfdee70add88882ec38ce9b9e7",
44
44
  "typeScriptVersion": "3.8"
45
45
  }