@vcmap/ui 5.0.1 → 5.1.0-rc.1

package/src/manager/collectionManager/collectionComponentClass.d.ts

@@ -0,0 +1,257 @@
+export default CollectionComponentClass;
+export type CollectionComponentUiOptions = {
+    id?: string | undefined;
+    title?: string | undefined;
+    /**
+     * - only supported for IndexedCollections
+     */
+    draggable?: boolean | undefined;
+    /**
+     * - adds actions to rename items from list. Sets a default titleChanged callback on all list items, which can be overwritten in the mapping function, if necessary.
+     */
+    renamable?: boolean | undefined;
+    /**
+     * - adds actions to remove items from list. Also adds a header action to delete selected, if selectable is set to true.
+     */
+    removable?: boolean | undefined;
+    selectable?: boolean | undefined;
+    singleSelect?: boolean | undefined;
+    /**
+     * - number of header action buttons rendered until overflow
+     */
+    overflowCount?: number | undefined;
+    /**
+     * - limit number of items in rendered list (more items are rendered in extra window)
+     */
+    limit?: number | undefined;
+};
+export type CollectionComponentClassOptions<T extends Object> = CollectionComponentUiOptions & {
+    collection: import("@vcmap/core").Collection<T>;
+};
+export type CollectionComponentListItem = import("../../components/lists/VcsList.vue").VcsListItem & {
+    actions: Array<import("../../actions/actionHelper.js").VcsAction & {
+        weight?: number;
+    }>;
+    clickedCallbacks: Array<(arg0: PointerEvent) => void>;
+    destroy: () => void | undefined;
+    destroyFunctions: Array<() => void>;
+};
+/**
+ * Manages one collection and creates a mirrored items array with ListItems.
+ * Listens to all collection events and synchronizes changes to the items array.
+ * The Collection Items will be transformed and filtered with the given itemMappings and itemFilter functions
+ * @class
+ * @template {Object|import("@vcmap/core").VcsObject} T
+ */
+declare class CollectionComponentClass<T extends Object | import("@vcmap/core/dist/src/vcsObject.js").default> {
+    /**
+     * @param {CollectionComponentClassOptions<T>} options
+     * @param {string|import("../../pluginHelper.js").vcsAppSymbol} owner
+     */
+    constructor(options: CollectionComponentClassOptions<T>, owner: string | symbol);
+    /**
+     * @type {import("@vcmap/core").Collection<T>}
+     * @private
+     */
+    private _collection;
+    /**
+     * @type {string}
+     * @private
+     */
+    private _id;
+    /**
+     * @type {import("vue").Ref<string>}
+     */
+    title: import("vue").Ref<string>;
+    /**
+     * @type {import("vue").Ref<boolean>}
+     */
+    open: import("vue").Ref<boolean>;
+    /**
+     *
+     * @type {import("vue").Ref<number>}
+     */
+    overflowCount: import("vue").Ref<number>;
+    /**
+     *
+     * @type {import("vue").Ref<number>}
+     */
+    limit: import("vue").Ref<number>;
+    /**
+     * @type {import("vue").Ref<boolean>}
+     * @private
+     */
+    private _draggable;
+    /**
+     * @type {import("vue").Ref<boolean>}
+     */
+    renamable: import("vue").Ref<boolean>;
+    /**
+     * @type {import("vue").Ref<boolean>}
+     */
+    removable: import("vue").Ref<boolean>;
+    /**
+     * @type {import("vue").Ref<boolean>}
+     */
+    selectable: import("vue").Ref<boolean>;
+    /**
+     * @type {import("vue").Ref<boolean>}
+     */
+    singleSelect: import("vue").Ref<boolean>;
+    /**
+     * @type {string|vcsAppSymbol}
+     * @private
+     */
+    private _owner;
+    /**
+     * @type {import("vue").Ref<Array<import("./collectionManager.js").OwnedAction>>}
+     */
+    _actions: import("vue").Ref<Array<import("./collectionManager.js").OwnedAction>>;
+    /**
+     * @type {Array<import("./collectionManager.js").ItemMapping<T>>}
+     * @private
+     */
+    private _itemMappings;
+    /**
+     * @type {Array<import("./collectionManager.js").ItemFilter<T>>}
+     * @private
+     */
+    private _itemFilters;
+    /**
+     * @type {import("vue").Ref<Array<CollectionComponentListItem>>}
+     * @private
+     */
+    private _listItems;
+    /**
+     * @type {import("vue").Ref<Array<CollectionComponentListItem>>}
+     */
+    selection: import("vue").Ref<Array<CollectionComponentListItem>>;
+    _resetWatchers: import("vue").WatchStopHandle[];
+    _destroyBulkDelete: () => void;
+    _listeners: (() => void)[];
+    /**
+     * @type {string}
+     */
+    get id(): string;
+    /**
+     * @type {import("@vcmap/core").Collection<T>}
+     */
+    get collection(): import("@vcmap/core/dist/src/util/collection.js").default<T>;
+    /**
+     * @type {import("vue").Ref<Array<CollectionComponentListItem>>}
+     */
+    get items(): import("vue").Ref<CollectionComponentListItem[]>;
+    /**
+     * @param {boolean} value
+     * @deprecated
+     */
+    set draggable(arg: import("vue").Ref<boolean>);
+    /**
+     * @type {import("vue").Ref<boolean>}
+     */
+    get draggable(): import("vue").Ref<boolean>;
+    /**
+     * @type {string|import("../../pluginHelper.js").vcsAppSymbol}
+     */
+    get owner(): string | symbol;
+    /**
+     * @returns {import("vue").ComputedRef<import("../../actions/actionHelper.js").VcsAction[]>}
+     */
+    getActions(): import("vue").ComputedRef<import("../../actions/actionHelper.js").VcsAction[]>;
+    /**
+     * @private
+     */
+    private _addBulkDeleteAction;
+    /**
+     * @private
+     */
+    private _removeBulkDeleteAction;
+    /**
+     * uses the itemMappings to transform the given Item to an CollectionComponentListItem usable in the VcsList
+     * @param {T} item
+     * @returns {CollectionComponentListItem}
+     * @template T
+     * @private
+     */
+    private _transformItem;
+    /**
+     * Inserts the listItem into the list items array at the correct relative position in respect to the position of the listItem
+     * in the collection
+     * @param {CollectionComponentListItem} listItem
+     * @private
+     */
+    private _insertListItem;
+    /**
+     * synchronizes the collection items with the internal items list.
+     * @param {T} item
+     * @template T
+     * @private
+     */
+    private _handleItemAdded;
+    /**
+     * synchronizes the collection items with the internal items list by preserving previous selection
+     * @param {import("@vcmap/core").ReplacedEvent<T>} replaced
+     * @private
+     */
+    private _handleItemReplaced;
+    /**
+     * synchronizes the order of the list items with respect to the order of the items in the collection.
+     * removes and reinserts the moved item.
+     * @param {T} item
+     * @template T
+     * @private
+     */
+    private _handleItemMoved;
+    /**
+     * synchronizes the collection items with the internal list items.
+     * @param {T} item
+     * @template T
+     * @private
+     */
+    private _handleItemRemoved;
+    /**
+     * @param {T} item
+     * @template T
+     * @returns {CollectionComponentListItem|undefined}
+     */
+    getListItemForItem<T_1>(item: T_1): CollectionComponentListItem | undefined;
+    /**
+     * recreates the items array with the new Mapping Function
+     * @param {import("./collectionManager.js").ItemMapping<T>} itemMapping
+     */
+    addItemMapping(itemMapping: import("./collectionManager.js").ItemMapping<T>): void;
+    /**
+     * recreates the items array with the new Mapping Function
+     * @param {import("./collectionManager.js").ItemMapping<T>} itemMapping
+     */
+    removeItemMapping(itemMapping: import("./collectionManager.js").ItemMapping<T>): void;
+    /**
+     * recreates the items array with the new Filter Function
+     * @param {import("./collectionManager.js").ItemFilter<T>} itemFilter
+     */
+    addItemFilter(itemFilter: import("./collectionManager.js").ItemFilter<T>): void;
+    /**
+     * recreates the items array with the new Filter Function
+     * @param {import("./collectionManager.js").ItemFilter<T>} itemFilter
+     */
+    removeItemFilter(itemFilter: import("./collectionManager.js").ItemFilter<T>): void;
+    /**
+     * @param {Array<import("./collectionManager.js").OwnedAction>} ownedActions
+     */
+    addActions(ownedActions: Array<import("./collectionManager.js").OwnedAction>): void;
+    /**
+     * @param {Array<import("./collectionManager.js").OwnedAction>} ownedActions
+     */
+    removeActions(ownedActions: Array<import("./collectionManager.js").OwnedAction>): void;
+    /**
+     * removes itemMapping, itemFilter and actions of provided owner and resets all list items
+     * @param {string | symbol} owner
+     */
+    removeOwner(owner: string | symbol): void;
+    /**
+     * resets this collection component by destroying all list items and
+     * re-adding them from the collection applying current filter and mapping functions
+     */
+    reset(): void;
+    destroy(): void;
+}