@sapui5/ts-types 1.144.1 → 1.146.0

package/types/sap.ui.vk.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.144.0
+// For Library Version: 1.146.0
 
 declare namespace sap {
   namespace ui {
@@ -4845,7 +4845,7 @@ declare namespace sap {
              * Include selected nodes
              */
             includeSelection: boolean
-          ): string;
+          ): Promise<string>;
           /**
            * Gets content of aggregation {@link #getMiniMap miniMap}.
            */
@@ -7194,6 +7194,10 @@ declare namespace sap {
                * Indicator to retrieve selection information.
                */
               selection?: boolean | object;
+              /**
+               * Indicator to retrieve cross-section tool information.
+               */
+              crossSection?: boolean | object;
             }
           ): object;
           /**
@@ -7372,6 +7376,27 @@ declare namespace sap {
                  */
                 outlined: string[];
               };
+              /**
+               * A JSON-like object containing the cross-section tool information.
+               */
+              crossSection?: {
+                /**
+                 * Indicator whether the cross-section tool is enabled.
+                 */
+                enabled?: boolean;
+                /**
+                 * Axis along which the cross-section is performed (0 - X, 1 - Y, 2 - Z).
+                 */
+                axis?: int;
+                /**
+                 * Indicator whether the cross-section direction is flipped.
+                 */
+                flip?: boolean;
+                /**
+                 * Position of the cross-section planes defined as [x, y, z].
+                 */
+                position?: float[];
+              };
             },
             /**
              * Fly-to animation duration in seconds.
@@ -8237,6 +8262,42 @@ declare namespace sap {
             | boolean
             | sap.ui.base.ManagedObject.PropertyBindingInfo
             | `{${string}}`;
+
+          outlineColor?:
+            | sap.ui.core.CSSColor
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          outlineWidth?:
+            | float
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          showOutline?:
+            | boolean
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          cappingColor?:
+            | sap.ui.core.CSSColor
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          cappingOpacity?:
+            | float
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          showCapping?:
+            | boolean
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          /**
+           * This event is fired when the tool's setState method is called and the new state is applied. The event
+           * can be used to update of the UI.
+           */
+          stateChanged?: (oEvent: sap.ui.base.Event) => void;
         }
 
         /**
@@ -9064,6 +9125,11 @@ declare namespace sap {
           request?: any;
         }
 
+        /**
+         * Parameters of the CrossSectionTool#stateChanged event.
+         */
+        interface CrossSectionTool$StateChangedEventParameters {}
+
         /**
          * Parameters of the DuplicateSvgElementTool#nodesCreated event.
          */
