mthb-canvas-table/lib/share/CanvasTableColum.d.ts

Canvas Table

import { CanvasColor, ICanvasContext2D } from "./CanvasContext2D";
import { CustomCanvasTable } from "./CustomCanvasTable";
export interface IEditRowItem {
    [field: string]: any;
}
export declare type CustomData<T = any> = (canvasTable: CustomCanvasTable, dataValue: string, row: T, data: T[], rowIndex: number, col: ICanvasTableColumnConf<T>) => string;
export declare type RenderValue<T = any> = (canvasTable: CustomCanvasTable, context: ICanvasContext2D, rowIndex: number, col: ICanvasTableColumnConf<T>, left: number, top: number, right: number, bottom: number, width: number, height: number, r: number, dataValue: string, row: T, data: T[]) => void;
export declare type CustomFilter<T = any> = (data: T[], row: T, col: Array<ICanvasTableColumnConf<T>>, index: number, edit: IEditRowItem) => boolean;
export declare type CustomRowColStyle<T = any> = (data: T[], row: T, col: ICanvasTableColumnConf<T>, isOver: boolean, isSepra: boolean, dataRowCol: string) => ICanvasTableRowColStyle | undefined | null;
export declare type GetLookup<T = any> = (row: number, data: string, col: ICanvasTableColumn<T>) => LookupValues;
export declare type LookupValues = string[] | Array<{
    key: string;
    caption: string;
}>;
export interface IUpdateRect {
    cellHeight: number;
    clipBottom: number | undefined;
    clipLeft: number | undefined;
    clipRight: number | undefined;
    clipTop: number | undefined;
    left: number;
    top: number;
    width: number;
    x: number;
    y: number;
}
export interface ICanvasTableColumn<T> {
    allowEdit: boolean;
    header: string;
    field: string;
    width: number;
    align: Align;
    index: number;
    leftPos: number;
    rightPos: number;
    renderer?: RenderValue<T>;
    customData?: CustomData<T>;
    orginalCol: ICanvasTableColumnConf<T>;
    lookupData?: LookupValues;
    getLookup?: GetLookup<T>;
}
/**
 * function pointer to custom sort
 * @param data  data Same array that was sent to CanvasTable, this array is not modified
 * @param rowA  row A
 * @param rowB  row B
 * @returns
 *      if rowA > rowB then return 1
 *      if rowA < rowB then return -1
 *      if rowA == rowB then return 0
 */
export declare type CustomSort<T = any> = (data: T[], rowA: T, rowB: T, a: number, b: number) => number;
/**
 * CanvasTableRowColStyle interface is return in [[CustomRowColStyle]]
 */
export interface ICanvasTableRowColStyle {
    /**
     * Font name
     */
    font?: string;
    /**
     * Font style example bold
     */
    fontStyle?: string;
    /**
     * Font size in px
     */
    fontSize?: number;
    /**
     * Font color
     */
    fontColor?: CanvasColor;
    /**
     * background color in the cell
     */
    backgroundColor?: CanvasColor;
    /**
     * Text align: left, center, right
     */
    align?: Align;
}
/**
 * Canvas Table Column Config
 */
export interface ICanvasTableColumnConf<T = any, LookupKey = number> {
    /**
     * Text in header
     */
    header: string;
    /**
     * Property field in data
     */
    field: string;
    /**
     * Width of the column
     */
    width?: number;
    /**
     * Align render data in the table. default Align.left
     */
    align?: Align;
    /**
     * Visible of the column. default visible
     */
    visible?: boolean;
    /**
     * function pointer to render the data with canvas
     */
    renderer?: RenderValue<T>;
    /**
     * function pointer to render string.
     */
    customData?: CustomData<T>;
    /**
     * lookup values
     */
    lookupData?: LookupValues;
    /**
     * Custom lookup value
     */
    getLookup?: GetLookup<T>;
}
export interface ICanvasTableColumnSort<T = any> {
    col: ICanvasTableColumnConf<T>;
    sort: Sort;
}
/**
 * Align text
 */
export declare enum Align {
    /**
     * Left = 0
     */
    left = 0,
    /**
     * Center = 1
     */
    center = 1,
    /**
     * Right = 2
     */
    right = 2
}
/**
 * Sort direction
 */
export declare enum Sort {
    /**
     * sort accending  = 1
     */
    ascending = 1,
    /**
     * sort descending = -1
     */
    descending = -1
}