All files / components/tek-grid interfaces.ts

100% Statements 3/3
100% Branches 0/0
100% Functions 1/1
100% Lines 2/2

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217                                                                                                                                                                                                                          1x 1x                                                                                                                                                                                                                    
import {
  IBeforeReportEvent,
  IComponent,
  IComponentEvents,
  IComponentRender,
  IGridColumnEditable,
  IGridEditable,
  IIterableColumnsButton,
  EventDef,
  IModal,
  IButton,
} from '@zeedhi/common';
import {
  IDictionary, IEvent, IEventParam, IDateHelperValue, IDateHelperValues,
} from '@zeedhi/core';
import {
  IDynamicFilterItem, TekGrid, TekGridLayoutOptions, TekTreeGrid,
} from '..';
 
export interface ITekGridLayoutEventParams extends IEventParam<ITekGrid> {
  layouts: ITekGridLayoutInfo;
}
 
export type ITekGridEvent<T> = (event: T) => Promise<any>;
 
export interface ITekGridEvents<T = IEventParam<any> | ITekGridLayoutEventParams> extends IComponentEvents<T> {
  addClick?: EventDef<T>;
  afterCancel?: EventDef<T>;
  afterDelete?: EventDef<T>;
  afterSave?: EventDef<T>;
  beforeApplyFilter?: EventDef<T>;
  beforeCancel?: EventDef<T>;
  beforeDelete?: EventDef<T>;
  beforeSave?: EventDef<T>;
  filterClick?: EventDef<T>;
  loadLayouts?: EventDef<T, ITekGridEvent<T>>;
  saveLayouts?: EventDef<T>;
  groupRowClick?: EventDef<T>;
  groupSelect?: EventDef<T>;
  groupUnselect?: EventDef<T>;
  beforeOpenReport?: EventDef<T, IBeforeReportEvent>;
  beforeReload?: EventDef<T>;
  [key: string]: any;
}
 
export type ITekGridLayoutOptionsEvent<T> = (event: T) => Promise<any>;
 
export interface ITekGridLayoutOptionsEvents<T = IEventParam<any> | ITekGridLayoutEventParams> extends IComponentEvents<T> {
  loadLayouts?: ITekGridEvent<T>;
  saveLayouts?: IEvent<T>;
  [key: string]: any;
}
 
export interface ITekGrid extends IGridEditable {
  actions?: IComponentRender[]
  addButton?: boolean
  columnFilterButton?: boolean
  columns?: ITekGridColumn[]
  columnsButton?: boolean
  columnsButtonIgnore?: string[]
  deleteButton?: 'none' | 'currentRow' | 'selection'
  events?: ITekGridEvents
  showEditButtons?: boolean
  filterButton?: boolean
  modalFilterProps?: IModalFilterProps
  showSearch?: boolean
  showLayoutOptions?: boolean
  title?: string
  showExport?: boolean
  showReload?: boolean
  exportConfig?: ITekGridExportConfig[]
  exportActions?: IComponentRender[]
  groupsOpened?: boolean
  showSummaryTotal?: boolean
  layoutOptions?: TekGridLayoutOptions
  mainGrid?: boolean
}
 
export type MultiOptionParams = {
  iconName: string;
  label: string;
  cssClass?: string;
  reportParams?: { portrait?: boolean; rowObj?: any };
};
 
export interface ITekGridExportConfig {
  type: string;
  portrait?: boolean;
  label?: string;
  iconName?: string;
  multiOption?: MultiOptionParams[];
}
 
export interface ITekGridLayoutInfo {
  currentLayoutName?: string;
  layouts?: IDictionary<ITekGridLayout>;
}
 
export interface ITekGridLayout {
  name: string;
  gridWidth?: string;
  columns?: ITekGridLayoutColumn[];
  order?: string[];
  dynamicFilter?: IDictionary<IDynamicFilterItem[]>;
  filter?: IDictionary<any>;
}
 
type Narrowable = string | number | boolean | symbol |
  object | {} | void | null | undefined;
const tuple = <T extends Narrowable[]>(...args: T) => args;
export const columnAggregationValues = tuple('SUM', 'MIN', 'MAX', 'AVG', 'COUNT', undefined);
 
export type ITekGridColumnAggregation = (typeof columnAggregationValues)[number];
 
export interface ITekGridLayoutColumn {
  name: string;
  width?: string;
  minWidth?: string;
  maxWidth?: string;
  isVisible?: boolean;
  fixed?: boolean;
  grouped?: boolean;
  aggregation?: ITekGridColumnAggregation;
  label?: string;
  align?: 'left' | 'right' | 'center';
  groupOpened?: boolean;
  filterHelperValue?: string | IDictionary<any>;
}
 
export interface ITekGridLayoutOptions extends IComponentRender {
  events?: ITekGridLayoutOptionsEvents;
}
 
export type IFilterRelation = 'AND' | 'OR';
 
export type IFilterOperation =
  'CONTAINS' |
  'NOT_CONTAINS' |
  'EQUALS' |
  'NOT_EQUALS' |
  'GREATER_THAN' |
  'LESS_THAN' |
  'GREATER_THAN_EQUALS' |
  'LESS_THAN_EQUALS' |
  'IN' |
  'NOT_IN' |
  'BETWEEN';
 
export interface IFilterPropsComponent extends IComponent {
  relation?: IFilterRelation;
  operation?: IFilterOperation;
  helperOptions?: string[];
  helperValue?: string;
}
 
export interface ITekGridColumn extends IGridColumnEditable {
  filterProps?: IFilterPropsComponent | IFilterPropsComponent[];
  filterable?: boolean;
  filterIndex?: number;
  grouped?: boolean;
  aggregation?: ITekGridColumnAggregation;
  groupOpened?: boolean;
  groupLabelForEmptyValue?: string;
  storeData?: boolean;
}
 
export interface ITekGridColumnsButton extends IIterableColumnsButton {
  hideGroups?: boolean;
}
 
export interface ITekGridFilterButton extends IButton {
  gridName?: string;
  grid?: TekGrid | TekTreeGrid;
}
 
export interface ITekGridGroup {
  column: ITekGridColumn;
  name: string;
  label: string;
  lastValue: any;
  footer: ITekGridFooter;
  initialized: boolean;
  lastGroupHeaderRow?: ITekGridGroupHeader;
}
 
export interface ITekGridGroupHeader {
  group: boolean;
  groupRow: IDictionary;
  groupColumnName: string;
  groupHeader: boolean;
  groupIndex: number;
  groupLabel: string;
  groupValue: any;
  groupOpened: boolean;
  groupHeaders: ITekGridGroupHeader[];
  children: IDictionary<any>[];
}
 
export interface ITekGridFooter {
  [key: string]: ITekGridSummary;
}
 
export interface ITekGridSummary {
  sum: number;
  count: number;
  min: any;
  max: any;
}
 
export interface ITekFilterHelperValue extends IDateHelperValue {}
 
export interface ITekFilterHelperValues extends IDateHelperValues {}
 
export interface IModalFilterProps extends IModal {
  height: string
}