@@ -11470,6 +11536,138 @@ declare namespace sap {
            * @returns Metadata object describing this class
            */
           static getMetadata(): sap.ui.core.ElementMetadata;
+          /**
+           * Attaches event handler `fnFunction` to the {@link #event:stateChanged stateChanged} event of this `sap.ui.vk.tools.CrossSectionTool`.
+           *
+           * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+           * otherwise it will be bound to this `sap.ui.vk.tools.CrossSectionTool` itself.
+           *
+           * This event is fired when the tool's setState method is called and the new state is applied. The event
+           * can be used to update of the UI.
+           *
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          attachStateChanged(
+            /**
+             * An application-specific payload object that will be passed to the event handler along with the event
+             * object when firing the event
+             */
+            oData: object,
+            /**
+             * The function to be called when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.CrossSectionTool` itself
+             */
+            oListener?: object
+          ): this;
+          /**
+           * Attaches event handler `fnFunction` to the {@link #event:stateChanged stateChanged} event of this `sap.ui.vk.tools.CrossSectionTool`.
+           *
+           * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+           * otherwise it will be bound to this `sap.ui.vk.tools.CrossSectionTool` itself.
+           *
+           * This event is fired when the tool's setState method is called and the new state is applied. The event
+           * can be used to update of the UI.
+           *
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          attachStateChanged(
+            /**
+             * The function to be called when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.CrossSectionTool` itself
+             */
+            oListener?: object
+          ): this;
+          /**
+           * Detaches event handler `fnFunction` from the {@link #event:stateChanged stateChanged} event of this `sap.ui.vk.tools.CrossSectionTool`.
+           *
+           * The passed function and listener object must match the ones used for event registration.
+           *
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          detachStateChanged(
+            /**
+             * The function to be called, when the event occurs
+             */
+            fnFunction: (p1: sap.ui.base.Event) => void,
+            /**
+             * Context object on which the given function had to be called
+             */
+            oListener?: object
+          ): this;
+          /**
+           * Fires event {@link #event:stateChanged stateChanged} to attached listeners.
+           *
+           * @ui5-protected Do not call from applications (only from related classes in the framework)
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          fireStateChanged(
+            /**
+             * Parameters to pass along with the event
+             */
+            mParameters?: object
+          ): this;
+          /**
+           * Gets the clipping plane axis.
+           *
+           *
+           * @returns Axis index from 0 to 2: 0 - X, 1 - Y, 2 - Z.
+           */
+          getAxis(): number;
+          /**
+           * Gets current value of property {@link #getCappingColor cappingColor}.
+           *
+           * Default value is `"#ff0000"`.
+           *
+           *
+           * @returns Value of property `cappingColor`
+           */
+          getCappingColor(): sap.ui.core.CSSColor;
+          /**
+           * Gets current value of property {@link #getCappingOpacity cappingOpacity}.
+           *
+           * Default value is `0.9`.
+           *
+           *
+           * @returns Value of property `cappingOpacity`
+           */
+          getCappingOpacity(): float;
+          /**
+           * Gets current value of property {@link #getOutlineColor outlineColor}.
+           *
+           * Default value is `"#000000"`.
+           *
+           *
+           * @returns Value of property `outlineColor`
+           */
+          getOutlineColor(): sap.ui.core.CSSColor;
+          /**
+           * Gets current value of property {@link #getOutlineWidth outlineWidth}.
+           *
+           * Default value is `2`.
+           *
+           *
+           * @returns Value of property `outlineWidth`
+           */
+          getOutlineWidth(): float;
+          /**
+           * Gets current value of property {@link #getShowCapping showCapping}.
+           *
+           * Default value is `true`.
+           *
+           *
+           * @returns Value of property `showCapping`
+           */
+          getShowCapping(): boolean;
           /**
            * Gets current value of property {@link #getShowEditingUI showEditingUI}.
            *
@@ -11481,6 +11679,24 @@ declare namespace sap {
            * @returns Value of property `showEditingUI`
            */
           getShowEditingUI(): boolean;
+          /**
+           * Gets current value of property {@link #getShowOutline showOutline}.
+           *
+           * Default value is `true`.
+           *
+           *
+           * @returns Value of property `showOutline`
+           */
+          getShowOutline(): boolean;
+          /**
+           * Gets information about the current state.
+           *
+           * @since 1.145.0
+           *
+           * @returns JSON-like object which holds the current state information. See {@link sap.ui.vk.tools.CrossSectionTool#setState setState }
+           * for details.
+           */
+          getState(): object | null;
           /**
            * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should
            * be called using this method.
@@ -11506,6 +11722,38 @@ declare namespace sap {
              */
             index?: number
           ): this;
+          /**
+           * Sets a new value for property {@link #getCappingColor cappingColor}.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `"#ff0000"`.
+           *
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setCappingColor(
+            /**
+             * New value for property `cappingColor`
+             */
+            sCappingColor?: sap.ui.core.CSSColor
+          ): this;
+          /**
+           * Sets a new value for property {@link #getCappingOpacity cappingOpacity}.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `0.9`.
+           *
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setCappingOpacity(
+            /**
+             * New value for property `cappingOpacity`
+             */
+            fCappingOpacity?: float
+          ): this;
           /**
            * Flips the clipping plane.
            *
@@ -11518,6 +11766,54 @@ declare namespace sap {
              */
             flip?: boolean
           ): this;
+          /**
+           * Sets a new value for property {@link #getOutlineColor outlineColor}.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `"#000000"`.
+           *
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setOutlineColor(
+            /**
+             * New value for property `outlineColor`
+             */
+            sOutlineColor?: sap.ui.core.CSSColor
+          ): this;
+          /**
+           * Sets a new value for property {@link #getOutlineWidth outlineWidth}.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `2`.
+           *
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setOutlineWidth(
+            /**
+             * New value for property `outlineWidth`
+             */
+            fOutlineWidth?: float
+          ): this;
+          /**
+           * Sets a new value for property {@link #getShowCapping showCapping}.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `true`.
+           *
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setShowCapping(
+            /**
+             * New value for property `showCapping`
+             */
+            bShowCapping?: boolean
+          ): this;
           /**
            * Sets a new value for property {@link #getShowEditingUI showEditingUI}.
            *
@@ -11536,6 +11832,84 @@ declare namespace sap {
              */
             bShowEditingUI?: boolean
           ): this;
