@sapui5/ts-types-esm 1.138.1 → 1.140.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.140.0
 
 declare module "sap/ui/vk/library" {
   /**
@@ -4898,6 +4898,8 @@ declare module "sap/ui/vk/ContentResource" {
      * Gets current value of property {@link #getSourceType sourceType}.
      *
      * The source type of the content resource. Valid types:
+     *
+     *
      * 	 - vds
      * 	 - vds4
      * 	 - vds4-2d
@@ -4907,17 +4909,21 @@ declare module "sap/ui/vk/ContentResource" {
      * 	 - jpeg
      * 	 - gif
      * 	 - bmp
-     * 	 - tif*
-     * 	 - tiff*
+     * 	 - tif
+     * 	 - tiff
      * 	 - stream
      * 	 - stream2d
      * 	 - ecad
-     * 	 - pdf  The source type may be omitted if this is a grouping content node.
-     * NOTE: The tif and tiff image formats are not supported on all browsers. Source type "vds" initializes
-     * deprecated DVL namespace and uses legacy library to load and display VDS file content. If source type
-     * of "vds4" is used then new namespace based on Threejs rendering model will be used to load and display
-     * VDS file content. Since DVL namespace is deprecated in one of future releases it will be removed and
-     * source type "vds" will also use Threejs model.
+     * 	 - pdf
+     * 	 - auto
+     *
+     * The source type may be omitted if this is a grouping content node.  If the `source` property points
+     * to an IPD Visualization service the `sourceType` property can be assigned value `auto`. The actual `sourceType`
+     * property will be detected by making a request to the backend.  NOTE: The tif and tiff image formats
+     * are not supported on all browsers. Source type "vds" initializes deprecated DVL namespace and uses legacy
+     * library to load and display VDS file content. If source type of "vds4" is used then new namespace based
+     * on Threejs rendering model will be used to load and display VDS file content. Since DVL namespace is
+     * deprecated in one of future releases it will be removed and source type "vds" will also use Threejs model.
      *
      *
      * @returns Value of property `sourceType`
@@ -5310,6 +5316,8 @@ declare module "sap/ui/vk/ContentResource" {
      * Sets a new value for property {@link #getSourceType sourceType}.
      *
      * The source type of the content resource. Valid types:
+     *
+     *
      * 	 - vds
      * 	 - vds4
      * 	 - vds4-2d
@@ -5319,17 +5327,21 @@ declare module "sap/ui/vk/ContentResource" {
      * 	 - jpeg
      * 	 - gif
      * 	 - bmp
-     * 	 - tif*
-     * 	 - tiff*
+     * 	 - tif
+     * 	 - tiff
      * 	 - stream
      * 	 - stream2d
      * 	 - ecad
-     * 	 - pdf  The source type may be omitted if this is a grouping content node.
-     * NOTE: The tif and tiff image formats are not supported on all browsers. Source type "vds" initializes
-     * deprecated DVL namespace and uses legacy library to load and display VDS file content. If source type
-     * of "vds4" is used then new namespace based on Threejs rendering model will be used to load and display
-     * VDS file content. Since DVL namespace is deprecated in one of future releases it will be removed and
-     * source type "vds" will also use Threejs model.
+     * 	 - pdf
+     * 	 - auto
+     *
+     * The source type may be omitted if this is a grouping content node.  If the `source` property points
+     * to an IPD Visualization service the `sourceType` property can be assigned value `auto`. The actual `sourceType`
+     * property will be detected by making a request to the backend.  NOTE: The tif and tiff image formats
+     * are not supported on all browsers. Source type "vds" initializes deprecated DVL namespace and uses legacy
+     * library to load and display VDS file content. If source type of "vds4" is used then new namespace based
+     * on Threejs rendering model will be used to load and display VDS file content. Since DVL namespace is
+     * deprecated in one of future releases it will be removed and source type "vds" will also use Threejs model.
      *
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
@@ -5389,6 +5401,8 @@ declare module "sap/ui/vk/ContentResource" {
 
     /**
      * The source type of the content resource. Valid types:
+     *
+     *
      * 	 - vds
      * 	 - vds4
      * 	 - vds4-2d
@@ -5398,17 +5412,21 @@ declare module "sap/ui/vk/ContentResource" {
      * 	 - jpeg
      * 	 - gif
      * 	 - bmp
-     * 	 - tif*
-     * 	 - tiff*
+     * 	 - tif
+     * 	 - tiff
      * 	 - stream
      * 	 - stream2d
      * 	 - ecad
-     * 	 - pdf  The source type may be omitted if this is a grouping content node.
-     * NOTE: The tif and tiff image formats are not supported on all browsers. Source type "vds" initializes
-     * deprecated DVL namespace and uses legacy library to load and display VDS file content. If source type
-     * of "vds4" is used then new namespace based on Threejs rendering model will be used to load and display
-     * VDS file content. Since DVL namespace is deprecated in one of future releases it will be removed and
-     * source type "vds" will also use Threejs model.
+     * 	 - pdf
+     * 	 - auto
+     *
+     * The source type may be omitted if this is a grouping content node.  If the `source` property points
+     * to an IPD Visualization service the `sourceType` property can be assigned value `auto`. The actual `sourceType`
+     * property will be detected by making a request to the backend.  NOTE: The tif and tiff image formats
+     * are not supported on all browsers. Source type "vds" initializes deprecated DVL namespace and uses legacy
+     * library to load and display VDS file content. If source type of "vds4" is used then new namespace based
+     * on Threejs rendering model will be used to load and display VDS file content. Since DVL namespace is
+     * deprecated in one of future releases it will be removed and source type "vds" will also use Threejs model.
      */
     sourceType?: string | PropertyBindingInfo;
 
@@ -8614,12 +8632,305 @@ declare module "sap/ui/vk/dvl/ViewStateManager" {
     extends $ViewStateManagerBaseSettings {}
 }
 
-declare module "sap/ui/vk/ecad/LayersPanel" {
+declare module "sap/ui/vk/ecad/ElementsPanel" {
   import { default as Control, $ControlSettings } from "sap/ui/core/Control";
 
   import Event from "sap/ui/base/Event";
 
-  import Table from "sap/m/Table";
+  import { ID, CSSSize } from "sap/ui/core/library";
+
+  import ElementMetadata from "sap/ui/core/ElementMetadata";
+
+  import ContentConnector from "sap/ui/vk/ContentConnector";
+
+  import ViewStateManagerBase from "sap/ui/vk/ViewStateManagerBase";
+
+  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+
+  /**
+   * Provides a list of all ECAD elements in a given scene in table format.
+   *
+   * **NOTE:** To use this control the application developer should add dependencies to the following libraries
+   * on application level to ensure that the libraries are loaded before the module dependencies will be required:
+   *
+   * 	 - sap.f
+   * 	 - sap.ui.comp
+   *
+   * @since 1.136.0
+   */
+  export default class ElementsPanel extends Control {
+    /**
+     * Constructor for a new ElementsPanel.
+     *
+     * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
+     * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
+     * of the syntax of the settings object.
+     */
+    constructor(
+      /**
+       * initial settings for the new control
+       */
+      mSettings?: $ElementsPanelSettings
+    );
+    /**
+     * Constructor for a new ElementsPanel.
+     *
+     * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
+     * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
+     * of the syntax of the settings object.
+     */
+    constructor(
+      /**
+       * id for the new control, generated automatically if no id is given
+       */
+      sId?: string,
+      /**
+       * initial settings for the new control
+       */
+      mSettings?: $ElementsPanelSettings
+    );
+
+    /**
+     * Creates a new subclass of class sap.ui.vk.ecad.ElementsPanel with name `sClassName` and enriches it with
+     * the information contained in `oClassInfo`.
+     *
+     * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
+     *
+     *
+     * @returns Created class / constructor function
+     */
+    static extend<T extends Record<string, unknown>>(
+      /**
+       * Name of the class being created
+       */
+      sClassName: string,
+      /**
+       * Object literal with information about the class
+       */
+      oClassInfo?: sap.ClassInfo<T, ElementsPanel>,
+      /**
+       * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+       * used by this class
+       */
+      FNMetaImpl?: Function
+    ): Function;
+    /**
+     * Returns a metadata object for class sap.ui.vk.ecad.ElementsPanel.
+     *
+     *
+     * @returns Metadata object describing this class
+     */
+    static getMetadata(): ElementMetadata;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:contentChanged contentChanged} event of this
+     * `sap.ui.vk.ecad.ElementsPanel`.
+     *
+     * 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.ecad.ElementsPanel` itself.
+     *
+     * This event will be fired when content is replaced.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachContentChanged(
+      /**
+       * 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: Event) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.ui.vk.ecad.ElementsPanel` itself
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:contentChanged contentChanged} event of this
+     * `sap.ui.vk.ecad.ElementsPanel`.
+     *
+     * 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.ecad.ElementsPanel` itself.
+     *
+     * This event will be fired when content is replaced.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachContentChanged(
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: Event) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.ui.vk.ecad.ElementsPanel` itself
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Detaches event handler `fnFunction` from the {@link #event:contentChanged contentChanged} event of this
+     * `sap.ui.vk.ecad.ElementsPanel`.
+     *
+     * The passed function and listener object must match the ones used for event registration.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    detachContentChanged(
+      /**
+       * The function to be called, when the event occurs
+       */
+      fnFunction: (p1: Event) => void,
+      /**
+       * Context object on which the given function had to be called
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Fires event {@link #event:contentChanged contentChanged} 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
+     */
+    fireContentChanged(
+      /**
+       * Parameters to pass along with the event
+       */
+      mParameters?: object
+    ): this;
+    /**
+     * ID of the element which is the current target of the association {@link #getContentConnector contentConnector},
+     * or `null`.
+     */
+    getContentConnector(): ID | null;
+    /**
+     * Gets current value of property {@link #getHeight height}.
+     *
+     * Default value is `"100%"`.
+     *
+     *
+     * @returns Value of property `height`
+     */
+    getHeight(): CSSSize;
+    /**
+     * ID of the element which is the current target of the association {@link #getViewStateManager viewStateManager},
+     * or `null`.
+     */
+    getViewStateManager(): ID | null;
+    /**
+     * Gets current value of property {@link #getWidth width}.
+     *
+     * Default value is `"auto"`.
+     *
+     *
+     * @returns Value of property `width`
+     */
+    getWidth(): CSSSize;
+    /**
+     * Sets the associated {@link #getContentConnector contentConnector}.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setContentConnector(
+      /**
+       * ID of an element which becomes the new target of this contentConnector association; alternatively, an
+       * element instance may be given
+       */
+      oContentConnector: ID | ContentConnector
+    ): this;
+    /**
+     * Sets a new value for property {@link #getHeight height}.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `"100%"`.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setHeight(
+      /**
+       * New value for property `height`
+       */
+      sHeight?: CSSSize
+    ): this;
+    /**
+     * Sets the associated {@link #getViewStateManager viewStateManager}.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setViewStateManager(
+      /**
+       * ID of an element which becomes the new target of this viewStateManager association; alternatively, an
+       * element instance may be given
+       */
+      oViewStateManager: ID | ViewStateManagerBase
+    ): this;
+    /**
+     * Sets a new value for property {@link #getWidth width}.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `"auto"`.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setWidth(
+      /**
+       * New value for property `width`
+       */
+      sWidth?: CSSSize
+    ): this;
+  }
+  /**
+   * Describes the settings that can be provided to the ElementsPanel constructor.
+   */
+  export interface $ElementsPanelSettings extends $ControlSettings {
+    width?: CSSSize | PropertyBindingInfo | `{${string}}`;
+
+    height?: CSSSize | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * An association to the `ContentConnector` instance that manages content resources.
+     */
+    contentConnector?: ContentConnector | string;
+
+    /**
+     * An association to the `ViewStateManager` instance.
+     */
+    viewStateManager?: ViewStateManagerBase | string;
+
+    /**
+     * This event will be fired when content is replaced.
+     */
+    contentChanged?: (oEvent: Event) => void;
+  }
+
+  /**
+   * Parameters of the ElementsPanel#contentChanged event.
+   */
+  export interface ElementsPanel$ContentChangedEventParameters {}
+
+  /**
+   * Event object of the ElementsPanel#contentChanged event.
+   */
+  export type ElementsPanel$ContentChangedEvent = Event<
+    ElementsPanel$ContentChangedEventParameters,
+    ElementsPanel
+  >;
+}
+
+declare module "sap/ui/vk/ecad/LayersPanel" {
+  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
+
+  import Event from "sap/ui/base/Event";
 
   import { ID, CSSSize } from "sap/ui/core/library";
 
@@ -8790,7 +9101,7 @@ declare module "sap/ui/vk/ecad/LayersPanel" {
     /**
      * Gets content of aggregation {@link #getContent content}.
      */
-    getContent(): Table;
+    getContent(): Control;
     /**
      * ID of the element which is the current target of the association {@link #getContentConnector contentConnector},
      * or `null`.
@@ -8829,7 +9140,7 @@ declare module "sap/ui/vk/ecad/LayersPanel" {
       /**
        * The content to set
        */
-      oContent: Table
+      oContent: Control
     ): this;
     /**
      * Sets the associated {@link #getContentConnector contentConnector}.
@@ -8898,7 +9209,7 @@ declare module "sap/ui/vk/ecad/LayersPanel" {
 
     height?: CSSSize | PropertyBindingInfo | `{${string}}`;
 
-    content?: Table;
+    content?: Control;
 
     /**
      * An association to the `ContentConnector` instance that manages content resources.
@@ -20425,6 +20736,8 @@ declare module "sap/ui/vk/SceneTree" {
 
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
+  import TreeTable from "sap/ui/table/TreeTable";
+
   import ContentConnector from "sap/ui/vk/ContentConnector";
 
   import ViewStateManagerBase from "sap/ui/vk/ViewStateManagerBase";
@@ -20639,7 +20952,7 @@ declare module "sap/ui/vk/SceneTree" {
     /**
      * Gets content of aggregation {@link #getTreeTable treeTable}.
      */
-    getTreeTable(): /* was: sap.ui.table.TreeTable */ any;
+    getTreeTable(): TreeTable;
     /**
      * ID of the element which is the current target of the association {@link #getViewStateManager viewStateManager},
      * or `null`.
@@ -20740,7 +21053,7 @@ declare module "sap/ui/vk/SceneTree" {
       /**
        * The treeTable to set
        */
-      oTreeTable: /* was: sap.ui.table.TreeTable */ any
+      oTreeTable: TreeTable
     ): this;
     /**
      * Sets the associated {@link #getViewStateManager viewStateManager}.
@@ -20780,7 +21093,7 @@ declare module "sap/ui/vk/SceneTree" {
      */
     legacyVisibilityMode?: boolean | PropertyBindingInfo | `{${string}}`;
 
