@swimlane/ngx-datatable 21.0.0 → 22.0.0-alpha.0

package/lib/types/table-column.type.d.ts

@@ -1,163 +0,0 @@
-import { PipeTransform, TemplateRef } from '@angular/core';
-import { ValueGetter } from '../utils/column-prop-getters';
-import { CellContext, HeaderCellContext } from './public.types';
-/**
- * Column property that indicates how to retrieve this column's
- * value from a row.
- * 'a.deep.value', 'normalprop', 0 (numeric)
- */
-export type TableColumnProp = string | number;
-/**
- * Column Type
- */
-export interface TableColumn<TRow = any> {
-    /**
-     * Internal unique id
-     */
-    $$id?: string;
-    /**
-     * Internal for column width distributions
-     */
-    $$oldWidth?: number;
-    /**
-     * Internal for setColumnDefaults
-     */
-    $$valueGetter?: ValueGetter;
-    /**
-     * Determines if column is checkbox
-     */
-    checkboxable?: boolean;
-    /**
-     * Determines if the column is frozen to the left
-     */
-    frozenLeft?: boolean;
-    /**
-     * Determines if the column is frozen to the right
-     */
-    frozenRight?: boolean;
-    /**
-     * The grow factor relative to other columns. Same as the flex-grow
-     * API from http =//www.w3.org/TR/css3-flexbox/. Basically;
-     * take any available extra width and distribute it proportionally
-     * according to all columns' flexGrow values.
-     */
-    flexGrow?: number;
-    /**
-     * Min width of the column
-     */
-    minWidth?: number;
-    /**
-     * Max width of the column
-     */
-    maxWidth?: number;
-    /**
-     * The default width of the column, in pixels
-     */
-    width?: number;
-    /**
-     * Can the column be resized
-     */
-    resizeable?: boolean;
-    /**
-     * Custom sort comparator
-     */
-    comparator?: any;
-    /**
-     * Custom pipe transforms
-     */
-    pipe?: PipeTransform;
-    /**
-     * Can the column be sorted
-     */
-    sortable?: boolean;
-    /**
-     * Can the column be re-arranged by dragging
-     */
-    draggable?: boolean;
-    /** @internal */
-    dragging?: boolean;
-    /** @internal */
-    isTarget?: boolean;
-    /** @internal */
-    targetMarkerContext?: any;
-    /**
-     * Whether the column can automatically resize to fill space in the table.
-     */
-    canAutoResize?: boolean;
-    /**
-     * Column name or label
-     */
-    name?: string;
-    /**
-     * Property to bind to the row. Example:
-     *
-     * `someField` or `some.field.nested`, 0 (numeric)
-     *
-     * If left blank, will use the name as camel case conversion
-     */
-    prop?: TableColumnProp;
-    /**
-     * By default, the property is bound using normal data binding `<span>{{content}}</span>`.
-     * If this property is set to true, the property will be bound as `<span [innerHTML]="content" />`.
-     *
-     * **DANGER** If enabling this feature, make sure the source of the data is trusted. This can be a vector for HTML injection attacks.
-     */
-    bindAsUnsafeHtml?: boolean;
-    /**
-     * Cell template ref
-     */
-    cellTemplate?: TemplateRef<CellContext<TRow>>;
-    /**
-     * Ghost Cell template ref
-     */
-    ghostCellTemplate?: TemplateRef<any>;
-    /**
-     * Header template ref
-     */
-    headerTemplate?: TemplateRef<HeaderCellContext>;
-    /**
-     * Tree toggle template ref
-     */
-    treeToggleTemplate?: any;
-    /**
-     * CSS Classes for the cell
-     */
-    cellClass?: string | ((data: {
-        row: TRow;
-        group?: TRow[];
-        column: TableColumn<TRow>;
-        value: any;
-        rowHeight: number;
-    }) => string | Record<string, boolean>);
-    /**
-     * CSS classes for the header
-     */
-    headerClass?: string | ((data: {
-        column: TableColumn;
-    }) => string | Record<string, boolean>);
-    /**
-     * Header checkbox enabled
-     */
-    headerCheckboxable?: boolean;
-    /**
-     * Is tree displayed on this column
-     */
-    isTreeColumn?: boolean;
-    /**
-     * Width of the tree level indent
-     */
-    treeLevelIndent?: number;
-    /**
-     * Summary function
-     */
-    summaryFunc?: (cells: any[]) => any;
-    /**
-     * Summary cell template ref
-     */
-    summaryTemplate?: TemplateRef<any>;
-}
-export interface TableColumnGroup {
-    left: TableColumn[];
-    center: TableColumn[];
-    right: TableColumn[];
-}

