@types/office-js 1.0.457 → 1.0.459

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.
office-js/README.md CHANGED
@@ -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.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Tue, 21 Jan 2025 20:02:16 GMT
11
+ * Last updated: Wed, 29 Jan 2025 23:02:16 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -119548,47 +119548,47 @@ declare namespace PowerPoint {
119548
119548
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
119549
119549
  context: RequestContext;
119550
119550
  /**
119551
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
119551
+ * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments.
119552
119552
  *
119553
119553
  * @remarks
119554
119554
  * [Api set: PowerPointApi 1.4]
119555
119555
  */
119556
- bold: boolean;
119556
+ bold: boolean | null;
119557
119557
  /**
119558
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
119558
+ * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
119559
119559
  *
119560
119560
  * @remarks
119561
119561
  * [Api set: PowerPointApi 1.4]
119562
119562
  */
119563
- color: string;
119563
+ color: string | null;
119564
119564
  /**
119565
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
119565
+ * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments.
119566
119566
  *
119567
119567
  * @remarks
119568
119568
  * [Api set: PowerPointApi 1.4]
119569
119569
  */
119570
- italic: boolean;
119570
+ italic: boolean | null;
119571
119571
  /**
119572
- * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
119572
+ * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
119573
119573
  *
119574
119574
  * @remarks
119575
119575
  * [Api set: PowerPointApi 1.4]
119576
119576
  */
119577
- name: string;
119577
+ name: string | null;
119578
119578
  /**
119579
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
119579
+ * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
119580
119580
  *
119581
119581
  * @remarks
119582
119582
  * [Api set: PowerPointApi 1.4]
119583
119583
  */
119584
- size: number;
119584
+ size: number | null;
119585
119585
  /**
119586
- * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
119586
+ * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
119587
119587
  *
119588
119588
  * @remarks
119589
119589
  * [Api set: PowerPointApi 1.4]
119590
119590
  */
119591
- underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
119591
+ underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
119592
119592
  /**
119593
119593
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
119594
119594
  *
@@ -121589,47 +121589,47 @@ declare namespace PowerPoint {
121589
121589
  /** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
121590
121590
  interface ShapeFontUpdateData {
121591
121591
  /**
121592
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
121592
+ * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments.
121593
121593
  *
121594
121594
  * @remarks
121595
121595
  * [Api set: PowerPointApi 1.4]
121596
121596
  */
121597
- bold?: boolean;
121597
+ bold?: boolean | null;
121598
121598
  /**
121599
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
121599
+ * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
121600
121600
  *
121601
121601
  * @remarks
121602
121602
  * [Api set: PowerPointApi 1.4]
121603
121603
  */
121604
- color?: string;
121604
+ color?: string | null;
121605
121605
  /**
121606
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
121606
+ * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments.
121607
121607
  *
121608
121608
  * @remarks
121609
121609
  * [Api set: PowerPointApi 1.4]
121610
121610
  */
121611
- italic?: boolean;
121611
+ italic?: boolean | null;
121612
121612
  /**
121613
- * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
121613
+ * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
121614
121614
  *
121615
121615
  * @remarks
121616
121616
  * [Api set: PowerPointApi 1.4]
121617
121617
  */
121618
- name?: string;
121618
+ name?: string | null;
121619
121619
  /**
121620
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
121620
+ * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
121621
121621
  *
121622
121622
  * @remarks
121623
121623
  * [Api set: PowerPointApi 1.4]
121624
121624
  */
121625
- size?: number;
121625
+ size?: number | null;
121626
121626
  /**
121627
- * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
121627
+ * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
121628
121628
  *
121629
121629
  * @remarks
121630
121630
  * [Api set: PowerPointApi 1.4]
121631
121631
  */
121632
- underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
121632
+ underline?: ShapeFontUnderlineStyle | null;
121633
121633
  }
121634
121634
  /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
