ng-virtual-list 14.11.4 → 14.12.0

package/lib/models/render-item-config.model.d.ts

@@ -1,69 +1,119 @@
-/**
- * Object with configuration parameters for IRenderVirtualListItem
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/14.x/projects/ng-virtual-list/src/lib/models/render-item-config.model.ts
- * @author Evgenii Alexandrovich Grebennikov
- * @email djonnyx@gmail.com
- */
-export interface IRenderVirtualListItemConfig {
-    /**
-     * Determines whether an element is new in the collection.
-     */
-    new: boolean;
-    /**
-     * Indicates that the element is odd.
-     */
-    odd: boolean;
-    /**
-     * Indicates that the element is even.
-     */
-    even: boolean;
-    /**
-     * Determines whether an element with a `sticky` property greater than zero can collapse and collapse elements in front that do not have a `sticky` property.
-     * Default value is `false`.
-     */
-    collapsable: boolean;
-    /**
-     * If greater than 0, the element will have a sticky position with the given zIndex.
-     */
-    sticky: 0 | 1 | 2;
-    /**
-     * Determines whether an element can be selected or not. Default value is `true`.
-     */
-    selectable: boolean;
-    /**
-     * Specifies whether the element will snap.
-     */
-    snap: boolean;
-    /**
-     * Indicates that the element is snapped.
-     */
-    snapped: boolean;
-    /**
-     * Indicates that the element is being shifted by another snap element.
-     */
-    snappedOut: boolean;
-    /**
-     * Indicates that the element is a vertical list item.
-     */
-    isVertical: boolean;
-    /**
-     * Specifies that the element adapts to the size of its content.
-     */
-    dynamic: boolean;
-    /**
-     * Returns true if the snapping method is advanced
-     */
-    isSnappingMethodAdvanced: boolean;
-    /**
-     * Tab index.
-     */
-    tabIndex: number;
-    /**
-     * z-index
-     */
-    zIndex: string;
-    /**
-     * Determines whether an element is a stub.
-     */
-    isStub?: boolean;
-}
+import { SnapToItemAlign } from "../types";
+import { Color } from "../types";
+/**
+ * Object with configuration parameters for IRenderVirtualListItem
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/14.x/projects/ng-virtual-list/src/lib/models/render-item-config.model.ts
+ * @author Evgenii Alexandrovich Grebennikov
+ * @email djonnyx@gmail.com
+ */
+export interface IRenderVirtualListItemConfig {
+    /**
+     * Determines whether an element is new in the collection.
+     */
+    new: boolean;
+    /**
+     * Indicates that the element is odd.
+     */
+    odd: boolean;
+    /**
+     * Indicates that the element is even.
+     */
+    even: boolean;
+    /**
+     * Determines whether an element with a `sticky` property greater than zero can collapse and collapse elements in front that do not have a `sticky` property.
+     * Default value is `false`.
+     */
+    collapsable: boolean;
+    /**
+     * If greater than 0, the element will have a sticky position with the given zIndex.
+     */
+    sticky: 0 | 1 | 2;
+    /**
+     * Determines whether an element can be selected or not. Default value is `true`.
+     */
+    selectable: boolean;
+    /**
+     * Specifies whether the element will snap.
+     */
+    snap: boolean;
+    /**
+     * Indicates that the element is snapped.
+     */
+    snapped: boolean;
+    /**
+     * Indicates that the element is being shifted by another snap element.
+     */
+    snappedOut: boolean;
+    /**
+     * Indicates that the element is a vertical list item.
+     */
+    isVertical: boolean;
+    /**
+     * Specifies that the element adapts to the size of its content.
+     */
+    dynamic: boolean;
+    /**
+     * Returns true if the snapping method is advanced
+     */
+    isSnappingMethodAdvanced: boolean;
+    /**
+     * layout offset;
+     */
+    layoutOffset: number;
+    /**
+     * layout index offset;
+     */
+    layoutIndexOffset: number;
+    /**
+     * Tab index.
+     */
+    tabIndex: number;
+    /**
+     * z-index
+     */
+    zIndex: string;
+    /**
+     * Opacity.
+     */
+    opacity: number;
+    /**
+     * Filter.
+     */
+    filter?: string;
+    /**
+     * Blend color.
+     */
+    blendColor?: Color | null;
+    /**
+     * Determines whether an element is a stub.
+     */
+    isStub?: boolean;
+    /**
+     * Division number.
+     */
+    divides: number;
+    /**
+     * Snap to an item. The default value is `false`.
+     */
+    snapToItem: boolean;
+    /**
+     * Alignment for snapToItem. Available values ​​are `start`, `center`, and `end`. The default value is `center`.
+     */
+    snapToItemAlign: SnapToItemAlign;
+    /**
+     * Indicates whether the element is the first in the collection.
+     */
+    isFirst: boolean;
+    /**
+     * Indicates whether the element is the last one in the collection.
+     */
+    isLast: boolean;
+    /**
+     * Determines the size of an element when rendering lists with cell divisions. If sticky is 1 or 2, fullSize automatically becomes true.
+     */
+    fullSize: boolean;
+    /**
+     * Number of elements in the collection to be visualized.
+     */
+    totalItems: number;
+}