package/lib/utils/camel-case.d.ts

@@ -1,10 +0,0 @@
-/**
- * Converts strings from something to camel case
- * http://stackoverflow.com/questions/10425287/convert-dash-separated-string-to-camelcase
- */
-export declare function camelCase(str: string): string;
-/**
- * Converts strings from camel case to words
- * http://stackoverflow.com/questions/7225407/convert-camelcasetext-to-camel-case-text
- */
-export declare function deCamelCase(str: string): string;

package/lib/utils/column-helper.d.ts

@@ -1,11 +0,0 @@
-import { TableColumn } from '../types/table-column.type';
-import { DataTableColumnDirective } from '../components/columns/column.directive';
-/**
- * Sets the column defaults
- */
-export declare function setColumnDefaults(columns: TableColumn[], defaultColumnWidth?: number): void;
-export declare function isNullOrUndefined<T>(value: T | null | undefined): value is null | undefined;
-/**
- * Translates templates definitions to objects
- */
-export declare function translateTemplates<TRow>(templates: DataTableColumnDirective<TRow>[]): TableColumn[];

package/lib/utils/column-prop-getters.d.ts

@@ -1,29 +0,0 @@
-import { TableColumnProp } from '../types/table-column.type';
-export type ValueGetter = (obj: any, prop: TableColumnProp) => any;
-/**
- * Always returns the empty string ''
- */
-export declare function emptyStringGetter(): string;
-/**
- * Returns the appropriate getter function for this kind of prop.
- * If prop == null, returns the emptyStringGetter.
- */
-export declare function getterForProp(prop: TableColumnProp): ValueGetter;
-/**
- * Returns the value at this numeric index.
- * @param row array of values
- * @param index numeric index
- * @returns any or '' if invalid index
- */
-export declare function numericIndexGetter(row: any[], index: number): any;
-/**
- * Returns the value of a field.
- * (more efficient than deepValueGetter)
- * @param obj object containing the field
- * @param fieldName field name string
- */
-export declare function shallowValueGetter(obj: any, fieldName: string): any;
-/**
- * Returns a deep object given a string. zoo['animal.type']
- */
-export declare function deepValueGetter(obj: any, path: string): any;

package/lib/utils/column.d.ts

@@ -1,19 +0,0 @@
-import { TableColumn, TableColumnGroup } from '../types/table-column.type';
-import { ColumnGroupWidth, PinnedColumns } from '../types/internal.types';
-/**
- * Returns the columns by pin.
- */
-export declare function columnsByPin(cols: TableColumn[]): TableColumnGroup;
-/**
- * Returns the widths of all group sets of a column
- */
-export declare function columnGroupWidths(groups: TableColumnGroup, all: TableColumn[]): ColumnGroupWidth;
-/**
- * Calculates the total width of all columns and their groups
- */
-export declare function columnTotalWidth(columns: TableColumn[], prop?: string): number;
-/**
- * Calculates the total width of all columns and their groups
- */
-export declare function columnsTotalWidth(columns: TableColumn[], prop?: keyof TableColumn): number;
-export declare function columnsByPinArr(val: TableColumn[]): PinnedColumns[];

package/lib/utils/id.d.ts

@@ -1,5 +0,0 @@
-/**
- * Creates a unique object id.
- * http://stackoverflow.com/questions/6248666/how-to-generate-short-uid-like-ax4j9z-in-js
- */
-export declare function id(): string;

package/lib/utils/keys.d.ts

@@ -1,8 +0,0 @@
-export declare enum Keys {
-    up = "ArrowUp",
-    down = "ArrowDown",
-    return = "Enter",
-    escape = "Escape",
-    left = "ArrowLeft",
-    right = "ArrowRight"
-}

package/lib/utils/math.d.ts