+          /**
+           * Sets a new value for property {@link #getShowOutline showOutline}.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `true`.
+           *
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setShowOutline(
+            /**
+             * New value for property `showOutline`
+             */
+            bShowOutline?: boolean
+          ): this;
+          /**
+           * Sets the current state.
+           *
+           * @since 1.145.0
+           *
+           * @returns `this` to allow method chaining.
+           */
+          setState(
+            /**
+             * JSON-like object which holds the state information. See below for details.
+             */
+            state?: {
+              /**
+               * Specifies whether the cross section tool should be activated.
+               */
+              enabled?: boolean;
+              /**
+               * Axis index from 0 to 2: 0 - X, 1 - Y, 2 - Z.
+               */
+              axis?: number;
+              /**
+               * If set to `true`, the clipping plane will be flipped.
+               */
+              flip?: boolean;
+              /**
+               * The position of the clipping planes defined as [x, y, z].
+               */
+              position?: number[];
+              /**
+               * The color of the outline defined as a CSS color string.
+               */
+              outlineColor?: string;
+              /**
+               * The width of the outline defined as a float.
+               */
+              outlineWidth?: number;
+              /**
+               * Specifies whether the outline should be shown.
+               */
+              showOutline?: boolean;
+              /**
+               * The color of the capping defined as a CSS color string.
+               */
+              cappingColor?: string;
+              /**
+               * The opacity of the capping defined as a float between 0 and 1.
+               */
+              cappingOpacity?: number;
+              /**
+               * Specifies whether the capping should be shown.
+               */
+              showCapping?: boolean;
+              /**
+               * Specifies whether the editing UI should be shown.
+               */
+              showEditingUI?: boolean;
+            },
+            /**
+             * The viewport where the tool is used.
+             */
+            viewport?: sap.ui.vk.Viewport
+          ): this;
         }
         /**
          * The DuplicateSvgElementTool allows applications to duplicate svg elements.
@@ -18045,6 +18419,14 @@ declare namespace sap {
           CreateTextTool
         >;
 
+        /**
+         * Event object of the CrossSectionTool#stateChanged event.
+         */
+        type CrossSectionTool$StateChangedEvent = sap.ui.base.Event<
+          CrossSectionTool$StateChangedEventParameters,
+          CrossSectionTool
+        >;
+
         /**
          * Event object of the DuplicateSvgElementTool#nodesCreated event.
          */
@@ -41938,6 +42320,10 @@ declare namespace sap {
              * Indicator to retrieve selection information.
              */
             selection?: boolean | object;
+            /**
+             * Indicator to retrieve cross-section information.
+             */
+            crossSection?: boolean | object;
           }
         ): object;
         /**
@@ -46232,6 +46618,8 @@ declare namespace sap {
 
         CrossSectionSeparator = "VIT-Cross-Section-Separator",
 
+        CrossSectionSettings = "VIT-Cross-Section-Settings",
+
         EcadSeparator = "VIT-ECAD-Separator",
 
         FitToPage = "VIT-Fit-To-Page",

package/types/sap.ui.vtm.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.144.0
+// For Library Version: 1.146.0
 
 declare namespace sap {
   namespace ui {
@@ -6935,7 +6935,7 @@ declare namespace sap {
        * Example:
        * ```javascript
        * {
-       *      id: jQuery.sap.uid(),
+       *      id: sap.base.util.uid(),
        *      name: "Tree item name",
        *      iconUrl: "sap-icon://tree",
        *      iconTooltip: "Group"

package/types/sap.ui.webc.common.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.144.0
+// For Library Version: 1.146.0
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.webc.fiori.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.144.0
+// For Library Version: 1.146.0
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.webc.main.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.144.0
+// For Library Version: 1.146.0
 
 declare namespace sap {
   namespace ui {

package/types/sap.uiext.inbox.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.144.0
+// For Library Version: 1.146.0
 
 declare namespace sap {
   namespace uiext {