package/lib/models/render-item-measures.model.d.ts

@@ -1,45 +1,116 @@
-import { IRect } from "../interfaces";
-/**
- * Measures for IRenderVirtualListItem
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/14.x/projects/ng-virtual-list/src/lib/models/render-item-measures.model.ts
- * @author Evgenii Alexandrovich Grebennikov
- * @email djonnyx@gmail.com
- */
-export interface IRenderVirtualListItemMeasures extends IRect {
-    /**
-     * Item position
-     */
-    position: number;
-    /**
-     * Scroll size
-     */
-    scrollSize: number;
-    /**
-     * Item size
-     */
-    size: number;
-    /**
-     * Bounds size
-     */
-    boundsSize: number;
-    /**
-     * Start position in viewport
-     */
-    absoluteStartPosition: number;
-    /**
-     * Start position in viewport (percent)
-     */
-    absoluteStartPositionPercent: number;
-    /**
-     * End position in viewport
-     */
-    absoluteEndPosition: number;
-    /**
-     * End position in viewport (percent)
-     */
-    absoluteEndPositionPercent: number;
-    /**
-     * Delta is calculated for Snapping Method.ADVANCED
-     */
-    delta: number;
-}
+import { IRect } from "../interfaces";
+import { ScrollDirection } from "../types";
+/**
+ * Measures for IRenderVirtualListItem
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/14.x/projects/ng-virtual-list/src/lib/models/render-item-measures.model.ts
+ * @author Evgenii Alexandrovich Grebennikov
+ * @email djonnyx@gmail.com
+ */
+export interface IRenderVirtualListItemMeasures extends IRect {
+    /**
+     * The X coordinate after transformation.
+     */
+    transformedX: number;
+    /**
+     * The Y coordinate after transformation.
+     */
+    transformedY: number;
+    /**
+     * The Z coordinate.
+     */
+    z: number;
+    /**
+     * Rotation X
+     */
+    rotationX: number;
+    /**
+     * Rotation Y
+     */
+    rotationY: number;
+    /**
+     * Rotation Z
+     */
+    rotationZ: number;
+    /**
+     * Scale X
+     */
+    scaleX: number;
+    /**
+     * Scale Y
+     */
+    scaleY: number;
+    /**
+     * Scale Z
+     */
+    scaleZ: number;
+    /**
+     * Minimal width.
+     */
+    minWidth: number;
+    /**
+     * Minimal height.
+     */
+    minHeight: number;
+    /**
+     * Maximum width.
+     */
+    maxWidth: number;
+    /**
+     * Maximum height.
+     */
+    maxHeight: number;
+    /**
+     * Item position
+     */
+    position: number;
+    /**
+     * Scroll size
+     */
+    scrollSize: number;
+    /**
+     * Item size
+     */
+    size: number;
+    /**
+     * Row
+     */
+    row: {
+        size: number;
+        /**
+         * Indicates that the element is odd.
+         */
+        odd: boolean;
+        /**
+         * Indicates that the element is even.
+         */
+        even: boolean;
+    };
+    /**
+     * Bounds size
+     */
+    boundsSize: number;
+    /**
+     * Start position in viewport
+     */
+    absoluteStartPosition: number;
+    /**
+     * Start position in viewport (percent)
+     */
+    absoluteStartPositionPercent: number;
+    /**
+     * End position in viewport
+     */
+    absoluteEndPosition: number;
+    /**
+     * End position in viewport (percent)
+     */
+    absoluteEndPositionPercent: number;
+    /**
+     * Scroll direction.
+     */
+    scrollDirection: ScrollDirection;
+    /**
+     * Delta is calculated for Snapping Method.ADVANCED
+     */
+    delta: number;
+}

package/lib/models/render-item.model.d.ts

