@yca/rest-admin
  1. Interfaces
  2. IParams

File

src/interfaces/IParams.ts

Index

Properties

Properties

api
api: string
Type : string
Defined in src/interfaces/IParams.ts:14

ycs restful api endpoint
cols
cols: IParamsCol[]
Type : IParamsCol[]
Defined in src/interfaces/IParams.ts:34

Columns
customButtons
customButtons: IParamsCustomButton[]
Type : IParamsCustomButton[]
Optional
Defined in src/interfaces/IParams.ts:84

Custom buttons in list
dt
dt: DataTable
Type : DataTable
Optional
Defined in src/interfaces/IParams.ts:79

DataTable
editorButtons
editorButtons: IParamsEditorButton[]
Type : IParamsEditorButton[]
Optional
Defined in src/interfaces/IParams.ts:89

Custom buttons while editing
formdata
formdata: boolean
Type : boolean
Optional
Defined in src/interfaces/IParams.ts:104

Whether post data as formdata. Default is json.
globalFilters
globalFilters: any
Type : any
Optional
Defined in src/interfaces/IParams.ts:94

Global filters for query
globalOptions
globalOptions: any
Type : any
Optional
Defined in src/interfaces/IParams.ts:99

Global options for query
hideAdd
hideAdd: boolean
Type : boolean
Optional
Defined in src/interfaces/IParams.ts:49

Hide button add
hideCancel
hideCancel: boolean
Type : boolean
Optional
Defined in src/interfaces/IParams.ts:69

Hide button cancel
hideCount
hideCount: boolean
Type : boolean
Optional
Defined in src/interfaces/IParams.ts:54

Hide count
hideDelete
hideDelete: boolean
Type : boolean
Optional
Defined in src/interfaces/IParams.ts:59

Hide button delete
hideExport
hideExport: boolean
Type : boolean
Optional
Defined in src/interfaces/IParams.ts:74

Hide button export cvs
hideSave
hideSave: boolean
Type : boolean
Optional
Defined in src/interfaces/IParams.ts:64

Hide button save
onShow
onShow: function
Type : function
Optional
Defined in src/interfaces/IParams.ts:44

Event on modal show
preEdit
preEdit: function
Type : function
Optional
Defined in src/interfaces/IParams.ts:114

Before edit a row
preSave
preSave: function
Type : function
Optional
Defined in src/interfaces/IParams.ts:109

Before save a row
renderer
renderer: function
Type : function
Optional
Defined in src/interfaces/IParams.ts:119

Render paginated data after query
rows
rows: number
Type : number
Optional
Defined in src/interfaces/IParams.ts:39

Number of rows a page
title
title: literal type
Type : literal type
Defined in src/interfaces/IParams.ts:19

Titles

 
import { DataTable } from 'primeng/primeng';
import { RestAdminComponent } from '../component';
import {
  IPaginateData,
  IParamsCol,
  IParamsCustomButton,
  IParamsEditorButton,
} from './';

export interface IParams {
  /**
   * ycs restful api endpoint
   */
  api: string;

  /**
   * Titles
   */
  title: {
    /**
     * Title in list
     */
    list: string;

    /**
     * Title while editing
     */
    edit: string;
  };

  /**
   * Columns
   */
  cols: IParamsCol[];

  /**
   * Number of rows a page
   */
  rows?: number;

  /**
   * Event on modal show
   */
  onShow?: (self: RestAdminComponent) => void;

  /**
   * Hide button add
   */
  hideAdd?: boolean;

  /**
   * Hide count
   */
  hideCount?: boolean;

  /**
   * Hide button delete
   */
  hideDelete?: boolean;

  /**
   * Hide button save
   */
  hideSave?: boolean;

  /**
   * Hide button cancel
   */
  hideCancel?: boolean;

  /**
   * Hide button export cvs
   */
  hideExport?: boolean;

  /**
   * DataTable
   */
  dt?: DataTable;

  /**
   * Custom buttons in list
   */
  customButtons?: IParamsCustomButton[];

  /**
   * Custom buttons while editing
   */
  editorButtons?: IParamsEditorButton[];

  /**
   * Global filters for query
   */
  globalFilters?: any;

  /**
   * Global options for query
   */
  globalOptions?: any;

  /**
   * Whether post data as formdata. Default is json.
   */
  formdata?: boolean;

  /**
   * Before save a row
   */
  preSave?: (params: any) => void;

  /**
   * Before edit a row
   */
  preEdit?: (self: RestAdminComponent) => void;

  /**
   * Render paginated data after query
   */
  renderer?: (data: IPaginateData) => IPaginateData;
}

results matching ""

    No results matching ""