@@ -1,30 +0,0 @@
-import { TableColumn } from '../types/table-column.type';
-/**
- * Calculates the Total Flex Grow
- */
-export declare function getTotalFlexGrow(columns: TableColumn[]): number;
-/**
- * Adjusts the column widths.
- * Inspired by: https://github.com/facebook/fixed-data-table/blob/master/src/FixedDataTableWidthHelper.js
- */
-export declare function adjustColumnWidths(allColumns: TableColumn[], expectedWidth: number): void;
-/**
- * Forces the width of the columns to
- * distribute equally but overflowing when necessary
- *
- * Rules:
- *
- *  - If combined withs are less than the total width of the grid,
- *    proportion the widths given the min / max / normal widths to fill the width.
- *
- *  - If the combined widths, exceed the total width of the grid,
- *    use the standard widths.
- *
- *  - If a column is resized, it should always use that width
- *
- *  - The proportional widths should never fall below min size if specified.
- *
- *  - If the grid starts off small but then becomes greater than the size ( + / - )
- *    the width should use the original width; not the newly proportioned widths.
- */
-export declare function forceFillColumnWidths(allColumns: TableColumn[], expectedWidth: number, startIdx: number, allowBleed: boolean, defaultColWidth?: number, verticalScrollWidth?: number): void;

package/lib/utils/row-height-cache.d.ts

@@ -1,52 +0,0 @@
-/**
- * This object contains the cache of the various row heights that are present inside
- * the data table.   Its based on Fenwick tree data structure that helps with
- * querying sums that have time complexity of log n.
- *
- * Fenwick Tree Credits: http://petr-mitrichev.blogspot.com/2013/05/fenwick-tree-range-updates.html
- * https://github.com/mikolalysenko/fenwick-tree
- *
- */
-export declare class RowHeightCache {
-    /**
-     * Tree Array stores the cumulative information of the row heights to perform efficient
-     * range queries and updates.  Currently the tree is initialized to the base row
-     * height instead of the detail row height.
-     */
-    private treeArray;
-    /**
-     * Clear the Tree array.
-     */
-    clearCache(): void;
-    /**
-     * Initialize the Fenwick tree with row Heights.
-     *
-     * @param rows The array of rows which contain the expanded status.
-     * @param rowHeight The row height.
-     * @param detailRowHeight The detail row height.
-     */
-    initCache(details: any): void;
-    /**
-     * Given the ScrollY position i.e. sum, provide the rowIndex
-     * that is present in the current view port.  Below handles edge cases.
-     */
-    getRowIndex(scrollY: number): number;
-    /**
-     * When a row is expanded or rowHeight is changed, update the height.  This can
-     * be utilized in future when Angular Data table supports dynamic row heights.
-     */
-    update(atRowIndex: number, byRowHeight: number): void;
-    /**
-     * Range Sum query from 1 to the rowIndex
-     */
-    query(atIndex: number): number;
-    /**
-     * Find the total height between 2 row indexes
-     */
-    queryBetween(atIndexA: number, atIndexB: number): number;
-    /**
-     * Given the ScrollY position i.e. sum, provide the rowIndex
-     * that is present in the current view port.
-     */
-    private calcRowIndex;
-}

package/lib/utils/selection.d.ts

@@ -1,2 +0,0 @@
-export declare function selectRows<TRow>(selected: TRow[], row: TRow, comparefn: any): TRow[];
-export declare function selectRowsBetween<TRow>(selected: TRow[], rows: TRow[], index: number, prevIndex: number): TRow[];

package/lib/utils/sort.d.ts

@@ -1,17 +0,0 @@
-import { Group, SortDirection, SortPropDir, SortType } from '../types/public.types';
-import { TableColumn } from '../types/table-column.type';
-/**
- * Gets the next sort direction
- */
-export declare function nextSortDir(sortType: SortType, current: SortDirection | 'desc' | 'asc'): SortDirection | undefined;
-/**
- * Adapted from fueld-ui on 6/216
- * https://github.com/FuelInteractive/fuel-ui/tree/master/src/pipes/OrderBy
- */
-export declare function orderByComparator(a: any, b: any): number;
-/**
- * creates a shallow copy of the `rows` input and returns the sorted copy. this function
- * does not sort the `rows` argument in place
- */
-export declare function sortRows<TRow>(rows: TRow[], columns: TableColumn[], dirs: SortPropDir[]): TRow[];
-export declare function sortGroupedRows<TRow>(groupedRows: Group<TRow>[], columns: TableColumn[], dirs: SortPropDir[], sortOnGroupHeader: SortPropDir): Group<TRow>[];

package/lib/utils/table-token.d.ts