@@ -1,40 +1,40 @@
-import { Id } from "../types/id";
-import { IVirtualListItem } from "./item.model";
-import { IRenderVirtualListItemConfig } from "./render-item-config.model";
-import { IRenderVirtualListItemMeasures } from "./render-item-measures.model";
-/**
- * List screen element model
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/14.x/projects/ng-virtual-list/src/lib/models/render-item.model.ts
- * @author Evgenii Alexandrovich Grebennikov
- * @email djonnyx@gmail.com
- */
-export interface IRenderVirtualListItem<E = any> {
-    /**
-     * Element index.
-     */
-    index: number;
-    /**
-     * Unique identifier of the element.
-     */
-    id: Id;
-    /**
-     * Element metrics.
-     */
-    measures: IRenderVirtualListItemMeasures;
-    /**
-     * Element data.
-     */
-    data: IVirtualListItem<E>;
-    /**
-     * Previous element data.
-     */
-    previouseData: IVirtualListItem<E>;
-    /**
-     * Next element data.
-     */
-    nextData: IVirtualListItem<E>;
-    /**
-     * Object with configuration parameters for IRenderVirtualListItem.
-     */
-    config: IRenderVirtualListItemConfig;
-}
+import { Id } from "../types/id";
+import { IVirtualListItem } from "./item.model";
+import { IRenderVirtualListItemConfig } from "./render-item-config.model";
+import { IRenderVirtualListItemMeasures } from "./render-item-measures.model";
+/**
+ * List screen element model
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/14.x/projects/ng-virtual-list/src/lib/models/render-item.model.ts
+ * @author Evgenii Alexandrovich Grebennikov
+ * @email djonnyx@gmail.com
+ */
+export interface IRenderVirtualListItem<E = any> {
+    /**
+     * Element index.
+     */
+    index: number;
+    /**
+     * Unique identifier of the element.
+     */
+    id: Id;
+    /**
+     * Element metrics.
+     */
+    measures: IRenderVirtualListItemMeasures;
+    /**
+     * Element data.
+     */
+    data: IVirtualListItem<E>;
+    /**
+     * Previous element data.
+     */
+    previouseData: IVirtualListItem<E>;
+    /**
+     * Next element data.
+     */
+    nextData: IVirtualListItem<E>;
+    /**
+     * Object with configuration parameters for IRenderVirtualListItem.
+     */
+    config: IRenderVirtualListItemConfig;
+}

package/lib/ng-virtual-list-public.service.d.ts

