@sapui5/types 1.124.0 → 1.125.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/index.d.ts +1 -0
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +1 -1
- package/types/sap.chart.d.ts +1 -1
- package/types/sap.collaboration.d.ts +1 -1
- package/types/sap.esh.search.ui.d.ts +1 -1
- package/types/sap.f.d.ts +1 -1
- package/types/sap.fe.base.d.ts +9 -0
- package/types/sap.fe.core.d.ts +5 -5
- package/types/sap.fe.macros.d.ts +670 -102
- package/types/sap.fe.navigation.d.ts +1 -1
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.plugins.managecache.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +1 -1
- package/types/sap.fe.test.d.ts +1 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +368 -323
- package/types/sap.insights.d.ts +1 -1
- package/types/sap.m.d.ts +307 -92
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.df.d.ts +28 -234
- package/types/sap.suite.ui.commons.d.ts +10 -6
- package/types/sap.suite.ui.generic.template.d.ts +4 -4
- package/types/sap.suite.ui.microchart.d.ts +19 -19
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +112 -38
- package/types/sap.ui.core.d.ts +133 -81
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +4 -39
- package/types/sap.ui.generic.app.d.ts +1 -1
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +6 -1
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/sap.ui.mdc.d.ts +42 -7
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +1 -1
- package/types/sap.ui.table.d.ts +27 -16
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.vbm.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +1 -1
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +169 -1
- package/types/sap.ui.webc.main.d.ts +493 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +51 -111
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +1 -1
- package/types/sap.viz.d.ts +1 -1
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +1 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +1 -1
package/types/sap.fe.macros.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.125.0
|
|
2
2
|
|
|
3
3
|
declare module "sap/fe/macros/CollectionBindingInfo" {
|
|
4
4
|
import Filter from "sap/ui/model/Filter";
|
|
@@ -903,6 +903,12 @@ declare module "sap/fe/macros/field/Field" {
|
|
|
903
903
|
* objects.
|
|
904
904
|
*/
|
|
905
905
|
semanticObject?: string | PropertyBindingInfo;
|
|
906
|
+
|
|
907
|
+
/**
|
|
908
|
+
* This is used to optionally provide an external value that comes from a different model than the oData
|
|
909
|
+
* model
|
|
910
|
+
*/
|
|
911
|
+
value?: string | PropertyBindingInfo;
|
|
906
912
|
}
|
|
907
913
|
|
|
908
914
|
/**
|
|
@@ -1135,6 +1141,12 @@ declare module "sap/fe/macros/field/FieldAPI" {
|
|
|
1135
1141
|
* objects.
|
|
1136
1142
|
*/
|
|
1137
1143
|
semanticObject?: string | PropertyBindingInfo;
|
|
1144
|
+
|
|
1145
|
+
/**
|
|
1146
|
+
* This is used to optionally provide an external value that comes from a different model than the oData
|
|
1147
|
+
* model
|
|
1148
|
+
*/
|
|
1149
|
+
value?: string | PropertyBindingInfo;
|
|
1138
1150
|
}
|
|
1139
1151
|
|
|
1140
1152
|
/**
|
|
@@ -1984,6 +1996,11 @@ declare module "sap/fe/macros/multiValueField/MultiValueField.block" {
|
|
|
1984
1996
|
*/
|
|
1985
1997
|
contextPath?: Context | PropertyBindingInfo | `{${string}}`;
|
|
1986
1998
|
|
|
1999
|
+
/**
|
|
2000
|
+
* Property added to be able to add data / items to the multi value field via a different model
|
|
2001
|
+
*/
|
|
2002
|
+
items?: string | PropertyBindingInfo;
|
|
2003
|
+
|
|
1987
2004
|
/**
|
|
1988
2005
|
* Defines the relative Metadata path to the MultiValueField.
|
|
1989
2006
|
* The metaPath should point to a Property or DataField.
|
|
@@ -3830,125 +3847,676 @@ declare module "sap/fe/macros/table/TreeTable.block" {
|
|
|
3830
3847
|
>;
|
|
3831
3848
|
}
|
|
3832
3849
|
|
|
3833
|
-
declare module "sap/fe/macros/table/
|
|
3850
|
+
declare module "sap/fe/macros/table/TreeTable" {
|
|
3834
3851
|
import {
|
|
3835
|
-
default as
|
|
3836
|
-
$
|
|
3837
|
-
} from "sap/fe/macros/controls/
|
|
3852
|
+
default as BuildingBlockWithTemplating,
|
|
3853
|
+
$BuildingBlockWithTemplatingSettings,
|
|
3854
|
+
} from "sap/fe/macros/controls/BuildingBlockWithTemplating";
|
|
3838
3855
|
|
|
3839
|
-
import
|
|
3856
|
+
import Action from "sap/fe/macros/table/Action";
|
|
3857
|
+
|
|
3858
|
+
import Column from "sap/fe/macros/table/Column";
|
|
3859
|
+
|
|
3860
|
+
import { MessageType } from "sap/ui/core/library";
|
|
3861
|
+
|
|
3862
|
+
import PresentationVariant from "sap/fe/navigation/PresentationVariant";
|
|
3863
|
+
|
|
3864
|
+
import Context from "sap/ui/model/odata/v4/Context";
|
|
3865
|
+
|
|
3866
|
+
import SelectionVariant from "sap/fe/navigation/SelectionVariant";
|
|
3867
|
+
|
|
3868
|
+
import {
|
|
3869
|
+
PropertyBindingInfo,
|
|
3870
|
+
AggregationBindingInfo,
|
|
3871
|
+
} from "sap/ui/base/ManagedObject";
|
|
3872
|
+
|
|
3873
|
+
import TreeTableCreationOptions from "sap/fe/macros/table/TreeTableCreationOptions";
|
|
3874
|
+
|
|
3875
|
+
import ActionGroup from "sap/fe/macros/table/ActionGroup";
|
|
3876
|
+
|
|
3877
|
+
import Event from "sap/ui/base/Event";
|
|
3840
3878
|
|
|
3841
3879
|
/**
|
|
3842
|
-
*
|
|
3843
|
-
|
|
3844
|
-
|
|
3845
|
-
|
|
3846
|
-
*
|
|
3880
|
+
* Building block used to create a table based on the metadata provided by OData V4.
|
|
3881
|
+
*
|
|
3882
|
+
*
|
|
3883
|
+
* Usually, a LineItem, PresentationVariant or SelectionPresentationVariant annotation is expected, but
|
|
3884
|
+
* the Table building block can also be used to display an EntitySet.
|
|
3885
|
+
*
|
|
3886
|
+
*
|
|
3887
|
+
* If a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.
|
|
3888
|
+
*
|
|
3889
|
+
*
|
|
3890
|
+
* If a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that
|
|
3891
|
+
* also has a UI.LineItem as the first property of the Visualizations.
|
|
3892
|
+
* Usage example:
|
|
3893
|
+
*
|
|
3894
|
+
* ```javascript
|
|
3895
|
+
*
|
|
3896
|
+
* sap.ui.require(["sap/fe/macros/table/TreeTable"], function(TreeTable) {
|
|
3897
|
+
* ...
|
|
3898
|
+
* new TreeTable("myTable", {metaPath:"@com.sap.vocabularies.UI.v1.LineItem"})
|
|
3899
|
+
* })
|
|
3900
|
+
* ```
|
|
3901
|
+
*
|
|
3902
|
+
* This is currently an experimental API because the structure of the generated content will change to come
|
|
3903
|
+
* closer to the Table that you get out of templates.
|
|
3904
|
+
* The public method and property will not change but the internal structure will so be careful on your
|
|
3905
|
+
* usage.
|
|
3906
|
+
*
|
|
3907
|
+
*
|
|
3908
|
+
* @since 1.125.0
|
|
3909
|
+
* @experimental (since 1.125.0)
|
|
3847
3910
|
*/
|
|
3848
|
-
export
|
|
3849
|
-
extends $BuildingBlockObjectPropertySettings {
|
|
3911
|
+
export default class TreeTable extends BuildingBlockWithTemplating {
|
|
3850
3912
|
/**
|
|
3851
|
-
*
|
|
3913
|
+
* Adds an action to the table.
|
|
3914
|
+
*
|
|
3915
|
+
* @since 1.125.0
|
|
3916
|
+
* @experimental (since 1.125.0)
|
|
3917
|
+
*
|
|
3918
|
+
* @returns Reference to this in order to allow method chaining
|
|
3852
3919
|
*/
|
|
3853
|
-
|
|
3854
|
-
|
|
3920
|
+
addAction(
|
|
3921
|
+
/**
|
|
3922
|
+
* The action to add
|
|
3923
|
+
*/
|
|
3924
|
+
action: Action
|
|
3925
|
+
): this;
|
|
3855
3926
|
/**
|
|
3856
|
-
*
|
|
3857
|
-
* Allowed values are `NewPage` or `Inline`.
|
|
3927
|
+
* Adds a column to the table.
|
|
3858
3928
|
*
|
|
3929
|
+
* @since 1.124.0
|
|
3930
|
+
* @experimental (since 1.124.0)
|
|
3859
3931
|
*
|
|
3932
|
+
* @returns Reference to this in order to allow method chaining
|
|
3933
|
+
*/
|
|
3934
|
+
addColumn(
|
|
3935
|
+
/**
|
|
3936
|
+
* The column to add
|
|
3937
|
+
*/
|
|
3938
|
+
column: Column
|
|
3939
|
+
): this;
|
|
3940
|
+
/**
|
|
3941
|
+
* Adds a message to the table.
|
|
3942
|
+
* The message applies to the whole table and not to an individual table row.
|
|
3860
3943
|
*
|
|
3861
|
-
* NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
|
|
3862
|
-
* or 'Deferred' is used.
|
|
3863
3944
|
*
|
|
3864
|
-
* Inline - the creation is done inline.
|
|
3865
3945
|
*
|
|
3866
|
-
*
|
|
3946
|
+
* @returns The ID of the message
|
|
3947
|
+
*/
|
|
3948
|
+
addMessage(
|
|
3949
|
+
/**
|
|
3950
|
+
* The parameters to create the message
|
|
3951
|
+
*/
|
|
3952
|
+
parameters: {
|
|
3953
|
+
/**
|
|
3954
|
+
* Message description
|
|
3955
|
+
*/
|
|
3956
|
+
description?: string;
|
|
3957
|
+
/**
|
|
3958
|
+
* Message text
|
|
3959
|
+
*/
|
|
3960
|
+
message?: string;
|
|
3961
|
+
/**
|
|
3962
|
+
* True if the message is persistent
|
|
3963
|
+
*/
|
|
3964
|
+
persistent?: boolean;
|
|
3965
|
+
/**
|
|
3966
|
+
* Message type
|
|
3967
|
+
*/
|
|
3968
|
+
type?: MessageType;
|
|
3969
|
+
}
|
|
3970
|
+
): string;
|
|
3971
|
+
/**
|
|
3972
|
+
* Get the variant management applied to the table.
|
|
3867
3973
|
*
|
|
3868
|
-
*
|
|
3974
|
+
*
|
|
3975
|
+
* @returns Key of the currently selected variant. In case the model is not yet set, `null` will be returned.
|
|
3869
3976
|
*/
|
|
3870
|
-
|
|
3871
|
-
|
|
3977
|
+
getCurrentVariantKey(): null | string;
|
|
3872
3978
|
/**
|
|
3873
|
-
*
|
|
3874
|
-
* This object must have the following properties:
|
|
3875
|
-
* propertyName: the name of the property on the page entity set used to categorize the node type to be
|
|
3876
|
-
* created within the hierarchy
|
|
3979
|
+
* Get the fields that should be ignored when generating the table.
|
|
3877
3980
|
*
|
|
3878
|
-
*
|
|
3879
|
-
*
|
|
3981
|
+
* @since 1.125.0
|
|
3982
|
+
* @experimental (since 1.125.0)
|
|
3983
|
+
*
|
|
3984
|
+
* @returns The value of the ignoredFields property
|
|
3880
3985
|
*/
|
|
3881
|
-
|
|
3882
|
-
|
|
3883
|
-
|
|
3884
|
-
|
|
3885
|
-
|
|
3886
|
-
|
|
3887
|
-
|
|
3888
|
-
|
|
3889
|
-
|
|
3890
|
-
|
|
3891
|
-
|
|
3892
|
-
|
|
3893
|
-
|
|
3894
|
-
|
|
3895
|
-
|
|
3896
|
-
|
|
3897
|
-
|
|
3898
|
-
|
|
3899
|
-
|
|
3900
|
-
|
|
3901
|
-
|
|
3902
|
-
|
|
3903
|
-
|
|
3904
|
-
|
|
3905
|
-
|
|
3906
|
-
|
|
3907
|
-
|
|
3908
|
-
|
|
3909
|
-
|
|
3910
|
-
|
|
3911
|
-
|
|
3912
|
-
|
|
3913
|
-
|
|
3914
|
-
|
|
3915
|
-
|
|
3916
|
-
|
|
3917
|
-
|
|
3918
|
-
|
|
3919
|
-
|
|
3920
|
-
|
|
3921
|
-
|
|
3922
|
-
|
|
3923
|
-
|
|
3924
|
-
|
|
3925
|
-
|
|
3926
|
-
|
|
3927
|
-
|
|
3928
|
-
|
|
3929
|
-
|
|
3930
|
-
|
|
3931
|
-
|
|
3932
|
-
|
|
3933
|
-
|
|
3934
|
-
|
|
3935
|
-
|
|
3936
|
-
|
|
3937
|
-
|
|
3938
|
-
|
|
3939
|
-
|
|
3940
|
-
|
|
3941
|
-
|
|
3942
|
-
|
|
3943
|
-
|
|
3944
|
-
|
|
3945
|
-
|
|
3946
|
-
|
|
3947
|
-
|
|
3948
|
-
|
|
3949
|
-
|
|
3950
|
-
|
|
3951
|
-
|
|
3986
|
+
getIgnoredFields(): string;
|
|
3987
|
+
/**
|
|
3988
|
+
* Gets the path to the metadata that should be used to generate the table.
|
|
3989
|
+
*
|
|
3990
|
+
* @since 1.125.0
|
|
3991
|
+
* @experimental (since 1.125.0)
|
|
3992
|
+
*
|
|
3993
|
+
* @returns The path to the metadata
|
|
3994
|
+
*/
|
|
3995
|
+
getMetaPath(): string;
|
|
3996
|
+
/**
|
|
3997
|
+
* Get the presentation variant that is currently applied on the table.
|
|
3998
|
+
*
|
|
3999
|
+
*
|
|
4000
|
+
* @returns The presentation variant applied to the table
|
|
4001
|
+
*/
|
|
4002
|
+
getPresentationVariant(): Promise<PresentationVariant>;
|
|
4003
|
+
/**
|
|
4004
|
+
* Gets contexts from the table that have been selected by the user.
|
|
4005
|
+
*
|
|
4006
|
+
*
|
|
4007
|
+
* @returns Contexts of the rows selected by the user
|
|
4008
|
+
*/
|
|
4009
|
+
getSelectedContexts(): Context[];
|
|
4010
|
+
/**
|
|
4011
|
+
* Get the selection variant from the Table.
|
|
4012
|
+
*
|
|
4013
|
+
*
|
|
4014
|
+
* @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
|
|
4015
|
+
*/
|
|
4016
|
+
getSelectionVariant(): Promise<SelectionVariant>;
|
|
4017
|
+
/**
|
|
4018
|
+
* Hide the columns with the given column keys by setting their availability to Default.
|
|
4019
|
+
*
|
|
4020
|
+
* @since 1.124.0
|
|
4021
|
+
* @experimental (since 1.124.0)
|
|
4022
|
+
*
|
|
4023
|
+
* @returns Promise
|
|
4024
|
+
*/
|
|
4025
|
+
hideColumns(
|
|
4026
|
+
/**
|
|
4027
|
+
* The keys for the columns to hide
|
|
4028
|
+
*/
|
|
4029
|
+
columnKeys: string[]
|
|
4030
|
+
): Promise<void>;
|
|
4031
|
+
/**
|
|
4032
|
+
* Requests a refresh of the table.
|
|
4033
|
+
*/
|
|
4034
|
+
refresh(): void;
|
|
4035
|
+
/**
|
|
4036
|
+
* Removes an action from the table.
|
|
4037
|
+
*
|
|
4038
|
+
* @since 1.125.0
|
|
4039
|
+
* @experimental (since 1.125.0)
|
|
4040
|
+
*
|
|
4041
|
+
* @returns The removed action or null
|
|
4042
|
+
*/
|
|
4043
|
+
removeAction(
|
|
4044
|
+
/**
|
|
4045
|
+
* The action to remove, or its index or ID
|
|
4046
|
+
*/
|
|
4047
|
+
action: number | Action | string
|
|
4048
|
+
): null | Action;
|
|
4049
|
+
/**
|
|
4050
|
+
* Removes a column from the table.
|
|
4051
|
+
*
|
|
4052
|
+
* @since 1.125.0
|
|
4053
|
+
* @experimental (since 1.125.0)
|
|
4054
|
+
*
|
|
4055
|
+
* @returns The removed column or null
|
|
4056
|
+
*/
|
|
4057
|
+
removeColumn(
|
|
4058
|
+
/**
|
|
4059
|
+
* The column to remove, or its index or ID
|
|
4060
|
+
*/
|
|
4061
|
+
column: number | Column | string
|
|
4062
|
+
): null | Column;
|
|
4063
|
+
/**
|
|
4064
|
+
* Removes a message from the table.
|
|
4065
|
+
*/
|
|
4066
|
+
removeMessage(
|
|
4067
|
+
/**
|
|
4068
|
+
* The id of the message
|
|
4069
|
+
*/
|
|
4070
|
+
id: string
|
|
4071
|
+
): void;
|
|
4072
|
+
/**
|
|
4073
|
+
* Set a variant management to the table.
|
|
4074
|
+
*/
|
|
4075
|
+
setCurrentVariantKey(
|
|
4076
|
+
/**
|
|
4077
|
+
* Key of the variant that should be selected. If the passed key doesn't identify a variant, it will be
|
|
4078
|
+
* ignored.
|
|
4079
|
+
*/
|
|
4080
|
+
key: string
|
|
4081
|
+
): void;
|
|
4082
|
+
/**
|
|
4083
|
+
* Sets the fields that should be ignored when generating the table.
|
|
4084
|
+
*
|
|
4085
|
+
* @since 1.125.0
|
|
4086
|
+
* @experimental (since 1.125.0)
|
|
4087
|
+
*
|
|
4088
|
+
* @returns Reference to this in order to allow method chaining
|
|
4089
|
+
*/
|
|
4090
|
+
setIgnoredFields(
|
|
4091
|
+
/**
|
|
4092
|
+
* The fields to ignore
|
|
4093
|
+
*/
|
|
4094
|
+
ignoredFields: string
|
|
4095
|
+
): this;
|
|
4096
|
+
/**
|
|
4097
|
+
* Sets the path to the metadata that should be used to generate the table.
|
|
4098
|
+
*
|
|
4099
|
+
* @since 1.125.0
|
|
4100
|
+
* @experimental (since 1.125.0)
|
|
4101
|
+
*
|
|
4102
|
+
* @returns Reference to this in order to allow method chaining
|
|
4103
|
+
*/
|
|
4104
|
+
setMetaPath(
|
|
4105
|
+
/**
|
|
4106
|
+
* The path to the metadata
|
|
4107
|
+
*/
|
|
4108
|
+
metaPath: string
|
|
4109
|
+
): this;
|
|
4110
|
+
/**
|
|
4111
|
+
* Set a new presentation variant to the table.
|
|
4112
|
+
*/
|
|
4113
|
+
setPresentationVariant(
|
|
4114
|
+
/**
|
|
4115
|
+
* The new presentation variant that is to be set on the table.
|
|
4116
|
+
*/
|
|
4117
|
+
tablePV: PresentationVariant
|
|
4118
|
+
): Promise<void>;
|
|
4119
|
+
/**
|
|
4120
|
+
* Sets {@link sap.fe.navigation.SelectionVariant } to the table. Note: setSelectionVariant will clear existing
|
|
4121
|
+
* filters and then apply the SelectionVariant values.
|
|
4122
|
+
*
|
|
4123
|
+
*
|
|
4124
|
+
* @returns A promise for asynchronous handling
|
|
4125
|
+
*/
|
|
4126
|
+
setSelectionVariant(
|
|
4127
|
+
/**
|
|
4128
|
+
* The {@link sap.fe.navigation.SelectionVariant } to apply to the table
|
|
4129
|
+
*/
|
|
4130
|
+
selectionVariant: SelectionVariant,
|
|
4131
|
+
/**
|
|
4132
|
+
* Optional. If true, we will use the associated text property values (if they're available in the SelectionVariant)
|
|
4133
|
+
* to display the filter value descriptions, instead of loading them from the backend
|
|
4134
|
+
*/
|
|
4135
|
+
prefillDescriptions?: boolean
|
|
4136
|
+
): Promise<any>;
|
|
4137
|
+
/**
|
|
4138
|
+
* Show the columns with the given column keys by setting their availability to Default.
|
|
4139
|
+
*
|
|
4140
|
+
* @since 1.124.0
|
|
4141
|
+
* @experimental (since 1.124.0)
|
|
4142
|
+
*
|
|
4143
|
+
* @returns Promise
|
|
4144
|
+
*/
|
|
4145
|
+
showColumns(
|
|
4146
|
+
/**
|
|
4147
|
+
* The keys for the columns to show
|
|
4148
|
+
*/
|
|
4149
|
+
columnKeys: string[]
|
|
4150
|
+
): Promise<void>;
|
|
4151
|
+
}
|
|
4152
|
+
/**
|
|
4153
|
+
* Describes the settings that can be provided to the TreeTable constructor.
|
|
4154
|
+
*
|
|
4155
|
+
* @experimental (since 1.125.0)
|
|
4156
|
+
*/
|
|
4157
|
+
export interface $TreeTableSettings
|
|
4158
|
+
extends $BuildingBlockWithTemplatingSettings {
|
|
4159
|
+
/**
|
|
4160
|
+
* An expression that allows you to control the 'busy' state of the table.
|
|
4161
|
+
*/
|
|
4162
|
+
busy?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4163
|
+
|
|
4164
|
+
/**
|
|
4165
|
+
* Defines the path of the context used in the current page or block.
|
|
4166
|
+
* This setting is defined by the framework.
|
|
4167
|
+
*/
|
|
4168
|
+
contextPath?: string | PropertyBindingInfo;
|
|
4169
|
+
|
|
4170
|
+
/**
|
|
4171
|
+
* A set of options that can be configured.
|
|
4172
|
+
*/
|
|
4173
|
+
creationMode?:
|
|
4174
|
+
| TreeTableCreationOptions
|
|
4175
|
+
| PropertyBindingInfo
|
|
4176
|
+
| `{${string}}`;
|
|
4177
|
+
|
|
4178
|
+
/**
|
|
4179
|
+
* Controls if the copy functionality of the table is disabled or not.
|
|
4180
|
+
*/
|
|
4181
|
+
disableCopyToClipboard?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4182
|
+
|
|
4183
|
+
/**
|
|
4184
|
+
* Specifies if the column width is automatically calculated.
|
|
4185
|
+
*/
|
|
4186
|
+
enableAutoColumnWidth?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4187
|
+
|
|
4188
|
+
/**
|
|
4189
|
+
* Controls if the export functionality of the table is enabled or not.
|
|
4190
|
+
*/
|
|
4191
|
+
enableExport?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4192
|
+
|
|
4193
|
+
/**
|
|
4194
|
+
* Controls whether the table can be opened in fullscreen mode or not.
|
|
4195
|
+
*/
|
|
4196
|
+
enableFullScreen?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4197
|
+
|
|
4198
|
+
/**
|
|
4199
|
+
* Controls if the paste functionality of the table is enabled or not.
|
|
4200
|
+
*/
|
|
4201
|
+
enablePaste?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4202
|
+
|
|
4203
|
+
/**
|
|
4204
|
+
* Maximum allowed number of records to be exported in one request.
|
|
4205
|
+
*/
|
|
4206
|
+
exportRequestSize?: int | PropertyBindingInfo | `{${string}}`;
|
|
4207
|
+
|
|
4208
|
+
/**
|
|
4209
|
+
* ID of the FilterBar building block associated with the table.
|
|
4210
|
+
*/
|
|
4211
|
+
filterBar?: string | PropertyBindingInfo;
|
|
4212
|
+
|
|
4213
|
+
/**
|
|
4214
|
+
* Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.
|
|
4215
|
+
* This property is not relevant for responsive tables
|
|
4216
|
+
*/
|
|
4217
|
+
frozenColumnCount?: int | PropertyBindingInfo | `{${string}}`;
|
|
4218
|
+
|
|
4219
|
+
/**
|
|
4220
|
+
* Specifies the header text that is shown in the table.
|
|
4221
|
+
*/
|
|
4222
|
+
header?: string | PropertyBindingInfo;
|
|
4223
|
+
|
|
4224
|
+
/**
|
|
4225
|
+
* Controls if the header text should be shown or not.
|
|
4226
|
+
*/
|
|
4227
|
+
headerVisible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4228
|
+
|
|
4229
|
+
/**
|
|
4230
|
+
* A set of options that can be configured.
|
|
4231
|
+
*/
|
|
4232
|
+
hierarchyQualifier?: string | PropertyBindingInfo;
|
|
4233
|
+
|
|
4234
|
+
/**
|
|
4235
|
+
* Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.
|
|
4236
|
+
*
|
|
4237
|
+
* The table building block is not going to create built-in columns or offer table personalization for comma-separated
|
|
4238
|
+
* value of fields that are provided in the ignoredfields.
|
|
4239
|
+
*
|
|
4240
|
+
* Any column referencing an ignored field is to be removed.
|
|
4241
|
+
*/
|
|
4242
|
+
ignoredFields?: string | PropertyBindingInfo;
|
|
4243
|
+
|
|
4244
|
+
/**
|
|
4245
|
+
* Defines the extension point to control if a source node can be dropped on a specific parent node.
|
|
4246
|
+
*/
|
|
4247
|
+
isMoveToPositionAllowed?: string | PropertyBindingInfo;
|
|
4248
|
+
|
|
4249
|
+
/**
|
|
4250
|
+
* Defines the extension point to control if a node can be dragged.
|
|
4251
|
+
*/
|
|
4252
|
+
isNodeMovable?: string | PropertyBindingInfo;
|
|
4253
|
+
|
|
4254
|
+
/**
|
|
4255
|
+
* Defines whether to display the search action.
|
|
4256
|
+
*/
|
|
4257
|
+
isSearchable?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4258
|
+
|
|
4259
|
+
/**
|
|
4260
|
+
* Defines the relative path to a LineItem, PresentationVariant or SelectionPresentationVariant in the metamodel,
|
|
4261
|
+
* based on the current contextPath.
|
|
4262
|
+
*/
|
|
4263
|
+
metaPath?: string | PropertyBindingInfo;
|
|
4264
|
+
|
|
4265
|
+
/**
|
|
4266
|
+
* Controls which options should be enabled for the table personalization dialog.
|
|
4267
|
+
* If it is set to `true`, all possible options for this kind of table are enabled.
|
|
4268
|
+
*
|
|
4269
|
+
* If it is set to `false`, personalization is disabled.
|
|
4270
|
+
*
|
|
4271
|
+
*
|
|
4272
|
+
*
|
|
4273
|
+
* You can also provide a more granular control for the personalization by providing a comma-separated list
|
|
4274
|
+
* with the options you want to be available.
|
|
4275
|
+
*
|
|
4276
|
+
* Available options are:
|
|
4277
|
+
*
|
|
4278
|
+
* - Sort
|
|
4279
|
+
*
|
|
4280
|
+
* - Column
|
|
4281
|
+
*
|
|
4282
|
+
* - Filter
|
|
4283
|
+
*/
|
|
4284
|
+
personalization?: string | PropertyBindingInfo;
|
|
4285
|
+
|
|
4286
|
+
/**
|
|
4287
|
+
* An expression that allows you to control the 'read-only' state of the table.
|
|
4288
|
+
* If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
|
|
4289
|
+
* current state.
|
|
4290
|
+
*/
|
|
4291
|
+
readOnly?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4292
|
+
|
|
4293
|
+
/**
|
|
4294
|
+
* Number of rows to be displayed in the table. Does not apply to responsive tables.
|
|
4295
|
+
*/
|
|
4296
|
+
rowCount?: int | PropertyBindingInfo | `{${string}}`;
|
|
4297
|
+
|
|
4298
|
+
/**
|
|
4299
|
+
* Defines how the table handles the visible rows. Does not apply to Responsive tables.
|
|
4300
|
+
* Allowed values are `Auto`, `Fixed`.
|
|
4301
|
+
*
|
|
4302
|
+
* - If set to `Fixed`, the table always has as many rows as defined in the rowCount property.
|
|
4303
|
+
*
|
|
4304
|
+
* - If set to `Auto`, the number of rows is changed by the table automatically. It will then adjust its
|
|
4305
|
+
* row count to the space it is allowed to cover (limited by the surrounding container) but it cannot have
|
|
4306
|
+
* less than defined in the `rowCount` property.
|
|
4307
|
+
*/
|
|
4308
|
+
rowCountMode?: string | PropertyBindingInfo;
|
|
4309
|
+
|
|
4310
|
+
/**
|
|
4311
|
+
* Defines the selection mode to be used by the table.
|
|
4312
|
+
* Allowed values are `None`, `Single`, `ForceSingle`, `Multi`, `ForceMulti` or `Auto`.
|
|
4313
|
+
* If set to 'Single', 'Multi' or 'Auto', SAP Fiori elements hooks into the standard lifecycle to determine
|
|
4314
|
+
* the consistent selection mode.
|
|
4315
|
+
* If set to 'ForceSingle' or 'ForceMulti' your choice will be respected but this might not respect the
|
|
4316
|
+
* Fiori guidelines.
|
|
4317
|
+
*/
|
|
4318
|
+
selectionMode?: string | PropertyBindingInfo;
|
|
4319
|
+
|
|
4320
|
+
/**
|
|
4321
|
+
* Defines the type of table that will be used by the building block to render the data. This setting is
|
|
4322
|
+
* defined by the framework.
|
|
4323
|
+
* Allowed value is `TreeTable`.
|
|
4324
|
+
*/
|
|
4325
|
+
type?: string | PropertyBindingInfo;
|
|
4326
|
+
|
|
4327
|
+
/**
|
|
4328
|
+
* Controls the kind of variant management that should be enabled for the table.
|
|
4329
|
+
* Allowed value is `Control`.
|
|
4330
|
+
*
|
|
4331
|
+
* If set with value `Control`, a variant management control is seen within the table and the table is linked
|
|
4332
|
+
* to this.
|
|
4333
|
+
*
|
|
4334
|
+
* If not set with any value, control level variant management is not available for this table.
|
|
4335
|
+
*/
|
|
4336
|
+
variantManagement?: string | PropertyBindingInfo;
|
|
4337
|
+
|
|
4338
|
+
/**
|
|
4339
|
+
* Indicates if the column header should be a part of the width calculation.
|
|
4340
|
+
*/
|
|
4341
|
+
widthIncludingColumnHeader?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4342
|
+
|
|
4343
|
+
/**
|
|
4344
|
+
* Aggregate actions of the table.
|
|
4345
|
+
*/
|
|
4346
|
+
actions?:
|
|
4347
|
+
| Array<ActionGroup | Action>
|
|
4348
|
+
| ActionGroup
|
|
4349
|
+
| Action
|
|
4350
|
+
| AggregationBindingInfo
|
|
4351
|
+
| `{${string}}`;
|
|
4352
|
+
|
|
4353
|
+
/**
|
|
4354
|
+
* Aggregate columns of the table.
|
|
4355
|
+
*/
|
|
4356
|
+
columns?: Column[] | Column | AggregationBindingInfo | `{${string}}`;
|
|
4357
|
+
}
|
|
4358
|
+
|
|
4359
|
+
/**
|
|
4360
|
+
* Parameters of the TreeTable#beforeRebindTable event.
|
|
4361
|
+
*/
|
|
4362
|
+
export interface TreeTable$BeforeRebindTableEventParameters {}
|
|
4363
|
+
|
|
4364
|
+
/**
|
|
4365
|
+
* Event object of the TreeTable#beforeRebindTable event.
|
|
4366
|
+
*/
|
|
4367
|
+
export type TreeTable$BeforeRebindTableEvent = Event<
|
|
4368
|
+
TreeTable$BeforeRebindTableEventParameters,
|
|
4369
|
+
TreeTable
|
|
4370
|
+
>;
|
|
4371
|
+
|
|
4372
|
+
/**
|
|
4373
|
+
* Parameters of the TreeTable#rowPress event.
|
|
4374
|
+
*/
|
|
4375
|
+
export interface TreeTable$RowPressEventParameters {}
|
|
4376
|
+
|
|
4377
|
+
/**
|
|
4378
|
+
* Event object of the TreeTable#rowPress event.
|
|
4379
|
+
*/
|
|
4380
|
+
export type TreeTable$RowPressEvent = Event<
|
|
4381
|
+
TreeTable$RowPressEventParameters,
|
|
4382
|
+
TreeTable
|
|
4383
|
+
>;
|
|
4384
|
+
|
|
4385
|
+
/**
|
|
4386
|
+
* Parameters of the TreeTable#selectionChange event.
|
|
4387
|
+
*/
|
|
4388
|
+
export interface TreeTable$SelectionChangeEventParameters {}
|
|
4389
|
+
|
|
4390
|
+
/**
|
|
4391
|
+
* Event object of the TreeTable#selectionChange event.
|
|
4392
|
+
*/
|
|
4393
|
+
export type TreeTable$SelectionChangeEvent = Event<
|
|
4394
|
+
TreeTable$SelectionChangeEventParameters,
|
|
4395
|
+
TreeTable
|
|
4396
|
+
>;
|
|
4397
|
+
}
|
|
4398
|
+
|
|
4399
|
+
declare module "sap/fe/macros/table/TreeTableCreationOptions" {
|
|
4400
|
+
import {
|
|
4401
|
+
default as BuildingBlockObjectProperty,
|
|
4402
|
+
$BuildingBlockObjectPropertySettings,
|
|
4403
|
+
} from "sap/fe/macros/controls/BuildingBlockObjectProperty";
|
|
4404
|
+
|
|
4405
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
4406
|
+
|
|
4407
|
+
/**
|
|
4408
|
+
* Create options for the tree table.
|
|
4409
|
+
*/
|
|
4410
|
+
export default class TreeTableCreationOptions extends BuildingBlockObjectProperty {}
|
|
4411
|
+
/**
|
|
4412
|
+
* Describes the settings that can be provided to the TreeTableCreationOptions constructor.
|
|
4413
|
+
*/
|
|
4414
|
+
export interface $TreeTableCreationOptionsSettings
|
|
4415
|
+
extends $BuildingBlockObjectPropertySettings {
|
|
4416
|
+
/**
|
|
4417
|
+
* Defines the extension point to control the enablement of the Create button or Create Menu buttons.
|
|
4418
|
+
*/
|
|
4419
|
+
isCreateEnabled?: string | PropertyBindingInfo;
|
|
4420
|
+
|
|
4421
|
+
/**
|
|
4422
|
+
* Defines the creation mode to be used by the tree table.
|
|
4423
|
+
* Allowed values are `NewPage` or `Inline`.
|
|
4424
|
+
*
|
|
4425
|
+
*
|
|
4426
|
+
*
|
|
4427
|
+
* NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
|
|
4428
|
+
* or 'Deferred' is used.
|
|
4429
|
+
*
|
|
4430
|
+
* Inline - the creation is done inline.
|
|
4431
|
+
*
|
|
4432
|
+
* If not set with any value:
|
|
4433
|
+
*
|
|
4434
|
+
* if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
|
|
4435
|
+
*/
|
|
4436
|
+
name?: string | PropertyBindingInfo;
|
|
4437
|
+
|
|
4438
|
+
/**
|
|
4439
|
+
* Defines the nodes to be added on the custom create.
|
|
4440
|
+
* This object must have the following properties:
|
|
4441
|
+
* propertyName: the name of the property on the page entity set used to categorize the node type to be
|
|
4442
|
+
* created within the hierarchy
|
|
4443
|
+
*
|
|
4444
|
+
* values: an array of key and label that define a value of the property defined by the propertyName key
|
|
4445
|
+
* and its label
|
|
4446
|
+
*/
|
|
4447
|
+
nodeType?: object | PropertyBindingInfo | `{${string}}`;
|
|
4448
|
+
}
|
|
4449
|
+
}
|
|
4450
|
+
|
|
4451
|
+
declare namespace sap {
|
|
4452
|
+
interface IUI5DefineDependencyNames {
|
|
4453
|
+
"sap/fe/macros/chart/Action": undefined;
|
|
4454
|
+
|
|
4455
|
+
"sap/fe/macros/chart/ActionGroup": undefined;
|
|
4456
|
+
|
|
4457
|
+
"sap/fe/macros/chart/Chart": undefined;
|
|
4458
|
+
|
|
4459
|
+
"sap/fe/macros/chart/ChartAPI": undefined;
|
|
4460
|
+
|
|
4461
|
+
"sap/fe/macros/CollectionBindingInfo": undefined;
|
|
4462
|
+
|
|
4463
|
+
"sap/fe/macros/controls/BuildingBlockObjectProperty": undefined;
|
|
4464
|
+
|
|
4465
|
+
"sap/fe/macros/controls/BuildingBlockWithTemplating": undefined;
|
|
4466
|
+
|
|
4467
|
+
"sap/fe/macros/fcl/FlexibleColumnLayoutActions.block": undefined;
|
|
4468
|
+
|
|
4469
|
+
"sap/fe/macros/field/Field": undefined;
|
|
4470
|
+
|
|
4471
|
+
"sap/fe/macros/field/FieldAPI": undefined;
|
|
4472
|
+
|
|
4473
|
+
"sap/fe/macros/filterBar/FilterBar": undefined;
|
|
4474
|
+
|
|
4475
|
+
"sap/fe/macros/filterBar/FilterBarAPI": undefined;
|
|
4476
|
+
|
|
4477
|
+
"sap/fe/macros/filterBar/FilterField": undefined;
|
|
4478
|
+
|
|
4479
|
+
"sap/fe/macros/form/Form.block": undefined;
|
|
4480
|
+
|
|
4481
|
+
"sap/fe/macros/form/FormElement.block": undefined;
|
|
4482
|
+
|
|
4483
|
+
"sap/fe/macros/kpiTag/KPITag.block": undefined;
|
|
4484
|
+
|
|
4485
|
+
"sap/fe/macros/library": undefined;
|
|
4486
|
+
|
|
4487
|
+
"sap/fe/macros/MacroAPI": undefined;
|
|
4488
|
+
|
|
4489
|
+
"sap/fe/macros/microchart/MicroChart": undefined;
|
|
4490
|
+
|
|
4491
|
+
"sap/fe/macros/microchart/MicroChart.block": undefined;
|
|
4492
|
+
|
|
4493
|
+
"sap/fe/macros/multiValueField/MultiValueField.block": undefined;
|
|
4494
|
+
|
|
4495
|
+
"sap/fe/macros/paginator/Paginator.block": undefined;
|
|
4496
|
+
|
|
4497
|
+
"sap/fe/macros/RichTextEditor": undefined;
|
|
4498
|
+
|
|
4499
|
+
"sap/fe/macros/richtexteditor/ButtonGroup": undefined;
|
|
4500
|
+
|
|
4501
|
+
"sap/fe/macros/richtexteditor/Plugin": undefined;
|
|
4502
|
+
|
|
4503
|
+
"sap/fe/macros/richtexteditor/RichTextEditorWithMetadata.block": undefined;
|
|
4504
|
+
|
|
4505
|
+
"sap/fe/macros/share/Share.block": undefined;
|
|
4506
|
+
|
|
4507
|
+
"sap/fe/macros/table/Action": undefined;
|
|
4508
|
+
|
|
4509
|
+
"sap/fe/macros/table/ActionGroup": undefined;
|
|
4510
|
+
|
|
4511
|
+
"sap/fe/macros/table/Column": undefined;
|
|
4512
|
+
|
|
4513
|
+
"sap/fe/macros/table/Table": undefined;
|
|
4514
|
+
|
|
4515
|
+
"sap/fe/macros/table/Table.block": undefined;
|
|
4516
|
+
|
|
4517
|
+
"sap/fe/macros/table/TableCreationOptions": undefined;
|
|
4518
|
+
|
|
4519
|
+
"sap/fe/macros/table/TreeTable": undefined;
|
|
3952
4520
|
|
|
3953
4521
|
"sap/fe/macros/table/TreeTable.block": undefined;
|
|
3954
4522
|
|