igniteui-webcomponents-layouts 7.1.1-beta.2 → 7.1.1-beta.4

package/esm2022/lib/igc-list-panel-component.d.ts

@@ -0,0 +1,345 @@
+import { ListPanel } from "./ListPanel";
+import { IDataSource } from "igniteui-webcomponents-core";
+import { IgcHTMLElement } from "igniteui-webcomponents-core";
+import { IgcListPanelTemplateItemUpdatingEventArgs } from './igc-list-panel-template-item-updating-event-args';
+import { ListPanelOrientation } from './ListPanelOrientation';
+import { IgcListPanelContentRefreshedEventArgs } from './igc-list-panel-content-refreshed-event-args';
+import { IgcListPanelTemplateWidthRequestedEventArgs } from './igc-list-panel-template-width-requested-event-args';
+import { IgcListPanelTemplateHeightRequestedEventArgs } from './igc-list-panel-template-height-requested-event-args';
+import { IExternalListPanel } from './IExternalListPanel';
+import { ScrollbarStyle } from "igniteui-webcomponents-core";
+import { IgcListPanelItemEventArgs } from './igc-list-panel-item-event-args';
+import { IgcListPanelActiveRowChangedEventArgs } from './igc-list-panel-active-row-changed-event-args';
+import { IgcListPanelSelectionChangedEventArgs } from './igc-list-panel-selection-changed-event-args';
+import { IgcListPanelSelectedKeysChangedEventArgs } from './igc-list-panel-selected-keys-changed-event-args';
+import { IgcListPanelSelectedItemsChangedEventArgs } from './igc-list-panel-selected-items-changed-event-args';
+import { IgcListPanelPrimaryKeyValue } from './igc-list-panel-primary-key-value';
+import { IgcListPanelSelectedKeysCollection } from './igc-list-panel-selected-keys-collection';
+import { ListPanelSelectionMode } from './ListPanelSelectionMode';
+import { ListPanelActivationMode } from './ListPanelActivationMode';
+import { ListPanelSelectionBehavior } from './ListPanelSelectionBehavior';
+import { IgcListPanelSelectedItemsCollection } from './igc-list-panel-selected-items-collection';
+import { IgcListPanelContentRecycledEventArgs } from './igc-list-panel-content-recycled-event-args';
+import { IgcListPanelContentRebindEventArgs } from './igc-list-panel-content-rebind-event-args';
+export declare class IgcListPanelComponent extends IgcHTMLElement implements IExternalListPanel {
+    private _implementation;
+    private _height;
+    private _width;
+    private _scroller;
+    setScrollbarStyle(style: ScrollbarStyle): void;
+    setScrollbarColor(color: any): void;
+    set height(value: string);
+    get height(): string;
+    set width(value: string);
+    get width(): string;
+    private ensureStretch;
+    createLocalDataSource(itemsSource: any, schemaIncludedProperties: string[]): IDataSource;
+    onContentSizeChanged(): void;
+    private _webComponentWrapper;
+    private _webComponentRenderer;
+    private _content;
+    constructor();
+    moveViewportTo(x: number, y: number): void;
+    onScroll(): void;
+    onScrollStart(): void;
+    onScrollStop(): void;
+    _scrollTo(x: number, y: number): void;
+    updateStyle(): void;
+    destroy(): void;
+    protected createImplementation(): ListPanel;
+    get i(): ListPanel;
+    private _disconnected;
+    disconnectedCallback(): void;
+    notifySizeChanged(): void;
+    connectedCallback(): void;
+    afterContentInit(): void;
+    private _dataSource;
+    set dataSource(value: any);
+    get dataSource(): any;
+    private _settingAttributes;
+    protected _attached: boolean;
+    private _queuedSetAttributes;
+    protected _enqueueSetAttribute(attrName: string, attrValue: string): void;
+    protected _flushQueuedAttributes(): void;
+    protected _a(attrName: string, attrValue: any): void;
+    private static _observedAttributesIgcListPanelComponent;
+    static get observedAttributes(): string[];
+    private _updatingFromAttribute;
+    attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
+    static htmlTagName: string;
+    protected static _isElementRegistered: boolean;
+    static register(): void;
+    /**
+ * Sets or gets the grid selection mode.
+*/
+    get selectionMode(): ListPanelSelectionMode;
+    set selectionMode(v: ListPanelSelectionMode);
+    /**
+     * Gets or sets whether the active row style will be applied to rows when made active.
+    */
+    get isActiveRowStyleEnabled(): boolean;
+    set isActiveRowStyleEnabled(v: boolean);
+    /**
+     * Gets or sets the background color to use for the cells when they are selected
+    */
+    get selectedBackground(): string;
+    set selectedBackground(v: string);
+    /**
+     * Gets or sets the background color to use.
+    */
+    get normalBackground(): string;
+    set normalBackground(v: string);
+    /**
+     * Gets or sets the activation border color to use.
+    */
+    get activationBorder(): string;
+    set activationBorder(v: string);
+    /**
+     * Gets or sets the amount of left activation border to use for the cell content for this column.
+    */
+    get activationBorderLeftWidth(): number;
+    set activationBorderLeftWidth(v: number);
+    /**
+     * Gets or sets the amount of top activation border to use for the cell content for this column.
+    */
+    get activationBorderTopWidth(): number;
+    set activationBorderTopWidth(v: number);
+    /**
+     * Gets or sets the amount of right activation border to use for the cell content of this column.
+    */
+    get activationBorderRightWidth(): number;
+    set activationBorderRightWidth(v: number);
+    /**
+     * Gets or sets the amount of bottom activation border to use for the cell content of this column.
+    */
+    get activationBorderBottomWidth(): number;
+    set activationBorderBottomWidth(v: number);
+    /**
+     * Sets or gets the grid selection mode.
+    */
+    get activationMode(): ListPanelActivationMode;
+    set activationMode(v: ListPanelActivationMode);
+    /**
+     * Sets or gets how selection behaves in the grid.
+    */
+    get selectionBehavior(): ListPanelSelectionBehavior;
+    set selectionBehavior(v: ListPanelSelectionBehavior);
+    /**
+     * Sets or gets the user provided primary key to assume for the data. Certain functionality of the grid requires a way to uniquely identify items in order to work correctly.
+     * If a primary key cannot be inferred from the data source, you may need to provide one here.
+    */
+    get primaryKey(): string[];
+    set primaryKey(v: string[]);
+    /**
+     * Gets either the inferred primary key from the data source, or the user provided primary key, if present. Represents the actual primary key that the grid will use in operations that require it.
+    */
+    get actualPrimaryKey(): string[];
+    set actualPrimaryKey(v: string[]);
+    private _selectedItems;
+    /**
+     * Gets which items are currently selected in the grid. Collection can be updated to programatically select items.
+    */
+    get selectedItems(): IgcListPanelSelectedItemsCollection;
+    set selectedItems(v: IgcListPanelSelectedItemsCollection);
+    private _selectedKeys;
+    /**
+     * Gets which primary key values are currently selected in the grid. Collection can be updated to programatically select items.
+    */
+    get selectedKeys(): IgcListPanelSelectedKeysCollection;
+    set selectedKeys(v: IgcListPanelSelectedKeysCollection);
+    /**
+     * Gets either the filtered properties to include in the schema of the data source.
+    */
+    get schemaIncludedProperties(): string[];
+    set schemaIncludedProperties(v: string[]);
+    /**
+     * Gets or sets the spacing between items.
+    */
+    get itemSpacing(): number;
+    set itemSpacing(v: number);
+    /**
+     * Gets or Sets the property name that contains the values.
+    */
+    get rowHeight(): number;
+    set rowHeight(v: number);
+    get actualRowHeight(): number;
+    set actualRowHeight(v: number);
+    /**
+     * Gets or Sets the property name that contains the values.
+    */
+    get cellTextStyle(): string;
+    set cellTextStyle(v: string);
+    get hasUnevenSizes(): boolean;
+    /**
+     * Gets or sets the style of scrollbar.
+    */
+    get scrollbarStyle(): ScrollbarStyle;
+    set scrollbarStyle(v: ScrollbarStyle);
+    /**
+     * Gets or sets the scrollbar background color.
+    */
+    get scrollbarBackground(): string;
+    set scrollbarBackground(v: string);
+    /**
+     * Gets or sets the color to use for the background of the component.
+    */
+    get backgroundColor(): string;
+    set backgroundColor(v: string);
+    /**
+     * Gets or sets the color to use for the background of the component.
+    */
+    get orientation(): ListPanelOrientation;
+    set orientation(v: ListPanelOrientation);
+    /**
+     * Gets or sets the color to use for the background of the component.
+    */
+    get isCustomRowHeightEnabled(): boolean;
+    set isCustomRowHeightEnabled(v: boolean);
+    /**
+     * Gets or sets the color to use for the text of the component.
+    */
+    get textColor(): string;
+    set textColor(v: string);
+    /**
+     * Gets or sets the position of the active row.
+    */
+    get activeRow(): number;
+    set activeRow(v: number);
+    /**
+     * Gets or sets if the grid should notify on programmatic selection changes as well as changes from the UI.
+    */
+    get notifyOnAllSelectionChanges(): boolean;
+    set notifyOnAllSelectionChanges(v: boolean);
+    findByName(name: string): any;
+    protected __p: string;
+    protected _hasUserValues: Set<string>;
+    protected get hasUserValues(): Set<string>;
+    protected __m(propertyName: string): void;
+    protected _stylingContainer: any;
+    protected _stylingParent: any;
+    protected _inStyling: boolean;
+    protected _styling(container: any, component: any, parent?: any): void;
+    getRowKey(primaryKey: string[], rowIndex: number): IgcListPanelPrimaryKeyValue;
+    getItemKey(primaryKey: string[], item_: any): IgcListPanelPrimaryKeyValue;
+    /**
+     * Gets the last visible index in the grid.
+    
+    */
+    getLastVisibleIndex(): number;
+    /**
+     * Gets the first visible index in the grid.
+    
+    */
+    getFirstVisibleIndex(): number;
+    /**
+     * Invalidates the bound data for the rows currently visible.
+    
+    */
+    invalidateVisibleItems(): void;
+    notifySetItem(index: number, oldItem: any, newItem: any): void;
+    /**
+     * Manually notifies the grid's data source that the data it has bound to has been cleared and needs to be re-examined.
+     * This should not be called if the data that the grid is bound to is already observable.
+    
+    */
+    notifyClearItems(): void;
+    notifyInsertItem(index: number, newItem: any): void;
+    notifyRemoveItem(index: number, oldItem: any): void;
+    /**
+     * Returns the data index of an item within the bound data source.
+    
+    * @param item  * The item from which to get the index.
+    */
+    dataIndexOfItem(item: any): number;
+    dataIndexOfPrimaryKey(key: any[]): number;
+    exportVisualData(): any;
+    exportSerializedVisualData(): string;
+    /**
+     * Selects all of the rows in the grid.
+    
+    */
+    selectAllRows(): void;
+    /**
+     * Scrolls the grid to given row, by index
+    
+    * @param rowNumber  * The row index to scroll to.
+    */
+    scrollToRowByIndex(rowNumber: number): void;
+    /**
+     * Scrolls the grid so that a row is the last visible, by index.
+    
+    * @param rowNumber  * The row index to scroll to.
+    */
+    scrollToLastRowByIndex(rowNumber: number): void;
+    /**
+     * Deselects all currently selected rows.
+    
+    */
+    deselectAllRows(): void;
+    private _itemRecycled;
+    private _itemRecycled_wrapped;
+    /**
+     * Called when item content is recycled.
+    */
+    get itemRecycled(): (s: IgcListPanelComponent, e: IgcListPanelContentRecycledEventArgs) => void;
+    set itemRecycled(ev: (s: IgcListPanelComponent, e: IgcListPanelContentRecycledEventArgs) => void);
+    private _itemRebind;
+    private _itemRebind_wrapped;
+    /**
+     * Called when item content is rebound.
+    */
+    get itemRebind(): (s: IgcListPanelComponent, e: IgcListPanelContentRebindEventArgs) => void;
+    set itemRebind(ev: (s: IgcListPanelComponent, e: IgcListPanelContentRebindEventArgs) => void);
+    private _selectedItemsChanged;
+    private _selectedItemsChanged_wrapped;
+    /**
+     * Called when the selected items change.
+    */
+    get selectedItemsChanged(): (s: IgcListPanelComponent, e: IgcListPanelSelectedItemsChangedEventArgs) => void;
+    set selectedItemsChanged(ev: (s: IgcListPanelComponent, e: IgcListPanelSelectedItemsChangedEventArgs) => void);
+    private _selectedKeysChanged;
+    private _selectedKeysChanged_wrapped;
+    /**
+     * Called when the selected keys change.
+    */
+    get selectedKeysChanged(): (s: IgcListPanelComponent, e: IgcListPanelSelectedKeysChangedEventArgs) => void;
+    set selectedKeysChanged(ev: (s: IgcListPanelComponent, e: IgcListPanelSelectedKeysChangedEventArgs) => void);
+    private _selectionChanged;
+    private _selectionChanged_wrapped;
+    /**
+     * Called when an individual selection operation has been made.
+    */
+    get selectionChanged(): (s: IgcListPanelComponent, e: IgcListPanelSelectionChangedEventArgs) => void;
+    set selectionChanged(ev: (s: IgcListPanelComponent, e: IgcListPanelSelectionChangedEventArgs) => void);
+    private _activeRowChanged;
+    private _activeRowChanged_wrapped;
+    /**
+     * Called when the active row changes.
+    */
+    get activeRowChanged(): (s: IgcListPanelComponent, e: IgcListPanelActiveRowChangedEventArgs) => void;
+    set activeRowChanged(ev: (s: IgcListPanelComponent, e: IgcListPanelActiveRowChangedEventArgs) => void);
+    private _contentRefreshed;
+    private _contentRefreshed_wrapped;
+    get contentRefreshed(): (s: IgcListPanelComponent, e: IgcListPanelContentRefreshedEventArgs) => void;
+    set contentRefreshed(ev: (s: IgcListPanelComponent, e: IgcListPanelContentRefreshedEventArgs) => void);
+    private _rowUpdating;
+    private _rowUpdating_wrapped;
+    get rowUpdating(): (s: IgcListPanelComponent, e: IgcListPanelTemplateItemUpdatingEventArgs) => void;
+    set rowUpdating(ev: (s: IgcListPanelComponent, e: IgcListPanelTemplateItemUpdatingEventArgs) => void);
+    private _itemWidthRequested;
+    private _itemWidthRequested_wrapped;
+    get itemWidthRequested(): (s: IgcListPanelComponent, e: IgcListPanelTemplateWidthRequestedEventArgs) => void;
+    set itemWidthRequested(ev: (s: IgcListPanelComponent, e: IgcListPanelTemplateWidthRequestedEventArgs) => void);
+    private _itemHeightRequested;
+    private _itemHeightRequested_wrapped;
+    get itemHeightRequested(): (s: IgcListPanelComponent, e: IgcListPanelTemplateHeightRequestedEventArgs) => void;
+    set itemHeightRequested(ev: (s: IgcListPanelComponent, e: IgcListPanelTemplateHeightRequestedEventArgs) => void);
+    private _itemClicked;
+    private _itemClicked_wrapped;
+    get itemClicked(): (s: IgcListPanelComponent, e: IgcListPanelItemEventArgs) => void;
+    set itemClicked(ev: (s: IgcListPanelComponent, e: IgcListPanelItemEventArgs) => void);
+    private _actualPrimaryKeyChange;
+    private _actualPrimaryKeyChange_wrapped;
+    get actualPrimaryKeyChange(): (s: IgcListPanelComponent, e: string[]) => void;
+    set actualPrimaryKeyChange(ev: (s: IgcListPanelComponent, e: string[]) => void);
+}