@@ -1,7 +0,0 @@
-import { InjectionToken } from '@angular/core';
-import type { DatatableComponent } from '../components/datatable.component';
-/**
- * This token is created to break cycling import error which occurs when we import
- * DatatableComponent in DataTableRowWrapperComponent.
- */
-export declare const DatatableComponentToken: InjectionToken<DatatableComponent<any>>;

package/lib/utils/throttle.d.ts

@@ -1,17 +0,0 @@
-/**
- * Throttle a function
- */
-export declare function throttle(func: any, wait: number, options?: any): (this: any) => any;
-/**
- * Throttle decorator
- *
- *  class MyClass {
- *    throttleable(10)
- *    myFn() { ... }
- *  }
- */
-export declare function throttleable(duration: number, options?: any): (target: any, key: PropertyKey, descriptor: PropertyDescriptor) => {
-    configurable: boolean;
-    enumerable: boolean;
-    get: () => any;
-};

package/lib/utils/tree.d.ts

@@ -1,40 +0,0 @@
-import { TableColumnProp } from '../types/table-column.type';
-export type OptionalValueGetter = (row: any) => any | undefined;
-export declare function optionalGetterForProp(prop: TableColumnProp): OptionalValueGetter;
-/**
- * This functions rearrange items by their parents
- * Also sets the level value to each of the items
- *
- * Note: Expecting each item has a property called parentId
- * Note: This algorithm will fail if a list has two or more items with same ID
- * NOTE: This algorithm will fail if there is a deadlock of relationship
- *
- * For example,
- *
- * Input
- *
- * id -> parent
- * 1  -> 0
- * 2  -> 0
- * 3  -> 1
- * 4  -> 1
- * 5  -> 2
- * 7  -> 8
- * 6  -> 3
- *
- *
- * Output
- * id -> level
- * 1      -> 0
- * --3    -> 1
- * ----6  -> 2
- * --4    -> 1
- * 2      -> 0
- * --5    -> 1
- * 7     -> 8
- *
- *
- * @param rows
- *
- */
-export declare function groupRowsByParents<TRow>(rows: TRow[], from?: OptionalValueGetter, to?: OptionalValueGetter): TRow[];

package/public-api.d.ts

@@ -1,48 +0,0 @@
-export * from './lib/ngx-datatable.module';
-export * from './lib/components/datatable.component';
-export * from './lib/components/header/header.component';
-export * from './lib/components/header/header-cell.component';
-export * from './lib/components/body/body.component';
-export * from './lib/components/body/body-cell.component';
-export * from './lib/components/body/body-row.component';
-export * from './lib/components/body/progress-bar.component';
-export * from './lib/components/body/scroller.component';
-export * from './lib/components/body/body-row-wrapper.component';
-export * from './lib/components/body/selection.component';
-export * from './lib/components/body/body-group-header.directive';
-export * from './lib/components/body/body-group-header-template.directive';
-export * from './lib/components/body/summary/summary-row.component';
-export * from './lib/components/footer/footer.component';
-export * from './lib/components/footer/pager.component';
-export * from './lib/components/footer/footer.directive';
-export * from './lib/components/footer/footer-template.directive';
-export * from './lib/components/columns/column.directive';
-export * from './lib/components/columns/column-header.directive';
-export * from './lib/components/columns/column-cell.directive';
-export * from './lib/components/columns/column-ghost-cell.directive';
-export * from './lib/components/columns/tree.directive';
-export * from './lib/components/row-detail/row-detail.directive';
-export * from './lib/components/row-detail/row-detail-template.directive';
-export * from './lib/components/body/body-row-def.component';
-export * from './lib/directives/draggable.directive';
-export * from './lib/directives/long-press.directive';
-export * from './lib/directives/orderable.directive';
-export * from './lib/directives/resizeable.directive';
-export * from './lib/directives/visibility.directive';
-export * from './lib/directives/disable-row.directive';
-export * from './lib/services/scrollbar-helper.service';
-export * from './lib/services/column-changes.service';
-export * from './lib/types/public.types';
-export * from './lib/types/table-column.type';
-export * from './lib/utils/id';
-export * from './lib/utils/column';
-export * from './lib/utils/column-prop-getters';
-export * from './lib/utils/camel-case';
-export * from './lib/utils/keys';
-export * from './lib/utils/math';
-export * from './lib/utils/selection';
-export * from './lib/utils/throttle';
-export * from './lib/utils/sort';
-export * from './lib/utils/row-height-cache';
-export * from './lib/utils/column-helper';
-export * from './lib/utils/tree';