// For Library Version: 1.149.0 declare namespace sap { namespace ui { /** * SAPUI5 library with controls to visualize, map and restructure hierarchical business data that maps to * 3D objects. * * @deprecated As of version 1.96.10. This library must not be used in production code as it will be completely * removed in future releases. * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ namespace vtm { /** * The AXIS1X component. */ export const AXIS1X: int; /** * The AXIS1Y component. */ export const AXIS1Y: int; /** * The AXIS1Z component. */ export const AXIS1Z: int; /** * The AXIS2X component. */ export const AXIS2X: int; /** * The AXIS2Y component. */ export const AXIS2Y: int; /** * The AXIS2Z component. */ export const AXIS2Z: int; /** * The AXIS3X component. */ export const AXIS3X: int; /** * The AXIS3Y component. */ export const AXIS3Y: int; /** * The AXIS3Z component. */ export const AXIS3Z: int; /** * The LOCX (X axis translation) component. */ export const LOCX: int; /** * The LOCY (Y axis translation) component. */ export const LOCY: int; /** * The LOCZ (Z axis translation) component. */ export const LOCZ: int; /** * The SCALE component (there is only one scale component for all axes). */ export const SCALE: int; /** * Creates an instance of {@link sap.ui.vtm.Vtm} with a default set of extensions. * * The {@link sap.ui.vtm.Vtm} constructor can be used to create an instance of {@link sap.ui.vtm.Vtm} with * a specific set of extensions. * * * @returns The created instance of {@link sap.ui.vtm.Vtm}. */ function createVtm( /** * The id to pass to the {@link sap.ui.vtm.Vtm} constructor. */ sId: string, /** * The settings to pass to the {@link sap.ui.vtm.Vtm} constructor. Any extensions specified in the settings * will be replaced with a default set. */ mSettings: object ): sap.ui.vtm.Vtm; /** * Namespace for extensions that are provided with the sap.ui.vtm library. * * @deprecated As of version 1.96.10. This library must not be used in production code as it will be completely * removed in future releases. * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ namespace extensions { /** * Describes the settings that can be provided to the DisplayStateCalculationExtension constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $DisplayStateCalculationExtensionSettings extends sap.ui.vtm.$ExtensionSettings {} /** * Describes the settings that can be provided to the InitialViewExtension constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $InitialViewExtensionSettings extends sap.ui.vtm.$ExtensionSettings { /** * Specifies a predefined view to use. If a specific view is not specified this extension will zoom to fit * all geometry without changing the camera angle. */ predefinedView?: | sap.ui.vtm.PredefinedView | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the LoadProgressExtension constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $LoadProgressExtensionSettings extends sap.ui.vtm.$ExtensionSettings {} /** * Describes the settings that can be provided to the MessageStatusCalculationExtension constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $MessageStatusCalculationExtensionSettings extends sap.ui.vtm.$ExtensionSettings {} /** * Describes the settings that can be provided to the MessageStatusIconClickExtension constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $MessageStatusIconClickExtensionSettings extends sap.ui.vtm.$ExtensionSettings {} /** * Describes the settings that can be provided to the SceneNodeHoverHighlightExtension constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $SceneNodeHoverHighlightExtensionSettings extends sap.ui.vtm.$ExtensionSettings { /** * The highlight color to use for the scene node being hovered over. */ highlightColor?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the SceneNodeHoverTooltipExtension constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $SceneNodeHoverTooltipExtensionSettings extends sap.ui.vtm.$ExtensionSettings { /** * A callback function that gets a tooltip for a given {@link sap.ui.vtm.SceneNode}. If unspecified, the * scene node name is used for the tooltip text. * * The first parameter is the {@link sap.ui.vtm.SceneNode} under cursor. * The function should return an object containing a tooltip text for the specified scene node. * ```javascript * * { * text: [string] * } * ``` * If function returns null no tooltip will be displayed. */ tooltipCallback?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the SelectionLinkingExtension constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $SelectionLinkingExtensionSettings extends sap.ui.vtm.$ExtensionSettings { /** * The value is a callback function that finds tree items in a particular tree that match a given tree item. * * The first parameter is the tree item to match against. * The second parameter is the {@link sap.ui.vtm.Tree} containing the specified tree item being matched * against. * The third parameter is the {@link sap.ui.vtm.Tree} to search for matches in. * The function returns an array of tree items that match the specified tree item. */ findMatchingTreeItems?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the ViewLinkingExtension constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $ViewLinkingExtensionSettings extends sap.ui.vtm.$ExtensionSettings {} /** * Describes the settings that can be provided to the ViewportSelectionLinkingExtension constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $ViewportSelectionLinkingExtensionSettings extends sap.ui.vtm.$ExtensionSettings {} /** * Describes the settings that can be provided to the VisibilityIconClickExtension constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $VisibilityIconClickExtensionSettings extends sap.ui.vtm.$ExtensionSettings {} /** * Adds a behavior that calculates display state (visibility, opacity, highlight color) for the scene nodes * in a viewport using information in the tree items, context display groups and override display groups. * * Excluded tree items are ignored when calculating display state since visible scene nodes that are not * visible due to a context or override display group should relate to one or more selectable tree items * in the tree. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class DisplayStateCalculationExtension extends sap.ui.vtm.Extension implements sap.ui.vtm.interfaces.IDisplayStateCalculationExtension { __implements__sap_ui_vtm_interfaces_IDisplayStateCalculationExtension: boolean; /** * Constructor for a new DisplayStateCalculationExtension. */ constructor( /** * id for the new {@link sap.ui.vtm.extensions.DisplayStateCalculationExtension} instance. */ sId: string, /** * Object with initial property values, aggregated objects etc. for the new {@link sap.ui.vtm.extensions.DisplayStateCalculationExtension } * instance. */ mSettings: sap.ui.vtm.extensions.$DisplayStateCalculationExtensionSettings ); /** * Creates a new subclass of class sap.ui.vtm.extensions.DisplayStateCalculationExtension 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.vtm.Extension.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.vtm.extensions.DisplayStateCalculationExtension >, /** * 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.vtm.extensions.DisplayStateCalculationExtension. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; } /** * Adds a behavior that zooms to all (or a specific view) after the first viewable has loaded successfully. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class InitialViewExtension extends sap.ui.vtm.Extension implements sap.ui.vtm.interfaces.IInitialViewExtension { __implements__sap_ui_vtm_interfaces_IInitialViewExtension: boolean; /** * Constructor for a new InitialViewExtension. * * 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 {@link sap.ui.vtm.extensions.InitialViewExtension} instance. */ sId: string, /** * Object with initial property values, aggregated objects etc. for the new {@link sap.ui.vtm.extensions.InitialViewExtension } * instance. */ mSettings: sap.ui.vtm.extensions.$InitialViewExtensionSettings ); /** * Creates a new subclass of class sap.ui.vtm.extensions.InitialViewExtension 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.vtm.Extension.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.vtm.extensions.InitialViewExtension >, /** * 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.vtm.extensions.InitialViewExtension. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getPredefinedView predefinedView}. * * Specifies a predefined view to use. If a specific view is not specified this extension will zoom to fit * all geometry without changing the camera angle. * * * @returns Value of property `predefinedView` */ getPredefinedView(): sap.ui.vtm.PredefinedView; /** * Sets a new value for property {@link #getPredefinedView predefinedView}. * * Specifies a predefined view to use. If a specific view is not specified this extension will zoom to fit * all geometry without changing the camera angle. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setPredefinedView( /** * New value for property `predefinedView` */ sPredefinedView: sap.ui.vtm.PredefinedView ): this; } /** * Adds a behavior that shows a progress dialog when downloading/loading of viewables is occurring. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class LoadProgressExtension extends sap.ui.vtm.Extension implements sap.ui.vtm.interfaces.ILoadProgressExtension, sap.ui.vtm.interfaces.IDownloadProgressExtension { __implements__sap_ui_vtm_interfaces_ILoadProgressExtension: boolean; __implements__sap_ui_vtm_interfaces_IDownloadProgressExtension: boolean; /** * Constructor for a new LoadProgressExtension. */ constructor( /** * id for the new {@link sap.ui.vtm.extensions.LoadProgressExtension} instance. */ sId: string, /** * Object with initial property values, aggregated objects etc. for the new {@link sap.ui.vtm.extensions.LoadProgressExtension } * instance. */ mSettings: sap.ui.vtm.extensions.$LoadProgressExtensionSettings ); /** * Creates a new subclass of class sap.ui.vtm.extensions.LoadProgressExtension 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.vtm.Extension.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.vtm.extensions.LoadProgressExtension >, /** * 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.vtm.extensions.LoadProgressExtension. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; } /** * Adds a behavior that calculates the properties of the message status icons. The behavior: * - Allows for error, warning and information messages. * - Uses red icons for error related indications. * - Uses yellow icons for warning related indications. * - Uses grey informational icons for informational indications. * - Uses solid icons to indicate errors or warnings that apply directly to a tree item. * - Uses hollow icons to indicate that an error or warning applies to a descendant of a tree item. * - The highest priority status that applies to a tree item or a descendant tree item is indicated on * each tree item. * - When the highest priority status that applies to a tree item is the same as the highest priority * status that applies to any descendant tree, the highest priority message that applies directly to the * tree item is indicated. * - Error messages on descendants are given higher priority than warning or information messages that * apply to the tree item itself * - Warning messages on descendants are given a higher priority than information messages that apply * to the tree item * - Information messages are not cascaded up the tree * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class MessageStatusCalculationExtension extends sap.ui.vtm.Extension implements sap.ui.vtm.interfaces.IMessageStatusCalculationExtension { __implements__sap_ui_vtm_interfaces_IMessageStatusCalculationExtension: boolean; /** * Constructor for a new MessageStatusCalculationExtension. */ constructor( /** * id for the new {@link sap.m.MessageStatusCalculationExtension} instance. */ sId: string, /** * Object with initial property values, aggregated objects etc. for the new {@link sap.m.MessageStatusCalculationExtension } * instance. */ mSettings: sap.ui.vtm.extensions.$MessageStatusCalculationExtensionSettings ); /** * Creates a new subclass of class sap.ui.vtm.extensions.MessageStatusCalculationExtension 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.vtm.Extension.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.vtm.extensions.MessageStatusCalculationExtension >, /** * 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.vtm.extensions.MessageStatusCalculationExtension. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; } /** * Adds a behavior that shows a {@link sap.ui.vtm.MessagesPopover} when a message status icon is clicked. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class MessageStatusIconClickExtension extends sap.ui.vtm.Extension implements sap.ui.vtm.interfaces.IMessageStatusIconClickExtension { __implements__sap_ui_vtm_interfaces_IMessageStatusIconClickExtension: boolean; /** * Constructor for a new MessageStatusIconClickExtension. */ constructor( /** * id for the new {@link sap.m.MessageStatusIconClickExtension} instance. */ sId: string, /** * Object with initial property values, aggregated objects etc. for the new {@link sap.m.MessageStatusIconClickExtension } * instance. */ mSettings: sap.ui.vtm.extensions.$MessageStatusIconClickExtensionSettings ); /** * Creates a new subclass of class sap.ui.vtm.extensions.MessageStatusIconClickExtension 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.vtm.Extension.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.vtm.extensions.MessageStatusIconClickExtension >, /** * 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.vtm.extensions.MessageStatusIconClickExtension. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; } /** * Adds a behaviour which highlights a scene node when the mouse hovers over it. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class SceneNodeHoverHighlightExtension extends sap.ui.vtm.Extension implements sap.ui.vtm.interfaces.ISceneNodeHoverHighlightExtension { __implements__sap_ui_vtm_interfaces_ISceneNodeHoverHighlightExtension: boolean; /** * Constructor for a new SceneNodeHoverTooltipExtension. * * 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 instance. */ sId: string, /** * Object with initial property values, aggregated objects etc. for the new instance. */ mSettings: sap.ui.vtm.extensions.$SceneNodeHoverHighlightExtensionSettings ); /** * Creates a new subclass of class sap.ui.vtm.extensions.SceneNodeHoverHighlightExtension 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.vtm.Extension.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.vtm.extensions.SceneNodeHoverHighlightExtension >, /** * 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.vtm.extensions.SceneNodeHoverHighlightExtension. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getHighlightColor highlightColor}. * * The highlight color to use for the scene node being hovered over. * * Default value is `"rgba(0, 0, 255, 0.7)"`. * * * @returns Value of property `highlightColor` */ getHighlightColor(): sap.ui.core.CSSColor; /** * Sets a new value for property {@link #getHighlightColor highlightColor}. * * The highlight color to use for the scene node being hovered over. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"rgba(0, 0, 255, 0.7)"`. * * * @returns Reference to `this` in order to allow method chaining */ setHighlightColor( /** * New value for property `highlightColor` */ sHighlightColor?: sap.ui.core.CSSColor ): this; } /** * Adds a behaviour in which a tooltip (which can be specified by application code using a callback function) * is displayed when the mouse is hovering over a scene node. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class SceneNodeHoverTooltipExtension extends sap.ui.vtm.Extension implements sap.ui.vtm.interfaces.ISceneNodeHoverTooltipExtension { __implements__sap_ui_vtm_interfaces_ISceneNodeHoverTooltipExtension: boolean; /** * Constructor for a new SceneNodeHoverTooltipExtension. * * 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 instance. */ sId: string, /** * Object with initial property values, aggregated objects etc. for the new instance. */ mSettings: sap.ui.vtm.extensions.$SceneNodeHoverTooltipExtensionSettings ); /** * Creates a new subclass of class sap.ui.vtm.extensions.SceneNodeHoverTooltipExtension 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.vtm.Extension.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.vtm.extensions.SceneNodeHoverTooltipExtension >, /** * 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.vtm.extensions.SceneNodeHoverTooltipExtension. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getTooltipCallback tooltipCallback}. * * A callback function that gets a tooltip for a given {@link sap.ui.vtm.SceneNode}. If unspecified, the * scene node name is used for the tooltip text. * * The first parameter is the {@link sap.ui.vtm.SceneNode} under cursor. * The function should return an object containing a tooltip text for the specified scene node. * ```javascript * * { * text: [string] * } * ``` * If function returns null no tooltip will be displayed. * * * @returns Value of property `tooltipCallback` */ getTooltipCallback(): any; /** * Sets a new value for property {@link #getTooltipCallback tooltipCallback}. * * A callback function that gets a tooltip for a given {@link sap.ui.vtm.SceneNode}. If unspecified, the * scene node name is used for the tooltip text. * * The first parameter is the {@link sap.ui.vtm.SceneNode} under cursor. * The function should return an object containing a tooltip text for the specified scene node. * ```javascript * * { * text: [string] * } * ``` * If function returns null no tooltip will be displayed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setTooltipCallback( /** * New value for property `tooltipCallback` */ oTooltipCallback?: any ): this; } /** * Adds a behavior that links items the visibility of tree items in a {@link sap.ui.vtm.Tree} with the visibility * of their associated scene nodes in the {@link sap.ui.vtm.Viewport} in the same {@link sap.ui.vtm.Panel}. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class SelectionLinkingExtension extends sap.ui.vtm.Extension implements sap.ui.vtm.interfaces.ISelectionLinkingExtension { __implements__sap_ui_vtm_interfaces_ISelectionLinkingExtension: boolean; /** * Constructor for a new SelectionLinkingExtension. * * 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 {@link sap.ui.vtm.extensions.SelectionLinkingExtension} instance. */ sId: string, /** * Object with initial property values, aggregated objects etc. for the new {@link sap.ui.vtm.extensions.SelectionLinkingExtension } * instance. */ mSettings: sap.ui.vtm.extensions.$SelectionLinkingExtensionSettings ); /** * Creates a new subclass of class sap.ui.vtm.extensions.SelectionLinkingExtension 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.vtm.Extension.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.vtm.extensions.SelectionLinkingExtension >, /** * 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.vtm.extensions.SelectionLinkingExtension. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getFindMatchingTreeItems findMatchingTreeItems}. * * The value is a callback function that finds tree items in a particular tree that match a given tree item. * * The first parameter is the tree item to match against. * The second parameter is the {@link sap.ui.vtm.Tree} containing the specified tree item being matched * against. * The third parameter is the {@link sap.ui.vtm.Tree} to search for matches in. * The function returns an array of tree items that match the specified tree item. * * * @returns Value of property `findMatchingTreeItems` */ getFindMatchingTreeItems(): any; /** * Sets a new value for property {@link #getFindMatchingTreeItems findMatchingTreeItems}. * * The value is a callback function that finds tree items in a particular tree that match a given tree item. * * The first parameter is the tree item to match against. * The second parameter is the {@link sap.ui.vtm.Tree} containing the specified tree item being matched * against. * The third parameter is the {@link sap.ui.vtm.Tree} to search for matches in. * The function returns an array of tree items that match the specified tree item. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setFindMatchingTreeItems( /** * New value for property `findMatchingTreeItems` */ oFindMatchingTreeItems?: any ): this; } /** * Adds a behavior that links the camera views for all the {@link sap.ui.vtm.Viewport} instances associated * with a {@link sap.ui.vtm.Vtm} instance. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class ViewLinkingExtension extends sap.ui.vtm.Extension implements sap.ui.vtm.interfaces.IViewLinkingExtension { __implements__sap_ui_vtm_interfaces_IViewLinkingExtension: boolean; /** * Constructor for the ViewLinkingExtension. */ constructor(); /** * Creates a new subclass of class sap.ui.vtm.extensions.ViewLinkingExtension 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.vtm.Extension.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.vtm.extensions.ViewLinkingExtension >, /** * 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.vtm.extensions.ViewLinkingExtension. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; } /** * Adds a behavior that links the selection state of tree items in a {@link sap.ui.vtm.Tree} with their * corresponding scene nodes in the {@link sap.ui.vtm.Viewport} in the same {@link sap.ui.vtm.Panel}. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class ViewportSelectionLinkingExtension extends sap.ui.vtm.Extension implements sap.ui.vtm.interfaces.IViewportSelectionLinkingExtension { __implements__sap_ui_vtm_interfaces_IViewportSelectionLinkingExtension: boolean; /** * Constructor for a new ViewportSelectionLinkingExtension. */ constructor( /** * id for the new {@link sap.ui.vtm.extensions.ViewportSelectionLinkingExtension} instance. */ sId: string, /** * Object with initial property values, aggregated objects etc. for the new {@link sap.ui.vtm.extensions.ViewportSelectionLinkingExtension } * instance. */ mSettings: sap.ui.vtm.extensions.$ViewportSelectionLinkingExtensionSettings ); /** * Creates a new subclass of class sap.ui.vtm.extensions.ViewportSelectionLinkingExtension 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.vtm.Extension.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.vtm.extensions.ViewportSelectionLinkingExtension >, /** * 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.vtm.extensions.ViewportSelectionLinkingExtension. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; } /** * Adds a behavior that updates visibility in the {@link sap.ui.vtm.Tree} when a visibility checkbox (eye) * is clicked. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.extensions * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class VisibilityIconClickExtension extends sap.ui.vtm.Extension implements sap.ui.vtm.interfaces.IVisibilityIconClickExtension, sap.ui.vtm.interfaces.IVisibilityHeaderIconClickExtension { __implements__sap_ui_vtm_interfaces_IVisibilityIconClickExtension: boolean; __implements__sap_ui_vtm_interfaces_IVisibilityHeaderIconClickExtension: boolean; /** * Constructor for a new VisibilityIconClickExtension. */ constructor( /** * id for the new {@link sap.ui.vtm.extensions.VisibilityIconClickExtension} instance. */ sId: string, /** * Object with initial property values, aggregated objects etc. for the new {@link sap.ui.vtm.extensions.VisibilityIconClickExtension } * instance. */ mSettings: sap.ui.vtm.extensions.$VisibilityIconClickExtensionSettings ); /** * Creates a new subclass of class sap.ui.vtm.extensions.VisibilityIconClickExtension 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.vtm.Extension.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.vtm.extensions.VisibilityIconClickExtension >, /** * 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.vtm.extensions.VisibilityIconClickExtension. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; } } /** * Namespace for interfaces that are provided with the sap.ui.vtm library. * * @deprecated As of version 1.96.10. This library must not be used in production code as it will be completely * removed in future releases. * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ namespace interfaces { /** * Interface for extensions which manage the display state (visibility, opacity, highlight color) of the * scene nodes in the VTM viewports. * * @since 1.50 * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.interfaces * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ interface IDisplayStateCalculationExtension { __implements__sap_ui_vtm_interfaces_IDisplayStateCalculationExtension: boolean; } /** * Interface for extensions which indicate progress while viewables are being downloaded. * * @since 1.50 * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.interfaces * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ interface IDownloadProgressExtension { __implements__sap_ui_vtm_interfaces_IDownloadProgressExtension: boolean; } /** * Interface for extensions which manage the initial view in the VTM viewports after loading an initial * set of viewables. * * @since 1.50 * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.interfaces * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ interface IInitialViewExtension { __implements__sap_ui_vtm_interfaces_IInitialViewExtension: boolean; } /** * Interface for extensions which indicate progress while viewables are being loaded. * * @since 1.50 * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.interfaces * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ interface ILoadProgressExtension { __implements__sap_ui_vtm_interfaces_ILoadProgressExtension: boolean; } /** * Interface for extensions which calculate the icon to show for each tree item in the {@link sap.ui.vtm.InternalColumnDescriptor.MessageStatus } * column. * * @since 1.50 * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.interfaces * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ interface IMessageStatusCalculationExtension { __implements__sap_ui_vtm_interfaces_IMessageStatusCalculationExtension: boolean; } /** * Interface for extensions which provide a behavior when the icon in the column header for the {@link sap.ui.vtm.InternalColumnDescriptor.MessageStatus } * column is clicked. * * @since 1.50 * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.interfaces * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ interface IMessageStatusHeaderIconClickExtension { __implements__sap_ui_vtm_interfaces_IMessageStatusHeaderIconClickExtension: boolean; } /** * Interface for extensions which provide a behavior when an icon in the {@link sap.ui.vtm.InternalColumnDescriptor.MessageStatus } * column is clicked. * * @since 1.50 * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.interfaces * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ interface IMessageStatusIconClickExtension { __implements__sap_ui_vtm_interfaces_IMessageStatusIconClickExtension: boolean; } /** * Interface for extensions which highlight the scene node that is being hovered over in a viewport. * * @since 1.50 * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.interfaces * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ interface ISceneNodeHoverHighlightExtension { __implements__sap_ui_vtm_interfaces_ISceneNodeHoverHighlightExtension: boolean; } /** * Interface for extensions which show a tooltip for the scene node that is being hovered over in a viewport. * * @since 1.50 * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.interfaces * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ interface ISceneNodeHoverTooltipExtension { __implements__sap_ui_vtm_interfaces_ISceneNodeHoverTooltipExtension: boolean; } /** * Interface for extensions which link the selections in trees across panels. * * @since 1.50 * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.interfaces * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ interface ISelectionLinkingExtension { __implements__sap_ui_vtm_interfaces_ISelectionLinkingExtension: boolean; } /** * Interface for extensions which link the views (camera positions) across VTM viewports. * * @since 1.50 * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.interfaces * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ interface IViewLinkingExtension { __implements__sap_ui_vtm_interfaces_IViewLinkingExtension: boolean; } /** * Interface for extensions which link the selection state between the tree and the viewport in each VTM * panel. * * @since 1.50 * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.interfaces * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ interface IViewportSelectionLinkingExtension { __implements__sap_ui_vtm_interfaces_IViewportSelectionLinkingExtension: boolean; } /** * Interface for extensions which provide a behavior when the icon in the column header for the {@link sap.ui.vtm.InternalColumnDescriptor.Visibility } * column is clicked. * * @since 1.50 * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.interfaces * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ interface IVisibilityHeaderIconClickExtension { __implements__sap_ui_vtm_interfaces_IVisibilityHeaderIconClickExtension: boolean; } /** * Interface for extensions which provide a behavior when an icon in the {@link sap.ui.vtm.InternalColumnDescriptor.Visibility } * column is clicked. * * @since 1.50 * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm.interfaces * @experimental As of version 1.50.0. This library is experimental and might be modified or removed in * future versions. */ interface IVisibilityIconClickExtension { __implements__sap_ui_vtm_interfaces_IVisibilityIconClickExtension: boolean; } } /** * Describes the settings that can be provided to the Column constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $ColumnSettings extends sap.ui.core.$ElementSettings { /** * The type of column. */ type?: | sap.ui.vtm.ColumnType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The descriptor is a JSON string identifying the column. * * When the type property has a value of {@link sap.ui.vtm.ColumnType.Metadata} the descriptor property * has the following form: `'{"category":"SAP","field":"MATERIAL"}'` * Such descriptors can be constructed using {@link sap.ui.vtm.DescriptorUtilities.createMetadataDescriptor}. * * When the type property has a value of {@link sap.ui.vtm.ColumnType.Identifier} the descriptor property * has the following form: `'{"source":"SAP","type":"VE_COMPONENT"}'` * Such descriptors can be constructed using {@link sap.ui.vtm.DescriptorUtilities.createIdentifierDescriptor}. * * When the type property has a value of {@link sap.ui.vtm.ColumnType.AppData} the descriptor property has * the following form: `'bomId'` */ descriptor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * A localized string to show in the column header tooltip. If unspecified, the label value will be used * as the column header tooltip. */ tooltip?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The horizontal alignment for the tree column. */ hAlign?: | sap.ui.core.HorizontalAlign | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The width of the tree column. */ width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to true, the column can be resized. */ resizable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A textual name for the column. This is also used in the {@link sap.ui.vtm.ColumnSelectionDialog}, so * it should be included whether or not the `labelControl` property is used. */ label?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * A {@link sap.ui.core.Control} that is used in the column header. When specified, this is used in preference * to the `label` property as the column header content. However the `label` property should also be specified * since it is used in the used in the {@link sap.ui.vtm.ColumnSelectionDialog}. */ labelControl?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If defined, this is a function that specifies the formatting of cell content text for this column. * The function must return a string containing the text to display in the cell (or null) for a given tree * item. * The first parameter to the function (which may not always be defined) is the tree item for the tree * table row. */ valueFormatter?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If defined, this is a function that specifies the formatting of cell content tooltips for this column * (overriding the default behaviour). * Not used if a custom template is specified. * The function must return a string containing the text to display in the tooltip (or null) for a given * tree item. * The first parameter to the function (which may not always be defined) is the tree item for the tree * table row. */ tooltipFormatter?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If defined, overrides the cell template for the column. * If this is defined, the `valueFormatter` and `tooltipFormatter` properties are ignored. */ template?: | sap.ui.core.Control | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the DisplayGroup constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $DisplayGroupSettings extends sap.ui.core.$ElementSettings { /** * A plain object map that uses scene node id as the key and a display state object as the value. The display * state is a plain JavaScript object that can contain the following properties: * - visibility - If defined, this boolean value specifies the scene node visibility * - opacity - If defined, this numeric value between 0 and 100 inclusive defines the scene node opacity. * * - highlightColor - If defined, this string value defines the scene node highlight color. If an empty * string (`""`) is used, the highlight color is cleared, otherwise the value is expected to be a {@link sap.ui.core.CSSColor}. * * - recursive - If `true` this display state will be applied to the scene node and its descendants. * For example: * ```javascript * * { * visibility: true, * opacity: 100, * highlightColor: "red", * recursive: false * }``` * Display state objects can be reused multiple times in the map to reduce memory usage. */ displayStatesBySceneNodeId?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the Extension constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $ExtensionSettings extends sap.ui.core.$ElementSettings { /** * Controls whether the extension is enabled. */ enabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Fired when the enabled property is changed. */ enabledChanged?: (oEvent: sap.ui.base.Event) => void; /** * Fired when initialization has completed. */ initialized?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the Lookup constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $LookupSettings extends sap.ui.core.$ElementSettings {} /** * Describes the settings that can be provided to the MessagesPopover constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $MessagesPopoverSettings extends sap.m.$PopoverSettings { /** * The set of {@link sap.ui.core.Message} objects to display. * * Only the following properties of each message will be used: * - `level` * - `text` * - `icon` */ messages?: | object[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Maximum height of status window. */ maxHeight?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the Panel constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $PanelSettings extends sap.ui.core.$ControlSettings { /** * The text to show in the title bar for this panel. */ title?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Controls whether the viewport will be shown for this panel. */ showViewport?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The width of the tree. */ treeWidth?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The height of the panel. */ height?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The set of controls to render in the title bar area. */ titleControls?: | sap.ui.core.Control[] | sap.ui.core.Control | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * The set of controls to render in the tree header area. */ treeHeaderControls?: | sap.ui.core.Control[] | sap.ui.core.Control | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * The set of controls to render in the viewport header area. */ viewportHeaderControls?: | sap.ui.core.Control[] | sap.ui.core.Control | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * The {@link sap.ui.vtm.Vtm} instance this panel is associated with. */ vtmId?: sap.ui.vtm.Vtm | string; /** * Raised when the panel is initialized. */ initialized?: (oEvent: sap.ui.base.Event) => void; /** * Raised when the web browser `contextmenu` event is raised. To prevent the default browser context menu * from being shown call preventDefault() on the event. */ contextMenu?: (oEvent: Panel$ContextMenuEvent) => void; } /** * Describes the settings that can be provided to the ProgressDialog constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $ProgressDialogSettings extends sap.ui.core.$ControlSettings { /** * The text to display in the progress dialog. */ progressText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The percentage (0-100) to show in the progress bar (if visible). */ percentComplete?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Whether the progress bar is visible. */ progressBarVisible?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the Scene constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $SceneSettings extends sap.ui.core.$ElementSettings { /** * Raised to indicate download progress of a viewable while viewables are being downloaded */ downloadProgress?: (oEvent: Scene$DownloadProgressEvent) => void; /** * Raised when starting a download of a set of viewables. */ downloadStarted?: (oEvent: Scene$DownloadStartedEvent) => void; /** * Raised when viewables have been downloaded (successfully or unsuccessfully) as a result of a call to * {@link #loadViewablesAsync}. * * If no viewables have been successfully downloaded, none of the viewables will be loaded, so no subsequent * {@link sap.ui.vtm.Scene.loadStarted}, {@link sap.ui.vtm.Scene.loadProgress} or {@link sap.ui.vtm.Scene.loadCompleted } * will occur as a result of the call to {@link #loadViewablesAsync} that resulted in the {@link sap.ui.vtm.Scene.downloadCompleted } * event being raised. */ downloadCompleted?: (oEvent: Scene$DownloadCompletedEvent) => void; /** * Raised when starting to load a set of viewables. */ loadStarted?: (oEvent: Scene$LoadStartedEvent) => void; /** * Raised to provide progress information for a viewable that is being loaded. */ loadProgress?: (oEvent: sap.ui.base.Event) => void; /** * Raised when all viewables specified in a call to {@link #loadViewablesAsync} have either loaded or failed * to load. */ loadCompleted?: (oEvent: Scene$LoadCompletedEvent) => void; /** * Raised when the scene hierarchy has been modified. */ hierarchyChanged?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the SceneNode constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $SceneNodeSettings extends sap.ui.core.$ElementSettings { /** * The scene node id. * * This is a transient identifier that exists in the context of the current scene. It should not be persisted. */ sceneNodeId?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The {@link sap.ui.vtm.Scene} for the scene node. */ scene?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the SelectColumnsDialog constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $SelectColumnsDialogSettings extends sap.ui.core.$ControlSettings { /** * The {@link sap.ui.vtm.Tree} that column selection is being performed for. */ tree?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The set of columns that should be shown in the dialog that may be selected for display. */ selectableColumns?: | sap.ui.vtm.Column[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the Tree constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $TreeSettings extends sap.ui.core.$ControlSettings { /** * The tree selection mode. */ selectionMode?: | sap.ui.vtm.SelectionMode | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A set of controls such as toolbars to show above the tree. */ headerControls?: | sap.ui.core.Control[] | sap.ui.core.Control | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Raised when a tree item drag is initiated. To prevent a drag from being initiated call preventDefault() * on the event. */ dragStart?: (oEvent: Tree$DragStartEvent) => void; /** * Raised when a tree item is dragged over a tree item or an unpopulated row in a tree. To allow a drop * to occur call preventDefault() on the event. */ dragOver?: (oEvent: Tree$DragOverEvent) => void; /** * Raised when a tree item is dropped on a tree item or an unpopulated row in a tree. A drop cannot occur * unless preventDefault() is called on the sap.ui.base.Event object in the preceding dragOver event. */ drop?: (oEvent: Tree$DropEvent) => void; /** * Raised when the set of selected tree items for a tree changes. */ selectionChanged?: (oEvent: Tree$SelectionChangedEvent) => void; /** * Raised when the icon in the visibility column header is clicked. */ visibilityHeaderIconClicked?: ( oEvent: Tree$VisibilityHeaderIconClickedEvent ) => void; /** * Raised when an icon in the visibility column is clicked. */ visibilityIconClicked?: ( oEvent: Tree$VisibilityIconClickedEvent ) => void; /** * Raised when a tree item entry is expanded or collapsed. */ expandedChanged?: (oEvent: Tree$ExpandedChangedEvent) => void; /** * Raised when the fixed columns are updated. */ fixedColumnsChanged?: (oEvent: sap.ui.base.Event) => void; /** * Raised when the data columns are updated. */ dataColumnsChanged?: (oEvent: sap.ui.base.Event) => void; /** * Raised before the model is updated. */ beforeModelUpdated?: (oEvent: sap.ui.base.Event) => void; /** * Raised after the model has been updated. */ modelUpdated?: (oEvent: sap.ui.base.Event) => void; /** * Raised when a tree item message status icon is clicked. */ messageStatusIconClicked?: ( oEvent: Tree$MessageStatusIconClickedEvent ) => void; /** * Raised when a tree item message status icon is clicked. */ messageStatusHeaderIconClicked?: (oEvent: sap.ui.base.Event) => void; /** * Raised when the tree hierarchy (the set of parent child relationships) changes. */ hierarchyChanged?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the Viewable constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $ViewableSettings extends sap.ui.core.$ElementSettings { /** * The source URL (string) or File for this Viewable. */ source?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The name for this Viewable. */ name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The root scene node IDs for this viewable. */ rootNodeIds?: | string[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The relative transformation matrix to apply to the scene node created to wrap the contents of the loaded * viewable. */ relativeMatrix?: | sap.ui.vtm.Matrix | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the ViewableLoadInfo constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $ViewableLoadInfoSettings extends sap.ui.core.$ElementSettings { /** * The {@link sap.ui.vtm.Viewable} this {@link sap.ui.vtm.ViewableLoadInfo} relates to. */ viewable?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The download/load status of the {@link sap.ui.vtm.Viewable} this {@link sap.ui.vtm.ViewableLoadInfo } * relates to. */ status?: | sap.ui.vtm.ViewableLoadStatus | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The error code describing why the Viewable failed to load. * * Use when {@link #getSucceeded} returns false. */ errorCode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The error text describing why the Viewable failed to load. This is an untranslated technical message. * Use when {@link #getSucceeded} returns false. */ errorText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; } /** * Describes the settings that can be provided to the Viewport constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $ViewportSettings extends sap.ui.core.$ControlSettings { /** * The background gradient top color. */ backgroundGradientTopColor?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The background gradient bottom color */ backgroundGradientBottomColor?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Allows the calculated display state of scene nodes in the viewport o be overridden. * * A set of {@link sap.ui.vtm.DisplayGroup} objects that each specify the display state for a set of scene * nodes. Precedence is inherent in the array ordering. Any display state specified in this way takes precedence * over display states specified for geometry associated with tree items or specified using {@link #contextGroups}. * Call {@link #refresh} to recalculate the display state in the viewport after modifying override display * groups. */ overrideDisplayGroups?: | object[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Allows the calculated display state for scene nodes whose display state is not determined by tree item * associations or override display groups to be specified. * * A set of {@link sap.ui.vtm.DisplayGroup} objects objects that describe display states to apply to scene * nodes. Precedence is inherent in the array ordering. Call {@link #refresh} to recalculate the display * state in the viewport after modifying override display groups. */ contextDisplayGroups?: | object[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A set of controls such as toolbars to appear above the 3D viewport. */ headerControls?: Array; /** * Raised when the selection is changed due to a click in the viewport (either on a node or in empty space). */ selectionChanged?: (oEvent: Viewport$SelectionChangedEvent) => void; /** * Raised when a node in the viewport is clicked. */ nodeClicked?: (oEvent: sap.ui.base.Event) => void; /** * Raised when the visibility of scene nodes changed in the viewport. */ visibilityChanged?: (oEvent: Viewport$VisibilityChangedEvent) => void; /** * Raised when viewport's camera view changed. */ viewChanged?: (oEvent: Viewport$ViewChangedEvent) => void; /** * Raised when {@link sap.ui.vk.dvl.Viewport#refresh refresh} is called. This event can be used by code * that is managing the viewport display state. */ refreshRequested?: (oEvent: sap.ui.base.Event) => void; /** * Raised on mouse move over viewport. */ hover?: (oEvent: Viewport$HoverEvent) => void; /** * Raised when a gesture begins. */ beginGesture?: (oEvent: sap.ui.base.Event) => void; /** * Raised when a gesture ends. */ endGesture?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the Vtm constructor. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface $VtmSettings extends sap.ui.core.$ElementSettings { /** * When true populates the `extensions` aggregation with the default set of extensions in the default configuration. */ addDefaultExtensions?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The set of VTM extensions. Extensions are used to provide extensibility. Default behaviors are implemented * as extensions that can be replaced. */ extensions?: | sap.ui.vtm.Extension[] | sap.ui.vtm.Extension | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Raised when a panel has been added. */ panelAdded?: (oEvent: Vtm$PanelAddedEvent) => void; /** * Raised when the active panel has changed. */ activePanelChanged?: (oEvent: sap.ui.base.Event) => void; /** * Raised when this {@link sap.ui.vtm.Vtm} instance and its extensions have been initialized. * * Applications should add event handlers after the {@link sap.ui.vtm.Vtm} instance has initialized so that * the extensions can attach event handlers before the application attempts to attach event handlers to * the same events. */ initialized?: (oEvent: sap.ui.base.Event) => void; } /** * Parameters of the Extension#enabledChanged event. */ interface Extension$EnabledChangedEventParameters {} /** * Parameters of the Extension#initialized event. */ interface Extension$InitializedEventParameters {} /** * Parameters of the Panel#contextMenu event. */ interface Panel$ContextMenuEventParameters { /** * The X coordinate of the mouse pointer in local (DOM content) coordinates. */ clientX?: int; /** * The Y coordinate of the mouse pointer in local (DOM content) coordinates. */ clientY?: int; /** * The X coordinate of the mouse pointer in page coordinates. */ pageX?: int; /** * The X coordinate of the mouse pointer in page coordinates. */ pageY?: int; /** * The X coordinate of the mouse pointer in screen coordinates. */ screenX?: int; /** * The X coordinate of the mouse pointer in screen coordinates. */ screenY?: int; /** * The jQuery event object. */ eventData?: object; } /** * Parameters of the Panel#initialized event. */ interface Panel$InitializedEventParameters {} /** * Parameters of the Scene#downloadCompleted event. */ interface Scene$DownloadCompletedEventParameters { /** * A set of {@link sap.ui.vtm.ViewableLoadInfo} objects that describe the status of each {@link sap.ui.vtm.Viewable } * passed to the {@link #loadViewablesAsync} call. */ viewableLoadInfos?: sap.ui.vtm.ViewableLoadInfo[]; /** * The set of viewables that were downloaded successfully in the call to {@link #loadViewablesAsync} that * resulted in this event being raised. */ downloadedViewables?: sap.ui.vtm.Viewable[]; } /** * Parameters of the Scene#downloadProgress event. */ interface Scene$DownloadProgressEventParameters { /** * The viewable that is being downloaded. */ viewable?: sap.ui.vtm.Viewable; /** * The number of bytes that have been downloaded. */ downloadedBytes?: int; /** * The total number of bytes that need to be downloaded. */ totalBytes?: int; } /** * Parameters of the Scene#downloadStarted event. */ interface Scene$DownloadStartedEventParameters { /** * A set of {@link sap.ui.vtm.ViewableLoadInfo} objects that describe the status of each {@link sap.ui.vtm.Viewable } * passed to the {@link #loadViewablesAsync} call. */ viewableLoadInfos?: sap.ui.vtm.ViewableLoadInfo[]; } /** * Parameters of the Scene#hierarchyChanged event. */ interface Scene$HierarchyChangedEventParameters {} /** * Parameters of the Scene#loadCompleted event. */ interface Scene$LoadCompletedEventParameters { /** * Indicates whether the scene was built/updated successfully. It is possible that this can be `false` when * all the content resources apparently loaded successfully. */ succeeeded?: boolean; /** * A set of {@link sap.ui.vtm.ViewableLoadInfo} objects that describe the status of each {@link sap.ui.vtm.Viewable } * passed to the {@link #loadViewablesAsync} call. */ viewableLoadInfos?: sap.ui.vtm.ViewableLoadInfo[]; /** * The set of viewables that were loaded successfully in the call to {@link #loadViewablesAsync} that resulted * in this event being raised. */ loadedViewables?: sap.ui.vtm.Viewable[]; } /** * Parameters of the Scene#loadProgress event. */ interface Scene$LoadProgressEventParameters {} /** * Parameters of the Scene#loadStarted event. */ interface Scene$LoadStartedEventParameters { /** * A set of {@link sap.ui.vtm.ViewableLoadInfo} objects that describe the status of each {@link sap.ui.vtm.Viewable } * passed to the {@link #loadViewablesAsync} call. */ viewableLoadInfos?: sap.ui.vtm.ViewableLoadInfo[]; } /** * Parameters of the Tree#beforeModelUpdated event. */ interface Tree$BeforeModelUpdatedEventParameters {} /** * Parameters of the Tree#dataColumnsChanged event. */ interface Tree$DataColumnsChangedEventParameters {} /** * Parameters of the Tree#dragOver event. */ interface Tree$DragOverEventParameters { /** * The tree item that was dragged. */ dragItem?: object; /** * The tree of the tree item that was dragged. */ dragTree?: sap.ui.vtm.Tree; /** * The tree item being dragged over or null if the tree item is being dragged over an unpopulated row. */ dragOverItem?: object; /** * The tree being dragged over. */ dragOverTree?: sap.ui.vtm.Tree; } /** * Parameters of the Tree#dragStart event. */ interface Tree$DragStartEventParameters { /** * The tree item that was dragged. */ dragItem?: object; /** * The tree of the tree item that was dragged. */ dragTree?: sap.ui.vtm.Tree; } /** * Parameters of the Tree#drop event. */ interface Tree$DropEventParameters { /** * The tree item that was dragged. */ dragItem?: object; /** * The tree of the tree item that was dragged. */ dragTree?: sap.ui.vtm.Tree; /** * The tree item that the drop occurred on or null if the item was not dropped on a tree item. */ dropItem?: object; /** * The tree that the drop occurred on. */ dropTree?: sap.ui.vtm.Tree; } /** * Parameters of the Tree#expandedChanged event. */ interface Tree$ExpandedChangedEventParameters { /** * The tree item associated with the row that was expanded or collapsed. */ item?: object; /** * If `true`, the row was expanded, otherwise it was collapsed. */ expanded?: boolean; /** * Indicates that the event was fired due to the user clicking an expander. */ userInteraction?: boolean; } /** * Parameters of the Tree#fixedColumnsChanged event. */ interface Tree$FixedColumnsChangedEventParameters {} /** * Parameters of the Tree#hierarchyChanged event. */ interface Tree$HierarchyChangedEventParameters {} /** * Parameters of the Tree#messageStatusHeaderIconClicked event. */ interface Tree$MessageStatusHeaderIconClickedEventParameters {} /** * Parameters of the Tree#messageStatusIconClicked event. */ interface Tree$MessageStatusIconClickedEventParameters { /** * The associated tree item. */ items?: object; /** * The message status icon control that was clicked. */ control?: sap.ui.core.Control; } /** * Parameters of the Tree#modelUpdated event. */ interface Tree$ModelUpdatedEventParameters {} /** * Parameters of the Tree#selectionChanged event. */ interface Tree$SelectionChangedEventParameters { /** * The tree items that were added to the selection set for the tree. */ addedItems?: object[]; /** * The tree items that were removed from the selection set for the tree. */ removedItems?: object[]; /** * Indicates that the event was fired due to an explicit user interaction */ userInteraction?: boolean; } /** * Parameters of the Tree#visibilityHeaderIconClicked event. */ interface Tree$VisibilityHeaderIconClickedEventParameters { /** * The visibility state of the tree item. */ visibility?: boolean; /** * The visibility header icon control that was clicked. */ control?: sap.ui.core.Control; } /** * Parameters of the Tree#visibilityIconClicked event. */ interface Tree$VisibilityIconClickedEventParameters { /** * The tree item whose visibility icon was clicked. */ item?: object; /** * The visibility state of the tree item. */ visibility?: boolean; /** * The visibility icon control that was clicked. */ control?: sap.ui.core.Control; } /** * Parameters of the Viewport#beginGesture event. */ interface Viewport$BeginGestureEventParameters {} /** * Parameters of the Viewport#endGesture event. */ interface Viewport$EndGestureEventParameters {} /** * Parameters of the Viewport#hover event. */ interface Viewport$HoverEventParameters { /** * Mouse X-coordinate within viewport */ x?: float; /** * Mouse Y-coordinate within viewport */ y?: float; /** * The ID of the node that is under the viewport coordinates (x, y). */ nodeId?: string; } /** * Parameters of the Viewport#nodeClicked event. */ interface Viewport$NodeClickedEventParameters {} /** * Parameters of the Viewport#refreshRequested event. */ interface Viewport$RefreshRequestedEventParameters {} /** * Parameters of the Viewport#selectionChanged event. */ interface Viewport$SelectionChangedEventParameters { /** * IDs of newly selected nodes. */ selectedIds?: string[]; /** * IDs of newly unselected nodes. */ unselectedIds?: string[]; /** * `true` if this event is raised as a result of a user clicking in the viewport. */ userInteraction?: boolean; } /** * Parameters of the Viewport#viewChanged event. */ interface Viewport$ViewChangedEventParameters { /** * Information about the current camera view. Can be passed to {@link sap.ui.vk.dvl.Viewport#setCameraInfo setCameraInfo}. */ cameraInfo?: object; } /** * Parameters of the Viewport#visibilityChanged event. */ interface Viewport$VisibilityChangedEventParameters { /** * The IDs of newly shown nodes. */ visibleIds?: string[]; /** * The IDs of newly hidden nodes. */ hiddenIds?: string[]; /** * `true` if this event is raised as a result of a user clicking in the viewport. */ userInteraction?: boolean; } /** * Parameters of the Vtm#activePanelChanged event. */ interface Vtm$ActivePanelChangedEventParameters {} /** * Parameters of the Vtm#initialized event. */ interface Vtm$InitializedEventParameters {} /** * Parameters of the Vtm#panelAdded event. */ interface Vtm$PanelAddedEventParameters { panel?: sap.ui.vtm.Panel; } /** * A set of utility functions for working with arrays. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface ArrayUtilities { /** * Returns `true` if a group of arrays are equal. * * * @returns `true` if the all the arrays are equal. */ areEqual( /** * The array of arrays to compare. */ arrayOfArrays: any[], /** * A function that takes two parameters and returns a boolean value indicating whether the parameter values * are equal. */ equalityFunc: Function ): boolean; /** * Creates a copy of an array in which the items are cloned. * * * @returns The cloned array */ deepClone( /** * The array to clone. */ array: any[], /** * A function used to clone an item of the array. The function has an argument that takes an item of the * type stored in the array and returns an item of the same type. */ itemCloneFunc: Function ): any[]; /** * Returns the first item in an array that matches the supplied predicate or returns undefined if no match * is found. * * * @returns The matching item or undefined if no match was found. */ find( /** * The array to search. */ array: any[], /** * A function that takes a value of the type stored in the array and returns a boolean value (true if the * item is a match. */ predicate: Function ): any | undefined; /** * Returns the index of the first item in an array that matches the supplied predicate or returns -1 if * no match is found. * * * @returns The index of the matching item or -1 if no match was found. */ findIndex( /** * The array to search. */ array: any[], /** * A function that takes a value of the type stored in the array and returns a boolean value (true if the * item is a match. */ predicate: Function ): number; /** * Flattens an array of arrays down to an array. * * * @returns A flattened array. */ flatten( /** * An array of arrays. */ arrayOfArrays: any[] ): any[]; /** * Converts from an array-like object (an object that supports indexing and has a length) to an array. * * * @returns The array containing the same values as the array-like object. */ fromArrayLike( /** * The array-like object to convert to an array. */ arrayLike: object ): any[]; /** * Converts an ES6 Set to an array. * * * @returns The array containing the same set of unique items as the Set. */ fromSet( /** * The Set to convert to an array. */ set: Set ): any[]; /** * Returns whether a group of arrays have a non empty set intersection. * * * @returns Whether the arrays have a non empty set intersection. */ haveIntersection( /** * An array of arrays to check for the existence of a set intersection. */ arrayOfArrays: any[], /** * A function that returns a Boolean value to compare values within arrays. When not specified, strict equality * (`===`) is used to compare values. */ equalityFunction: Function ): boolean; /** * Returns the set intersection of a group of arrays. * * * @returns The set intersection of the arrays. */ intersect( /** * An array of arrays to to find the set intersection of. */ arrayOfArrays: any[], /** * A function that returns a Boolean value to compare values within arrays. When not specified, strict equality * (`===`) is used to compare values. */ equalityFunction: Function ): any[]; /** * Creates a copy of an array in which the items are copied by reference rather than being cloned. * * * @returns The cloned array */ shallowClone( /** * The array to clone. */ array: any[] ): any[]; /** * Converts an array to an ES6 Set. * * * @returns The Set containing the same set of unique items as the array. */ toSet( /** * The array to convert to a Set. */ array: any[] ): Set; /** * Returns the set union (as an array) of a group of arrays. * * * @returns The set union of the arrays. */ union( /** * An array of arrays to find the set union of. */ arrayOfArrays: any[], /** * A function that returns a Boolean value to compare values within arrays. When not specified, strict equality * (`===`) is used to compare values. */ equalityFunction: Function ): any[]; /** * The inverse of {@link sap.ui.vtm.ArrayUtilities.wrap}. * * * - If the parameter is not an array, the parameter is returned. * - If the parameter is an array of length 0, `undefined` is returned. * - If the parameter is an array of length 1, the first element of the array is returned. * - Otherwise if the parameter is an array of length > 1, the parameter is returned (as an array). * * * @returns The unwrapped value. */ unwrap( /** * The item to unwrap. */ item: any ): any | any[] | undefined; /** * Wraps an item in an array if it is not already an array. * * * - If the parameter is an array, the parameter is returned. * - If the parameter is `undefined` an empty array is returned. * - Otherwise a single element array containing the parameter value is returned. * * * @returns The parameter if it is an array, otherwise returns a single element array containing the parameter * value */ wrap( /** * The item to wrap as an array if it is not already an array. */ item: any ): any[]; } /** * A set of utility functions for working with metadata and identifier descriptors. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface DescriptorUtilities { /** * Creates a descriptor for an identifier. * * * @returns The descriptor representing the identifier. */ createIdentifierDescriptor( /** * The identifier source. */ source: string, /** * The identifier type. */ type: string ): string; /** * Creates a descriptor for a metadata field. * * * @returns The descriptor representing the metadata field. */ createMetadataDescriptor( /** * The category name. */ category: string, /** * The field name. */ field: string ): string; } /** * A set of utility functions for working with hash values. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface HashUtilities { /** * Creates a single hash code from a set of hash code values and normalizes it using {@link sap.ui.vtm.HashUtilities.normalizeHash}. * * * @returns The combined hash code. */ combineHashes( /** * A set of hash code values to combine. */ hashValues: int[], /** * An upper bound for the hash code. Defaults to 50000. */ upperLimit: int ): int; /** * Creates a hash code for a {@link sap.ui.vtm.Matrix} value. * * The resulting hash value can be any integer value. Use {@link sap.ui.vtm.HashUtilities.normalizeHash } * on the result to create a hash code that is useful as a key in a {@link sap.ui.vtm.Lookup}. * * * @returns The hash code for the specified transformation matrix. */ hashMatrix( /** * The matrix to hash. */ vtmMatrix: sap.ui.vtm.Matrix ): int; /** * Creates a hash code for a string. * * The resulting hash value can be any integer value. Use {@link sap.ui.vtm.HashUtilities.normalizeHash } * on the result to create a hash code that is useful as a key in a {@link sap.ui.vtm.Lookup}. * * * @returns The hash code value for the string. */ hashString( /** * The string to hash. */ stringToHash: string ): int; /** * Normalizes a hash code to a range between 0 and an upper bound. Useful for creating a hash code that * can be used as a key in a {@link sap.ui.vtm.Lookup} (to limit the number of buckets in the lookup). * * * @returns The normalized hash code. */ normalizeHash( /** * A hash code to normalize. */ hashValue: int, /** * An upper bound for the hash code value. Defaults to 50000. */ upperLimit: int ): int; } /** * A set of utility functions for creating internal tree columns. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface InternalColumns { /** * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.AbsoluteMatrix} column. * * * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.AbsoluteMatrix} column. */ createAbsoluteMatrixColumn(): sap.ui.vtm.Column; /** * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.MessageStatus} internal column. * * * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.MessageStatus} internal column. */ createMessageStatusColumn(): sap.ui.vtm.Column; /** * Creates an {@link sap.ui.vtm.InternalColumnDescriptor.Opacity} column. * * * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.Opacity} column. */ createOpacityColumn(): sap.ui.vtm.Column; /** * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.RelativeMatrix} column. * * * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.RelativeMatrix} column. */ createRelativeMatrixColumn(): sap.ui.vtm.Column; /** * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.SceneNodeIds} column. * * * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.SceneNodeIds} column. */ createSceneNodeIdsColumn(): sap.ui.vtm.Column; /** * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.Tree} internal column. * * * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.Tree} internal column. */ createTreeColumn(): sap.ui.vtm.Column; /** * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.TreeItemId} column. * * * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.TreeItemId} column. */ createTreeItemIdColumn(): sap.ui.vtm.Column; /** * Creates a {@link sap.ui.vtm.InternalColumnDescriptor.Visibility} internal column. * * * @returns The {@link sap.ui.vtm.InternalColumnDescriptor.Visibility} internal column. */ createVisibilityColumn(): sap.ui.vtm.Column; } /** * A set of utility functions for working with transformation matrices in a ISO 10303-42 format (in the * form of a 1 dimensional array of 13 numbers) * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface MatrixUtilities { /** * Returns true when the two matrix parameters are equal. * * * @returns `true` if the two matrix parameters are equal. */ areEqual( /** * One matrix to compare. */ vtmMatrixA: sap.ui.vtm.Matrix, /** * The other matrix to compare. */ vtmMatrixB: sap.ui.vtm.Matrix ): boolean; /** * Returns an identity transformation matrix. * * * @returns A new identity transformation matrix. */ createIdentity(): sap.ui.vtm.Matrix; /** * Converts a 4x4 transformation matrix to a {@link sap.ui.vtm.Matrix}. * * * @returns The {@link sap.ui.vtm.Matrix} value. */ from4x4Matrix( /** * The 4x4 matrix (represented as an array of arrays of numbers) to convert. */ mat4x4: number[] ): sap.ui.vtm.Matrix; /** * Converts a {@link sap.ui.vk.TransformationMatrix} (as used by the sap.ui.vk library) to a {@link sap.ui.vtm.Matrix } * value. * * * @returns The {@link sap.ui.vtm.Matrix} value. */ fromVkMatrix( /** * The VIT transformation matrix. */ vkMatrix: sap.ui.vk.TransformationMatrix ): sap.ui.vtm.Matrix; /** * Converts a VSM transformation matrix string to a {@link sap.ui.vtm.Matrix} value. * * * @returns The {@link sap.ui.vtm.Matrix} value. */ fromVsmMatrixString( /** * The VSM transformation matrix string. */ vsmMatrixString: string ): sap.ui.vtm.Matrix; /** * Returns the inverse of the passed matrix without modifying the passed matrix. * * * @returns The inverse of the specified matrix. */ invert( /** * The matrix to invert. */ vtmMatrix: sap.ui.vtm.Matrix ): sap.ui.vtm.Matrix; /** * Returns whether a matrix is invertible. * * * @returns Whether the matrix is invertible. */ isInvertible( /** * The matrix to check. */ vtmMatrix: sap.ui.vtm.Matrix ): boolean; /** * Returns true if the parameter represents a valid transformation matrix. * * * @returns true if the parameter represents a valid transformation matrix. */ isValid( /** * The transformation matrix to check. */ vtmMatrix: sap.ui.vtm.Matrix, /** * Checks whether the matrix is invertible. * Matrices must be invertible to be used as transformation matrices. * This check is optional due to the additional cost of performing it. */ checkInvertibility: boolean ): boolean; /** * Returns the result of multiplying two matrices (without modifying the passed matrices). * * * @returns The matrix representing the multiplication result. */ multiply( /** * One multiplicand. */ vtmMatrixA: sap.ui.vtm.Matrix, /** * The other multiplicand. */ vtmMatrixB: sap.ui.vtm.Matrix ): sap.ui.vtm.Matrix; /** * Converts a {@link sap.ui.vtm.Matrix} to a 4x4 transformation matrix. * * * @returns A 4x4 transformation matrix (represented as an array of arrays of numbers). */ to4x4Matrix( /** * The {@link sap.ui.vtm.Matrix} value to convert. */ vtmMatrix: sap.ui.vtm.Matrix ): number[]; /** * Converts a {@link sap.ui.vtm.Matrix} value to a {@link sap.ui.vk.TransformationMatrix} as used by the * sap.ui.vk library. * * * @returns The {@link sap.ui.vk.TransformationMatrix} value. */ toVkMatrix( /** * The {@link sap.ui.vtm.Matrix} value */ vtmMatrix: sap.ui.vtm.Matrix ): sap.ui.vk.TransformationMatrix; /** * Converts a {@link sap.ui.vtm.Matrix} value to a VSM transformation matrix string. * * * @returns The VSM transformation matrix string. */ toVsmMatrixString( /** * The {@link sap.ui.vtm.Matrix} value. */ vtmMatrix: sap.ui.vtm.Matrix ): string; } /** * A set of utility functions for working with tree items for {@link sap.ui.vtm.Tree} controls. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ interface TreeItemUtilities { /** * Adds a child tree item to the end of the the `includedChildren` or `excludedChildren` collection of its * parent tree item. */ addChild( /** * The parent tree item. */ item: object, /** * The child tree item. */ childItem: object, /** * Controls which child collection to add the child tree item to. * - {@link sap.ui.vtm.ChildCollectionType.None} - No action is performed. * - {@link sap.ui.vtm.ChildCollectionType.Included} - The child tree item will be added to the `includedChildren` * collection of the tree item. * - {@link sap.ui.vtm.ChildCollectionType.Excluded} - The child tree item will be added to the `excludedChildren` * collection of the tree item. * - {@link sap.ui.vtm.ChildCollectionType.IncludedAndExcluded} - Results in an exception being thrown * because tree item IDs must be unique in the tree at any given point in time, so a tree item cannot be * added to both collections. The default value is {@link sap.ui.vtm.ChildCollectionType.Included}. */ childCollectionType: sap.ui.vtm.ChildCollectionType ): void; /** * Adds a child tree item to the end of the the `excludedChildren` collection of its parent tree item. */ addExcludedChild( /** * The parent tree item. */ item: object, /** * The child tree item. */ childItem: object ): void; /** * Adds a child tree item to the end of the the `includedChildren` collection of its parent tree item. */ addIncludedChild( /** * The parent tree item. */ item: object, /** * The child tree item. */ childItem: object ): void; /** * Adds a root item to the tree. */ addRoot( /** * The existing set of root items. */ rootItems: object[], /** * The root tree item to remove. */ rootItemToAdd: object ): void; /** * Calculates the absolute matrix that should be applied to a tree item given its relative matrix and the * absolute matrix of its parent. * * * @returns The calculated absolute matrix. */ calculateAbsoluteMatrix( /** * The relative matrix of the tree item. */ relativeMatrix: sap.ui.vtm.Matrix, /** * The absolute matrix of the parent tree item. */ parentAbsoluteMatrix: sap.ui.vtm.Matrix ): sap.ui.vtm.Matrix; /** * Calculates the relative matrix that should be applied to a tree item given its absolute matrix and the * absolute matrix of its parent. * * * @returns The calculated relative matrix. */ calculateRelativeMatrix( /** * The absolute matrix of the tree item. */ absoluteMatrix: sap.ui.vtm.Matrix, /** * The absolute matrix of the parent tree item. */ parentAbsoluteMatrix: sap.ui.vtm.Matrix ): sap.ui.vtm.Matrix; /** * Returns a cloned copy of the appData on the passed tree item. * * * @returns A cloned copy of the appData on the passed tree item. */ cloneAppData( /** * The tree item. */ treeItem: object ): object; /** * Returns a cloned copy of the identifiers on the passed tree item. * * * @returns A cloned copy of the metadata on the passed tree item. */ cloneIdentifiers( /** * The tree item. */ treeItem: object ): object; /** * Returns a cloned copy of the metadata on the passed tree item. * * * @returns A cloned copy of the metadata on the passed tree item. */ cloneMetadata( /** * The tree item. */ treeItem: object ): object; /** * Moves all items from the `includedChildren` collection of a tree item (or set of tree items) to the `excludedChildren` * collection. */ excludeAllChildren( /** * The tree item or items. */ treeItems: object[] | object, /** * When `true` the items in the `includedChildren` collections of descendants are moved to the `excludedChildren` * collection of the descendant tree item. Defaults to `false`. */ recursive: boolean ): void; /** * Gets the application data field descriptors for a given tree item. * * * @returns The application data field descriptors for the given tree item. */ getAppDataDescriptors( /** * The tree item to get application data field descriptors from. */ treeItem: object ): string[]; /** * Gets the application data values associated with a particular descriptor for a tree item. * * * @returns The application data values. */ getAppDataValues( /** * The tree item to get application data values from. */ treeItem: object, /** * The descriptor describing the application data value(s) to retrieve. */ descriptor: string ): string[] | number[] | boolean[] | object[]; /** * Gets the children of a tree item from the `includedChildren` and/or `excludedChildren` collections. * * * @returns The children of the tree item of the given type. */ getChildren( /** * The tree item. */ treeItem: object, /** * Specifies which child item collections to get children from. * - {@link sap.ui.vtm.ChildCollectionType.None} - An empty array is returned. * - {@link sap.ui.vtm.ChildCollectionType.Included} - Gets the items in the `includedChildren` collection * of the tree item. * - {@link sap.ui.vtm.ChildCollectionType.Excluded} - Gets the items in the `excludedChildren` collection * of the tree item. * - {@link sap.ui.vtm.ChildCollectionType.IncludedAndExcluded} - Gets the items in the `includedChildren` * and `excludedChildren` collections of the tree item. The default value is {@link sap.ui.vtm.ChildCollectionType.Included}. */ childCollectionType: sap.ui.vtm.ChildCollectionType ): object[]; /** * Gets the excluded children of a tree item. * * * @returns The excluded children of the tree item. */ getExcludedChildren( /** * The tree item. */ treeItem: object ): object[]; /** * Gets the identifier descriptors for a given tree item. * * * @returns The identifier descriptors for the given tree item. */ getIdentifierDescriptors( /** * The tree item to get identifier descriptors from. */ treeItem: object ): string[]; /** * Gets the identifier values associated with a particular descriptor for a tree item. * * * @returns The identifier values. */ getIdentifierValues( /** * The tree item to retrieve values from. */ treeItem: object, /** * The descriptor describing the identifier value(s) to retrieve. */ descriptor: string ): string[]; /** * Gets the included children of a tree item. * * * @returns The included children of the tree item. */ getIncludedChildren( /** * The tree item. */ treeItem: object ): object[]; /** * Gets the messages stored on a tree item. * * * @returns The tree item messages. */ getMessages( /** * The tree item. */ treeItem: object ): sap.ui.core.Message[]; /** * Gets the metadata field descriptors for a given tree item. * * * @returns The metadata field descriptors for the given tree item. */ getMetadataDescriptors( /** * The tree item to get metadata field descriptors from. */ treeItem: object ): string[]; /** * Gets the metadata values associated with a particular descriptor for a tree item. * * * @returns The metadata values. */ getMetadataValues( /** * The tree item to metadata values from. */ treeItem: object, /** * The descriptor describing the metadata value(s) to retrieve. */ descriptor: string ): string[] | number[] | boolean[] | object[]; /** * Gets the IDs of the scene nodes associated with a tree item as an array of strings. * * * @returns The scene node IDs for the tree item. */ getSceneNodeIds( /** * The tree item. */ treeItem: object ): string[]; /** * Gets whether a tree item has items in the `includedChildren` and/or `excludedChildren` collections. * * * @returns Whether the tree item has children of the given type. */ hasChildren( /** * The tree item. */ treeItem: object, /** * The child item collections to check. * - {@link sap.ui.vtm.ChildCollectionType.None} - Returns `false`. * - {@link sap.ui.vtm.ChildCollectionType.Included} - Gets whether there are items in the `includedChildren` * collection of the tree item. * - {@link sap.ui.vtm.ChildCollectionType.Excluded} - Gets whether there are items in the `excludedChildren` * collection of the tree item. * - {@link sap.ui.vtm.ChildCollectionType.IncludedAndExcluded} - Gets whether there are items in either * the `includedChildren` collection or the `excludedChildren` collection of the tree item. The default * value is {@link sap.ui.vtm.ChildCollectionType.Included}. */ childCollectionType: sap.ui.vtm.ChildCollectionType ): boolean; /** * Gets whether a tree item has excluded children. * * * @returns The excluded children of the tree item. */ hasExcludedChildren( /** * The tree item. */ treeItem: object ): object[]; /** * Gets whether a tree item has included children. * * * @returns The included children of the tree item. */ hasIncludedChildren( /** * The tree item. */ treeItem: object ): object[]; /** * Returns whether the tree item has a `visibility` value. * * * @returns Whether the tree item has a `visibility` value. */ hasVisibility( /** * The tree item. */ treeItem: object ): boolean; /** * Moves all items from the `excludedChildren` collection of a tree item (or set of tree items) to the `includedChildren` * collection. */ includeAllChildren( /** * The tree item or items. */ treeItems: object[] | object, /** * When `true` the items in the `excludedChildren` collections of descendants are moved to the `includedChildren` * collection of the descendant tree item. Defaults to `false`. */ recursive: boolean ): void; /** * Applies a mapping function to each tree item in a branch of a tree to create a new tree branch. * * * @returns The mapped tree branch. */ mapBranch( /** * The tree item representing the branch to map. */ treeItem: object, /** * A function that takes a tree item and returns a new tree item. */ mapFunc: Function ): object; /** * Applies a mapping function to each tree item in a tree to create a new tree. * * * @returns The root tree items of the mapped tree. */ mapTree( /** * The root tree items of the tree to map. */ rootTreeItems: object[], /** * A function that takes a tree item and returns a new tree item. */ mapFunc: Function ): object[]; /** * Removes a child tree item from the `includedChildren` and/or `excludedChildren` collection of its parent * tree item. * * * @returns Returns the deleted item or undefined if no item was removed. */ removeChild( /** * The parent tree item. */ item: object, /** * The child tree item to remove (or its id). */ childItem: string | object, /** * Controls which child collection to remove the child tree item from. * - {@link sap.ui.vtm.ChildCollectionType.None} - No action is performed. * - {@link sap.ui.vtm.ChildCollectionType.Included} - The child tree item will be removed from the `includedChildren` * collection of the tree item. * - {@link sap.ui.vtm.ChildCollectionType.Excluded} - The child tree item will be removed from the `excludedChildren` * collection of the tree item. * - {@link sap.ui.vtm.ChildCollectionType.IncludedAndExcluded} - The child tree item will be removed * from the `includedChildren` and `excludedChildren` collections of the tree item. * Note that duplicate tree item ids are not allowed in the tree, so a given tree item should exist in * at most one of these collections at a given point in time. The default value is {@link sap.ui.vtm.ChildCollectionType.Included}. */ childCollectionType: sap.ui.vtm.ChildCollectionType ): object | undefined; /** * Removes a child tree item from the `excludedChildren` collection of its parent tree item. * * * @returns Returns the deleted item or undefined if no item was removed. */ removeExcludedChild( /** * The parent tree item. */ item: object, /** * The child tree item to remove (or its id). */ childItem: string | object ): object | undefined; /** * Removes a child tree item from the `includedChildren` collection of its parent tree item. * * * @returns Returns the deleted item or undefined if no item was removed. */ removeIncludedChild( /** * The parent tree item. */ item: object, /** * The child tree item to remove (or its id). */ childItem: string | object ): object | undefined; /** * Removes a root item from the tree. * * * @returns Returns the deleted item or undefined if no item was removed. */ removeRoot( /** * The existing set of root items. */ rootItems: object[], /** * The root tree item to remove (or its id). */ rootItemToRemove: string | object ): object | undefined; /** * Set the application data values associated with a particular descriptor for a tree item (replacing any * existing values). */ setAppDataValues( /** * The tree item to update. */ treeItem: object, /** * The descriptor describing the application data value(s) to update. */ descriptor: string, /** * The application data value or values to apply. A value of undefined clears all values for the descriptor. */ values: | undefined | string | string[] | number | number[] | boolean | boolean[] | object | object[] ): void; /** * Sets either the `includedChildren` or `excludedChildren` collection of a tree item. */ setChildren( /** * The tree item. */ treeItem: object, /** * The items to set in the `includedChildren` or `excludedChildren` collection of the tree item. */ children: object[], /** * Controls which child collection to set on the tree item. * - {@link sap.ui.vtm.ChildCollectionType.None} - No action is performed. * - {@link sap.ui.vtm.ChildCollectionType.Included} - The `includedChildren` collection of the tree item * will be set. * - {@link sap.ui.vtm.ChildCollectionType.Excluded} - The `excludedChildren` collection of the tree item * will be set. * - {@link sap.ui.vtm.ChildCollectionType.IncludedAndExcluded} - Results in an exception being thrown * because tree item IDs must be unique in the tree at any given point in time, so a tree item cannot be * added to both collections. The default value is {@link sap.ui.vtm.ChildCollectionType.Included}. */ childCollectionType: sap.ui.vtm.ChildCollectionType ): void; /** * Sets the `excludedChildren` collection of a tree item. */ setExcludedChildren( /** * The tree item. */ treeItem: object, /** * The items to set in the `includedChildren` collection of the tree item. */ excludedChildren: object[] ): void; /** * Set the identifier values associated with a particular descriptor for a tree item (replacing any existing * values). */ setIdentifierValues( /** * The tree item to update. */ treeItem: object, /** * The descriptor describing the identifier value(s) to update. */ descriptor: string, /** * The identifier value or values to apply. A value of undefined clears all values for the descriptor. */ values: string | string[] | undefined ): void; /** * Sets the `includedChildren` collection of a tree item. */ setIncludedChildren( /** * The tree item. */ treeItem: object, /** * The items to set in the `includedChildren` collection of the tree item. */ includedChildren: object[] ): void; /** * Sets the messages stored on a tree item. */ setMessages( /** * The tree item. */ treeItem: object, /** * The set of messages to apply to the tree item. */ messages: sap.ui.core.Message[] ): void; /** * Set the metadata values associated with a particular descriptor for a tree item (replacing any existing * values). */ setMetadataValues( /** * The tree item to update. */ treeItem: object, /** * The descriptor describing the metadata value(s) to update. */ descriptor: string, /** * The metadata value or values to apply. A value of undefined clears all values for the descriptor. */ values: | undefined | string | string[] | number | number[] | boolean | boolean[] | object | object[] ): void; /** * Sets the IDs of the scene nodes to associate with a tree item in a memory efficient manner. */ setSceneNodeIds( /** * The tree item. */ treeItem: object, /** * The scene node IDs for the tree item. A value of undefined clears all values for the descriptor. */ sceneNodeIds: string | string[] | undefined ): void; /** * Recursively traverses a tree branch calling a function on each item (including the tree item that is * the root of the branch). */ traverseBranch( /** * The root of the branch to apply the function to. */ treeItem: object, /** * The function to apply to tree items in the branch. * The first parameter to the callback function is the current tree item object (at the current point of * the traversal. * The second parameter to the callback function is the set of ancestors of the current tree item. * The second parameter to the callback function will not be populated unless the `ancestors` parameter * of {@link sap.ui.vtm.TreeItemUtilities.traverseBranch traverseBranch} is provided. * The function may return a {@link sap.ui.vtm.ChildCollectionType} value to specify which immediate children * of the tree item to traverse. * If no such value is returned a default of {@link sap.ui.vtm.ChildCollectionType.Included} is used. */ callback: Function, /** * The ancestors of the tree item. If provided this will be used to calculate the set of ancestors of each * tree item during traversal (to be passed into the callback function). */ ancestors?: object[] ): void; /** * Recursively traverses a tree calling a function on each item. */ traverseTree( /** * The root items of the tree. */ rootItems: object[], /** * The function to apply to tree items in the tree. * The first parameter to the callback function is the current tree item object (at the current point of * the traversal. * The second parameter to the callback function is the set of ancestors of the current tree item. * The function may return a {@link sap.ui.vtm.ChildCollectionType} value to specify which immediate children * to traverse. If no such value is returned a default of {@link sap.ui.vtm.ChildCollectionType.Included } * is used. */ callback: Function ): void; /** * Validates a tree and returns a set of error messages. * * * @returns The set of validation errors for the tree item. */ validateTree( /** * The root tree items. */ rootItems: object[] ): string[]; /** * Validates a tree item and returns a set of error messages. * * * @returns The set of validation errors for the tree item. */ validateTreeItem( /** * The tree item. */ treeItem: object ): string[]; } /** * Represents a data column for a {@link sap.ui.vtm.Tree}. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class Column extends sap.ui.core.Element { /** * Constructor for a new Column. * * 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( /** * An optional ID for the {@link sap.ui.vtm.Column}. */ sId: string, /** * An optional object with initial settings for the new {@link sap.ui.vtm.Column} instance. */ mSettings: sap.ui.vtm.$ColumnSettings ); /** * Creates a new subclass of class sap.ui.vtm.Column 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.vtm.Column. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getDescriptor descriptor}. * * The descriptor is a JSON string identifying the column. * * When the type property has a value of {@link sap.ui.vtm.ColumnType.Metadata} the descriptor property * has the following form: `'{"category":"SAP","field":"MATERIAL"}'` * Such descriptors can be constructed using {@link sap.ui.vtm.DescriptorUtilities.createMetadataDescriptor}. * * When the type property has a value of {@link sap.ui.vtm.ColumnType.Identifier} the descriptor property * has the following form: `'{"source":"SAP","type":"VE_COMPONENT"}'` * Such descriptors can be constructed using {@link sap.ui.vtm.DescriptorUtilities.createIdentifierDescriptor}. * * When the type property has a value of {@link sap.ui.vtm.ColumnType.AppData} the descriptor property has * the following form: `'bomId'` * * * @returns Value of property `descriptor` */ getDescriptor(): string; /** * Gets current value of property {@link #getHAlign hAlign}. * * The horizontal alignment for the tree column. * * Default value is `"Left"`. * * * @returns Value of property `hAlign` */ getHAlign(): sap.ui.core.HorizontalAlign; /** * Gets current value of property {@link #getLabel label}. * * A textual name for the column. This is also used in the {@link sap.ui.vtm.ColumnSelectionDialog}, so * it should be included whether or not the `labelControl` property is used. * * * @returns Value of property `label` */ getLabel(): string; /** * Gets current value of property {@link #getLabelControl labelControl}. * * A {@link sap.ui.core.Control} that is used in the column header. When specified, this is used in preference * to the `label` property as the column header content. However the `label` property should also be specified * since it is used in the used in the {@link sap.ui.vtm.ColumnSelectionDialog}. * * * @returns Value of property `labelControl` */ getLabelControl(): object; /** * Gets current value of property {@link #getResizable resizable}. * * If set to true, the column can be resized. * * Default value is `true`. * * * @returns Value of property `resizable` */ getResizable(): boolean; /** * Gets current value of property {@link #getTemplate template}. * * If defined, overrides the cell template for the column. * If this is defined, the `valueFormatter` and `tooltipFormatter` properties are ignored. * * * @returns Value of property `template` */ getTemplate(): sap.ui.core.Control; /** * Gets current value of property {@link #getTooltip tooltip}. * * A localized string to show in the column header tooltip. If unspecified, the label value will be used * as the column header tooltip. * * * @returns Value of property `tooltip` */ getTooltip(): string; /** * Gets current value of property {@link #getTooltipFormatter tooltipFormatter}. * * If defined, this is a function that specifies the formatting of cell content tooltips for this column * (overriding the default behaviour). * Not used if a custom template is specified. * The function must return a string containing the text to display in the tooltip (or null) for a given * tree item. * The first parameter to the function (which may not always be defined) is the tree item for the tree * table row. * * * @returns Value of property `tooltipFormatter` */ getTooltipFormatter(): any; /** * Gets current value of property {@link #getType type}. * * The type of column. * * * @returns Value of property `type` */ getType(): sap.ui.vtm.ColumnType; /** * Gets current value of property {@link #getValueFormatter valueFormatter}. * * If defined, this is a function that specifies the formatting of cell content text for this column. * The function must return a string containing the text to display in the cell (or null) for a given tree * item. * The first parameter to the function (which may not always be defined) is the tree item for the tree * table row. * * * @returns Value of property `valueFormatter` */ getValueFormatter(): any; /** * Gets current value of property {@link #getWidth width}. * * The width of the tree column. * * Default value is `"200px"`. * * * @returns Value of property `width` */ getWidth(): sap.ui.core.CSSSize; /** * Sets a new value for property {@link #getDescriptor descriptor}. * * The descriptor is a JSON string identifying the column. * * When the type property has a value of {@link sap.ui.vtm.ColumnType.Metadata} the descriptor property * has the following form: `'{"category":"SAP","field":"MATERIAL"}'` * Such descriptors can be constructed using {@link sap.ui.vtm.DescriptorUtilities.createMetadataDescriptor}. * * When the type property has a value of {@link sap.ui.vtm.ColumnType.Identifier} the descriptor property * has the following form: `'{"source":"SAP","type":"VE_COMPONENT"}'` * Such descriptors can be constructed using {@link sap.ui.vtm.DescriptorUtilities.createIdentifierDescriptor}. * * When the type property has a value of {@link sap.ui.vtm.ColumnType.AppData} the descriptor property has * the following form: `'bomId'` * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setDescriptor( /** * New value for property `descriptor` */ sDescriptor: string ): this; /** * Sets a new value for property {@link #getHAlign hAlign}. * * The horizontal alignment for the tree column. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"Left"`. * * * @returns Reference to `this` in order to allow method chaining */ setHAlign( /** * New value for property `hAlign` */ sHAlign?: sap.ui.core.HorizontalAlign ): this; /** * Sets a new value for property {@link #getLabel label}. * * A textual name for the column. This is also used in the {@link sap.ui.vtm.ColumnSelectionDialog}, so * it should be included whether or not the `labelControl` property is used. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setLabel( /** * New value for property `label` */ sLabel: string ): this; /** * Sets a new value for property {@link #getLabelControl labelControl}. * * A {@link sap.ui.core.Control} that is used in the column header. When specified, this is used in preference * to the `label` property as the column header content. However the `label` property should also be specified * since it is used in the used in the {@link sap.ui.vtm.ColumnSelectionDialog}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setLabelControl( /** * New value for property `labelControl` */ oLabelControl: object ): this; /** * Sets a new value for property {@link #getResizable resizable}. * * If set to true, the column can be resized. * * 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 */ setResizable( /** * New value for property `resizable` */ bResizable?: boolean ): this; /** * Sets a new value for property {@link #getTemplate template}. * * If defined, overrides the cell template for the column. * If this is defined, the `valueFormatter` and `tooltipFormatter` properties are ignored. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setTemplate( /** * New value for property `template` */ sTemplate: sap.ui.core.Control ): this; /** * Sets a new value for property {@link #getTooltip tooltip}. * * A localized string to show in the column header tooltip. If unspecified, the label value will be used * as the column header tooltip. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setTooltip( /** * New value for property `tooltip`. NOTE: in sap.ui.vtm.Column you can ONLY use a string, not a TooltipBase, * even though the API formally allows it for TypeScript compatibility reasons. */ vTooltip: string | sap.ui.core.TooltipBase ): this; /** * Sets a new value for property {@link #getTooltipFormatter tooltipFormatter}. * * If defined, this is a function that specifies the formatting of cell content tooltips for this column * (overriding the default behaviour). * Not used if a custom template is specified. * The function must return a string containing the text to display in the tooltip (or null) for a given * tree item. * The first parameter to the function (which may not always be defined) is the tree item for the tree * table row. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setTooltipFormatter( /** * New value for property `tooltipFormatter` */ oTooltipFormatter: any ): this; /** * Sets a new value for property {@link #getType type}. * * The type of column. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setType( /** * New value for property `type` */ sType: sap.ui.vtm.ColumnType ): this; /** * Sets a new value for property {@link #getValueFormatter valueFormatter}. * * If defined, this is a function that specifies the formatting of cell content text for this column. * The function must return a string containing the text to display in the cell (or null) for a given tree * item. * The first parameter to the function (which may not always be defined) is the tree item for the tree * table row. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setValueFormatter( /** * New value for property `valueFormatter` */ oValueFormatter: any ): this; /** * Sets a new value for property {@link #getWidth width}. * * The width of the tree column. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"200px"`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: sap.ui.core.CSSSize ): this; } /** * This class is used to represent display states for a set of scene nodes. The same display state need * not be used for all of the scene nodes in the set. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class DisplayGroup extends sap.ui.core.Element { /** * Constructor for a new DisplayGroup. * * 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( /** * An optional ID for the {@link sap.ui.vtm.DisplayGroup}. */ sId: string, /** * An optional object with initial settings for the new {@link sap.ui.vtm.DisplayGroup} instance. */ mSettings?: sap.ui.vtm.$DisplayGroupSettings ); /** * Creates a new subclass of class sap.ui.vtm.DisplayGroup 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.vtm.DisplayGroup. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getDisplayStatesBySceneNodeId displayStatesBySceneNodeId}. * * A plain object map that uses scene node id as the key and a display state object as the value. The display * state is a plain JavaScript object that can contain the following properties: * - visibility - If defined, this boolean value specifies the scene node visibility * - opacity - If defined, this numeric value between 0 and 100 inclusive defines the scene node opacity. * * - highlightColor - If defined, this string value defines the scene node highlight color. If an empty * string (`""`) is used, the highlight color is cleared, otherwise the value is expected to be a {@link sap.ui.core.CSSColor}. * * - recursive - If `true` this display state will be applied to the scene node and its descendants. * For example: * ```javascript * * { * visibility: true, * opacity: 100, * highlightColor: "red", * recursive: false * }``` * Display state objects can be reused multiple times in the map to reduce memory usage. * * Default value is `{}`. * * * @returns Value of property `displayStatesBySceneNodeId` */ getDisplayStatesBySceneNodeId(): object; /** * Sets a new value for property {@link #getDisplayStatesBySceneNodeId displayStatesBySceneNodeId}. * * A plain object map that uses scene node id as the key and a display state object as the value. The display * state is a plain JavaScript object that can contain the following properties: * - visibility - If defined, this boolean value specifies the scene node visibility * - opacity - If defined, this numeric value between 0 and 100 inclusive defines the scene node opacity. * * - highlightColor - If defined, this string value defines the scene node highlight color. If an empty * string (`""`) is used, the highlight color is cleared, otherwise the value is expected to be a {@link sap.ui.core.CSSColor}. * * - recursive - If `true` this display state will be applied to the scene node and its descendants. * For example: * ```javascript * * { * visibility: true, * opacity: 100, * highlightColor: "red", * recursive: false * }``` * Display state objects can be reused multiple times in the map to reduce memory usage. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `{}`. * * * @returns Reference to `this` in order to allow method chaining */ setDisplayStatesBySceneNodeId( /** * New value for property `displayStatesBySceneNodeId` */ oDisplayStatesBySceneNodeId?: object ): this; } /** * A base class for extensions. * * Extensions provide an extensibility mechanism through which behaviors can be added, allowing for a default * set of behaviors that can be overridden by application developers. Extensions react to events raised * by VTM elements/controls or other extensions. * * Derived classes should provide their own {@link #initialize} implementation. Extensions are expected * to be as independent from one another as possible. * * Extensions implement interfaces to indicate the functional role(s) that they fulfill. Extensions can * be found by interface calling {@link sap.ui.vtm.Vtm#getExtensionByInterface getExtensionByInterface}. * Specific extensions can be found using {@link sap.ui.vtm.Vtm#getExtensionByName getExtensionByName}. * Typically extensions are retrieved using these methods in order to get or set their `enabled` property. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class Extension extends sap.ui.core.Element { /** * This class is an abstract class that is not intended to be instantiated directly. * * 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 {@link sap.m.Extension} instance. */ sId: string, /** * Object with initial property values, aggregated objects etc. for the new {@link sap.m.Extension} instance. */ mSettings: sap.ui.vtm.$ExtensionSettings ); /** * Creates a new subclass of class sap.ui.vtm.Extension 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.vtm.Extension. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Calls a function once for each panel that is attached (currently or in the future) to the {@link sap.ui.vtm.Vtm } * instance that owns this extension. * * This function should only be used after the Promise returned by {@link #getVtmPromise} has resolved. */ applyPanelHandler( /** * A function that takes one {@link sap.ui.vtm.Panel} argument. */ panelHandler: Function ): void; /** * Attaches event handler `fnFunction` to the {@link #event:enabledChanged enabledChanged} event of this * `sap.ui.vtm.Extension`. * * 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.vtm.Extension` itself. * * Fired when the enabled property is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachEnabledChanged( /** * 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.vtm.Extension` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:enabledChanged enabledChanged} event of this * `sap.ui.vtm.Extension`. * * 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.vtm.Extension` itself. * * Fired when the enabled property is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachEnabledChanged( /** * 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.vtm.Extension` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialized initialized} event of this `sap.ui.vtm.Extension`. * * 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.vtm.Extension` itself. * * Fired when initialization has completed. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialized( /** * 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.vtm.Extension` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialized initialized} event of this `sap.ui.vtm.Extension`. * * 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.vtm.Extension` itself. * * Fired when initialization has completed. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialized( /** * 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.vtm.Extension` itself */ oListener?: object ): this; /** * Binds property {@link #getEnabled enabled} to model data. * * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description * of the possible properties of `oBindingInfo` * * * @returns Reference to `this` in order to allow method chaining */ bindEnabled( /** * The binding information */ oBindingInfo: sap.ui.base.ManagedObject.PropertyBindingInfo ): this; /** * Detaches event handler `fnFunction` from the {@link #event:enabledChanged enabledChanged} event of this * `sap.ui.vtm.Extension`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachEnabledChanged( /** * 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; /** * Detaches event handler `fnFunction` from the {@link #event:initialized initialized} event of this `sap.ui.vtm.Extension`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachInitialized( /** * 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:enabledChanged enabledChanged} 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 */ fireEnabledChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:initialized initialized} 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 */ fireInitialized( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Gets current value of property {@link #getEnabled enabled}. * * Controls whether the extension is enabled. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets a {@link Promise} that resolves after the {@link #initialize initialize} method has been called * for the extension. * * The {@link #initialize initialize} method is called after the {@link Promise} returned by {@link #getVtmPromise getVtmPromise } * resolves. * * * @returns A {@link Promise} that is resolved after the {@link #initialize initialize} method has been * called for the extension. */ getInitializedPromise(): Promise; /** * Gets a {@link Promise} that resolves when the extension is added to the `extensions` aggregation of an * {@link sap.ui.vtm.Vtm} instance. * * The relevant {@link sap.ui.vtm.Vtm} instance is passed to the resolve handler. * * * @returns A {@link Promise} that is resolved when the extension is added to the `extensions` aggregation * of an {@link sap.ui.vtm.Vtm} instance. */ getVtmPromise(): Promise; /** * Contains initialization code for the extension. Derived classes must redefine this method. */ initialize( /** * The {@link sap.ui.vtm.Vtm} instance that this extension belongs to. */ vtm: sap.ui.vtm.Vtm ): void; /** * Sets a new value for property {@link #getEnabled enabled}. * * Controls whether the extension is enabled. * * 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 */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Unbinds property {@link #getEnabled enabled} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindEnabled(): this; } /** * A map that can contain multiple values per key value. This is a utility class that can be used as a data * structure for: * - Maintaining a lookup containing scene nodes keyed by a particular value in order to determine the * scene nodes that should be associated with a particular tree item * - Maintaining lookups (one for each tree) of tree items keyed by a particular value in order to determine * the tree items in one tree that are associated with tree items in another tree A typical usage * would be to use a {@link sap.ui.vtm.Lookup} that is keyed using a hash code constructed from some or * all of the information needed to match a particular tree item or scene node. In this scenario the {@link sap.ui.vtm.Lookup } * is used to return a set of possible matches which are then filtered to find the actual matches. The usage * of the {@link sap.ui.vtm.Lookup} with a suitable key can drastically reduces the number of items that * need to be compared when performing a search. This is important when there are large numbers of searches * that need to be performed within a large set of items. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class Lookup extends sap.ui.core.Element { /** * Constructor for a new Lookup. * * 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( /** * A function to compare two values for equality (takes two values as parameters and returns true if they * are equal). */ equalsFunc: Function ); /** * Creates a new subclass of class sap.ui.vtm.Lookup 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.vtm.Lookup. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds a value to the set of values stored against a given key. * * * @returns `this` for method chaining. */ addValue( /** * The key. */ key: any, /** * The value. */ value: any ): sap.ui.vtm.Lookup; /** * Clears the Lookup. * * * @returns `this` for method chaining. */ clear(): sap.ui.vtm.Lookup; /** * Loops over the key/value array pairs calling the callback function for each pair. * * * @returns `this` for method chaining. */ forEach( /** * The callback function to call for each key/value array pair. The first argument to the callback function * is the value array and the second parameter is the key. */ callback: Function ): sap.ui.vtm.Lookup; /** * Gets the values stored against a given key. * * * @returns The values (if any) associated with the given key. */ getValues( /** * The key to use to index the Lookup. */ key: any ): any[]; /** * Returns whether there are any values stored against the given key. * * * @returns `true` if there are any values stored against the given key. */ hasValue( /** * The key. */ key: any ): boolean; /** * Removes a particular value. * * * @returns `this` for method chaining. */ removeValue( /** * The key. */ key: any, /** * The value. */ value: any, /** * A function to compare two values for equality (takes two values as parameters and returns true if they * are equal). */ equalsFunc: Function ): sap.ui.vtm.Lookup; } /** * A control that can be used to show messages applied to a tree item. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class MessagesPopover extends sap.m.Popover { /** * Constructor for a new MessagesPopover. * * 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(); /** * Creates a new subclass of class sap.ui.vtm.MessagesPopover 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.m.Popover.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.vtm.MessagesPopover. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getMaxHeight maxHeight}. * * Maximum height of status window. * * * @returns Value of property `maxHeight` */ getMaxHeight(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getMessages messages}. * * The set of {@link sap.ui.core.Message} objects to display. * * Only the following properties of each message will be used: * - `level` * - `text` * - `icon` * * * @returns Value of property `messages` */ getMessages(): object[]; /** * Sets a new value for property {@link #getMaxHeight maxHeight}. * * Maximum height of status window. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setMaxHeight( /** * New value for property `maxHeight` */ sMaxHeight?: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getMessages messages}. * * The set of {@link sap.ui.core.Message} objects to display. * * Only the following properties of each message will be used: * - `level` * - `text` * - `icon` * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setMessages( /** * New value for property `messages` */ sMessages: object[] ): this; } /** * A control that represents a VTM panel. Contains: * - A header area containing a title and optionally a set of application controls * - A sap.ui.vtm.Tree and a sap.ui.vtm.Viewport separated by a splitter * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class Panel extends sap.ui.core.Control { /** * Constructor for a new Panel. * * 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 {@link sap.ui.vtm.Panel} instance. */ sId: string, /** * Object with initial property values, aggregated objects etc. for the new {@link sap.ui.vtm.Panel} instance. * The `vtmId` association needs to be set in order for the panel to be associated with a {@link sap.ui.vtm.Vtm } * instance. * {@link sap.ui.vtm.Vtm#createPanel createPanel} creates a {@link sap.ui.vtm.Panel} instance and populates * the `vtmId` association. */ mSettings: sap.ui.vtm.$PanelSettings ); /** * Creates a new subclass of class sap.ui.vtm.Panel 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.vtm.Panel. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some titleControl to the aggregation {@link #getTitleControls titleControls}. * * * @returns Reference to `this` in order to allow method chaining */ addTitleControl( /** * The titleControl to add; if empty, nothing is inserted */ oTitleControl: sap.ui.core.Control ): this; /** * Adds some treeHeaderControl to the aggregation {@link #getTreeHeaderControls treeHeaderControls}. * * * @returns Reference to `this` in order to allow method chaining */ addTreeHeaderControl( /** * The treeHeaderControl to add; if empty, nothing is inserted */ oTreeHeaderControl: sap.ui.core.Control ): this; /** * Adds some viewportHeaderControl to the aggregation {@link #getViewportHeaderControls viewportHeaderControls}. * * * @returns Reference to `this` in order to allow method chaining */ addViewportHeaderControl( /** * The viewportHeaderControl to add; if empty, nothing is inserted */ oViewportHeaderControl: sap.ui.core.Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contextMenu contextMenu} event of this `sap.ui.vtm.Panel`. * * 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.vtm.Panel` itself. * * Raised when the web browser `contextmenu` event is raised. To prevent the default browser context menu * from being shown call preventDefault() on the event. * * * @returns Reference to `this` in order to allow method chaining */ attachContextMenu( /** * 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: Panel$ContextMenuEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Panel` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contextMenu contextMenu} event of this `sap.ui.vtm.Panel`. * * 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.vtm.Panel` itself. * * Raised when the web browser `contextmenu` event is raised. To prevent the default browser context menu * from being shown call preventDefault() on the event. * * * @returns Reference to `this` in order to allow method chaining */ attachContextMenu( /** * The function to be called when the event occurs */ fnFunction: (p1: Panel$ContextMenuEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Panel` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialized initialized} event of this `sap.ui.vtm.Panel`. * * 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.vtm.Panel` itself. * * Raised when the panel is initialized. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialized( /** * 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.vtm.Panel` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialized initialized} event of this `sap.ui.vtm.Panel`. * * 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.vtm.Panel` itself. * * Raised when the panel is initialized. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialized( /** * 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.vtm.Panel` itself */ oListener?: object ): this; /** * Destroys all the titleControls in the aggregation {@link #getTitleControls titleControls}. * * * @returns Reference to `this` in order to allow method chaining */ destroyTitleControls(): this; /** * Destroys all the treeHeaderControls in the aggregation {@link #getTreeHeaderControls treeHeaderControls}. * * * @returns Reference to `this` in order to allow method chaining */ destroyTreeHeaderControls(): this; /** * Destroys all the viewportHeaderControls in the aggregation {@link #getViewportHeaderControls viewportHeaderControls}. * * * @returns Reference to `this` in order to allow method chaining */ destroyViewportHeaderControls(): this; /** * Detaches event handler `fnFunction` from the {@link #event:contextMenu contextMenu} event of this `sap.ui.vtm.Panel`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachContextMenu( /** * The function to be called, when the event occurs */ fnFunction: (p1: Panel$ContextMenuEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:initialized initialized} event of this `sap.ui.vtm.Panel`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachInitialized( /** * 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:contextMenu contextMenu} to attached listeners. * * Listeners may prevent the default action of this event by calling the `preventDefault` method on the * event object. The return value of this method indicates whether the default action should be executed. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Whether or not to prevent the default action */ fireContextMenu( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Panel$ContextMenuEventParameters ): boolean; /** * Fires event {@link #event:initialized initialized} 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 */ fireInitialized( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Gets current value of property {@link #getHeight height}. * * The height of the panel. * * Default value is `"inherit"`. * * * @returns Value of property `height` */ getHeight(): sap.ui.core.CSSSize; /** * Gets whether this is the active {@link sap.ui.vtm.Panel}. * * * @returns `true` if this is the active panel. */ getIsActive(): boolean; /** * Gets current value of property {@link #getShowViewport showViewport}. * * Controls whether the viewport will be shown for this panel. * * Default value is `true`. * * * @returns Value of property `showViewport` */ getShowViewport(): boolean; /** * Gets current value of property {@link #getTitle title}. * * The text to show in the title bar for this panel. * * * @returns Value of property `title` */ getTitle(): string; /** * Gets content of aggregation {@link #getTitleControls titleControls}. * * The set of controls to render in the title bar area. */ getTitleControls(): sap.ui.core.Control[]; /** * Gets the tree owned by this panel. * * * @returns The tree owned by this panel. */ getTree(): sap.ui.vtm.Tree; /** * Gets content of aggregation {@link #getTreeHeaderControls treeHeaderControls}. * * The set of controls to render in the tree header area. */ getTreeHeaderControls(): sap.ui.core.Control[]; /** * Gets current value of property {@link #getTreeWidth treeWidth}. * * The width of the tree. * * Default value is `"50%"`. * * * @returns Value of property `treeWidth` */ getTreeWidth(): sap.ui.core.CSSSize; /** * Gets the viewport owned by this panel. * * * @returns The viewport owned by this panel. */ getViewport(): sap.ui.vtm.Viewport; /** * Gets content of aggregation {@link #getViewportHeaderControls viewportHeaderControls}. * * The set of controls to render in the viewport header area. */ getViewportHeaderControls(): sap.ui.core.Control[]; /** * Gets the {@link sap.ui.vtm.Vtm} instance that owns this panel. * * * @returns The {@link sap.ui.vtm.Vtm} instance that owns this panel. */ getVtm(): sap.ui.vtm.Vtm; /** * ID of the element which is the current target of the association {@link #getVtmId vtmId}, or `null`. */ getVtmId(): sap.ui.core.ID | null; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getTitleControls titleControls}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfTitleControl( /** * The titleControl whose index is looked for */ oTitleControl: sap.ui.core.Control ): int; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getTreeHeaderControls treeHeaderControls}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfTreeHeaderControl( /** * The treeHeaderControl whose index is looked for */ oTreeHeaderControl: sap.ui.core.Control ): int; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getViewportHeaderControls viewportHeaderControls}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfViewportHeaderControl( /** * The viewportHeaderControl whose index is looked for */ oViewportHeaderControl: sap.ui.core.Control ): int; /** * Inserts a titleControl into the aggregation {@link #getTitleControls titleControls}. * * * @returns Reference to `this` in order to allow method chaining */ insertTitleControl( /** * The titleControl to insert; if empty, nothing is inserted */ oTitleControl: sap.ui.core.Control, /** * The `0`-based index the titleControl should be inserted at; for a negative value of `iIndex`, the titleControl * is inserted at position 0; for a value greater than the current size of the aggregation, the titleControl * is inserted at the last position */ iIndex: int ): this; /** * Inserts a treeHeaderControl into the aggregation {@link #getTreeHeaderControls treeHeaderControls}. * * * @returns Reference to `this` in order to allow method chaining */ insertTreeHeaderControl( /** * The treeHeaderControl to insert; if empty, nothing is inserted */ oTreeHeaderControl: sap.ui.core.Control, /** * The `0`-based index the treeHeaderControl should be inserted at; for a negative value of `iIndex`, the * treeHeaderControl is inserted at position 0; for a value greater than the current size of the aggregation, * the treeHeaderControl is inserted at the last position */ iIndex: int ): this; /** * Inserts a viewportHeaderControl into the aggregation {@link #getViewportHeaderControls viewportHeaderControls}. * * * @returns Reference to `this` in order to allow method chaining */ insertViewportHeaderControl( /** * The viewportHeaderControl to insert; if empty, nothing is inserted */ oViewportHeaderControl: sap.ui.core.Control, /** * The `0`-based index the viewportHeaderControl should be inserted at; for a negative value of `iIndex`, * the viewportHeaderControl is inserted at position 0; for a value greater than the current size of the * aggregation, the viewportHeaderControl is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getTitleControls titleControls}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllTitleControls(): sap.ui.core.Control[]; /** * Removes all the controls from the aggregation {@link #getTreeHeaderControls treeHeaderControls}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllTreeHeaderControls(): sap.ui.core.Control[]; /** * Removes all the controls from the aggregation {@link #getViewportHeaderControls viewportHeaderControls}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllViewportHeaderControls(): sap.ui.core.Control[]; /** * Removes a titleControl from the aggregation {@link #getTitleControls titleControls}. * * * @returns The removed titleControl or `null` */ removeTitleControl( /** * The titleControl to remove or its index or id */ vTitleControl: int | string | sap.ui.core.Control ): sap.ui.core.Control | null; /** * Removes a treeHeaderControl from the aggregation {@link #getTreeHeaderControls treeHeaderControls}. * * * @returns The removed treeHeaderControl or `null` */ removeTreeHeaderControl( /** * The treeHeaderControl to remove or its index or id */ vTreeHeaderControl: int | string | sap.ui.core.Control ): sap.ui.core.Control | null; /** * Removes a viewportHeaderControl from the aggregation {@link #getViewportHeaderControls viewportHeaderControls}. * * * @returns The removed viewportHeaderControl or `null` */ removeViewportHeaderControl( /** * The viewportHeaderControl to remove or its index or id */ vViewportHeaderControl: int | string | sap.ui.core.Control ): sap.ui.core.Control | null; /** * Sets a new value for property {@link #getHeight height}. * * The height of the panel. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"inherit"`. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ sHeight?: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getShowViewport showViewport}. * * Controls whether the viewport will be shown for this panel. * * 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 */ setShowViewport( /** * New value for property `showViewport` */ bShowViewport?: boolean ): this; /** * Sets the panel title. * * * @returns Returns `this` for method chaining. */ setTitle( /** * The panel title text */ title: string ): sap.ui.vtm.Panel; /** * Sets a new value for property {@link #getTreeWidth treeWidth}. * * The width of the tree. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"50%"`. * * * @returns Reference to `this` in order to allow method chaining */ setTreeWidth( /** * New value for property `treeWidth` */ sTreeWidth?: sap.ui.core.CSSSize ): this; /** * Sets the associated {@link #getVtmId vtmId}. * * * @returns Reference to `this` in order to allow method chaining */ setVtmId( /** * ID of an element which becomes the new target of this vtmId association; alternatively, an element instance * may be given */ oVtmId: sap.ui.core.ID | sap.ui.vtm.Vtm ): this; } /** * A progress control to show viewable download and load progress. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class ProgressDialog extends sap.ui.core.Control { /** * Constructor for a new ProgressDialog. * * 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( /** * The scene that is being used to load viewables. */ scene: sap.ui.vtm.Scene ); /** * Creates a new subclass of class sap.ui.vtm.ProgressDialog 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.vtm.ProgressDialog. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Closes the dialog. * * * @returns `this` for method chaining. */ close(): sap.ui.vtm.ProgressDialog; /** * Gets current value of property {@link #getPercentComplete percentComplete}. * * The percentage (0-100) to show in the progress bar (if visible). * * Default value is `0`. * * * @returns Value of property `percentComplete` */ getPercentComplete(): int; /** * Gets current value of property {@link #getProgressBarVisible progressBarVisible}. * * Whether the progress bar is visible. * * Default value is `"true"`. * * * @returns Value of property `progressBarVisible` */ getProgressBarVisible(): boolean; /** * Gets current value of property {@link #getProgressText progressText}. * * The text to display in the progress dialog. * * * @returns Value of property `progressText` */ getProgressText(): string; /** * Returns whether the dialog is open. * * * @returns `true` when the dialog is open. */ isOpen(): boolean; /** * Opens the dialog. * * * @returns `this` for method chaining. */ open(): sap.ui.vtm.ProgressDialog; /** * Sets a new value for property {@link #getPercentComplete percentComplete}. * * The percentage (0-100) to show in the progress bar (if visible). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setPercentComplete( /** * New value for property `percentComplete` */ iPercentComplete?: int ): this; /** * Sets a new value for property {@link #getProgressBarVisible progressBarVisible}. * * Whether the progress bar is visible. * * 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 */ setProgressBarVisible( /** * New value for property `progressBarVisible` */ bProgressBarVisible?: boolean ): this; /** * Sets a new value for property {@link #getProgressText progressText}. * * The text to display in the progress dialog. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setProgressText( /** * New value for property `progressText` */ sProgressText: string ): this; } /** * Allows access to scene nodes in the scene. A single {@link sap.ui.vtm.Scene} is shared by the {@link sap.ui.vtm.Viewport } * objects in all the {@link sap.ui.vtm.Panel} objects associated with a {@link sap.ui.vtm.Vtm} instance. * Visibility, selection, highlighting and opacity can be controlled for each scene node separately in each * {@link sap.ui.vtm.Viewport}. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class Scene extends sap.ui.core.Element { /** * This class is not intended to be directly instantiated by application code. A {@link sap.ui.vtm.Scene } * object is created when a {@link sap.ui.vtm.Vtm} object is created. * * 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(); /** * Creates a new subclass of class sap.ui.vtm.Scene 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.vtm.Scene. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:downloadCompleted downloadCompleted} event of * this `sap.ui.vtm.Scene`. * * 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.vtm.Scene` itself. * * Raised when viewables have been downloaded (successfully or unsuccessfully) as a result of a call to * {@link #loadViewablesAsync}. * * If no viewables have been successfully downloaded, none of the viewables will be loaded, so no subsequent * {@link sap.ui.vtm.Scene.loadStarted}, {@link sap.ui.vtm.Scene.loadProgress} or {@link sap.ui.vtm.Scene.loadCompleted } * will occur as a result of the call to {@link #loadViewablesAsync} that resulted in the {@link sap.ui.vtm.Scene.downloadCompleted } * event being raised. * * * @returns Reference to `this` in order to allow method chaining */ attachDownloadCompleted( /** * 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: Scene$DownloadCompletedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Scene` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:downloadCompleted downloadCompleted} event of * this `sap.ui.vtm.Scene`. * * 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.vtm.Scene` itself. * * Raised when viewables have been downloaded (successfully or unsuccessfully) as a result of a call to * {@link #loadViewablesAsync}. * * If no viewables have been successfully downloaded, none of the viewables will be loaded, so no subsequent * {@link sap.ui.vtm.Scene.loadStarted}, {@link sap.ui.vtm.Scene.loadProgress} or {@link sap.ui.vtm.Scene.loadCompleted } * will occur as a result of the call to {@link #loadViewablesAsync} that resulted in the {@link sap.ui.vtm.Scene.downloadCompleted } * event being raised. * * * @returns Reference to `this` in order to allow method chaining */ attachDownloadCompleted( /** * The function to be called when the event occurs */ fnFunction: (p1: Scene$DownloadCompletedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Scene` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:downloadProgress downloadProgress} event of * this `sap.ui.vtm.Scene`. * * 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.vtm.Scene` itself. * * Raised to indicate download progress of a viewable while viewables are being downloaded * * * @returns Reference to `this` in order to allow method chaining */ attachDownloadProgress( /** * 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: Scene$DownloadProgressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Scene` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:downloadProgress downloadProgress} event of * this `sap.ui.vtm.Scene`. * * 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.vtm.Scene` itself. * * Raised to indicate download progress of a viewable while viewables are being downloaded * * * @returns Reference to `this` in order to allow method chaining */ attachDownloadProgress( /** * The function to be called when the event occurs */ fnFunction: (p1: Scene$DownloadProgressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Scene` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:downloadStarted downloadStarted} event of this * `sap.ui.vtm.Scene`. * * 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.vtm.Scene` itself. * * Raised when starting a download of a set of viewables. * * * @returns Reference to `this` in order to allow method chaining */ attachDownloadStarted( /** * 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: Scene$DownloadStartedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Scene` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:downloadStarted downloadStarted} event of this * `sap.ui.vtm.Scene`. * * 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.vtm.Scene` itself. * * Raised when starting a download of a set of viewables. * * * @returns Reference to `this` in order to allow method chaining */ attachDownloadStarted( /** * The function to be called when the event occurs */ fnFunction: (p1: Scene$DownloadStartedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Scene` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:hierarchyChanged hierarchyChanged} event of * this `sap.ui.vtm.Scene`. * * 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.vtm.Scene` itself. * * Raised when the scene hierarchy has been modified. * * * @returns Reference to `this` in order to allow method chaining */ attachHierarchyChanged( /** * 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.vtm.Scene` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:hierarchyChanged hierarchyChanged} event of * this `sap.ui.vtm.Scene`. * * 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.vtm.Scene` itself. * * Raised when the scene hierarchy has been modified. * * * @returns Reference to `this` in order to allow method chaining */ attachHierarchyChanged( /** * 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.vtm.Scene` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:loadCompleted loadCompleted} event of this `sap.ui.vtm.Scene`. * * 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.vtm.Scene` itself. * * Raised when all viewables specified in a call to {@link #loadViewablesAsync} have either loaded or failed * to load. * * * @returns Reference to `this` in order to allow method chaining */ attachLoadCompleted( /** * 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: Scene$LoadCompletedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Scene` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:loadCompleted loadCompleted} event of this `sap.ui.vtm.Scene`. * * 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.vtm.Scene` itself. * * Raised when all viewables specified in a call to {@link #loadViewablesAsync} have either loaded or failed * to load. * * * @returns Reference to `this` in order to allow method chaining */ attachLoadCompleted( /** * The function to be called when the event occurs */ fnFunction: (p1: Scene$LoadCompletedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Scene` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:loadProgress loadProgress} event of this `sap.ui.vtm.Scene`. * * 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.vtm.Scene` itself. * * Raised to provide progress information for a viewable that is being loaded. * * * @returns Reference to `this` in order to allow method chaining */ attachLoadProgress( /** * 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.vtm.Scene` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:loadProgress loadProgress} event of this `sap.ui.vtm.Scene`. * * 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.vtm.Scene` itself. * * Raised to provide progress information for a viewable that is being loaded. * * * @returns Reference to `this` in order to allow method chaining */ attachLoadProgress( /** * 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.vtm.Scene` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:loadStarted loadStarted} event of this `sap.ui.vtm.Scene`. * * 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.vtm.Scene` itself. * * Raised when starting to load a set of viewables. * * * @returns Reference to `this` in order to allow method chaining */ attachLoadStarted( /** * 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: Scene$LoadStartedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Scene` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:loadStarted loadStarted} event of this `sap.ui.vtm.Scene`. * * 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.vtm.Scene` itself. * * Raised when starting to load a set of viewables. * * * @returns Reference to `this` in order to allow method chaining */ attachLoadStarted( /** * The function to be called when the event occurs */ fnFunction: (p1: Scene$LoadStartedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Scene` itself */ oListener?: object ): this; /** * Clones a scene node. * * * @returns The scene node ID of the created node. */ cloneNode( /** * The ID of the node to clone. */ nodeIdToClone: string, /** * The ID of the node that will be the parent of the created node. If `null` the newly created node is a * top level node. */ parentNodeId: string, /** * The created node is added before this specified node. If `null` the newly created node is added at the * end of the parent's list of nodes. */ insertBeforeNodeId: string, /** * The name of the new node. */ name: string, /** * If `true`, the descendants of the scene node will also be cloned. Defaults to `true`. */ recursive: boolean ): string; /** * Creates a scene node. * * * @returns The scene node ID of the created node. */ createNode( /** * The ID of the node that will be the parent of the created node. If `null` the newly created node is a * top level node. */ parentNodeId: string, /** * The created node is added before this specified node. If `null` the newly created node is added at the * end of the parent's list of nodes. */ insertBeforeNodeId: string, /** * The name of the new node. */ name: string ): string; /** * Deletes a node from the scene. * * * @returns `this` for method chaining. */ deleteNode( /** * The ID of the node to delete. */ nodeId: string ): sap.ui.vtm.Scene; /** * Detaches event handler `fnFunction` from the {@link #event:downloadCompleted downloadCompleted} event * of this `sap.ui.vtm.Scene`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachDownloadCompleted( /** * The function to be called, when the event occurs */ fnFunction: (p1: Scene$DownloadCompletedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:downloadProgress downloadProgress} event of * this `sap.ui.vtm.Scene`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachDownloadProgress( /** * The function to be called, when the event occurs */ fnFunction: (p1: Scene$DownloadProgressEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:downloadStarted downloadStarted} event of * this `sap.ui.vtm.Scene`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachDownloadStarted( /** * The function to be called, when the event occurs */ fnFunction: (p1: Scene$DownloadStartedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:hierarchyChanged hierarchyChanged} event of * this `sap.ui.vtm.Scene`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachHierarchyChanged( /** * 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; /** * Detaches event handler `fnFunction` from the {@link #event:loadCompleted loadCompleted} event of this * `sap.ui.vtm.Scene`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachLoadCompleted( /** * The function to be called, when the event occurs */ fnFunction: (p1: Scene$LoadCompletedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:loadProgress loadProgress} event of this `sap.ui.vtm.Scene`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachLoadProgress( /** * 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; /** * Detaches event handler `fnFunction` from the {@link #event:loadStarted loadStarted} event of this `sap.ui.vtm.Scene`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachLoadStarted( /** * The function to be called, when the event occurs */ fnFunction: (p1: Scene$LoadStartedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:downloadCompleted downloadCompleted} 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 */ fireDownloadCompleted( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Scene$DownloadCompletedEventParameters ): this; /** * Fires event {@link #event:downloadProgress downloadProgress} 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 */ fireDownloadProgress( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Scene$DownloadProgressEventParameters ): this; /** * Fires event {@link #event:downloadStarted downloadStarted} 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 */ fireDownloadStarted( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Scene$DownloadStartedEventParameters ): this; /** * Fires event {@link #event:hierarchyChanged hierarchyChanged} 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 */ fireHierarchyChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:loadCompleted loadCompleted} 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 */ fireLoadCompleted( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Scene$LoadCompletedEventParameters ): this; /** * Fires event {@link #event:loadProgress loadProgress} 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 */ fireLoadProgress( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:loadStarted loadStarted} 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 */ fireLoadStarted( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Scene$LoadStartedEventParameters ): this; /** * Gets the scene node IDs of all the scene nodes in the scene. * * * @returns The scene node IDs of all the scene nodes in the scene. */ getAllIds(): string[]; /** * Gets the scene node IDs of the ancestors of the specified scene node. The root scene node is the first * item in the array and the parent is the last. * * * @returns The scene node IDs of the ancestors of the scene node. */ getAncestorIds( /** * The scene node to find the ancestors of. */ sceneNodeId: string ): string[]; /** * Gets set of all scene node IDs in the scene that have been discovered via scene traversal performed by * the application. * * Accurate population of this value requires application support (whereas {@link #getAllIds} always returns * the exact set of all scene nodes in the scene). * * Scene node IDs are added to this set as they are discovered through methods the application calls: * * - {@link #getAllIds} * - {@link #getRootIds} * - {@link #getParentIds} * - {@link #getAncestorIds} * - {@link #getChildIds} * - {@link #getDescendantIds} * * The methods above are also used by the following methods: * - {@link #traverseTree} * - {@link #traverseBranch} * * All of the scene nodes that have been traversed by these traversal methods will be included in the cached * set. If during a call to {@link #traverseTree} or {@link #traverseBranch} the application stops traversal * of a particular branch of the scene tree by returning `false` in the callback for a particular scene * node, the application can call {@link #getDescendantIds} for that scene node to ensure that all the scene * node IDs for the descendants of that scene node are included in the set of cached IDs. * * Scene nodes are also added/removed from the to the cached set as required when the following methods * are called: * - {@link #createNode} * - {@link #cloneNode} * - {@link #deleteNode} * * If this method is called before any scene traversal has occurred, it populates the set of cached scene * node IDs using {@link #getAllIds}. * * * @returns The set of all scene node IDs in the scene that have been discovered via scene traversal performed * by the application. */ getCachedIds(): string[]; /** * Gets the scene node IDs of the children of the specified scene node. * * * @returns The scene node IDs of the children of the specified scene node. */ getChildIds( /** * The scene node to find the children of. */ sceneNodeId: string ): string[]; /** * Gets the scene node IDs of the descendants of the specified scene node. * * * @returns The scene node IDs of the descendants of the specified scene node. */ getDescendantIds( /** * The scene node to find the descendants of. */ sceneNodeId: string ): string[]; /** * Gets the set of downloaded viewables. * * * @returns The set of downloaded viewables. */ getDownloadedViewables(): sap.ui.vtm.Viewable[]; /** * Gets the set of loaded viewables. * * * @returns The set of loaded viewables. */ getLoadedViewables(): sap.ui.vtm.Viewable[]; /** * Gets the scene node ID of the parent node of the specified scene node or null if the specified scene * node is a root scene node. * * * @returns The scene node ID of the parent scene node of the specified scene node or null if the specified * scene node is a root scene node. */ getParentId( /** * The scene node to find the parent of. */ sceneNodeId: string ): string | null; /** * Gets the IDs of the the root scene nodes. * * * @returns The root scene node IDs. */ getRootIds(): string[]; /** * Gets the set of {@link sap.ui.vtm.ViewableLoadInfo} objects that describe the status of each {@link sap.ui.vtm.Viewable } * that has been passed to a {@link #loadViewablesAsyc} call made on this {@link sap.ui.vtm.Scene} instance. * * * @returns The set of {@link sap.ui.vtm.ViewableLoadInfo} objects that describe the status of each {@link sap.ui.vtm.Viewable } * that has been passed to a {@link #loadViewablesAsyc} call made on this {@link sap.ui.vtm.Scene} instance. */ getViewableLoadInfos(): sap.ui.vtm.ViewableLoadInfo[]; /** * Gets the {@link sap.ui.vtm.Vtm} instance that owns this scene. * * * @returns The {@link sap.ui.vtm.Vtm} instance that owns this scene. */ getVtm(): sap.ui.vtm.Vtm; /** * Load a set of viewables asynchronously. Progress is indicated by the `progress` event and completion * is indicated by the `loadComplete` event. * * * @returns `this` for method chaining. */ loadViewablesAsync( /** * The set of viewables to load. */ viewables: sap.ui.vtm.Viewable | sap.ui.vtm.Viewable[] ): sap.ui.vtm.Scene; /** * Recursively traverses a scene tree branch calling a function on each scene node. * * Does not traverse the descendants of closed nodes. * * * @returns this */ traverseBranch( /** * The ID of the scene node that represents the root of the branch to traverse. */ sceneNodeId: string, /** * The function to apply to the traversed scene nodes. * The first parameter to the callback function is of type {@link sap.ui.vtm.SceneNode}. * The second parameter to the callback function is an array of IDs of ancestors of the scene node being * processed. * When the function returns `false`, the descendants of the scene node passed as the parameter are not * traversed. */ callback: Function ): sap.ui.vtm.Scene; /** * Traverses a set of scene nodes specified by scene node ID, calling a function on each scene node. * * * @returns this */ traverseNodes( /** * The IDs of the scene nodes to traverse. */ sceneNodeIds: string | string[], /** * The function to apply to the traversed scene nodes. * The function takes two parameters. * The first parameter to the function is of type {@link sap.ui.vtm.SceneNode}. The second parameter to * the function is the zero based index of the current scene node in the traversal. Traversal stops if the * function returns `false`. */ callback: Function ): sap.ui.vtm.Scene; /** * Recursively traverses the scene tree calling a function on each scene node. * * * @returns this */ traverseTree( /** * The function to apply to the traversed scene nodes. The first parameter to the callback function is of * type {@link sap.ui.vtm.SceneNode}. * The second parameter to the callback function is an array of IDs of ancestors of the scene node being * processed. * When the function returns `false`, the descendants of the scene node passed as the parameter are not * traversed. */ callback: Function ): sap.ui.vtm.Scene; } /** * This class provides access to the data for a scene node. Objects of this type are transient. Long lived * references to such objects should not be kept. A single {@link sap.ui.vtm.SceneNode} object can be reused * to refer to a different scene node by changing the value of the `sceneNodeId` property. Scene traversal * methods typically reuse a single {@link sap.ui.vtm.SceneNode} object to avoid construction and destruction. * Applications are expected to use their own data structures to store data extracted from scene nodes that * needs to be accessed efficiently. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class SceneNode extends sap.ui.core.Element { /** * This class is not intended to be directly instantiated by application code. The scene traversal methods * ({@link sap.ui.vtm.Scene#traverseTree traverseTree}, {@link sap.ui.vtm.Scene#traverseBranch traverseBranch}, * {@link sap.ui.vtm.Scene#traverseNodes traverseNodes}) should be used to access scene nodes * * 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( /** * An optional ID for the {@link sap.ui.vtm.SceneNode}. */ sId: string, /** * An optional object with initial settings for the new {@link sap.ui.vtm.SceneNode} instance. */ mSettings?: sap.ui.vtm.$SceneNodeSettings ); /** * Creates a new subclass of class sap.ui.vtm.SceneNode 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.vtm.SceneNode. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets the absolute transformation matrix that applies to the scene node in ISO 10303-42 format. * * * @returns The absolute transformation matrix that applies to the scene node in ISO 10303-42 format. */ getAbsoluteMatrix(): sap.ui.vtm.Matrix; /** * Gets whether this scene node is closed. When a scene node is closed, the closed scene node and its descendants * are treated as a single scene node (at least in terms of selection). * * * @returns Whether this scene node is closed. */ getClosed(): boolean; /** * Gets a plain JavaScript object map of identifier values. Keys are in the form: `['{"source":"SAP","type":"VE_COMPONENT"}'`. * Values are strings or arrays of strings in the form: `'[{"name":"ID", "value":"_moto_x_asm"},{"name":"version", * "value": "00"},{"name": "timestamp", "value":"2016-05-18 03:44:53.93"}]'`. * * * @returns The plain JavaScript object map of identifier values. */ getIdentifiers(): object; /** * Gets the name of the scene node. * * * @returns The scene node name. */ getName(): string; /** * Gets a plain JavaScript object map of metadata values. Keys are in the form: `'{"category":"SAP","field":"MATERIAL"}'`. * Values are in the form of strings or arrays of strings. * * * @returns The plain JavaScript object map of metadata values. */ getNodeMetadata(): object; /** * Gets the relative transformation matrix that applies to the scene node in ISO 10303-42 format. * * * @returns The relative transformation matrix that applies to the scene node in ISO 10303-42 format. */ getRelativeMatrix(): sap.ui.vtm.Matrix; /** * Gets current value of property {@link #getScene scene}. * * The {@link sap.ui.vtm.Scene} for the scene node. * * * @returns Value of property `scene` */ getScene(): object; /** * Gets current value of property {@link #getSceneNodeId sceneNodeId}. * * The scene node id. * * This is a transient identifier that exists in the context of the current scene. It should not be persisted. * * * @returns Value of property `sceneNodeId` */ getSceneNodeId(): string; /** * Sets the absolute transformation matrix that applies to the scene node in ISO 10303-42 format. * * * @returns `this` for method chaining. */ setAbsoluteMatrix( /** * The absolute transformation matrix that applies to the scene node in ISO 10303-42 format. */ matrix: sap.ui.vtm.Matrix ): sap.ui.vtm.SceneNode; /** * Sets the relative transformation matrix that applies to the scene node in ISO 10303-42 format. * * * @returns `this` for method chaining. */ setRelativeMatrix( /** * The relative transformation matrix that applies to the scene node in ISO 10303-42 format. */ matrix: sap.ui.vtm.Matrix ): sap.ui.vtm.SceneNode; /** * Sets a new value for property {@link #getScene scene}. * * The {@link sap.ui.vtm.Scene} for the scene node. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setScene( /** * New value for property `scene` */ oScene: object ): this; /** * Sets a new value for property {@link #getSceneNodeId sceneNodeId}. * * The scene node id. * * This is a transient identifier that exists in the context of the current scene. It should not be persisted. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setSceneNodeId( /** * New value for property `sceneNodeId` */ sSceneNodeId: string ): this; } /** * A dialog used to select the columns to display in a {@link sap.ui.vtm.Tree}. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class SelectColumnsDialog extends sap.ui.core.Control { /** * Constructor for a new SelectColumnsDialog. * * 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(); /** * Creates a new subclass of class sap.ui.vtm.SelectColumnsDialog 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.vtm.SelectColumnsDialog. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getSelectableColumns selectableColumns}. * * The set of columns that should be shown in the dialog that may be selected for display. * * * @returns Value of property `selectableColumns` */ getSelectableColumns(): sap.ui.vtm.Column[]; /** * Gets current value of property {@link #getTree tree}. * * The {@link sap.ui.vtm.Tree} that column selection is being performed for. * * * @returns Value of property `tree` */ getTree(): object; /** * Opens the dialog. The dialog applies the updated set of columns to the tree if confirmed. * * * @returns `this` for method chaining. */ open(): sap.ui.vtm.SelectColumnsDialog; /** * Sets a new value for property {@link #getSelectableColumns selectableColumns}. * * The set of columns that should be shown in the dialog that may be selected for display. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setSelectableColumns( /** * New value for property `selectableColumns` */ sSelectableColumns: sap.ui.vtm.Column[] ): this; /** * Sets a new value for property {@link #getTree tree}. * * The {@link sap.ui.vtm.Tree} that column selection is being performed for. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setTree( /** * New value for property `tree` */ oTree: object ): this; } /** * A control that contains a tree and associated data columns and provides helper methods for tree manipulation. * * Call {@link #setRootItems} to provide a tree model. * Call {@link #updateCollections} after making changes to the tree hierarchy. * Call {@link #updateModel} after making changes to the tree model (either changes to the the tree hierarchy * or changes to properties of tree items). * * * Items in the tree are plain JavaScript objects that have the following set of properties: * - `id` - The unique id for the tree item. This is the only required field in the tree item object. * * - `name` - The tree item name. * - `iconUrl` - The URL string for the icon to show in the "tree" column. * - `iconColor` - The color for the icon to show in the "tree" column. * - `iconTooltip` - A tooltip for the icon to show in the "tree" column. * - `absoluteMatrix` - An array of 13 numbers in ISO 10303-42 format representing an absolute transformation * matrix. * - `relativeMatrix` - An array of 13 numbers in ISO 10303-42 format representing a relative transformation * matrix. * - `includedChildren` - An array of tree items containing the children of this tree item that can be * displayed in the tree. * - `excludedChildren` - An array of tree items containing the children of this tree item that are not * displayed in the tree. * - `metadata` - A plain JavaScript object map containing metadata values for the tree item. * Keys are JSON strings that can be parsed using JSON.parse() to get an object with category and field * string properties. * Values can be of the following types: `string, string[]`, `number`, `number[]`, `boolean`, `boolean[]`, * `object`, `object[]`. * - `identifiers` - A plain JavaScript object map containing VE9 identifier values for the tree item. * Keys are JSON strings that can be parsed using JSON.parse() to get an object with source and type string * properties. * Values can be of the following types: string, string[]. * Each value string is a JSON string that can be parsed using JSON.parse to get an array of name/value * pairs. * The value in each name/value pair is optional. * - `appData` - A plain JavaScript object map containing application data values for the tree item. * Keys are application defined strings. * Values can be of the following types: `string, string[]`, `number`, `number[]`, `boolean`, `boolean[]`, * `object`, `object[]`. * - `textColor` - A {@link sap.ui.vtm.TextColor} value that specifies the color of the text for the tree * item in the Name data column (defaults to {@link sap.ui.vtm.TextColor.Default}). * - `sceneNodeIds` - A string or array of strings containing the IDs of scene nodes to associate with * this tree item. * - `visibility` - Used to determine visibility of associated scene nodes and control a visibility icon * shown in the {@link sap.ui.vtm.InternalColumnDescriptor.Visibility} column. * When `true` associated scene nodes should be visible in the viewport (when their visibility is not overridden). * When `false` associated scene nodes should not be visible in the viewport (when their visibility is * not overridden). * When `null` or `undefined` no visibility icon is shown for the tree item and associated scene nodes * should not be visible in the viewport (when their visibility is not overridden). * - `opacity` - A numeric value between 0 and 1 (inclusive) that specifies the opacity to apply to associated * scene nodes (when their opacity is not overridden). * - `highlightColor` - A sap.ui.core.CSSColor that specifies a highlight color to apply to associated * scene nodes (when their highlight color is not overridden). The alpha component specifies the blend ratio * between the highlight color and the scene node color. * - `messages` A string that can be parsed using JSON.parse() to produce an array of objects that can * be used to construct {@link sap.ui.core.Message} objects. * Refer to the documentation for the `mSettings` parameter of the {@link sap.ui.core.Message} constructor * for valid values. * - `messageStatusIconUrl` The URL of the icon to display in the message status column. If an extension * implementing {@link sap.ui.vtm.interfaces.IMessageStatusCalculationExtension} is being used, only that * extension should set values for this field. * - `messageStatusIconColor` The {@link sap.ui.core.CSSColor} color of the icon to display in the message * status column. If an extension implementing {@link sap.ui.vtm.interfaces.IMessageStatusCalculationExtension } * is being used, only that extension should set values for this field. * - `messageStatusIconTooltip` The tooltip for the icon in the message status column. If an extension * implementing {@link sap.ui.vtm.interfaces.IMessageStatusCalculationExtension} is being used, only that * extension should set values for this field. * * The `sceneNodeIds`, `visibility`, `opacity` and `highlightColor` properties are used by the extension * implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension} to determine the display * state of scene nodes shown in the {@link sap.ui.vtm.Viewport} associated with the {@link sap.ui.vtm.Tree}. * * Example: * ```javascript * { * id: sap.base.util.uid(), * name: "Tree item name", * iconUrl: "sap-icon://tree", * iconTooltip: "Group" * absoluteMatrix: [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1, 1], * relativeMatrix: [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1, 1], * includedChildren: [], * metadata:{ * '{"category":"SAP","field":"MATERIAL"}': ["mat1", "mat2"]] * }, * identifiers: { * '{"source":"SAP","type":"VE_COMPONENT"}': '[{"name":"ID", "value":"_moto_x_asm"},{"name":"version", "value": "00"},{"name": "timestamp", "value":"2016-05-18 03:44:53.93"}]', * '{"source":"SAP","type":"MATERIAL"}': ['[{"name":"ID", "value":"mat1"}]', '[{"name":"ID", "value":"mat2"}]'] * }, * appData:{ * "bomId: "bom1", * "bomItemId: "bomItem1", * }, * textColor: sap.ui.vtm.TextColor.Gray, * sceneNodeIds: ["iffffffff01021520", "iffffffff01021528"], * visibility: true, * opacity: 0.3, * highlightColor: "rgba(0,255,0,0.8)" * messages: '[{"level":"Error","text":"some error"},{"level":"Error","text":"Another error"},{"level":"Warning","A warning"}]', * messageStatusIconUrl: "sap-icon://error", * messageStatusIconColor: "red", * messageStatusIconTooltip: "Error" * }``` * * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class Tree extends sap.ui.core.Control { /** * This class is not intended to be instantiated directly by application code. A {@link sap.ui.vtm.Tree } * object is created when a {@link sap.ui.vtm.Panel} object is instantiated. * * 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 {@link sap.ui.vtm.Tree}. */ sId: string, /** * Object with initial property values, aggregated objects etc. for the new {@link sap.ui.vtm.Tree}. */ mSettings: sap.ui.vtm.$TreeSettings ); /** * Creates a new subclass of class sap.ui.vtm.Tree 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.vtm.Tree. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some headerControl to the aggregation {@link #getHeaderControls headerControls}. * * * @returns Reference to `this` in order to allow method chaining */ addHeaderControl( /** * The headerControl to add; if empty, nothing is inserted */ oHeaderControl: sap.ui.core.Control ): this; /** * Adds a root item to the tree. * * * @returns `this` to allow method chaining. */ addRoot( /** * The root tree item to remove. */ rootItemToAdd: object ): sap.ui.vtm.Tree; /** * Attaches event handler `fnFunction` to the {@link #event:beforeModelUpdated beforeModelUpdated} event * of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised before the model is updated. * * * @returns Reference to `this` in order to allow method chaining */ attachBeforeModelUpdated( /** * 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.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeModelUpdated beforeModelUpdated} event * of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised before the model is updated. * * * @returns Reference to `this` in order to allow method chaining */ attachBeforeModelUpdated( /** * 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.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:dataColumnsChanged dataColumnsChanged} event * of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when the data columns are updated. * * * @returns Reference to `this` in order to allow method chaining */ attachDataColumnsChanged( /** * 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.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:dataColumnsChanged dataColumnsChanged} event * of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when the data columns are updated. * * * @returns Reference to `this` in order to allow method chaining */ attachDataColumnsChanged( /** * 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.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:dragOver dragOver} event of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when a tree item is dragged over a tree item or an unpopulated row in a tree. To allow a drop * to occur call preventDefault() on the event. * * * @returns Reference to `this` in order to allow method chaining */ attachDragOver( /** * 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: Tree$DragOverEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:dragOver dragOver} event of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when a tree item is dragged over a tree item or an unpopulated row in a tree. To allow a drop * to occur call preventDefault() on the event. * * * @returns Reference to `this` in order to allow method chaining */ attachDragOver( /** * The function to be called when the event occurs */ fnFunction: (p1: Tree$DragOverEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:dragStart dragStart} event of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when a tree item drag is initiated. To prevent a drag from being initiated call preventDefault() * on the event. * * * @returns Reference to `this` in order to allow method chaining */ attachDragStart( /** * 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: Tree$DragStartEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:dragStart dragStart} event of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when a tree item drag is initiated. To prevent a drag from being initiated call preventDefault() * on the event. * * * @returns Reference to `this` in order to allow method chaining */ attachDragStart( /** * The function to be called when the event occurs */ fnFunction: (p1: Tree$DragStartEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:drop drop} event of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when a tree item is dropped on a tree item or an unpopulated row in a tree. A drop cannot occur * unless preventDefault() is called on the sap.ui.base.Event object in the preceding dragOver event. * * * @returns Reference to `this` in order to allow method chaining */ attachDrop( /** * 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: Tree$DropEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:drop drop} event of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when a tree item is dropped on a tree item or an unpopulated row in a tree. A drop cannot occur * unless preventDefault() is called on the sap.ui.base.Event object in the preceding dragOver event. * * * @returns Reference to `this` in order to allow method chaining */ attachDrop( /** * The function to be called when the event occurs */ fnFunction: (p1: Tree$DropEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:expandedChanged expandedChanged} event of this * `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when a tree item entry is expanded or collapsed. * * * @returns Reference to `this` in order to allow method chaining */ attachExpandedChanged( /** * 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: Tree$ExpandedChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:expandedChanged expandedChanged} event of this * `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when a tree item entry is expanded or collapsed. * * * @returns Reference to `this` in order to allow method chaining */ attachExpandedChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: Tree$ExpandedChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:fixedColumnsChanged fixedColumnsChanged} event * of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when the fixed columns are updated. * * * @returns Reference to `this` in order to allow method chaining */ attachFixedColumnsChanged( /** * 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.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:fixedColumnsChanged fixedColumnsChanged} event * of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when the fixed columns are updated. * * * @returns Reference to `this` in order to allow method chaining */ attachFixedColumnsChanged( /** * 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.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:hierarchyChanged hierarchyChanged} event of * this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when the tree hierarchy (the set of parent child relationships) changes. * * * @returns Reference to `this` in order to allow method chaining */ attachHierarchyChanged( /** * 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.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:hierarchyChanged hierarchyChanged} event of * this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when the tree hierarchy (the set of parent child relationships) changes. * * * @returns Reference to `this` in order to allow method chaining */ attachHierarchyChanged( /** * 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.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:messageStatusHeaderIconClicked messageStatusHeaderIconClicked } * event of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when a tree item message status icon is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachMessageStatusHeaderIconClicked( /** * 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.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:messageStatusHeaderIconClicked messageStatusHeaderIconClicked } * event of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when a tree item message status icon is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachMessageStatusHeaderIconClicked( /** * 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.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:messageStatusIconClicked messageStatusIconClicked } * event of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when a tree item message status icon is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachMessageStatusIconClicked( /** * 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: Tree$MessageStatusIconClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:messageStatusIconClicked messageStatusIconClicked } * event of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when a tree item message status icon is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachMessageStatusIconClicked( /** * The function to be called when the event occurs */ fnFunction: (p1: Tree$MessageStatusIconClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:modelUpdated modelUpdated} event of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised after the model has been updated. * * * @returns Reference to `this` in order to allow method chaining */ attachModelUpdated( /** * 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.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:modelUpdated modelUpdated} event of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised after the model has been updated. * * * @returns Reference to `this` in order to allow method chaining */ attachModelUpdated( /** * 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.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of * this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when the set of selected tree items for a tree changes. * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChanged( /** * 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: Tree$SelectionChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of * this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when the set of selected tree items for a tree changes. * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: Tree$SelectionChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:visibilityHeaderIconClicked visibilityHeaderIconClicked } * event of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when the icon in the visibility column header is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachVisibilityHeaderIconClicked( /** * 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: Tree$VisibilityHeaderIconClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:visibilityHeaderIconClicked visibilityHeaderIconClicked } * event of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when the icon in the visibility column header is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachVisibilityHeaderIconClicked( /** * The function to be called when the event occurs */ fnFunction: (p1: Tree$VisibilityHeaderIconClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:visibilityIconClicked visibilityIconClicked } * event of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when an icon in the visibility column is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachVisibilityIconClicked( /** * 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: Tree$VisibilityIconClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:visibilityIconClicked visibilityIconClicked } * event of this `sap.ui.vtm.Tree`. * * 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.vtm.Tree` itself. * * Raised when an icon in the visibility column is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachVisibilityIconClicked( /** * The function to be called when the event occurs */ fnFunction: (p1: Tree$VisibilityIconClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Tree` itself */ oListener?: object ): this; /** * Expands all tree items in the tree. * * * @returns Returns `this` for method chaining. */ collapseAll(): sap.ui.vtm.Tree; /** * Destroys all the headerControls in the aggregation {@link #getHeaderControls headerControls}. * * * @returns Reference to `this` in order to allow method chaining */ destroyHeaderControls(): this; /** * Detaches event handler `fnFunction` from the {@link #event:beforeModelUpdated beforeModelUpdated} event * of this `sap.ui.vtm.Tree`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachBeforeModelUpdated( /** * 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; /** * Detaches event handler `fnFunction` from the {@link #event:dataColumnsChanged dataColumnsChanged} event * of this `sap.ui.vtm.Tree`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachDataColumnsChanged( /** * 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; /** * Detaches event handler `fnFunction` from the {@link #event:dragOver dragOver} event of this `sap.ui.vtm.Tree`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachDragOver( /** * The function to be called, when the event occurs */ fnFunction: (p1: Tree$DragOverEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:dragStart dragStart} event of this `sap.ui.vtm.Tree`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachDragStart( /** * The function to be called, when the event occurs */ fnFunction: (p1: Tree$DragStartEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:drop drop} event of this `sap.ui.vtm.Tree`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachDrop( /** * The function to be called, when the event occurs */ fnFunction: (p1: Tree$DropEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:expandedChanged expandedChanged} event of * this `sap.ui.vtm.Tree`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachExpandedChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: Tree$ExpandedChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:fixedColumnsChanged fixedColumnsChanged} event * of this `sap.ui.vtm.Tree`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachFixedColumnsChanged( /** * 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; /** * Detaches event handler `fnFunction` from the {@link #event:hierarchyChanged hierarchyChanged} event of * this `sap.ui.vtm.Tree`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachHierarchyChanged( /** * 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; /** * Detaches event handler `fnFunction` from the {@link #event:messageStatusHeaderIconClicked messageStatusHeaderIconClicked } * event of this `sap.ui.vtm.Tree`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachMessageStatusHeaderIconClicked( /** * 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; /** * Detaches event handler `fnFunction` from the {@link #event:messageStatusIconClicked messageStatusIconClicked } * event of this `sap.ui.vtm.Tree`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachMessageStatusIconClicked( /** * The function to be called, when the event occurs */ fnFunction: (p1: Tree$MessageStatusIconClickedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:modelUpdated modelUpdated} event of this `sap.ui.vtm.Tree`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachModelUpdated( /** * 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; /** * Detaches event handler `fnFunction` from the {@link #event:selectionChanged selectionChanged} event of * this `sap.ui.vtm.Tree`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelectionChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: Tree$SelectionChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:visibilityHeaderIconClicked visibilityHeaderIconClicked } * event of this `sap.ui.vtm.Tree`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachVisibilityHeaderIconClicked( /** * The function to be called, when the event occurs */ fnFunction: (p1: Tree$VisibilityHeaderIconClickedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:visibilityIconClicked visibilityIconClicked } * event of this `sap.ui.vtm.Tree`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachVisibilityIconClicked( /** * The function to be called, when the event occurs */ fnFunction: (p1: Tree$VisibilityIconClickedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Expands all tree items in the tree. * * * @returns Returns `this` for method chaining. */ expandAll(): sap.ui.vtm.Tree; /** * Expands all ancestors of specified tree item. * * This method relies on {@link #updateCollections} being called after the tree is populated/changed. * * * @returns Returns `this` for method chaining. */ expandAncestors( /** * Tree item. */ treeItem: object ): sap.ui.vtm.Tree; /** * Expands tree items in the tree from the root down to the given level. * * * @returns Returns `this` for method chaining. */ expandToLevel( /** * The tree level to expand to. */ iLevel: int ): sap.ui.vtm.Tree; /** * Fires event {@link #event:beforeModelUpdated beforeModelUpdated} 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 */ fireBeforeModelUpdated( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:dataColumnsChanged dataColumnsChanged} 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 */ fireDataColumnsChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:dragOver dragOver} to attached listeners. * * Listeners may prevent the default action of this event by calling the `preventDefault` method on the * event object. The return value of this method indicates whether the default action should be executed. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Whether or not to prevent the default action */ fireDragOver( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Tree$DragOverEventParameters ): boolean; /** * Fires event {@link #event:dragStart dragStart} to attached listeners. * * Listeners may prevent the default action of this event by calling the `preventDefault` method on the * event object. The return value of this method indicates whether the default action should be executed. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Whether or not to prevent the default action */ fireDragStart( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Tree$DragStartEventParameters ): boolean; /** * Fires event {@link #event:drop drop} 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 */ fireDrop( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Tree$DropEventParameters ): this; /** * Fires event {@link #event:expandedChanged expandedChanged} 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 */ fireExpandedChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Tree$ExpandedChangedEventParameters ): this; /** * Fires event {@link #event:fixedColumnsChanged fixedColumnsChanged} 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 */ fireFixedColumnsChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:hierarchyChanged hierarchyChanged} 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 */ fireHierarchyChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:messageStatusHeaderIconClicked messageStatusHeaderIconClicked} 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 */ fireMessageStatusHeaderIconClicked( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:messageStatusIconClicked messageStatusIconClicked} 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 */ fireMessageStatusIconClicked( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Tree$MessageStatusIconClickedEventParameters ): this; /** * Fires event {@link #event:modelUpdated modelUpdated} 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 */ fireModelUpdated( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:selectionChanged selectionChanged} 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 */ fireSelectionChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Tree$SelectionChangedEventParameters ): this; /** * Fires event {@link #event:visibilityHeaderIconClicked visibilityHeaderIconClicked} 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 */ fireVisibilityHeaderIconClicked( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Tree$VisibilityHeaderIconClickedEventParameters ): this; /** * Fires event {@link #event:visibilityIconClicked visibilityIconClicked} 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 */ fireVisibilityIconClicked( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Tree$VisibilityIconClickedEventParameters ): this; /** * Finds all tree items in the tree of a given type. * * This method relies on {@link #updateCollections} being called after the tree is populated/changed. * * * @returns All the tree items in the tree. */ getAllItems( /** * Indicates the types of tree item to match. Defaults to {@link sap.ui.vtm.TreeItemType.Included}. */ treeItemType: sap.ui.vtm.TreeItemType ): object[]; /** * Finds all ancestors of a tree item. * * An empty array will be returned for root items. * Otherwise an array of ancestor tree items will be returned. * The array will be ordered such that: * - The root item will be first element in the array. * - The parent item will be last element in the array. * * This method relies on {@link #updateCollections} being called after the tree is populated/changed. * * * @returns The ancestors of the tree item. */ getAncestorItems( /** * The tree item or id of the tree item to get the ancestors of. */ treeItem: object | string ): object[]; /** * Gets the set of data columns for the tree. * * * @returns The data columns for the tree. */ getDataColumns(): sap.ui.vtm.Column[]; /** * Gets the descendants of a tree item. * * This method relies on {@link #updateCollections} being called after the tree is populated/changed. * * * @returns The descendants of the tree item or undefined if the tree item is not found. */ getDescendantItems( /** * The tree item or id of the tree item to get the descendants of. */ treeItem: object | string, /** * Indicates the types of tree item to match. Defaults to {@link sap.ui.vtm.TreeItemType.Included}. */ treeItemType: sap.ui.vtm.TreeItemType ): object[] | undefined; /** * Gets whether the row associated with a tree item is expanded. * * This method relies on {@link #updateCollections} being called after the tree is populated/changed. * * * @returns Whether the row associated with the specified tree item is expanded. */ getExpanded( /** * The tree item. */ oTreeItem: object ): boolean; /** * Gets the fixed columns for the tree. * * * @returns The fixed columns. */ getFixedColumns(): sap.ui.vtm.Column[]; /** * Gets content of aggregation {@link #getHeaderControls headerControls}. * * A set of controls such as toolbars to show above the tree. */ getHeaderControls(): sap.ui.core.Control[]; /** * Gets the `highlightColor` property of a tree item or array of tree items. * * If a single tree item is passed to the method then a single value is returned. * If an array of tree items is passed to the method then an array is returned. * * * @returns A single value or an array of values representing the highlight color values of the tree item(s) * passed in. */ getHighlightColor( /** * The tree item or the array of tree items. */ treeItems: object | object[] ): string | string[]; /** * Finds a tree item by id or returns undefined if it is not found. * This method relies on {@link #updateCollections} being called after the tree is populated/changed. * * * @returns The tree item matching the specified id or undefined if no match was found. */ getItem( /** * The tree item id to look for. */ treeItemId: string ): object | undefined; /** * Finds a tree item by binding context path or returns undefined if it is not found. This is typically * used to find the corresponding tree item in event handlers for custom column template controls. * * * @returns The tree item matching the specified binding context path or undefined if no match was found. */ getItemByBindingContextPath( /** * The binding context path to look for. */ bindingContextPath: string ): object | undefined; /** * Finds the set of tree items that are associated with a particular scene node id. * * This method relies on {@link #updateCollections} being called after the tree is populated/changed. * * * @returns The set of tree items that have a `sceneNodeIds` property that contains the specified scene * node id. */ getItemsBySceneNodeId( /** * The scene node ID or IDs to find. */ sceneNodeIds: string | string[], /** * Indicates the types of tree item to match. Defaults to {@link sap.ui.vtm.TreeItemType.Included}. */ treeItemType: sap.ui.vtm.TreeItemType ): object[]; /** * Gets the `opacity` property of a tree item or array of tree items. * * If a single tree item is passed to the method then a single value is returned. * If an array of tree items is passed to the method then an array is returned. * * * @returns A single value or an array of values representing the opacity values of the tree item(s) passed * in. */ getOpacity( /** * The tree item or the array of tree items. */ treeItems: object | object[] ): float | float[]; /** * Gets the panel this tree belongs to. * * * @returns The panel this tree belongs to. */ getPanel(): sap.ui.vtm.Panel; /** * Finds a parent tree item or returns undefined if it is not found. * * This method relies on {@link #updateCollections} being called after the tree is populated/changed. * * * @returns The parent tree item or undefined if no match was found. */ getParentItem( /** * The child tree item or child tree item id. */ treeItem: object | string ): object | undefined; /** * Gets the root tree items. * * * @returns The root tree items. */ getRootItems(): object[]; /** * Gets the selected tree items. * * * @returns The selected tree items. */ getSelectedItems(): object[]; /** * Gets current value of property {@link #getSelectionMode selectionMode}. * * The tree selection mode. * * Default value is `"Single"`. * * * @returns Value of property `selectionMode` */ getSelectionMode(): sap.ui.vtm.SelectionMode; /** * Gets the `visibility` property of a tree item or array of tree items. * * If a single tree item is passed to the method then a single value is returned. * If an array of tree items is passed to the method then an array is returned. * * * @returns A single value or an array of values where the value is `true` if the tree item is visible, * `false` otherwise. */ getVisibility( /** * The tree item or the array of tree items. */ treeItems: object | object[] ): boolean | boolean[]; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getHeaderControls headerControls}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfHeaderControl( /** * The headerControl whose index is looked for */ oHeaderControl: sap.ui.core.Control ): int; /** * Inserts a headerControl into the aggregation {@link #getHeaderControls headerControls}. * * * @returns Reference to `this` in order to allow method chaining */ insertHeaderControl( /** * The headerControl to insert; if empty, nothing is inserted */ oHeaderControl: sap.ui.core.Control, /** * The `0`-based index the headerControl should be inserted at; for a negative value of `iIndex`, the headerControl * is inserted at position 0; for a value greater than the current size of the aggregation, the headerControl * is inserted at the last position */ iIndex: int ): this; /** * Returns whether the tree is empty. * * * @returns Whether the tree is empty. */ isEmpty(): boolean; /** * Returns whether a tree item object is an excluded tree item in the tree model of this {@link sap.ui.vtm.Tree}. * * This method relies on {@link #updateCollections} being called after the tree is populated/changed. * * * @returns Whether a tree item object is an included tree item in this tree. */ isExcludedItem( /** * The tree item or tree item id to check. */ treeItem: object | string ): boolean; /** * Returns whether a tree item object is an included tree item in the tree model of this {@link sap.ui.vtm.Tree}. * * This method relies on {@link #updateCollections} being called after the tree is populated/changed. * * * @returns Whether a tree item object is an included tree item in this tree. */ isIncludedItem( /** * The tree item or tree item id to check. */ treeItem: object | string ): boolean; /** * Removes all the controls from the aggregation {@link #getHeaderControls headerControls}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllHeaderControls(): sap.ui.core.Control[]; /** * Removes a headerControl from the aggregation {@link #getHeaderControls headerControls}. * * * @returns The removed headerControl or `null` */ removeHeaderControl( /** * The headerControl to remove or its index or id */ vHeaderControl: int | string | sap.ui.core.Control ): sap.ui.core.Control | null; /** * Removes a root item from the tree. * * * @returns Returns the deleted item or undefined if no item was removed. */ removeRoot( /** * The root tree item to remove (or its id). */ rootItemToRemove: string | object ): object | undefined; /** * Brings specified tree item to view, expanding the tree if necessary. * * This method relies on {@link #updateCollections} being called after the tree is populated/changed. * * * @returns Returns `this` for method chaining. */ scrollIntoView( /** * The tree item to scroll into view. */ treeItem: object ): sap.ui.vtm.Tree; /** * Sets the data columns for the tree. * * * @returns Returns `this` for method chaining. */ setDataColumns( /** * The data columns for the tree. */ dataColumns: sap.ui.vtm.Column[] ): sap.ui.vtm.Tree; /** * Expands or collapses the row associated with a tree item. * * This method relies on {@link #updateCollections} being called after the tree is populated/changed. * * * @returns A reference to `this` for method chaining. */ setExpanded( /** * The tree item. */ oTreeItem: object, /** * If `true` the row will be expanded otherwise it will be collapsed. */ bExpanded: boolean ): sap.ui.vtm.Tree; /** * Sets the fixed columns for the tree. * * * @returns Returns `this` for method chaining. */ setFixedColumns( /** * The fixed columns. */ fixedColumns: sap.ui.vtm.Column[] ): sap.ui.vtm.Tree; /** * Sets the `highlightColor` property of some tree items. * * * @returns `this` to allow method chaining. */ setHighlightColor( /** * The tree item or the array of tree items. */ treeItems: object | object[], /** * The new highlight color value of the tree items. */ highlightColor: sap.ui.core.CSSColor, /** * If `true` changes are applied recursively to included and excluded descendant tree items. Default value * is `true`. */ recursive: boolean, /** * If `true` changes are only made to tree items that have a defined `visibility` property value. Default * value is `true`. */ visualOnly: boolean, /** * If `true, {@link #updateModel} is called to refresh the tree (so the check eye icons are updated) * and {@link sap.ui.vtm.Viewport#refresh} is called on the corresponding {@link sap.ui.vtm.Viewport} to * recalculate the display state. Default value is true`. */ refresh: boolean ): sap.ui.vtm.Tree; /** * Sets the `opacity` property of some tree items. * * * @returns `this` to allow method chaining. */ setOpacity( /** * The tree item or the array of tree items. */ treeItems: object | object[], /** * The new opacity value of the tree items (between 0.0 and 1.0 inclusive). */ opacity: float, /** * If `true` changes are applied recursively to included and excluded descendant tree items. Default value * is `true`. */ recursive: boolean, /** * If `true` changes are only made to tree items that have a defined `visibility` property value. Default * value is `true`. */ visualOnly: boolean, /** * If `true, {@link #updateModel} is called to refresh the tree (so the check eye icons are updated) * and {@link sap.ui.vtm.Viewport#refresh} is called on the corresponding {@link sap.ui.vtm.Viewport} to * recalculate the display state. Default value is true`. */ refresh: boolean ): sap.ui.vtm.Tree; /** * Sets the root tree items. * * * @returns Returns `this` for method chaining. */ setRootItems( /** * The root tree items. */ rootItems: object[] ): sap.ui.vtm.Tree; /** * Sets the selected tree items. * * This method relies on {@link #updateCollections} being called after the tree is populated/changed. * * * @returns Returns `this` for method chaining. */ setSelectedItems( /** * Tree item(s) to select in the tree. */ items: object | object[], /** * When set brings selected item into view. Default value is to true. */ scrollToView: boolean ): sap.ui.vtm.Tree; /** * Sets a new value for property {@link #getSelectionMode selectionMode}. * * The tree selection mode. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"Single"`. * * * @returns Reference to `this` in order to allow method chaining */ setSelectionMode( /** * New value for property `selectionMode` */ sSelectionMode?: sap.ui.vtm.SelectionMode ): this; /** * Sets the `visibility` property of some tree items. * * * @returns `this` to allow method chaining. */ setVisibility( /** * The tree item or the array of tree items. */ treeItems: object | object[], /** * The new visibility state of the tree items. */ visibility: boolean, /** * If `true` changes are applied recursively to included and excluded descendant tree items. Default value * is `true`. */ recursive: boolean, /** * If `true` changes are only made to tree items that have a defined `visibility` property value. Default * value is `true`. */ visualOnly: boolean, /** * If `true, {@link #updateModel} is called to refresh the tree (so the check eye icons are updated) * and {@link sap.ui.vtm.Viewport#refresh} is called on the corresponding {@link sap.ui.vtm.Viewport} to * recalculate the display state. Default value is true`. */ refresh: boolean ): sap.ui.vtm.Tree; /** * Recursively traverses a tree branch calling a function on each item (including the tree item that is * the root of the branch). * * * @returns `this` to allow method chaining. */ traverseBranch( /** * The root of the branch to apply the function to. */ treeItem: object, /** * The function to apply to tree items in the branch. * The first parameter to the callback function is the current tree item object (at the current point of * the traversal. * The second parameter to the callback function is the set of ancestors of the current tree item in the * traversal. * The function may return a {@link sap.ui.vtm.ChildCollectionType} value to specify which immediate children * of the tree item to traverse. * If no such value is returned a default of {@link sap.ui.vtm.ChildCollectionType.Included} is used. */ callback: Function ): sap.ui.vtm.Tree; /** * Recursively traverses the tree calling a function on each item. * * * @returns `this` to allow method chaining. */ traverseTree( /** * The function to apply to tree items in the tree. * The first parameter to the callback function is the current tree item object (at the current point of * the traversal. * The second parameter to the callback function is the set of ancestors of the current tree item. * The function may return a {@link sap.ui.vtm.ChildCollectionType} value to specify which immediate children * to traverse. If no such value is returned a default of {@link sap.ui.vtm.ChildCollectionType.Included } * is used. */ callback: Function ): sap.ui.vtm.Tree; /** * Updates collections used to find tree items by various criteria. * This method should be called whenever the tree has been populated, when the tree structure has changed * or when any of the following fields have been modified for a tree item in the tree: * - id * - sceneNodeIds ***** * - includedChildren * - excludedChildren * Correct usage of this method is required by the following methods: * - {@link #getItem} * - {@link #getParentItem} * - {@link #getDescendantItems} * - {@link #getAncestorItems} * - {@link #getItemsBySceneNodeId} ***** * - {@link #setExpanded} * - {@link #getExpanded} * - {@link #expandAncestors} * - {@link #scrollIntoView} * - {@link #setSelectedItems} * - {@link #isIncludedItem} * - {@link #isExcludedItem} * - {@link #traverseBranch} * ***** When the only changes to the tree since the last call to {@link #updateCollections} are changes * to the sceneNodeIds properties of the tree items, {@link #updateTreeItemsBySceneNodeId} can * be used instead of {@link #updateCollections}. * * * @returns Returns `this` for method chaining. */ updateCollections( /** * When true a `hierarchyChanged` event will be raised if the hierarchy has changed since the last time * this method was called. This method is called when the tree is empty as part of the {@link sap.ui.vtm.Tree } * constructor, so the first time it is called from application code a `hierarchyChanged` event will be * raised if the tree has been populated. The default value for the parameter is `true`. */ checkForHierarchyChanges: boolean ): sap.ui.vtm.Tree; /** * Updates the model. * * The application should call this whenever changes are made to the tree model. * * * @returns Returns `this` for method chaining. */ updateModel( /** * If `true`, the tree control model and bindings are recreated. If `false` and the model and bindings already * exist, this call only results in the bindings being refreshed. Rebuilding the model and bindings is much * more expensive than refreshing the bindings, so only use a value of `true` for this parameter when a * value of `false` does not result in the the tree being updated correctly. */ forceRecreate: boolean ): sap.ui.vtm.Tree; /** * Update the collection used by {@link #getItemsBySceneNodeId}. * * This is useful when the only changes to the tree since the last call to {@link #updateCollections} are * changes to the sceneNodeIds properties of the tree items. * * * @returns Returns `this` for method chaining. */ updateTreeItemsBySceneNodeId(): sap.ui.vtm.Tree; /** * Validates the tree. If errors are found they are written to the console log and an exception is thrown. * * * @returns `this` for method chaining. */ validateTree(): sap.ui.vtm.Tree; } /** * A viewable containing 3D content that can be loaded into a {@link sap.ui.vtm.Scene}. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class Viewable extends sap.ui.core.Element { /** * Constructor for a new Viewable. * * 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( /** * An optional ID for the {@link sap.ui.vtm.Viewable}. */ sId: string, /** * An optional object with initial settings for the new {@link sap.ui.vtm.Viewable} instance */ mSettings?: sap.ui.vtm.$ViewableSettings ); /** * Creates a new subclass of class sap.ui.vtm.Viewable 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.vtm.Viewable. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getName name}. * * The name for this Viewable. * * * @returns Value of property `name` */ getName(): string; /** * Gets current value of property {@link #getRelativeMatrix relativeMatrix}. * * The relative transformation matrix to apply to the scene node created to wrap the contents of the loaded * viewable. * * * @returns Value of property `relativeMatrix` */ getRelativeMatrix(): sap.ui.vtm.Matrix; /** * Gets current value of property {@link #getRootNodeIds rootNodeIds}. * * The root scene node IDs for this viewable. * * * @returns Value of property `rootNodeIds` */ getRootNodeIds(): string[]; /** * Gets current value of property {@link #getSource source}. * * The source URL (string) or File for this Viewable. * * * @returns Value of property `source` */ getSource(): any; /** * Gets the unique ID that identifies this Viewable. This is an alias for {@link #getId} * * * @returns The unique ID that identifies this Viewable. */ getSourceId(): string; /** * Returns a string representation of the source. If the source is a {@link File} this returns the file * name (which is not guaranteed to uniquely identify the file). * * * @returns A string representation of the source. */ getSourceString(): string; /** * Sets the name for this Viewable. * * * @returns `this` for method chaining. */ setName( /** * The name for this Viewable. */ name: string ): sap.ui.vtm.Viewable; /** * Sets a new value for property {@link #getRelativeMatrix relativeMatrix}. * * The relative transformation matrix to apply to the scene node created to wrap the contents of the loaded * viewable. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setRelativeMatrix( /** * New value for property `relativeMatrix` */ sRelativeMatrix: sap.ui.vtm.Matrix ): this; /** * Sets a new value for property {@link #getRootNodeIds rootNodeIds}. * * The root scene node IDs for this viewable. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setRootNodeIds( /** * New value for property `rootNodeIds` */ sRootNodeIds: string[] ): this; /** * Sets the source URL or File for this Viewable. * * * @returns `this` for method chaining. */ setSource( /** * The source URL of File for this Viewable. */ source: string | File ): sap.ui.vtm.Viewable; } /** * Contains information about the result of an attempt to download/load a viewable. * * The {@link sap.ui.vtm.Scene.downloadCompleted} and {@link sap.ui.vtm.Scene.loadCompleted} events have * a `results` parameter that is passed an array of {@link sap.ui.vtm.ViewableLoadInfo} objects. {@link sap.ui.vtm.Scene#getViewableLoadInfos } * also returns a array of {@link sap.ui.vtm.ViewableLoadInfo} objects for all viewables that have been * passed into calls to {@link sap.ui.vtm.Scene#loadViewablesAsync}. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class ViewableLoadInfo extends sap.ui.core.Element { /** * This class is not intended to be instantiated directly by application code. * * 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(); /** * Creates a new subclass of class sap.ui.vtm.ViewableLoadInfo 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.vtm.ViewableLoadInfo. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getErrorCode errorCode}. * * The error code describing why the Viewable failed to load. * * Use when {@link #getSucceeded} returns false. * * * @returns Value of property `errorCode` */ getErrorCode(): string; /** * Gets current value of property {@link #getErrorText errorText}. * * The error text describing why the Viewable failed to load. This is an untranslated technical message. * Use when {@link #getSucceeded} returns false. * * * @returns Value of property `errorText` */ getErrorText(): string; /** * Gets current value of property {@link #getStatus status}. * * The download/load status of the {@link sap.ui.vtm.Viewable} this {@link sap.ui.vtm.ViewableLoadInfo } * relates to. * * * @returns Value of property `status` */ getStatus(): sap.ui.vtm.ViewableLoadStatus; /** * Gets current value of property {@link #getViewable viewable}. * * The {@link sap.ui.vtm.Viewable} this {@link sap.ui.vtm.ViewableLoadInfo} relates to. * * * @returns Value of property `viewable` */ getViewable(): object; /** * Sets a new value for property {@link #getErrorCode errorCode}. * * The error code describing why the Viewable failed to load. * * Use when {@link #getSucceeded} returns false. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setErrorCode( /** * New value for property `errorCode` */ sErrorCode: string ): this; /** * Sets a new value for property {@link #getErrorText errorText}. * * The error text describing why the Viewable failed to load. This is an untranslated technical message. * Use when {@link #getSucceeded} returns false. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setErrorText( /** * New value for property `errorText` */ sErrorText: string ): this; /** * Sets a new value for property {@link #getStatus status}. * * The download/load status of the {@link sap.ui.vtm.Viewable} this {@link sap.ui.vtm.ViewableLoadInfo } * relates to. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setStatus( /** * New value for property `status` */ sStatus: sap.ui.vtm.ViewableLoadStatus ): this; /** * Sets a new value for property {@link #getViewable viewable}. * * The {@link sap.ui.vtm.Viewable} this {@link sap.ui.vtm.ViewableLoadInfo} relates to. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setViewable( /** * New value for property `viewable` */ oViewable: object ): this; } /** * A control that contains a 3D viewport. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class Viewport extends sap.ui.core.Control { /** * This class is not intended to be instantiated directly by application code. A {@link sap.ui.vtm.Viewport } * object is created when a {@link sap.ui.vtm.Panel} object is instantiated. * * 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(); /** * Creates a new subclass of class sap.ui.vtm.Viewport 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.vtm.Viewport. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds an override display group to the `overrideDisplayGroups` property. * * * @returns `this` for method chaining. */ addContextDisplayGroup( /** * The context display group to add to the `contextDisplayGroups` property. */ contextDisplayGroup: sap.ui.vtm.DisplayGroup ): sap.ui.vtm.Viewport; /** * Adds some headerControl into the association {@link #getHeaderControls headerControls}. * * * @returns Reference to `this` in order to allow method chaining */ addHeaderControl( /** * The headerControls to add; if empty, nothing is inserted */ vHeaderControl: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Adds an override display group to the `overrideDisplayGroups` property. * * * @returns `this` for method chaining. */ addOverrideDisplayGroup( /** * The override display group to add to the `overrideDisplayGroups` property. */ overrideDisplayGroup: sap.ui.vtm.DisplayGroup ): sap.ui.vtm.Viewport; /** * Attaches event handler `fnFunction` to the {@link #event:beginGesture beginGesture} event of this `sap.ui.vtm.Viewport`. * * 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.vtm.Viewport` itself. * * Raised when a gesture begins. * * * @returns Reference to `this` in order to allow method chaining */ attachBeginGesture( /** * 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.vtm.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beginGesture beginGesture} event of this `sap.ui.vtm.Viewport`. * * 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.vtm.Viewport` itself. * * Raised when a gesture begins. * * * @returns Reference to `this` in order to allow method chaining */ attachBeginGesture( /** * 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.vtm.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:endGesture endGesture} event of this `sap.ui.vtm.Viewport`. * * 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.vtm.Viewport` itself. * * Raised when a gesture ends. * * * @returns Reference to `this` in order to allow method chaining */ attachEndGesture( /** * 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.vtm.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:endGesture endGesture} event of this `sap.ui.vtm.Viewport`. * * 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.vtm.Viewport` itself. * * Raised when a gesture ends. * * * @returns Reference to `this` in order to allow method chaining */ attachEndGesture( /** * 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.vtm.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:hover hover} event of this `sap.ui.vtm.Viewport`. * * 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.vtm.Viewport` itself. * * Raised on mouse move over viewport. * * * @returns Reference to `this` in order to allow method chaining */ attachHover( /** * 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: Viewport$HoverEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:hover hover} event of this `sap.ui.vtm.Viewport`. * * 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.vtm.Viewport` itself. * * Raised on mouse move over viewport. * * * @returns Reference to `this` in order to allow method chaining */ attachHover( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewport$HoverEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeClicked nodeClicked} event of this `sap.ui.vtm.Viewport`. * * 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.vtm.Viewport` itself. * * Raised when a node in the viewport is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeClicked( /** * 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.vtm.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeClicked nodeClicked} event of this `sap.ui.vtm.Viewport`. * * 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.vtm.Viewport` itself. * * Raised when a node in the viewport is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeClicked( /** * 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.vtm.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:refreshRequested refreshRequested} event of * this `sap.ui.vtm.Viewport`. * * 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.vtm.Viewport` itself. * * Raised when {@link sap.ui.vk.dvl.Viewport#refresh refresh} is called. This event can be used by code * that is managing the viewport display state. * * * @returns Reference to `this` in order to allow method chaining */ attachRefreshRequested( /** * 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.vtm.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:refreshRequested refreshRequested} event of * this `sap.ui.vtm.Viewport`. * * 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.vtm.Viewport` itself. * * Raised when {@link sap.ui.vk.dvl.Viewport#refresh refresh} is called. This event can be used by code * that is managing the viewport display state. * * * @returns Reference to `this` in order to allow method chaining */ attachRefreshRequested( /** * 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.vtm.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of * this `sap.ui.vtm.Viewport`. * * 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.vtm.Viewport` itself. * * Raised when the selection is changed due to a click in the viewport (either on a node or in empty space). * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChanged( /** * 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: Viewport$SelectionChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of * this `sap.ui.vtm.Viewport`. * * 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.vtm.Viewport` itself. * * Raised when the selection is changed due to a click in the viewport (either on a node or in empty space). * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewport$SelectionChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:viewChanged viewChanged} event of this `sap.ui.vtm.Viewport`. * * 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.vtm.Viewport` itself. * * Raised when viewport's camera view changed. * * * @returns Reference to `this` in order to allow method chaining */ attachViewChanged( /** * 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: Viewport$ViewChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:viewChanged viewChanged} event of this `sap.ui.vtm.Viewport`. * * 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.vtm.Viewport` itself. * * Raised when viewport's camera view changed. * * * @returns Reference to `this` in order to allow method chaining */ attachViewChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewport$ViewChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:visibilityChanged visibilityChanged} event of * this `sap.ui.vtm.Viewport`. * * 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.vtm.Viewport` itself. * * Raised when the visibility of scene nodes changed in the viewport. * * * @returns Reference to `this` in order to allow method chaining */ attachVisibilityChanged( /** * 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: Viewport$VisibilityChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:visibilityChanged visibilityChanged} event of * this `sap.ui.vtm.Viewport`. * * 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.vtm.Viewport` itself. * * Raised when the visibility of scene nodes changed in the viewport. * * * @returns Reference to `this` in order to allow method chaining */ attachVisibilityChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewport$VisibilityChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Viewport` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:beginGesture beginGesture} event of this `sap.ui.vtm.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachBeginGesture( /** * 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; /** * Detaches event handler `fnFunction` from the {@link #event:endGesture endGesture} event of this `sap.ui.vtm.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachEndGesture( /** * 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; /** * Detaches event handler `fnFunction` from the {@link #event:hover hover} event of this `sap.ui.vtm.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachHover( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewport$HoverEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:nodeClicked nodeClicked} event of this `sap.ui.vtm.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachNodeClicked( /** * 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; /** * Detaches event handler `fnFunction` from the {@link #event:refreshRequested refreshRequested} event of * this `sap.ui.vtm.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachRefreshRequested( /** * 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; /** * Detaches event handler `fnFunction` from the {@link #event:selectionChanged selectionChanged} event of * this `sap.ui.vtm.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelectionChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewport$SelectionChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:viewChanged viewChanged} event of this `sap.ui.vtm.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachViewChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewport$ViewChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:visibilityChanged visibilityChanged} event * of this `sap.ui.vtm.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachVisibilityChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewport$VisibilityChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:beginGesture beginGesture} 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 */ fireBeginGesture( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:endGesture endGesture} 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 */ fireEndGesture( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:hover hover} 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 */ fireHover( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Viewport$HoverEventParameters ): this; /** * Fires event {@link #event:nodeClicked nodeClicked} 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 */ fireNodeClicked( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:refreshRequested refreshRequested} 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 */ fireRefreshRequested( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:selectionChanged selectionChanged} 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 */ fireSelectionChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Viewport$SelectionChangedEventParameters ): this; /** * Fires event {@link #event:viewChanged viewChanged} 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 */ fireViewChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Viewport$ViewChangedEventParameters ): this; /** * Fires event {@link #event:visibilityChanged visibilityChanged} 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 */ fireVisibilityChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Viewport$VisibilityChangedEventParameters ): this; /** * Gets current value of property {@link #getBackgroundGradientBottomColor backgroundGradientBottomColor}. * * The background gradient bottom color * * Default value is `"white"`. * * * @returns Value of property `backgroundGradientBottomColor` */ getBackgroundGradientBottomColor(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getBackgroundGradientTopColor backgroundGradientTopColor}. * * The background gradient top color. * * Default value is `"black"`. * * * @returns Value of property `backgroundGradientTopColor` */ getBackgroundGradientTopColor(): sap.ui.core.CSSColor; /** * Retrieves an object containing the current camera information for this viewport. * * This value can then be passed to {@link sap.ui.vtm.Viewport#setCameraInfo setCameraInfo} to restore the * camera position at a later point in time. * * * @returns An object containing the current camera information for this viewport. */ getCameraInfo(): object; /** * Gets current value of property {@link #getContextDisplayGroups contextDisplayGroups}. * * Allows the calculated display state for scene nodes whose display state is not determined by tree item * associations or override display groups to be specified. * * A set of {@link sap.ui.vtm.DisplayGroup} objects objects that describe display states to apply to scene * nodes. Precedence is inherent in the array ordering. Call {@link #refresh} to recalculate the display * state in the viewport after modifying override display groups. * * Default value is `[]`. * * * @returns Value of property `contextDisplayGroups` */ getContextDisplayGroups(): object[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getHeaderControls headerControls}. */ getHeaderControls(): sap.ui.core.ID[]; /** * Gets the highlight colors for a set of scene nodes in this viewport. * * * @returns The highlight colors for the relevant scene nodes. The */ getHighlightColor( /** * A scene node ID or an array of scene node IDs. */ sceneNodeIds: string | string[] ): sap.ui.core.CSSColor | sap.ui.core.CSSColor[]; /** * Returns whether the {@link sap.ui.vtm.Viewport} has been initialized. * * * @returns Whether the {@link sap.ui.vtm.Viewport} has been initialized. */ getInitialized(): boolean; /** * Gets the opacity for a set of scene nodes in this viewport. Opacity is specified as a floating point * value in the interval [0,1]. * * * @returns The opacity states for the relevant scene nodes. */ getOpacity( /** * A scene node ID or an array of scene node IDs. */ sceneNodeIds: string | string[] ): number | number[]; /** * Gets current value of property {@link #getOverrideDisplayGroups overrideDisplayGroups}. * * Allows the calculated display state of scene nodes in the viewport o be overridden. * * A set of {@link sap.ui.vtm.DisplayGroup} objects that each specify the display state for a set of scene * nodes. Precedence is inherent in the array ordering. Any display state specified in this way takes precedence * over display states specified for geometry associated with tree items or specified using {@link #contextGroups}. * Call {@link #refresh} to recalculate the display state in the viewport after modifying override display * groups. * * Default value is `[]`. * * * @returns Value of property `overrideDisplayGroups` */ getOverrideDisplayGroups(): object[]; /** * Gets the panel this viewport belongs to. * * * @returns The panel this viewport belongs to. */ getPanel(): sap.ui.vtm.Panel; /** * Gets the {@link sap.ui.vtm.Scene} used by this {@link sap.ui.vtm.Viewport}. * * * @returns The sap.ui.vtm.Scene used by this Viewport. */ getScene(): sap.ui.vtm.Scene; /** * Gets the selection state for a set of scene nodes in this viewport. * * * @returns The selection states for the relevant scene nodes. */ getSelected( /** * A scene node ID or an array of scene node IDs. */ sceneNodeIds: string | string[] ): boolean | boolean[]; /** * Gets the IDs of the scene nodes that are selected in this viewport. * * * @returns The IDs of the scene nodes that are selected in this viewport. */ getSelectedIds(): string[]; /** * Gets the visibility state for a set of scene nodes in this viewport. * * * @returns The visibility states for the relevant scene nodes. */ getVisibility( /** * A scene node ID or an array of scene node IDs. */ sceneNodeIds: string | string[] ): boolean | boolean[]; /** * Fires a `refreshRequested` event. * * * @returns `this` for method chaining. */ refresh(): sap.ui.vtm.Viewport; /** * Removes all the controls in the association named {@link #getHeaderControls headerControls}. * * * @returns An array of the removed elements (might be empty) */ removeAllHeaderControls(): sap.ui.core.ID[]; /** * Removes an headerControl from the association named {@link #getHeaderControls headerControls}. * * * @returns The removed headerControl or `null` */ removeHeaderControl( /** * The headerControl to be removed or its index or ID */ vHeaderControl: int | sap.ui.core.ID | sap.ui.core.Control ): sap.ui.core.ID | null; /** * Sets a new value for property {@link #getBackgroundGradientBottomColor backgroundGradientBottomColor}. * * The background gradient bottom color * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"white"`. * * * @returns Reference to `this` in order to allow method chaining */ setBackgroundGradientBottomColor( /** * New value for property `backgroundGradientBottomColor` */ sBackgroundGradientBottomColor?: sap.ui.core.CSSColor ): this; /** * Sets a new value for property {@link #getBackgroundGradientTopColor backgroundGradientTopColor}. * * The background gradient top color. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"black"`. * * * @returns Reference to `this` in order to allow method chaining */ setBackgroundGradientTopColor( /** * New value for property `backgroundGradientTopColor` */ sBackgroundGradientTopColor?: sap.ui.core.CSSColor ): this; /** * Updates the camera for this viewport. * * * @returns A reference to `this` to allow method chaining. */ setCameraInfo( /** * An object containing camera information returned by {@link sap.ui.vtm.Viewport#getCameraInfo getCameraInfo}. */ cameraInfo: object, /** * A duration in seconds for the transition to the new camera position. Defaults to 0. */ flyToDuration: float ): sap.ui.vtm.Viewport; /** * Sets a new value for property {@link #getContextDisplayGroups contextDisplayGroups}. * * Allows the calculated display state for scene nodes whose display state is not determined by tree item * associations or override display groups to be specified. * * A set of {@link sap.ui.vtm.DisplayGroup} objects objects that describe display states to apply to scene * nodes. Precedence is inherent in the array ordering. Call {@link #refresh} to recalculate the display * state in the viewport after modifying override display groups. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `[]`. * * * @returns Reference to `this` in order to allow method chaining */ setContextDisplayGroups( /** * New value for property `contextDisplayGroups` */ sContextDisplayGroups?: object[] ): this; /** * Sets the highlight color for a set of scene nodes in this viewport. * * This method should not be called by application code when an extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension } * is being used. In that case the extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension } * should perform all management of scene node visibility in the viewports. * * * @returns `this` for method chaining. */ setHighlightColor( /** * A scene node ID or an array of scene node IDs. */ sceneNodeIds: string | string[], /** * The highlight color to apply to the relevant scene nodes. If null, the highlight color is removed. * The alpha component of the color controls the blending ratio between the highlight color and the geometry * color. */ color: sap.ui.core.CSSColor | null, /** * If true the specified highlight color will be applied to the descendants of the specified scene nodes. */ recursive: boolean ): sap.ui.vtm.Viewport; /** * Sets the opacity for a set of scene nodes in this viewport. Opacity is specified as a floating point * value in the interval [0,1]. * * This method should not be called by application code when an extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension } * is being used. In that case the extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension } * should perform all management of scene node visibility in the viewports. * * * @returns `this` for method chaining. */ setOpacity( /** * A scene node ID or an array of scene node IDs. */ sceneNodeIds: string | string[], /** * The opacity state to apply to the relevant scene nodes. */ opacity: number, /** * If true the specified opacity state will be applied to the descendants of the specified scene nodes. */ recursive: boolean ): sap.ui.vtm.Viewport; /** * Sets a new value for property {@link #getOverrideDisplayGroups overrideDisplayGroups}. * * Allows the calculated display state of scene nodes in the viewport o be overridden. * * A set of {@link sap.ui.vtm.DisplayGroup} objects that each specify the display state for a set of scene * nodes. Precedence is inherent in the array ordering. Any display state specified in this way takes precedence * over display states specified for geometry associated with tree items or specified using {@link #contextGroups}. * Call {@link #refresh} to recalculate the display state in the viewport after modifying override display * groups. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `[]`. * * * @returns Reference to `this` in order to allow method chaining */ setOverrideDisplayGroups( /** * New value for property `overrideDisplayGroups` */ sOverrideDisplayGroups?: object[] ): this; /** * Sets the view in the current viewport to one of the predefined views. * * * @returns `this` for method chaining. */ setPredefinedView( /** * The predefined view to apply. */ view: sap.ui.vtm.PredefinedView ): sap.ui.vtm.Viewport; /** * Sets the selection state for a set of scene nodes in this viewport. * * This method should not be called by application code when an extension implementing {@link sap.ui.vtm.interfaces.IViewportSelectionLinkingExtension } * is being used. In that case the extension implementing {@link sap.ui.vtm.interfaces.IViewportSelectionLinkingExtension } * should perform all management of scene node selection in the viewports. * * * @returns `this` for method chaining. */ setSelected( /** * A scene node ID or an array of scene node IDs. */ sceneNodeIds: string | string[], /** * The new selection state of the nodes. */ selected: boolean, /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean ): sap.ui.vtm.Viewport; /** * Sets the visibility state for a set of scene nodes in this viewport. * * This method should not be called by application code when an extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension } * is being used. In that case the extension implementing {@link sap.ui.vtm.interfaces.IDisplayStateCalculationExtension } * should perform all management of scene node visibility in the viewports. * * * @returns `this` for method chaining. */ setVisibility( /** * A scene node ID or an array of scene node IDs. */ sceneNodeIds: string | string[], /** * The visibility state to apply to the relevant scene nodes. */ visibility: boolean, /** * If true the specified visibility state will be applied to the descendants of the specified scene nodes. */ recursive: boolean ): sap.ui.vtm.Viewport; /** * Zooms to a view in the current viewport that can fit all geometry in the scene (visible or not). * * * @returns Returns `this` for method chaining. */ zoomToAll( /** * The duration of the zoom animation in seconds. */ durationInSeconds: number ): sap.ui.vtm.Viewport; /** * Calls {@link sap.ui.vtm.Viewport#zoomToSelected zoomToSelected} if any geometry is selected in this viewport, * otherwise calls {@link sap.ui.vtm.Viewport#zoomToAll zoomToAll}. * * * @returns Returns `this` for method chaining. */ zoomToFit( /** * The duration of the zoom animation in seconds. */ durationInSeconds: number ): sap.ui.vtm.Viewport; /** * Zooms to the set of geometry that is selected in the current viewport. If no geometry is selected, no * action is taken. * * * @returns Returns `this` for method chaining. */ zoomToSelected( /** * The duration of the zoom animation in seconds. */ durationInSeconds: number ): sap.ui.vtm.Viewport; /** * Zooms to the set of geometry that is visible in the current viewport. If no geometry is visible, this * zooms to all geometry in the current viewport. * * * @returns Returns `this` for method chaining. */ zoomToVisible( /** * The duration of the zoom animation in seconds. */ durationInSeconds: number ): sap.ui.vtm.Viewport; } /** * The main entry point for constructing VTM controls. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This class is experimental and might be modified or removed in future * versions. */ class Vtm extends sap.ui.core.Element { /** * Constructor for a new Vtm. This constructor can be used to construct an instance of {@link sap.ui.vtm.Vtm } * with a specific set of extensions. Alternatively {@link sap.ui.vtm.createVtm} can be used to create a * {@link sap.ui.vtm.Vtm} instance with a default set of extensions. * * 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( /** * The id to use for the {@link sap.ui.vtm.Vtm} instance. */ sId: string, /** * A set of settings for the {@link sap.ui.vtm.Vtm} instance (normally used to populate the `extensions` * aggregation). */ mSettings: sap.ui.vtm.$VtmSettings ); /** * Creates a new subclass of class sap.ui.vtm.Vtm 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.vtm.Vtm. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some extension to the aggregation {@link #getExtensions extensions}. * * * @returns Reference to `this` in order to allow method chaining */ addExtension( /** * The extension to add; if empty, nothing is inserted */ oExtension: sap.ui.vtm.Extension ): this; /** * Attaches event handler `fnFunction` to the {@link #event:activePanelChanged activePanelChanged} event * of this `sap.ui.vtm.Vtm`. * * 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.vtm.Vtm` itself. * * Raised when the active panel has changed. * * * @returns Reference to `this` in order to allow method chaining */ attachActivePanelChanged( /** * 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.vtm.Vtm` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:activePanelChanged activePanelChanged} event * of this `sap.ui.vtm.Vtm`. * * 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.vtm.Vtm` itself. * * Raised when the active panel has changed. * * * @returns Reference to `this` in order to allow method chaining */ attachActivePanelChanged( /** * 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.vtm.Vtm` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialized initialized} event of this `sap.ui.vtm.Vtm`. * * 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.vtm.Vtm` itself. * * Raised when this {@link sap.ui.vtm.Vtm} instance and its extensions have been initialized. * * Applications should add event handlers after the {@link sap.ui.vtm.Vtm} instance has initialized so that * the extensions can attach event handlers before the application attempts to attach event handlers to * the same events. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialized( /** * 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.vtm.Vtm` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialized initialized} event of this `sap.ui.vtm.Vtm`. * * 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.vtm.Vtm` itself. * * Raised when this {@link sap.ui.vtm.Vtm} instance and its extensions have been initialized. * * Applications should add event handlers after the {@link sap.ui.vtm.Vtm} instance has initialized so that * the extensions can attach event handlers before the application attempts to attach event handlers to * the same events. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialized( /** * 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.vtm.Vtm` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:panelAdded panelAdded} event of this `sap.ui.vtm.Vtm`. * * 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.vtm.Vtm` itself. * * Raised when a panel has been added. * * * @returns Reference to `this` in order to allow method chaining */ attachPanelAdded( /** * 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: Vtm$PanelAddedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Vtm` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:panelAdded panelAdded} event of this `sap.ui.vtm.Vtm`. * * 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.vtm.Vtm` itself. * * Raised when a panel has been added. * * * @returns Reference to `this` in order to allow method chaining */ attachPanelAdded( /** * The function to be called when the event occurs */ fnFunction: (p1: Vtm$PanelAddedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vtm.Vtm` itself */ oListener?: object ): this; /** * Creates a VTM panel associated with this {@link sap.ui.vtm.Vtm} instance. * * * @returns The created panel. */ createPanel( /** * The ID to pass to the panel constructor. */ sId: string, /** * The settings to pass to the panel constructor. */ mSettings: object ): sap.ui.vtm.Panel; /** * Destroys all the extensions in the aggregation {@link #getExtensions extensions}. * * * @returns Reference to `this` in order to allow method chaining */ destroyExtensions(): this; /** * Detaches event handler `fnFunction` from the {@link #event:activePanelChanged activePanelChanged} event * of this `sap.ui.vtm.Vtm`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachActivePanelChanged( /** * 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; /** * Detaches event handler `fnFunction` from the {@link #event:initialized initialized} event of this `sap.ui.vtm.Vtm`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachInitialized( /** * 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; /** * Detaches event handler `fnFunction` from the {@link #event:panelAdded panelAdded} event of this `sap.ui.vtm.Vtm`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachPanelAdded( /** * The function to be called, when the event occurs */ fnFunction: (p1: Vtm$PanelAddedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:activePanelChanged activePanelChanged} 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 */ fireActivePanelChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:initialized initialized} 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 */ fireInitialized( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:panelAdded panelAdded} 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 */ firePanelAdded( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vtm.Vtm$PanelAddedEventParameters ): this; /** * Gets the active panel. * * * @returns The active panel, or null if there is no active panel. */ getActivePanel(): sap.ui.vtm.Panel | null; /** * Gets current value of property {@link #getAddDefaultExtensions addDefaultExtensions}. * * When true populates the `extensions` aggregation with the default set of extensions in the default configuration. * * * @returns Value of property `addDefaultExtensions` */ getAddDefaultExtensions(): boolean; /** * Gets the extension implementing a specified interface. * * Returns `undefined` if there is not exactly one matching extension. * * * @returns The matching extension or `undefined` if there is not exactly one matching extension. */ getExtensionByInterface( /** * The fully qualified name of the interface. */ sInterfaceName: string ): sap.ui.vtm.Extension | undefined; /** * Gets an extension with a specified class name. * * Returns `undefined` if there is not exactly one matching extension. * * * @returns The matching extension or `undefined` if there is not exactly one matching extension. */ getExtensionByName( /** * The fully qualified class name of the extension. */ sExtensionName: string ): sap.ui.vtm.Extension | undefined; /** * Gets content of aggregation {@link #getExtensions extensions}. * * The set of VTM extensions. Extensions are used to provide extensibility. Default behaviors are implemented * as extensions that can be replaced. */ getExtensions(): sap.ui.vtm.Extension[]; /** * Gets the extensions implementing a specified interface. * * * @returns The matching extensions. */ getExtensionsByInterface( /** * The fully qualified name of the interface. */ sInterfaceName: string ): sap.ui.vtm.Extension[]; /** * Gets the extensions with a specified class name. * * * @returns The matching extensions. */ getExtensionsByName( /** * The fully qualified class name of the extension. */ sExtensionName: string ): sap.ui.vtm.Extension[]; /** * Gets a panel given its id. Returns undefined if no match is found. * * * @returns The matching panel or undefined if no match is found. */ getPanel( /** * The id of the panel to find. */ panelId: string ): sap.ui.vtm.Panel | undefined; /** * Gets the set of created panels. Do not modify the returned array. * * * @returns The created panels. */ getPanels(): sap.ui.vtm.Panel[]; /** * Gets the scene. * * * @returns The scene. */ getScene(): sap.ui.vtm.Scene; /** * Checks for the provided `sap.ui.vtm.Extension` in the aggregation {@link #getExtensions extensions}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfExtension( /** * The extension whose index is looked for */ oExtension: sap.ui.vtm.Extension ): int; /** * Inserts a extension into the aggregation {@link #getExtensions extensions}. * * * @returns Reference to `this` in order to allow method chaining */ insertExtension( /** * The extension to insert; if empty, nothing is inserted */ oExtension: sap.ui.vtm.Extension, /** * The `0`-based index the extension should be inserted at; for a negative value of `iIndex`, the extension * is inserted at position 0; for a value greater than the current size of the aggregation, the extension * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getExtensions extensions}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllExtensions(): sap.ui.vtm.Extension[]; /** * Removes a extension from the aggregation {@link #getExtensions extensions}. * * * @returns The removed extension or `null` */ removeExtension( /** * The extension to remove or its index or id */ vExtension: int | string | sap.ui.vtm.Extension ): sap.ui.vtm.Extension | null; /** * Sets the active panel. * * * @returns A reference to `this` for method chaining. */ setActivePanel( /** * The active panel. */ oActivePanel: sap.ui.vtm.Panel ): sap.ui.vtm.Vtm; /** * Sets a new value for property {@link #getAddDefaultExtensions addDefaultExtensions}. * * When true populates the `extensions` aggregation with the default set of extensions in the default configuration. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setAddDefaultExtensions( /** * New value for property `addDefaultExtensions` */ bAddDefaultExtensions: boolean ): this; } /** * Enumeration specifying which tree item child collections an operation should apply to. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This type is experimental and might be modified or removed in future * versions. */ enum ChildCollectionType { /** * The operation should apply to the `excludedChildren` collection of the tree item only. */ Excluded = "Excluded", /** * The operation should apply to the `includedChildren` collection of the tree item only. */ Included = "Included", /** * The operation should apply to the `includedChildren` and the `excludedChildren` collection of the tree * item. */ IncludedAndExcluded = "IncludedAndExcluded", /** * The operation should not apply to either the `includedChildren` or `excludedChildren` collection of the * tree item. */ None = "None", } /** * Enumeration specifying types of {@link sap.ui.vtm.Column}. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This type is experimental and might be modified or removed in future * versions. */ enum ColumnType { /** * The AppData (application data) column type. This type of column represents application data that is neither * metadata nor identifier data. */ AppData = "AppData", /** * The Identifier column type. This type of column represents identifiers retrieved from viewables (or metadata * values supplied by the application which will be present in exported viewables). */ Identifier = "Identifier", /** * The Internal column type. Columns of this type: * - Should not be used for application data (all columns of this type are defined by VTM). * - Is not normally expected to be used by end users (columns of this type are typically expected to * be used for development/debugging). */ Internal = "Internal", /** * The Metadata column type. This type of column represents metadata retrieved from viewables (or metadata * values supplied by the application which will be present in exported viewables). */ Metadata = "Metadata", } /** * Enumeration specifying descriptors for {@link sap.ui.vtm.Column} objects of type {@link sap.ui.vtm.ColumnType.Internal}. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This type is experimental and might be modified or removed in future * versions. */ enum InternalColumnDescriptor { /** * A column showing the `absoluteMatrix` field of the tree item. */ AbsoluteMatrix = "AbsoluteMatrix", /** * A column showing the `highlightColor` field of the tree item. */ HighlightColor = "HighlightColor", /** * The column that is used to provide an indication of the messages that apply to the tree item and its * descendants. */ MessageStatus = "MessageStatus", /** * A column showing the `opacity` field of the tree item. */ Opacity = "Opacity", /** * A column showing the `relativeMatrix` field of the tree item. */ RelativeMatrix = "RelativeMatrix", /** * A column showing the `sceneNodeIds` field of the tree item. */ SceneNodeIds = "SceneNodeIds", /** * The column that contains the tree item name and the tree type icon. This must always be the first column. */ Tree = "Tree", /** * A column containing the `id` field of the tree item. */ TreeItemId = "TreeItemId", /** * The column that is used to indicate and control visibility of the scene nodes associated with the tree * item. */ Visibility = "Visibility", } /** * Enumeration specifying predefined views. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This type is experimental and might be modified or removed in future * versions. */ enum PredefinedView { /** * The view from the back. */ Back = "undefined", /** * The view from the bottom. */ Bottom = "undefined", /** * The view from the front. */ Front = "undefined", /** * The view from the left. */ Left = "undefined", /** * The view from the right. */ Right = "undefined", /** * The view from the top. */ Top = "undefined", } /** * Enumeration specifying row selection modes for a {@link sap.ui.vtm.Tree}. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This type is experimental and might be modified or removed in future * versions. */ enum SelectionMode { /** * A multiple selection mode that toggles the selection state of a row when it is clicked. */ MultiToggle = "MultiToggle", /** * Single selection mode. */ Single = "Single", } /** * Enumeration specifying text colors. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This type is experimental and might be modified or removed in future * versions. */ enum TextColor { /** * The default text color. */ Default = "Default", /** * Gray. */ Gray = "Gray", /** * Grey. A synonym for Gray. */ Grey = "Grey", } /** * Enumeration specifying the type(s) of tree item to match during tree traversal. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This type is experimental and might be modified or removed in future * versions. */ enum TreeItemType { /** * A tree item that is in the object hierarchy of the tree model, but cannot be shown in the tree. A tree * item is an excluded tree item when any ancestor of the tree item is included in the `excludedChildren` * collection of its parent. */ Excluded = "Excluded", /** * A tree item that can be shown in the tree. A tree item is an included tree item when it is a root tree * item or is included in the `includedChildren` collection of its parent. */ Included = "Included", /** * Matches either included or excluded tree items. */ IncludedOrExcluded = "IncludedOrExcluded", } /** * Enumeration specifying the download/load status of a {@link sap.ui.vtm.Viewable}. * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.50.0. This type is experimental and might be modified or removed in future * versions. */ enum ViewableLoadStatus { /** * The {@link sap.ui.vtm.Viewable} was downloaded successfully. */ Downloaded = "Downloaded", /** * The attempt to download the {@link sap.ui.vtm.Viewable} failed. */ DownloadFailed = "DownloadFailed", /** * The {@link sap.ui.vtm.Viewable} is being downloaded. */ Downloading = "Downloading", /** * The {@link sap.ui.vtm.Viewable} was loaded successfully. */ Loaded = "Loaded", /** * The attempt to load the {@link sap.ui.vtm.Viewable} failed. */ LoadFailed = "LoadFailed", /** * The {@link sap.ui.vtm.Viewable} is being loaded. */ Loading = "Loading", } /** * A float[] type representing a transformation matrix in a ISO 10303-42 format (in a 1 dimensional array * of 13 numbers). * * The {@link sap.ui.vtm.MatrixComponent} enumeration enumerates the array indices of the matrix components * for this type * * @deprecated As of version 1.96.10. because it is part of the deprecated package sap.ui.vtm * @experimental As of version 1.0.0. This class is experimental and might be modified or removed in future * versions. */ type Matrix = float[]; /** * Event object of the Extension#enabledChanged event. */ type Extension$EnabledChangedEvent = sap.ui.base.Event< Extension$EnabledChangedEventParameters, Extension >; /** * Event object of the Extension#initialized event. */ type Extension$InitializedEvent = sap.ui.base.Event< Extension$InitializedEventParameters, Extension >; /** * Event object of the Panel#contextMenu event. */ type Panel$ContextMenuEvent = sap.ui.base.Event< Panel$ContextMenuEventParameters, Panel >; /** * Event object of the Panel#initialized event. */ type Panel$InitializedEvent = sap.ui.base.Event< Panel$InitializedEventParameters, Panel >; /** * Event object of the Scene#downloadCompleted event. */ type Scene$DownloadCompletedEvent = sap.ui.base.Event< Scene$DownloadCompletedEventParameters, Scene >; /** * Event object of the Scene#downloadProgress event. */ type Scene$DownloadProgressEvent = sap.ui.base.Event< Scene$DownloadProgressEventParameters, Scene >; /** * Event object of the Scene#downloadStarted event. */ type Scene$DownloadStartedEvent = sap.ui.base.Event< Scene$DownloadStartedEventParameters, Scene >; /** * Event object of the Scene#hierarchyChanged event. */ type Scene$HierarchyChangedEvent = sap.ui.base.Event< Scene$HierarchyChangedEventParameters, Scene >; /** * Event object of the Scene#loadCompleted event. */ type Scene$LoadCompletedEvent = sap.ui.base.Event< Scene$LoadCompletedEventParameters, Scene >; /** * Event object of the Scene#loadProgress event. */ type Scene$LoadProgressEvent = sap.ui.base.Event< Scene$LoadProgressEventParameters, Scene >; /** * Event object of the Scene#loadStarted event. */ type Scene$LoadStartedEvent = sap.ui.base.Event< Scene$LoadStartedEventParameters, Scene >; /** * Event object of the Tree#beforeModelUpdated event. */ type Tree$BeforeModelUpdatedEvent = sap.ui.base.Event< Tree$BeforeModelUpdatedEventParameters, Tree >; /** * Event object of the Tree#dataColumnsChanged event. */ type Tree$DataColumnsChangedEvent = sap.ui.base.Event< Tree$DataColumnsChangedEventParameters, Tree >; /** * Event object of the Tree#dragOver event. */ type Tree$DragOverEvent = sap.ui.base.Event< Tree$DragOverEventParameters, Tree >; /** * Event object of the Tree#dragStart event. */ type Tree$DragStartEvent = sap.ui.base.Event< Tree$DragStartEventParameters, Tree >; /** * Event object of the Tree#drop event. */ type Tree$DropEvent = sap.ui.base.Event; /** * Event object of the Tree#expandedChanged event. */ type Tree$ExpandedChangedEvent = sap.ui.base.Event< Tree$ExpandedChangedEventParameters, Tree >; /** * Event object of the Tree#fixedColumnsChanged event. */ type Tree$FixedColumnsChangedEvent = sap.ui.base.Event< Tree$FixedColumnsChangedEventParameters, Tree >; /** * Event object of the Tree#hierarchyChanged event. */ type Tree$HierarchyChangedEvent = sap.ui.base.Event< Tree$HierarchyChangedEventParameters, Tree >; /** * Event object of the Tree#messageStatusHeaderIconClicked event. */ type Tree$MessageStatusHeaderIconClickedEvent = sap.ui.base.Event< Tree$MessageStatusHeaderIconClickedEventParameters, Tree >; /** * Event object of the Tree#messageStatusIconClicked event. */ type Tree$MessageStatusIconClickedEvent = sap.ui.base.Event< Tree$MessageStatusIconClickedEventParameters, Tree >; /** * Event object of the Tree#modelUpdated event. */ type Tree$ModelUpdatedEvent = sap.ui.base.Event< Tree$ModelUpdatedEventParameters, Tree >; /** * Event object of the Tree#selectionChanged event. */ type Tree$SelectionChangedEvent = sap.ui.base.Event< Tree$SelectionChangedEventParameters, Tree >; /** * Event object of the Tree#visibilityHeaderIconClicked event. */ type Tree$VisibilityHeaderIconClickedEvent = sap.ui.base.Event< Tree$VisibilityHeaderIconClickedEventParameters, Tree >; /** * Event object of the Tree#visibilityIconClicked event. */ type Tree$VisibilityIconClickedEvent = sap.ui.base.Event< Tree$VisibilityIconClickedEventParameters, Tree >; /** * Event object of the Viewport#beginGesture event. */ type Viewport$BeginGestureEvent = sap.ui.base.Event< Viewport$BeginGestureEventParameters, Viewport >; /** * Event object of the Viewport#endGesture event. */ type Viewport$EndGestureEvent = sap.ui.base.Event< Viewport$EndGestureEventParameters, Viewport >; /** * Event object of the Viewport#hover event. */ type Viewport$HoverEvent = sap.ui.base.Event< Viewport$HoverEventParameters, Viewport >; /** * Event object of the Viewport#nodeClicked event. */ type Viewport$NodeClickedEvent = sap.ui.base.Event< Viewport$NodeClickedEventParameters, Viewport >; /** * Event object of the Viewport#refreshRequested event. */ type Viewport$RefreshRequestedEvent = sap.ui.base.Event< Viewport$RefreshRequestedEventParameters, Viewport >; /** * Event object of the Viewport#selectionChanged event. */ type Viewport$SelectionChangedEvent = sap.ui.base.Event< Viewport$SelectionChangedEventParameters, Viewport >; /** * Event object of the Viewport#viewChanged event. */ type Viewport$ViewChangedEvent = sap.ui.base.Event< Viewport$ViewChangedEventParameters, Viewport >; /** * Event object of the Viewport#visibilityChanged event. */ type Viewport$VisibilityChangedEvent = sap.ui.base.Event< Viewport$VisibilityChangedEventParameters, Viewport >; /** * Event object of the Vtm#activePanelChanged event. */ type Vtm$ActivePanelChangedEvent = sap.ui.base.Event< Vtm$ActivePanelChangedEventParameters, Vtm >; /** * Event object of the Vtm#initialized event. */ type Vtm$InitializedEvent = sap.ui.base.Event< Vtm$InitializedEventParameters, Vtm >; /** * Event object of the Vtm#panelAdded event. */ type Vtm$PanelAddedEvent = sap.ui.base.Event< Vtm$PanelAddedEventParameters, Vtm >; } } interface IUI5DefineDependencyNames { "sap/ui/vtm/ArrayUtilities": undefined; "sap/ui/vtm/ChildCollectionType": undefined; "sap/ui/vtm/Column": undefined; "sap/ui/vtm/ColumnType": undefined; "sap/ui/vtm/DescriptorUtilities": undefined; "sap/ui/vtm/DisplayGroup": undefined; "sap/ui/vtm/Extension": undefined; "sap/ui/vtm/extensions/DisplayStateCalculationExtension": undefined; "sap/ui/vtm/extensions/InitialViewExtension": undefined; "sap/ui/vtm/extensions/LoadProgressExtension": undefined; "sap/ui/vtm/extensions/MessageStatusCalculationExtension": undefined; "sap/ui/vtm/extensions/MessageStatusIconClickExtension": undefined; "sap/ui/vtm/extensions/SceneNodeHoverHighlightExtension": undefined; "sap/ui/vtm/extensions/SceneNodeHoverTooltipExtension": undefined; "sap/ui/vtm/extensions/SelectionLinkingExtension": undefined; "sap/ui/vtm/extensions/ViewLinkingExtension": undefined; "sap/ui/vtm/extensions/ViewportSelectionLinkingExtension": undefined; "sap/ui/vtm/extensions/VisibilityIconClickExtension": undefined; "sap/ui/vtm/HashUtilities": undefined; "sap/ui/vtm/InternalColumnDescriptor": undefined; "sap/ui/vtm/InternalColumns": undefined; "sap/ui/vtm/library": undefined; "sap/ui/vtm/Lookup": undefined; "sap/ui/vtm/MatrixUtilities": undefined; "sap/ui/vtm/MessagesPopover": undefined; "sap/ui/vtm/Panel": undefined; "sap/ui/vtm/PredefinedView": undefined; "sap/ui/vtm/ProgressDialog": undefined; "sap/ui/vtm/Scene": undefined; "sap/ui/vtm/SceneNode": undefined; "sap/ui/vtm/SelectColumnsDialog": undefined; "sap/ui/vtm/SelectionMode": undefined; "sap/ui/vtm/TextColor": undefined; "sap/ui/vtm/Tree": undefined; "sap/ui/vtm/TreeItemType": undefined; "sap/ui/vtm/TreeItemUtilities": undefined; "sap/ui/vtm/Viewable": undefined; "sap/ui/vtm/ViewableLoadInfo": undefined; "sap/ui/vtm/ViewableLoadStatus": undefined; "sap/ui/vtm/Viewport": undefined; "sap/ui/vtm/Vtm": undefined; } }