@sap/ux-specification 1.84.43 → 1.84.46

package/dist/src/specification/v2/controls/Card.d.ts

@@ -1,655 +0,0 @@
-/**
- * Represents the card default grid size in columns and rows
- */
-export declare type DefaultSpanDef = {
-    /**
-     * Represents the card width calculated based on window width.
-     */
-    cols: number;
-    /**
-     * Represents the number of line items to display for table and list cards.
-     */
-    rows: number;
-    /**
-     * Set showOnlyHeader to true to render only the card header.
-     */
-    showOnlyHeader?: boolean;
-    /**
-     * To show more lines of text in the title you can configure this property (maximum allowed: 3 lines).
-     */
-    minimumTitleRow?: number;
-    /**
-     * To show more lines of text in the sub-title you can configure this property (maximum allowed: 2 lines).
-     */
-    minimumSubTitleRow?: number;
-} | 'auto';
-export interface TabSetting {
-    /**
-     * Represents the annotation path.
-     */
-    annotationPath?: string;
-    /**
-     * Represents the selection annotation path.
-     */
-    selectionAnnotationPath?: string;
-    /**
-     * Represents the chart annotation path.
-     */
-    chartAnnotationPath?: string;
-    /**
-     * Represents the presentation annotation path.
-     */
-    presentationAnnotationPath?: string;
-    /**
-     * Represents the data point annotation path.
-     */
-    dataPointAnnotationPath?: string;
-    /**
-     * Represents the identification annotation path.
-     */
-    identificationAnnotationPath?: string;
-    /**
-     * Represents the dynamic subtitle annotation path
-     */
-    dynamicSubtitleAnnotationPath?: string;
-    /**
-     * Represents the drop down value to be shown
-     */
-    value?: string;
-    /**
-     * This property is responsible for setting specific chart settings.
-     */
-    chartProperties?: {
-        plotArea?: PlotAreaDef;
-    };
-    /**
-     * Represents the configuration to customize the column stacked chart.
-     */
-    colorPalette?: {
-        [k: string]: any;
-    }[] | {
-        [k: string]: any;
-    };
-    [k: string]: any;
-}
-export interface CommonCardSettings {
-    /**
-     * Represents the dominant entity set that will be displayed in the given card.
-     */
-    entitySet?: string;
-    /**
-     * The language-dependent title of the card, used in the card header.
-     * @i18nClassification TIT: Title of the card, used in the card header
-     */
-    title: string;
-    /**
-     * The language-dependent subtitle of the card, used in the card header.
-     * @i18nClassification TIT: Subtitle of the card, used in the card header
-     */
-    subTitle?: string;
-    /**
-     * Represents the identification annotation path.
-     */
-    identificationAnnotationPath?: string;
-    /**
-     * Represents the selection annotation path.
-     */
-    selectionAnnotationPath?: string;
-    /**
-     * Represents the presentation annotation path.
-     */
-    presentationAnnotationPath?: string;
-    /**
-     * The category of the card, as used in the card header.
-     */
-    category?: string;
-    /**
-     * To load cards with specific requirements, define a default size as part of the card definition in the descriptor file.
-     */
-    defaultSpan?: DefaultSpanDef;
-    /**
-     * Define an authorization check at card level.
-     */
-    requireAppAuthorization?: string;
-    /**
-     * Represents the card with view switch control.
-     */
-    tabs?: [TabSetting, ...TabSetting[]];
-    /**
-     * add $Select parameter in data fetch URL
-     */
-    addODataSelect?: boolean;
-}
-export declare enum ChartCardType {
-    cardBubble = "cardBubble",
-    cardchartsline = "cardchartsline",
-    cardchartsdonut = "cardchartsdonut"
-}
-export declare enum CardTemplateType {
-    analytical = "sap.ovp.cards.charts.analytical",
-    analyticalv4 = "sap.ovp.cards.v4.charts.analytical",
-    list = "sap.ovp.cards.list",
-    listv4 = "sap.ovp.cards.v4.list",
-    linklist = "sap.ovp.cards.linklist",
-    table = "sap.ovp.cards.table",
-    tablev4 = "sap.ovp.cards.v4.table",
-    stack = "sap.ovp.cards.stack"
-}
-export declare const cardTemplateTypeMap: {
-    'sap.ovp.cards.charts.analytical': string;
-    'sap.ovp.cards.v4.charts.analytical': string;
-    'sap.ovp.cards.list': string;
-    'sap.ovp.cards.v4.list': string;
-    'sap.ovp.cards.linklist': string;
-    'sap.ovp.cards.table': string;
-    'sap.ovp.cards.v4.table': string;
-    'sap.ovp.cards.stack': string;
-};
-export declare enum CardSettingsType {
-    analyticalCardSettings = "analyticalCardSettings",
-    analyticalCardSettingsv4 = "analyticalCardSettingsv4",
-    listCardSettings = "listCardSettings",
-    listCardSettingsv4 = "listCardSettingsv4",
-    stackCardSettings = "stackCardSettings",
-    linkListCardSettings = "linkListCardSettings",
-    tableCardSettings = "tableCardSettings",
-    tableCardSettingsv4 = "tableCardSettingsv4"
-}
-export declare enum MeasureAggregateValues {
-    average = "average",
-    max = "max",
-    min = "min",
-    sum = "sum",
-    count = "$count"
-}
-export interface MeasureAggregateSettings {
-    Axis1?: MeasureAggregateValues;
-    Axis2?: MeasureAggregateValues;
-    Axis3?: MeasureAggregateValues;
-}
-/**
- * Custom Card
- * @isViewNode true
- */
-export interface CustomCard {
-    /**
-     * Represents the model for the card
-     */
-    model: string;
-    /**
-     * Represents the card component path to use for this card.
-     * @TJS-pattern ^(?!(sap.ovp.cards.charts.analytical|sap.ovp.cards.v4.charts.analytical|sap.ovp.cards.linklist|sap.ovp.cards.list|sap.ovp.cards.v4.list|sap.ovp.cards.stack|sap.ovp.cards.table|sap.ovp.cards.v4.table)$).*$
-     */
-    template: string;
-    /**
-     * Represents the properties that are passed to the custom card.
-     */
-    settings?: CustomCardSettings;
-}
-/**
- * List Card
- * @isViewNode true
- * @controlProperty template
- */
-export interface ListCard {
-    /**
-     * Represents the model for the List Card
-     */
-    model: string;
-    /**
-     * Represents the card component path to use for this List Card.
-     */
-    template: CardTemplateType.list | CardTemplateType.listv4;
-    /**
-     * Represents the properties that are passed to the list card.
-     */
-    listCardSettings: ListCardSettings;
-}
-/**
- * Stack Card
- * @isViewNode true
- * @controlProperty template
- */
-export interface StackCard {
-    /**
-     * Represents the model for the StackCard.
-     */
-    model: string;
-    /**
-     * Represents the Stack Card component path to use for this card.
-     */
-    template: CardTemplateType.stack;
-    /**
-     * Represents the properties that are passed to the stack card.
-     */
-    stackCardSettings: StackCardSettings;
-}
-/**
- * Link List Card
- * @isViewNode true
- * @controlProperty template
- */
-export interface LinklistCard {
-    /**
-     * Represents the model for the Link list Card.
-     */
-    model?: string;
-    /**
-     * Represents the Link list Card component path to use for this card.
-     */
-    template: CardTemplateType.linklist;
-    /**
-     * Represents the properties that are passed to the link list card.
-     */
-    linkListCardSettings: LinkListCardSettings;
-}
-/**
- * Table Card
- * @isViewNode true
- * @controlProperty template
- */
-export interface TableCard {
-    /**
-     * Represents the model for the TableCard.
-     */
-    model: string;
-    /**
-     * Represents the Table Card component path to use for this card.
-     */
-    template: CardTemplateType.table | CardTemplateType.tablev4;
-    /**
-     * Represents the properties that are passed to the table card.
-     */
-    tableCardSettings: TableCardSettings;
-    /**
-     * If you set disableTableCardFlexibility to true, then at runtime, DataField records are sorted according to the importance set in the com.sap.vocabularies.UI.v1.ImportanceType annotation, and their order of entry.
-     * If you set disableTableCardFlexibility to false, then at runtime, table columns are sorted according to the importance set in the com.sap.vocabularies.UI.v1.ImportanceType annotation, and their order of entry.
-     */
-    disableTableCardFlexibility?: boolean;
-}
-/**
- * Analytical Card
- * @isViewNode true
- * @controlProperty template
- */
-export interface AnalyticalCard {
-    /**
-     * Represents the model for the Analytical Card
-     */
-    model: string;
-    /**
-     * Represents the Analytical Card component path to use for this card.
-     */
-    template: CardTemplateType.analytical | CardTemplateType.analyticalv4;
-    /**
-     * Represents the properties that are passed to the analytical card.
-     */
-    analyticalCardSettings: AnalyticalCardSettings | AnalyticalCardSettingsv4;
-}
-export declare type CustomCardNavigationType = 'dataPointNav' | 'chartNav' | 'headerNav' | 'noHeaderNav';
-/**
- * @displayName settings
- */
-export interface CustomCardSettings extends CommonCardSettings {
-    /**
-     * Represents the user defined string in placeholder card.
-     */
-    itemText?: string;
-    /**
-     * Represents things like people, number of items.
-     */
-    valueSelectionInfo?: string;
-    /**
-     * Represents the static content that will be displayed in this card.
-     */
-    staticContent?: {
-        [k: string]: any;
-    }[];
-    /**
-     * Represents the flavor of the list to use in this card. The flavor can be bar chart, carousel or standard.
-     */
-    listFlavor?: 'standard' | 'bar' | 'carousel';
-    /**
-     * Represents the type of list to use for this card. The list can be extended to display more information or condensed to take up less space on the card.
-     */
-    listType?: 'extended' | 'condensed';
-    /**
-     * Represents the sort key for the entity set.
-     */
-    sortBy?: string;
-    /**
-     * Represents the sort order for the entity set.
-     */
-    sortOrder?: 'ascending' | 'descending';
-    /**
-     * Represents the annotation path.
-     */
-    annotationPath?: string;
-    /**
-     * Represents the chart annotation path.
-     */
-    chartAnnotationPath?: string;
-    /**
-     * Represents the data point annotation path.
-     */
-    dataPointAnnotationPath?: string;
-    /**
-     * Represents the KPI annotation path.
-     */
-    kpiAnnotationPath?: string;
-    /**
-     * Represents the selection presentation annotation path.
-     */
-    selectionPresentationAnnotationPath?: string;
-    /**
-     * Represents the dynamic subtitle annotation path.
-     */
-    dynamicSubtitleAnnotationPath?: string;
-    /**
-     * Represents the flag to indicate priority of number formatting over sap text.
-     */
-    ignoreSapText?: boolean;
-    /**
-     * Represents the Object Stream properties - properties that are passed to the Object Stream cards.
-     */
-    objectStreamCardsSettings?: {
-        /**
-         * If this flag is set to true, the first action on the footer of the quick view card will be a navigation action.
-         * If the flag is set to false, the navigation action on the footer of the quick view card isn't displayed. Other actions are shown instead.
-         * The default value of the flag is false.
-         */
-        showFirstActionInFooter?: boolean;
-        /**
-         * Represents the annotation path.
-         */
-        annotationPath?: string;
-    };
-    /**
-     * Represents the flag to indicate the use of object number/smart field.
-     */
-    enableLocaleCurrencyFormatting?: boolean;
-    /**
-     * Represents the configuration to alter the navigation mode in OVP Analytical Cards.
-     */
-    navigation?: CustomCardNavigationType;
-    /**
-     * Represents a switch to Show or Hide Filters in Cards Headers in OVP application.
-     */
-    showFilterInHeader?: boolean;
-    /**
-     * Represents a switch to Show or Hide Sorting in Cards Headers in OVP application.
-     */
-    showSortingInHeader?: boolean;
-    /**
-     * Flag for enabling images in a condensed list card.
-     */
-    imageSupported?: boolean;
-    /**
-     * Flag for show line item detail in list and table card.
-     */
-    showLineItemDetail?: boolean;
-    /**
-     * This property is responsible for showing and hiding text labels on the geo spots.
-     */
-    showLabelText?: boolean;
-    /**
-     * This property is responsible for passing custom parameters present in the entity set to the navigating application.
-     */
-    customParams?: string;
-    /**
-     * This property is responsible for setting specific chart settings.
-     */
-    chartProperties?: {
-        plotArea?: PlotAreaDef;
-    };
-    /**
-     * Represents the configuration to customize the column stacked chart.
-     */
-    colorPalette?: {
-        [k: string]: any;
-    }[] | {
-        [k: string]: any;
-    };
-    [k: string]: any;
-}
-/**
- * @displayName settings
- */
-export interface AnalyticalCardSettings extends CommonCardSettings {
-    /**
-     * Represents the chart annotation path.
-     */
-    chartAnnotationPath?: string;
-    /**
-     * Represents the data point annotation path.
-     */
-    dataPointAnnotationPath?: string;
-    /**
-     * Represents things like people, number of items.
-     */
-    valueSelectionInfo?: string;
-}
-/**
- * @displayName settings
- */
-export interface AnalyticalCardSettingsv4 extends AnalyticalCardSettings {
-    /**
-     *
-     */
-    measureAggregate?: MeasureAggregateSettings;
-}
-export declare enum ListFlavorType {
-    standard = "standard",
-    bar = "bar",
-    carousel = "carousel"
-}
-export declare enum ListTypeType {
-    extended = "extended",
-    condensed = "condensed"
-}
-export declare enum SortOrderType {
-    ascending = "ascending",
-    descending = "descending"
-}
-/**
- * @displayName settings
- */
-export interface ListCardSettings extends CommonCardSettings {
-    /**
-     * Represents the flavor of the list to use in this card. The flavor can be bar chart, carousel or standard.
-     */
-    listFlavor?: ListFlavorType;
-    /**
-     * Represents the type of list to use for this card. The list can be extended to display more information or condensed to take up less space on the card.
-     */
-    listType?: ListTypeType;
-    /**
-     * Represents the annotation path.
-     */
-    annotationPath?: string;
-    /**
-     * Represents things like people, number of items.
-     */
-    valueSelectionInfo?: string;
-    /**
-     * Defines the property by which the list shall be sorted.
-     */
-    sortBy?: string;
-    /**
-     * Defines the sort order.
-     */
-    sortOrder?: SortOrderType;
-    /**
-     * Represents the data point annotation path.
-     */
-    dataPointAnnotationPath?: string;
-    /**
-     * Flag for show line item detail in list and table card.
-     */
-    showLineItemDetail?: boolean;
-}
-/**
- * @displayName settings
- */
-export interface StackCardSettings extends CommonCardSettings {
-    /**
-     * Represents the user defined string in placeholder card.
-     */
-    itemText?: string;
-    /**
-     * The navigation property used to display information from a secondary entity set.
-     */
-    objectStreamCardsNavigationProperty?: string;
-    /**
-     * Configures additional settings for the cards displayed in the object stream.
-     */
-    objectStreamCardsSettings?: {
-        /**
-         * If this flag is set to true, the first action on the footer of the quick view card will be a navigation action.
-         * If the flag is set to false, the navigation action on the footer of the quick view card isn't displayed. Other actions are shown instead.
-         * The default value of the flag is false.
-         */
-        showFirstActionInFooter?: boolean;
-        /**
-         * Represents the annotation path.
-         */
-        annotationPath?: string;
-    };
-}
-/**
- * @displayName settings
- */
-export interface TableCardSettings extends CommonCardSettings {
-    /**
-     * Represents the annotation path.
-     */
-    annotationPath?: string;
-    /**
-     * Represents the flavor of the list to use in this card. The flavor can be bar chart, carousel or standard.
-     */
-    listFlavor?: ListFlavorType;
-    /**
-     * Represents the type of list to use for this card. The list can be extended to display more information or condensed to take up less space on the card.
-     */
-    listType?: ListTypeType;
-    /**
-     * Represents the data point annotation path.
-     */
-    dataPointAnnotationPath?: string;
-    /**
-     * Represents the selection presentation annotation path.
-     */
-    selectionPresentationAnnotationPath?: string;
-    /**
-     * Represents things like people, number of items.
-     */
-    valueSelectionInfo?: string;
-    /**
-     * Defines the property by which the list shall be sorted.
-     */
-    sortBy?: string;
-    /**
-     * Defines the sort order.
-     */
-    sortOrder?: SortOrderType;
-    /**
-     * Flag for show line item detail in list and table card.
-     */
-    showLineItemDetail?: boolean;
-}
-export declare enum LinkListFlavorType {
-    standard = "standard",
-    carousel = "carousel"
-}
-/**
- * @displayName settings
- */
-export interface LinkListCardSettings extends CommonCardSettings {
-    /**
-     * The targetUri is a URI defining the link to a quick view, related application or external resource.
-     */
-    targetUri?: string;
-    /**
-     * listFlavor represents the flavor of the list to use in this card. The flavor can be bar chart, carousel or standard.
-     */
-    listFlavor?: LinkListFlavorType;
-    /**
-     * sortBy defines the property by which the list shall be sorted.
-     */
-    sortBy?: string;
-    /**
-     * sortOrder defines the sort order. Valid values are 'ascending' or 'descending'
-     */
-    sortOrder?: SortOrderType;
-    /**
-     * headerAnnotationPath represents the path to a HeaderInfo annotation.
-     */
-    headerAnnotationPath?: string;
-    /**
-     * staticContent represents the static content of a static link list card.
-     */
-    staticContent?: StaticContent[];
-    /**
-     * Represents the annotation path.
-     */
-    annotationPath?: string;
-}
-export interface StaticContent {
-    /**
-     * The language-dependent title of the StaticContent.
-     * @i18nClassification TIT: Title of the StaticContent
-     */
-    title: string;
-    /**
-     * The language-dependent subtitle of the StaticContent.
-     * @i18nClassification TIT: Subtitle of the StaticContent
-     */
-    subTitle?: string;
-    /**
-     * The uri for the image of the StaticContent.
-     */
-    imageUri?: string;
-    /**
-     * The uri for the target of the StaticContent.
-     */
-    targetUri?: string;
-    /**
-     * The alternative text for the image of the StaticContent.
-     * @i18nClassification ALT: The alternative text for the image of the StaticContent
-     */
-    imageAltText?: string;
-    /**
-     * Used to provide intent based navigation.
-     */
-    semanticObject?: string;
-    /**
-     * Used to provide intent based navigation.
-     */
-    action?: string;
-    /**
-     * Open static content in a new window.
-     */
-    openInNewWindow?: boolean;
-}
-/**
- * Plot area is a parent property which defines multiple other properties for smoothness and marker size.
- */
-export interface PlotAreaDef {
-    /**
-     * isSmoothed represents whether smoother curves are required or not.
-     */
-    isSmoothed?: boolean;
-    /**
-     * markerSize represents the size of the markers in scatter plots.
-     */
-    markerSize?: number;
-    /**
-     * dataLabel is a parent property that defines other properties for type.
-     */
-    dataLabel?: {
-        /**
-         * The data label type defines whether to display percentage values or actual counts in the donut chart.
-         */
-        type?: 'value' | 'percentage';
-    };
-}