121635
121635
  interface ShapeCollectionUpdateData {
@@ -122015,47 +122015,47 @@ declare namespace PowerPoint {
122015
122015
  /** An interface describing the data returned by calling `shapeFont.toJSON()`. */
122016
122016
  interface ShapeFontData {
122017
122017
  /**
122018
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
122018
+ * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments.
122019
122019
  *
122020
122020
  * @remarks
122021
122021
  * [Api set: PowerPointApi 1.4]
122022
122022
  */
122023
- bold?: boolean;
122023
+ bold?: boolean | null;
122024
122024
  /**
122025
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
122025
+ * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
122026
122026
  *
122027
122027
  * @remarks
122028
122028
  * [Api set: PowerPointApi 1.4]
122029
122029
  */
122030
- color?: string;
122030
+ color?: string | null;
122031
122031
  /**
122032
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
122032
+ * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments.
122033
122033
  *
122034
122034
  * @remarks
122035
122035
  * [Api set: PowerPointApi 1.4]
122036
122036
  */
122037
- italic?: boolean;
122037
+ italic?: boolean | null;
122038
122038
  /**
122039
- * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
122039
+ * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
122040
122040
  *
122041
122041
  * @remarks
122042
122042
  * [Api set: PowerPointApi 1.4]
122043
122043
  */
122044
- name?: string;
122044
+ name?: string | null;
122045
122045
  /**
122046
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
122046
+ * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
122047
122047
  *
122048
122048
  * @remarks
122049
122049
  * [Api set: PowerPointApi 1.4]
122050
122050
  */
122051
- size?: number;
122051
+ size?: number | null;
122052
122052
  /**
122053
- * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
122053
+ * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
122054
122054
  *
122055
122055
  * @remarks
122056
122056
  * [Api set: PowerPointApi 1.4]
122057
122057
  */
122058
- underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
122058
+ underline?: ShapeFontUnderlineStyle | null;
122059
122059
  }
122060
122060
  /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
122061
122061
  interface ShapeCollectionData {
@@ -122659,42 +122659,42 @@ declare namespace PowerPoint {
122659
122659
  */
122660
122660
  $all?: boolean;
122661
122661
  /**
122662
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
122662
+ * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments.
122663
122663
  *
122664
122664
  * @remarks
122665
122665
  * [Api set: PowerPointApi 1.4]
122666
122666
  */
122667
122667
  bold?: boolean;
122668
122668
  /**
122669
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
122669
+ * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
122670
122670
  *
122671
122671
  * @remarks
122672
122672
  * [Api set: PowerPointApi 1.4]
122673
122673
  */
122674
122674
  color?: boolean;
122675
122675
  /**
122676
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
122676
+ * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments.
122677
122677
  *
122678
122678
  * @remarks
122679
122679
  * [Api set: PowerPointApi 1.4]
122680
122680
  */
122681
122681
  italic?: boolean;
122682
122682
  /**
122683
- * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
122683
+ * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
122684
122684
  *
122685
122685
  * @remarks
122686
122686
  * [Api set: PowerPointApi 1.4]
122687
122687
  */
122688
122688
  name?: boolean;
122689
122689
  /**
122690
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
122690
+ * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
122691
122691
  *
122692
122692
  * @remarks
122693
122693
  * [Api set: PowerPointApi 1.4]
122694
122694
  */
122695
122695
  size?: boolean;
122696
122696
  /**
122697
- * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
122697
+ * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
122698
122698
  *
122699
122699
  * @remarks
122700
122700
  * [Api set: PowerPointApi 1.4]
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.457",
3
+ "version": "1.0.459",
4
4
  "description": "TypeScript definitions for office-js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -46,6 +46,6 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "1f81cd9d53a0170782bbee6021fda6bbfd4ff3ef48583941a288fa6f5bf903ff",
49
+ "typesPublisherContentHash": "f2ff3d6447bdaa2815bafa300499397e9b9b2fb877ebce959bb0534ee0cf9838",
50
50
  "typeScriptVersion": "5.0"
51
51
  }