@types/office-js 1.0.440 → 1.0.441

office-js/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
 
 ### Additional Details
- * Last updated: Tue, 29 Oct 2024 17:34:47 GMT
+ * Last updated: Tue, 29 Oct 2024 18:37:44 GMT
  * Dependencies: none
 
 # Credits

office-js/index.d.ts

@@ -116963,6 +116963,109 @@ declare namespace PowerPoint {
          */
         slideMasterId?: string;
     }
+    /**
+     * Represents a single hyperlink.
+     *
+     * @remarks
+     * [Api set: PowerPointApi 1.6]
+     */
+    class Hyperlink extends OfficeExtension.ClientObject {
+        /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+        context: RequestContext;
+        /**
+         * Specifies the URL target of the hyperlink.
+         *
+         * @remarks
+         * [Api set: PowerPointApi 1.6]
+         */
+        address: string;
+        /**
+         * Specifies the string displayed when hovering over the hyperlink.
+         *
+         * @remarks
+         * [Api set: PowerPointApi 1.6]
+         */
+        screenTip: string;
+        /**
+         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+         *
+         * @param options Provides options for which properties of the object to load.
+         */
+        load(options?: PowerPoint.Interfaces.HyperlinkLoadOptions): PowerPoint.Hyperlink;
+        /**
+         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+         *
+         * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+         */
+        load(propertyNames?: string | string[]): PowerPoint.Hyperlink;
+        /**
+         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+         *
+         * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
+         */
+        load(propertyNamesAndPaths?: {
+            select?: string;
+            expand?: string;
+        }): PowerPoint.Hyperlink;
+        /**
+        * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
+        * Whereas the original `PowerPoint.Hyperlink` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkData`) that contains shallow copies of any loaded child properties from the original object.
+        */
+        toJSON(): PowerPoint.Interfaces.HyperlinkData;
+    }
+    /**
+     * Represents a collection of hyperlinks.
+     *
+     * @remarks
+     * [Api set: PowerPointApi 1.6]
+     */
+    class HyperlinkCollection extends OfficeExtension.ClientObject {
+        /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+        context: RequestContext;
+        /** Gets the loaded child items in this collection. */
+        readonly items: PowerPoint.Hyperlink[];
+        /**
+         * Gets the number of hyperlinks in the collection.
+         *
+         * @remarks
+         * [Api set: PowerPointApi 1.6]
+         * @returns The number of hyperlinks in the collection.
+         */
+        getCount(): OfficeExtension.ClientResult<number>;
+        /**
+         * Gets a hyperlink using its zero-based index in the collection. An error is thrown if the index is out of range.
+         *
+         * @remarks
+         * [Api set: PowerPointApi 1.6]
+         *
+         * @param index The index of the hyperlink in the collection.
+         * @returns The hyperlink at the given index. An error is thrown if index is out of range.
+         */
+        getItemAt(index: number): PowerPoint.Hyperlink;
+        /**
+         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+         *
+         * @param options Provides options for which properties of the object to load.
+         */
+        load(options?: PowerPoint.Interfaces.HyperlinkCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.HyperlinkCollection;
+        /**
+         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+         *
+         * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+         */
+        load(propertyNames?: string | string[]): PowerPoint.HyperlinkCollection;
+        /**
+         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+         *
+         * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
+         */
+        load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.HyperlinkCollection;
+        /**
+        * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
+        * Whereas the original `PowerPoint.HyperlinkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.HyperlinkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+        */
+        toJSON(): PowerPoint.Interfaces.HyperlinkCollectionData;
+    }
     /**
      * Specifies the connector type for line shapes.
      *
@@ -118861,6 +118964,13 @@ declare namespace PowerPoint {
     class Slide extends OfficeExtension.ClientObject {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
         context: RequestContext;
+        /**
+         * Returns a collection of hyperlinks in the slide.
+         *
+         * @remarks
+         * [Api set: PowerPointApi 1.6]
+         */
+        readonly hyperlinks: PowerPoint.HyperlinkCollection;
         /**
          * Gets the layout of the slide.
          *
@@ -120162,6 +120272,27 @@ declare namespace PowerPoint {
             */
             $skip?: number;
         }
+        /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */
+        interface HyperlinkUpdateData {
+            /**
+             * Specifies the URL target of the hyperlink.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.6]
+             */
+            address?: string;
+            /**
+             * Specifies the string displayed when hovering over the hyperlink.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.6]
+             */
+            screenTip?: string;
+        }
+        /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */
+        interface HyperlinkCollectionUpdateData {
+            items?: PowerPoint.Interfaces.HyperlinkData[];
+        }
         /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
         interface ShapeCollectionUpdateData {
             items?: PowerPoint.Interfaces.ShapeData[];
@@ -120454,6 +120585,27 @@ declare namespace PowerPoint {
             id?: string;
             title?: string;
         }
+        /** An interface describing the data returned by calling `hyperlink.toJSON()`. */
+        interface HyperlinkData {
+            /**
+             * Specifies the URL target of the hyperlink.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.6]
+             */
+            address?: string;
+            /**
+             * Specifies the string displayed when hovering over the hyperlink.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.6]
+             */
+            screenTip?: string;
+        }
+        /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */
+        interface HyperlinkCollectionData {
+            items?: PowerPoint.Interfaces.HyperlinkData[];
+        }
         /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
         interface ShapeCollectionData {
             items?: PowerPoint.Interfaces.ShapeData[];
@@ -120832,6 +120984,58 @@ declare namespace PowerPoint {
             id?: boolean;
             title?: boolean;
         }
+        /**
+         * Represents a single hyperlink.
+         *
+         * @remarks
+         * [Api set: PowerPointApi 1.6]
+         */
+        interface HyperlinkLoadOptions {
+            /**
+              Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
+             */
+            $all?: boolean;
+            /**
+             * Specifies the URL target of the hyperlink.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.6]
+             */
+            address?: boolean;
+            /**
+             * Specifies the string displayed when hovering over the hyperlink.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.6]
+             */
+            screenTip?: boolean;
+        }
+        /**
+         * Represents a collection of hyperlinks.
+         *
+         * @remarks
+         * [Api set: PowerPointApi 1.6]
+         */
+        interface HyperlinkCollectionLoadOptions {
+            /**
+              Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
+             */
+            $all?: boolean;
+            /**
+             * For EACH ITEM in the collection: Specifies the URL target of the hyperlink.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.6]
+             */
+            address?: boolean;
+            /**
+             * For EACH ITEM in the collection: Specifies the string displayed when hovering over the hyperlink.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.6]
+             */
+            screenTip?: boolean;
+        }
         /**
          * Represents the collection of shapes.
          *

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.440",
+    "version": "1.0.441",
     "description": "TypeScript definitions for office-js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
@@ -46,6 +46,6 @@
     "scripts": {},
     "dependencies": {},
     "peerDependencies": {},
-    "typesPublisherContentHash": "41a36640f78da75e36022c60b4d0ef10cfb50e9e73c87c074503e9c0c62b3f39",
+    "typesPublisherContentHash": "f373f8c962e060db72a7320a2d73b0f035623e97ef8cd9d00e69bd8bed779db0",
     "typeScriptVersion": "4.8"
 }