@@ -1,93 +1,92 @@
-import { Observable } from 'rxjs';
-import { IRenderVirtualListItem } from './models';
-import { IScrollOptions } from './interfaces';
-import { FocusAlignment, Id } from './types';
-import { FocusItemParams } from './types/focus-item-params';
-import * as i0 from "@angular/core";
-/**
- * NgVirtualListPublicService
- * Maximum performance for extremely large lists.
- * It is based on algorithms for virtualization of screen objects.
- * @link https://github.com/DjonnyX/ng-virtual-list/blob/14.x/projects/ng-virtual-list/src/lib/ng-virtual-list-publick.service.ts
- * @author Evgenii Alexandrovich Grebennikov
- * @email djonnyx@gmail.com
- */
-export declare class NgVirtualListPublicService {
-    private _internalService;
-    /**
-     * Unique list identifier.
-     */
-    get id(): number;
-    /**
-     * Informs about a click on a list item.
-     */
-    get $itemClick(): Observable<IRenderVirtualListItem<any> | null>;
-    /**
-     * Informs about the selection of a list item(s).
-     */
-    get $selectedIds(): Observable<Array<Id> | Id | null>;
-    /**
-     * Informs about the collapse (expanding) of a list element(s).
-     */
-    get $collapsedIds(): Observable<Array<Id>>;
-    /**
-     * Informs the focus on the specified list item.
-     */
-    get $focusItem(): Observable<FocusItemParams>;
-    /**
-     * Notifies about the next change detection tick. Works similarly to `setTimeout` with a timeout of 0.
-     */
-    get $tick(): Observable<void>;
-    /**
-     * Specifies a list of selected items.
-     */
-    set selectedIds(ids: Array<Id> | Id | null);
-    /**
-     * Returns a list of selected items.
-     */
-    get selectedIds(): Array<Id> | Id | null;
-    /**
-     * Specifies a list of collapsed elements.
-     */
-    set сollapsedIds(ids: Array<Id>);
-    /**
-     * Returns a list of collapsed elements.
-     */
-    get сollapsedIds(): Array<Id>;
-    /**
-     * Updates the list
-     * @param immediately - Indicates that the list is updated instantly.
-     * @param force - Forced update.
-     */
-    update(immediately?: boolean, force?: boolean): void;
-    /**
-     * Selects a list item
-     * @param id
-     * @param selected - If the value is undefined, then the toggle method is executed, if false or true, then the selection/deselection is performed.
-     */
-    select(id: Id, selected?: boolean | undefined): void;
-    /**
-      * Collapse list items
-      * @param id
-      * @param collapsed - If the value is undefined, then the toggle method is executed, if false or true, then the collapse/expand is performed.
-      */
-    collapse(id: Id, collapsed?: boolean | undefined): void;
-    /**
-     * Focus an list item by a given id.
-     */
-    focus(id: Id, align?: FocusAlignment, scrollBehavior?: ScrollBehavior): void;
-    /**
-      * The method scrolls the list to the element with the given `id` and returns the value of the scrolled area.
-      */
-    scrollTo(id: Id, cb?: (() => void) | null, options?: IScrollOptions | null): void;
-    /**
-     * Scrolls the scroll area to the first item in the collection.
-     */
-    scrollToStart(options?: IScrollOptions): void;
-    /**
-     * Scrolls the list to the end of the content size.
-     */
-    scrollToEnd(options?: IScrollOptions): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgVirtualListPublicService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<NgVirtualListPublicService>;
-}
+import { Observable } from 'rxjs';
+import { IRenderVirtualListItem } from './models';
+import { IScrollOptions } from './interfaces';
+import { FocusAlignment, Id } from './types';
+import { FocusItemParams } from './types/focus-item-params';
+import * as i0 from "@angular/core";
+/**
+ * NgVirtualListPublicService
+ * Maximum performance for extremely large lists.
+ * It is based on algorithms for virtualization of screen objects.
+ * @link https://github.com/DjonnyX/ng-virtual-list/blob/14.x/projects/ng-virtual-list/src/lib/ng-virtual-list-publick.service.ts
+ * @author Evgenii Alexandrovich Grebennikov
+ * @email djonnyx@gmail.com
+ */
+export declare class NgVirtualListPublicService {
+    private _internalService;
+    /**
+     * Unique list identifier.
+     */
+    get id(): number;
+    /**
+     * Informs about a click on a list item.
+     */
+    get $virtualClick(): Observable<IRenderVirtualListItem<any> | null>;
+    /**
+     * Informs about the selection of a list item(s).
+     */
+    get $selectedIds(): Observable<Array<Id> | Id | null>;
+    /**
+     * Informs about the collapse (expanding) of a list element(s).
+     */
+    get $collapsedIds(): Observable<Array<Id>>;
+    /**
+     * Informs the focus on the specified list item.
+     */
+    get $focusItem(): Observable<FocusItemParams>;
+    /**
+     * Notifies about the next change detection tick. Works similarly to `setTimeout` with a timeout of 0.
+     */
+    get $tick(): Observable<void>;
+    /**
+     * Specifies a list of selected items.
+     */
+    set selectedIds(ids: Array<Id> | Id | null);
+    /**
+     * Returns a list of selected items.
+     */
+    get selectedIds(): Array<Id> | Id | null;
+    /**
+     * Specifies a list of collapsed elements.
+     */
+    set collapsedIds(ids: Array<Id>);
+    /**
+     * Returns a list of collapsed elements.
+     */
+    get collapsedIds(): Array<Id>;
+    /**
+     * Updates the list
+     * @param immediately - Indicates that the list is updated instantly.
+     */
+    update(immediately?: boolean): void;
+    /**
+     * Selects a list item
+     * @param id
+     * @param selected - If the value is undefined, then the toggle method is executed, if false or true, then the selection/deselection is performed.
+     */
+    select(id: Id, selected?: boolean | undefined): void;
+    /**
+      * Collapse list items
+      * @param id
+      * @param collapsed - If the value is undefined, then the toggle method is executed, if false or true, then the collapse/expand is performed.
+      */
+    collapse(id: Id, collapsed?: boolean | undefined): void;
+    /**
+     * Focus an list item by a given id.
+     */
+    focus(id: Id, align?: FocusAlignment, scrollBehavior?: ScrollBehavior): void;
+    /**
+      * The method scrolls the list to the element with the given `id` and returns the value of the scrolled area.
+      */
+    scrollTo(id: Id, cb?: (() => void) | null, options?: IScrollOptions | null): void;
+    /**
+     * Scrolls the scroll area to the first item in the collection.
+     */
+    scrollToStart(options?: IScrollOptions): void;
+    /**
+     * Scrolls the list to the end of the content size.
+     */
+    scrollToEnd(options?: IScrollOptions): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgVirtualListPublicService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<NgVirtualListPublicService>;
+}