@mediusinc/mng-commons 0.21.1 → 1.0.0

package/lib/descriptors/table.descriptor.d.ts

@@ -1,182 +1,188 @@
-import { Type } from '@angular/core';
-import { MediusQueryResult } from '../api/models';
-import { ILookupDataProvider } from '../data-providers';
-import { IColumnValueComponent } from '../models';
-import { TableviewAttributeDef } from '../models/tableview-attr.model';
-import { ClassType, EnumType } from '../types';
-import { ColumnDescriptor, ColumnDynamicDescriptor } from './column.descriptor';
-import { ModelDescriptor } from './model.descriptor';
-import { ColumnDisplayTypeEnum, ColumnTypeEnum, TableDynamicColumnsModeEnum, TableFilterDisplayEnum, TablePaginationModeEnum, TableSizeEnum } from './types';
-export declare class TableDescriptor<T> {
-    private readonly _model;
-    private _modelType;
-    private _filterDisplay;
-    private _paginationMode?;
-    private _rowsPerPageOptions;
-    private _defaultNumRows;
-    protected _columns: Array<ColumnDescriptor<any, T>>;
-    private _title?;
-    private _hideHeader;
-    private _dataKeyProperty?;
-    private _hasDefaultSort;
-    private _defaultSortProperty;
-    private _defaultSortAsc;
-    private _className;
-    private _size;
-    private _tableFullHeightOffset?;
-    private _rowHeight?;
-    private _hasHover;
-    private _hasGridlines;
-    private _headerClassName?;
-    private _rowClassName?;
-    private _rowClassNameMapFn?;
-    private _autoGenerated;
-    constructor(modelType: ClassType<T>, idProperty?: string, titleProperty?: string, i18nBaseKey?: string | ClassType<unknown>);
-    /**
-     * generates descriptor based on modelType attribute definition
-     * @param modelType class type
-     * @param idProperty
-     * @param titleProperty
-     */
-    static from<T>(modelType: ClassType<T>, idProperty?: string, titleProperty?: string): TableDescriptor<T>;
-    /**
-     * generates descriptor base on given attribute definition
-     * @param modelType class type
-     * @param attributes attributes from which descriptor is generated
-     * @param idProperty
-     * @param titleProperty
-     */
-    static fromModelWithAttributes<T>(modelType: ClassType<T>, attributes: TableviewAttributeDef[], idProperty?: string, titleProperty?: string): TableDescriptor<T>;
-    get filterDisplay(): TableFilterDisplayEnum;
-    get paginationMode(): TablePaginationModeEnum | undefined;
-    get rowsPerPageOptions(): number[];
-    get defaultNumRows(): number;
-    get columns(): ColumnDescriptor<any, T>[];
-    get title(): string | undefined;
-    get hideHeader(): boolean;
-    get dataKeyProperty(): string | undefined;
-    get hasDefaultSort(): boolean;
-    get defaultSortProperty(): string[];
-    get defaultSortAsc(): boolean[];
-    get model(): ModelDescriptor<T>;
-    get className(): string;
-    get size(): TableSizeEnum;
-    get tableFullHeightOffset(): number | undefined;
-    get rowHeight(): number | undefined;
-    get hasHover(): boolean;
-    get hasGridlines(): boolean;
-    get rowClassName(): string | undefined;
-    get rowClassNameMapFn(): ((className?: string | undefined, item?: T | undefined) => string) | undefined;
-    get headerClassName(): string | undefined;
-    getColumn(property: string): ColumnDescriptor<string, T> | undefined;
-    addColumnDescriptor<CT>(column: ColumnDescriptor<CT, T>): TableDescriptor<T>;
-    addColumn(property: string): ColumnDescriptor<string, T>;
-    addColumnNumber(property: string, displayFormat?: string): ColumnDescriptor<number, T>;
-    addColumnDate(property: string, displayFormat?: string): ColumnDescriptor<Date, T>;
-    addColumnBoolean(property: string, yes?: string, no?: string, asIcon?: boolean): ColumnDescriptor<boolean, T>;
-    addColumnEnum(property: string, enumType: EnumType, nameAsValue?: boolean, titlePath?: string | null): ColumnDescriptor<EnumType, T>;
-    addColumnCustomComponent(property: string, customComponentType: Type<IColumnValueComponent<T>>): ColumnDescriptor<any, T>;
-    removeColumn(property: string): void;
-    withFilterDisplay(filterDisplayType: TableFilterDisplayEnum): this;
-    withPaginationMode(paginationMode: TablePaginationModeEnum): this;
-    withRowsPerPage(rows: number, options?: Array<number>): this;
-    withTitle(title: string): this;
-    withHideHeader(hideHeader?: boolean): this;
-    withDataKeyProperty(property: string): this;
-    withDefaultSort(property: string, asc?: boolean): this;
-    withClassName(className: string): this;
-    withSize(size?: TableSizeEnum): this;
-    withTableFullHeightOffset(tableFullHeightOffset: number): this;
-    withRowHeight(rowHeight: number): this;
-    withHover(hover: boolean): this;
-    withGridlines(gridlines: boolean): this;
-    withRowClassName(rowClassName?: string, classNameMapFn?: (className?: string, item?: T) => string): this;
-    withHeaderClassName(headerClassName: string): this;
-    protected copyFieldsTo(obj: TableDescriptor<T>): void;
-    copy(): TableDescriptor<T>;
-    /**
-     * generates column based on attributes
-     * @param attribute attribute map
-     * @param column if provided, replaced by new, otherwise new is created
-     * @param args additional parameters
-     */
-    private upsertColumnFromAttributeDef;
-    /**
-     * defines modified type of column
-     * DO NOT USE with enum (use withCustomEnumType)
-     * @param property column name
-     * @param columnType modified type
-     * @param args additional attributes
-     */
-    withColumnModifiedType(property: string, columnType?: ColumnTypeEnum, columnDisplayType?: ColumnDisplayTypeEnum, ...args: any[]): this;
-    /**
-     * defines custom enum type for column
-     * @param property column name
-     * @param enumType
-     */
-    withColumnModifiedEnum(property: string, enumType?: EnumType): this;
-    /**
-     * modifies column with class and lookup provider
-     * @param property column name
-     * @param lookupProvider lookupProvider for class
-     * @param itemsLabelProperty
-     * @param filterProperty
-     */
-    withColumnModifiedLookup(property: string, lookupProvider: ILookupDataProvider<any, any>, itemsLabelProperty?: string, filterProperty?: string): this;
-}
-export declare class TableDynamicDescriptor extends TableDescriptor<any> {
-    private _excludedColumns;
-    private _filterColumns;
-    private _sortColumns;
-    private _sortColumnMode;
-    private _filterColumnMode;
-    protected _columns: ColumnDynamicDescriptor[];
-    constructor(idProperty?: string, titleProperty?: string);
-    get columns(): ColumnDynamicDescriptor[];
-    /**
-     * defines excluded columns when generating descriptor
-     * @param excludedColumn names of excluded columns
-     */
-    withColumnsExcluded(excludedColumn: string[]): this;
-    /**
-     * defines column properties on which sort is defined or not depending on sortColumnMode
-     * @param sortOnColumns column names
-     * @param sortColumnMode INCLUDE_ONLY (default) only given columns will have sort, EXCLUDE given columns will NOT have sort
-     */
-    withColumnsSort(sortOnColumns: string[], sortColumnMode?: TableDynamicColumnsModeEnum): this;
-    /**
-     * defines column properties on which filter is defined or not depending on filterColumnMode
-     * @param filterOnColumn column names
-     * @param filterColumnMode INCLUDE_ONLY (default) only given columns will have filter, EXCLUDE given columns will NOT have filter
-     */
-    withColumnsFilter(filterOnColumn: string[], filterColumnMode?: TableDynamicColumnsModeEnum): this;
-    /**
-     * sets given type to column with given property and returns this table
-     * @param property column's property
-     * @param type custom type for column
-     * @param args addition arguments for column
-     */
-    withColumnModifiedType(property: string, type: ColumnTypeEnum, displayType?: ColumnDisplayTypeEnum, ...args: any[]): this;
-    /**
-     * sets title to column with given property and returns this table
-     * @param property column's property
-     * @param title column's title
-     */
-    withColumnTitle(property: string, title: string): this;
-    /**
-     * generates columns defined on table based on data fetched from api
-     * @param data data from api
-     */
-    toTableDescriptorFromData(data: MediusQueryResult<any>): TableDescriptor<any>;
-    /**
-     * adds ColumnDynamicDescriptor to this table
-     * @param property column's property
-     */
-    addColumn(property: string): ColumnDynamicDescriptor;
-    removeColumn(property: string): this;
-    /**
-     * creates deep copy of table dynamic descriptor
-     */
-    copy(): TableDynamicDescriptor;
-    toTableDescriptor(): TableDescriptor<any>;
-}
+import { Type } from '@angular/core';
+import { MediusQueryResult } from '../api/models';
+import { ILookupDataProvider } from '../data-providers';
+import { IColumnValueComponent } from '../models';
+import { TableviewAttributeDef } from '../models/tableview-attr.model';
+import { ClassType, EnumType } from '../types';
+import { ColumnDescriptor, ColumnDynamicDescriptor } from './column.descriptor';
+import { ModelDescriptor } from './model.descriptor';
+import { ColumnDisplayTypeEnum, ColumnTypeEnum, TableDynamicColumnsModeEnum, TableFilterDisplayEnum, TablePaginationModeEnum, TableSizeEnum } from './types';
+export declare class TableDescriptor<T> {
+    private readonly _model;
+    private _modelType;
+    private _filterDisplay;
+    private _paginationMode?;
+    private _rowsPerPageOptions;
+    private _defaultNumRows;
+    protected _columns: Array<ColumnDescriptor<any, T>>;
+    private _title?;
+    private _hideHeader;
+    private _dataKeyProperty?;
+    private _hasDefaultSort;
+    private _defaultSortProperty;
+    private _defaultSortAsc;
+    private _className;
+    private _size;
+    private _tableFullHeightOffset?;
+    private _rowHeight?;
+    private _hasHover;
+    private _hasGridlines;
+    private _headerClassName?;
+    private _rowClassName?;
+    private _rowClassNameMapFn?;
+    private _autoGenerated;
+    private _isLocalized;
+    private _localizationLocaleProperty?;
+    constructor(modelType: ClassType<T>, idProperty?: string, titleProperty?: string, i18nBaseKey?: string | ClassType<unknown>);
+    /**
+     * generates descriptor based on modelType attribute definition
+     * @param modelType class type
+     * @param idProperty
+     * @param titleProperty
+     */
+    static from<T>(modelType: ClassType<T>, idProperty?: string, titleProperty?: string): TableDescriptor<T>;
+    /**
+     * generates descriptor base on given attribute definition
+     * @param modelType class type
+     * @param attributes attributes from which descriptor is generated
+     * @param idProperty
+     * @param titleProperty
+     */
+    static fromModelWithAttributes<T>(modelType: ClassType<T>, attributes: TableviewAttributeDef[], idProperty?: string, titleProperty?: string): TableDescriptor<T>;
+    get filterDisplay(): TableFilterDisplayEnum;
+    get paginationMode(): TablePaginationModeEnum | undefined;
+    get rowsPerPageOptions(): number[];
+    get defaultNumRows(): number;
+    get columns(): ColumnDescriptor<any, T>[];
+    get title(): string | undefined;
+    get hideHeader(): boolean;
+    get dataKeyProperty(): string | undefined;
+    get hasDefaultSort(): boolean;
+    get defaultSortProperty(): string[];
+    get defaultSortAsc(): boolean[];
+    get model(): ModelDescriptor<T>;
+    get className(): string;
+    get size(): TableSizeEnum;
+    get tableFullHeightOffset(): number | undefined;
+    get rowHeight(): number | undefined;
+    get hasHover(): boolean;
+    get hasGridlines(): boolean;
+    get rowClassName(): string | undefined;
+    get rowClassNameMapFn(): ((className?: string | undefined, item?: T | undefined) => string) | undefined;
+    get headerClassName(): string | undefined;
+    get isLocalized(): boolean;
+    get localizationLocaleProperty(): string | undefined;
+    getColumn(property: string): ColumnDescriptor<string, T> | undefined;
+    addColumnDescriptor<CT>(column: ColumnDescriptor<CT, T>): TableDescriptor<T>;
+    addColumn(property: string): ColumnDescriptor<string, T>;
+    addColumnNumber(property: string, displayFormat?: string): ColumnDescriptor<number, T>;
+    addColumnDate(property: string, displayFormat?: string): ColumnDescriptor<Date, T>;
+    addColumnBoolean(property: string, yes?: string, no?: string, asIcon?: boolean): ColumnDescriptor<boolean, T>;
+    addColumnEnum(property: string, enumType: EnumType, nameAsValue?: boolean, titlePath?: string | null): ColumnDescriptor<EnumType, T>;
+    addColumnCustomComponent(property: string, customComponentType: Type<IColumnValueComponent<T>>): ColumnDescriptor<any, T>;
+    removeColumn(property: string): void;
+    withFilterDisplay(filterDisplayType: TableFilterDisplayEnum): this;
+    withPaginationMode(paginationMode: TablePaginationModeEnum): this;
+    withRowsPerPage(rows: number, options?: Array<number>): this;
+    withTitle(title: string): this;
+    withHideHeader(hideHeader?: boolean): this;
+    withDataKeyProperty(property: string): this;
+    withDefaultSort(property: string, asc?: boolean): this;
+    withClassName(className: string): this;
+    withSize(size?: TableSizeEnum): this;
+    withTableFullHeightOffset(tableFullHeightOffset: number): this;
+    withRowHeight(rowHeight: number): this;
+    withHover(hover: boolean): this;
+    withGridlines(gridlines: boolean): this;
+    withRowClassName(rowClassName?: string, classNameMapFn?: (className?: string, item?: T) => string): this;
+    withHeaderClassName(headerClassName: string): this;
+    withLocalized(): this;
+    withLocalizationLocaleProperty(localizationLocaleProperty: string): this;
+    protected copyFieldsTo(obj: TableDescriptor<T>): void;
+    copy(): TableDescriptor<T>;
+    /**
+     * generates column based on attributes
+     * @param attribute attribute map
+     * @param column if provided, replaced by new, otherwise new is created
+     * @param args additional parameters
+     */
+    private upsertColumnFromAttributeDef;
+    /**
+     * defines modified type of column
+     * DO NOT USE with enum (use withCustomEnumType)
+     * @param property column name
+     * @param columnType modified type
+     * @param args additional attributes
+     */
+    withColumnModifiedType(property: string, columnType?: ColumnTypeEnum, columnDisplayType?: ColumnDisplayTypeEnum, ...args: any[]): this;
+    /**
+     * defines custom enum type for column
+     * @param property column name
+     * @param enumType
+     */
+    withColumnModifiedEnum(property: string, enumType?: EnumType): this;
+    /**
+     * modifies column with class and lookup provider
+     * @param property column name
+     * @param lookupProvider lookupProvider for class
+     * @param itemsLabelProperty
+     * @param filterProperty
+     */
+    withColumnModifiedLookup(property: string, lookupProvider: ILookupDataProvider<any, any>, itemsLabelProperty?: string, filterProperty?: string): this;
+}
+export declare class TableDynamicDescriptor extends TableDescriptor<any> {
+    private _excludedColumns;
+    private _filterColumns;
+    private _sortColumns;
+    private _sortColumnMode;
+    private _filterColumnMode;
+    protected _columns: ColumnDynamicDescriptor[];
+    constructor(idProperty?: string, titleProperty?: string);
+    get columns(): ColumnDynamicDescriptor[];
+    /**
+     * defines excluded columns when generating descriptor
+     * @param excludedColumn names of excluded columns
+     */
+    withColumnsExcluded(excludedColumn: string[]): this;
+    /**
+     * defines column properties on which sort is defined or not depending on sortColumnMode
+     * @param sortOnColumns column names
+     * @param sortColumnMode INCLUDE_ONLY (default) only given columns will have sort, EXCLUDE given columns will NOT have sort
+     */
+    withColumnsSort(sortOnColumns: string[], sortColumnMode?: TableDynamicColumnsModeEnum): this;
+    /**
+     * defines column properties on which filter is defined or not depending on filterColumnMode
+     * @param filterOnColumn column names
+     * @param filterColumnMode INCLUDE_ONLY (default) only given columns will have filter, EXCLUDE given columns will NOT have filter
+     */
+    withColumnsFilter(filterOnColumn: string[], filterColumnMode?: TableDynamicColumnsModeEnum): this;
+    /**
+     * sets given type to column with given property and returns this table
+     * @param property column's property
+     * @param type custom type for column
+     * @param args addition arguments for column
+     */
+    withColumnModifiedType(property: string, type: ColumnTypeEnum, displayType?: ColumnDisplayTypeEnum, ...args: any[]): this;
+    /**
+     * sets title to column with given property and returns this table
+     * @param property column's property
+     * @param title column's title
+     */
+    withColumnTitle(property: string, title: string): this;
+    /**
+     * generates columns defined on table based on data fetched from api
+     * @param data data from api
+     */
+    toTableDescriptorFromData(data: MediusQueryResult<any>): TableDescriptor<any>;
+    /**
+     * adds ColumnDynamicDescriptor to this table
+     * @param property column's property
+     */
+    addColumn(property: string): ColumnDynamicDescriptor;
+    removeColumn(property: string): this;
+    /**
+     * creates deep copy of table dynamic descriptor
+     */
+    copy(): TableDynamicDescriptor;
+    toTableDescriptor(): TableDescriptor<any>;
+}