-    treeTable?: /* was: sap.ui.table.TreeTable */ any;
+    treeTable?: TreeTable;
 
     /**
      * An association to the `ContentConnector` instance that manages content resources.
@@ -26125,7 +26438,7 @@ declare module "sap/ui/vk/threejs/ViewStateManager" {
   import NodeHierarchy from "sap/ui/vk/NodeHierarchy";
 
   /**
-   * Manages the visibility and selection states of nodes in the scene.
+   * Manages the visibility, selection, opacity and tint color states of nodes in the scene.
    *
    * @since 1.32.0
    */
@@ -26202,7 +26515,7 @@ declare module "sap/ui/vk/threejs/ViewStateManager" {
      * Enumerates IDs of the outlined nodes.
      *
      *
-     * @returns `this` to allow method chaining.
+     * @returns Returns `this` to allow method chaining
      */
     enumerateOutlinedNodes(
       /**
@@ -26214,7 +26527,7 @@ declare module "sap/ui/vk/threejs/ViewStateManager" {
      * Enumerates IDs of the selected nodes.
      *
      *
-     * @returns `this` to allow method chaining.
+     * @returns Returns `this` to allow method chaining
      */
     enumerateSelection(
       /**
@@ -26248,17 +26561,13 @@ declare module "sap/ui/vk/threejs/ViewStateManager" {
      *
      * If a single node is passed to the method then a single value is returned.
      *  If an array of nodes is passed to the method then an array of values is returned.
-     *
-     *
-     * @returns A single value or an array of values. Value `null` means that the node's own opacity should
-     * be used.
      */
     getOpacity(
       /**
        * The node reference or the array of node references.
        */
       nodeRefs: any | any[]
-    ): float | float[];
+    ): void;
     /**
      * Gets the outline color
      *
@@ -26403,14 +26712,14 @@ declare module "sap/ui/vk/threejs/ViewStateManager" {
       nodeRef: any
     ): this;
     /**
-     * Sets the default highlighting color
+     * Sets the default selection color
      *
      *
-     * @returns `this` to allow method chaining.
+     * @returns Returns `this` to allow method chaining
      */
     setHighlightColor(
       /**
-       * The new highlighting color. The value can be defined as a string in the CSS color format or as an integer
+       * The new selection color. The value can be defined as a string in the CSS color format or as an integer
        * in the ABGR format. If `null` is passed then the tint color is reset and the node's own tint color should
        * be used.
        */
@@ -26428,11 +26737,32 @@ declare module "sap/ui/vk/threejs/ViewStateManager" {
        */
       state: /* was: sap.ui.vk.HighlightDisplayState */ any
     ): this;
+    /**
+     * Sets the highlight color of the nodes.
+     *
+     *
+     * @returns Returns `this` to allow method chaining
+     */
+    setNodesHighlightColor(
+      /**
+       * The node reference or the array of node references.
+       */
+      nodeRefs: any | any[],
+      /**
+       * The new highlight color of the nodes. The value should be defined as an array of floats in the RGBA format.
+       * If `null` is passed then the highlight color is reset and the node's own highlight color should be used.
+       */
+      highlightColor: float[] | null,
+      /**
+       * This flag indicates if the change needs to propagate recursively to child nodes.
+       */
+      recursive?: boolean
+    ): this;
     /**
      * Sets the opacity of the nodes.
      *
      *
-     * @returns `this` to allow method chaining.
+     * @returns Returns `this` to allow method chaining
      */
     setOpacity(
       /**
@@ -26453,7 +26783,7 @@ declare module "sap/ui/vk/threejs/ViewStateManager" {
      * Sets the outline color
      *
      *
-     * @returns `this` to allow method chaining.
+     * @returns Returns `this` to allow method chaining
      */
     setOutlineColor(
       /**
@@ -26479,7 +26809,7 @@ declare module "sap/ui/vk/threejs/ViewStateManager" {
      * Sets or resets the outlining state of the nodes.
      *
      *
-     * @returns `this` to allow method chaining.
+     * @returns Returns `this` to allow method chaining
      */
     setOutliningStates(
       /**
@@ -26504,7 +26834,7 @@ declare module "sap/ui/vk/threejs/ViewStateManager" {
      *
      * @deprecated As of version 1.56.3. Use {@link sap.ui.vk.threejs.ViewStateManager#setSelectionStates} instead.
      *
-     * @returns `this` to allow method chaining.
+     * @returns Returns `this` to allow method chaining
      */
     setSelectionState(
       /**
@@ -26528,7 +26858,7 @@ declare module "sap/ui/vk/threejs/ViewStateManager" {
      * Sets or resets the selection state of the nodes.
      *
      *
-     * @returns `this` to allow method chaining.
+     * @returns Returns `this` to allow method chaining
      */
     setSelectionStates(
       /**
@@ -26561,7 +26891,7 @@ declare module "sap/ui/vk/threejs/ViewStateManager" {
      * Sets the tint color of the nodes.
      *
      *
-     * @returns `this` to allow method chaining.
+     * @returns Returns `this` to allow method chaining
      */
     setTintColor(
       /**
@@ -26570,8 +26900,8 @@ declare module "sap/ui/vk/threejs/ViewStateManager" {
       nodeRefs: any | any[],
       /**
        * The new tint color of the nodes. The value can be defined as a string in the CSS color format or as an
-       * integer in the ABGR format or it could be array of these values. If `null` is passed then the tint color
-       * is reset and the node's own tint color should be used.
+       * integer in the ABGR format or it could be an array of these values. If `null` is passed then the tint
+       * color is reset and the node's own tint color should be used.
        */
       tintColor: CSSColor | int | CSSColor[] | int[] | null,
       /**
@@ -26583,7 +26913,7 @@ declare module "sap/ui/vk/threejs/ViewStateManager" {
      * Sets the visibility state of the nodes.
      *
      *
-     * @returns `this` to allow method chaining.
+     * @returns Returns `this` to allow method chaining
      */
     setVisibilityState(
       /**
@@ -38854,6 +39184,12 @@ declare module "sap/ui/vk/Viewer" {
    * Provides simple 3D visualization capability by connecting, configuring and presenting the essential Visualization
    * Toolkit controls a single composite control.
    *
+   * **NOTE:** To use this control the application developer should add dependencies to the following libraries
+   * on application level to ensure that the libraries are loaded before the module dependencies will be required:
+   *
+   * 	 - sap.f
+   * 	 - sap.ui.comp
+   *
    * @since 1.32.0
    */
   export default class Viewer extends Control {
@@ -46180,17 +46516,13 @@ declare module "sap/ui/vk/ViewStateManagerBase" {
      *
      * If a single node reference is passed to the method then a single value is returned.
      *  If an array of node references is passed to the method then an array of values is returned.
-     *
-     *
-     * @returns A single value or an array of values. Value `null` means that the node's own opacity should
-     * be used.
      */
     getOpacity(
       /**
        * The node reference or the array of node references.
        */
       nodeRefs: any | any[]
-    ): float | float[];
+    ): void;
     /**
      * Gets the outline color
      *
@@ -47234,6 +47566,8 @@ declare namespace sap {
 
     "sap/ui/vk/dvl/ViewStateManager": undefined;
 
+    "sap/ui/vk/ecad/ElementsPanel": undefined;
+
     "sap/ui/vk/ecad/LayersPanel": undefined;
 
     "sap/ui/vk/FlexibleControl": undefined;