tym-table v0.9.5

[tym-table]

tym-table は，シンプルなtable表示の angular コンポーネントです。

表示サンプル (Display image)

動作イメージ (Demo screen)

https://shinichi-tym.github.io/tym-ng-ws-demo/index.html#tym-table

インストール (Installation)

次のコマンド実行します。

npm install tym-table

基本的な使い方 (Basic usage)

表示される場所に htmlタグ を用意し，その中に<ngx-tym-table>タグを作成します。

<div style="width:300px;height:200px;overflow:auto;">
    <ngx-tym-table #tymTable
        [cols]="cols"
        [data]="data"
    ><ngx-tym-table>
</div>

コンポーネントを利用できるようにします。

  :
import { TymTableModule } from "tym-table";
  :
@NgModule({
  declarations: [ .. ],
  imports: [ TymTableModule ],

コンポーネントの機能を利用する。

  :
import { TymTableComponent } from "tym-table";
  :
  @ViewChild("tymTable")
  private tymTable?: TymTableComponent;
  :
  // 直接再描画を実行
  this.tymTable?.drowData();

表示するためのデータを用意します。

let cols: string[] = [ "単価", "販売数", "売上" ]
or
let cols: COL[] = [
  { title: "単価" },
  { title: "販売数" },
  { title: "売上" }
]

let data = [
  [ 980, 627, 614460 ],
  [ 1980, 1219, 2413620 ],
  [ 2980, 116, 345680 ]
]; 

機能 (Features)

• 基本機能 (Basic Function)
• カラーカスタマイズ (Color Customization)
• チェックボックス非表示 (No CheckBox)
• スペースカラム非表示 (No Last Space)
• カラムサイズ自動変更 (Column Auto Change)
• カラムサイズ変更 (ColumnSize Change)
• 行選択 (Row Selection)
• 行フォーカス (Row Focus)
• ソートイベント (Sort Event)
• ドラッグアンドドロップ (Drag And Drop)

• 公開関数 (Public Functions)

基本機能

• custom, afnc, cols, data, odrmk 値を指定すると，その値に従ってテーブルを表示します。

• 定義

<ngx-tym-table #tymTable
    [custom]="custom"
    [afnc]="afnc"
    [cols]="cols"
    [data]="data"
    [odrmk]="odrmk"
    [dddef]="dddef"
    [chkbox]="chkbox"
    [latstp]="latstp"
    [autors]="autors"
></ngx-tym-table>

• custom: TYM_CUSTOM

/* テーブルカスタマイズの定義 */
export interface TYM_CUSTOM {
                              // innerid: default
  fontFamily?: string;        // --fo-fa: Consolas, monaco, monospace
  fontSize?: string           // --fo-sz: 1rem
  borderColor?: string;       // --bo-co: #888
  headerBackground?: string;  // --hd-bg: #888 linear-gradient(#888, #666)
  headerColor?: string;       // --hd-co: #fff
  headerBoxShadow?: string;   // --hd-sa: 1px 1px 3px 0 #ccc inset
  bodyColor?: string;         // --bd-co: #000
  bodyBoxShadow?: string;     // --bd-sa: 1px 1px 3px 0 #ccc inset
  bodyBoxPadding?: string;    // --bd-pa: .4em
  bodyEvenColor?: string;     // --ev-co: #eee
  bodyOddColor?: string;      // --od-co: #fff
  bodySeldColor?: string;     // --se-co: #fee
  bodyHovrColor?: string;     // --ho-co: #efe
  bodyFocusColor?: string;    // --fc-co: #ffa
}

• afnc: TYM_FUNCS

/* 関数の定義 */
export interface TYM_FUNCS {
  /** data から表示行数を取得するための関数を定義, 規定値: data.length */
  getRowSize?: (data: any) => number;
  /** data から行データを取得するための関数を定義, 規定値: data[num] */
  getRow?: (data: any, num: number) => any;
  /** 行データから列データを取得するための関数を定義, 規定値: row[num] */
  getVal?: (row: any, num: number) => string;
  /** ソート対象ヘッダークリック時の関数を定義 */
  doOrder?: (order: string, col: number) => void;
  /** コンテキストアクションの関数を定義, 規定値: { } */
  doContext?: (event: MouseEvent, num: number, row: any) => boolean;
  /** クリックアクションの関数を定義, 規定値: { } */
  doClick?: (event: MouseEvent, num: number, row: any) => void;
}
/* 規定値 */
doOrder(order: string, num: number) {
  this.odrmk = {
    column: num,
    order: (order == 'asc') ? 'desc' : 'asc' } as TYM_ORDER;
}

• cols: TYM_COL[]

/* テーブルカラムの定義 */
export interface TYM_COL {
  /** タイトル */
  title: string;
  /** 桁幅, 例:8em, 規定値:なし */
  width?: string;
  /** 揃え, 例:right, 規定値:なし(left) */
  align?: string;
  /** ソート対象, 規定値:なし(false) */
  sortable?: boolean;
  /** クリックアクション対象, 規定値:なし(false) */
  clickable?: boolean;
}

• data: string[][] | any

• odrmk: TYM_ORDER

/* テーブルカラムの定義 */
export interface TYM_ORDER {
  /** ソートマーク位置 */
  column: number;
  /** ソート方向, {'asc','desc',empty}, 規定値:empty */
  order: string;
}

• dddef: TYM_DDDEF

/* ドラッグアンドドロップの定義 */
export interface TYM_DDDEF {
  /** ドラッグタイプ(effectAllowed), 規定値: none */
  dragType?: TYM_DRAG_TYPE;
  /** ドロップ効果(dropEffect), 規定値: none */
  dropType?: TYM_DROP_TYPE;
  /** ドラッグ開始時の関数を定義 */
  doDragStart?: (event: DragEvent, num: number, row: any) => void;
  /** ドラッグ終了時の関数を定義, 規定値: { } */
  doDragEnd?: (event: DragEvent, num: number, row: any) => void;
  /** ドロップターゲットに入った時の関数を定義 */
  doDragEnter?: (event: DragEvent, num: number, row: any) => void;
  /** ドロップターゲットの上にある時の関数を定義 */
  doDragOver?: (event: DragEvent, num: number, row: any) => void;
  /** ドロップターゲットにドロップされた時の関数を定義, 規定値: { } */
  doDrop?: (event: DragEvent, num: number, row: any) => void;
  /** @private @access private */
  _getRow?: (num: number) => any;
  /** @private @access private */
  _getComData?: () => any;
}
/* 規定値 */
doDragStart(event: DragEvent, num: number, row: any) {
  event.dataTransfer?.setData('text/plain', num.toString());
  event.dataTransfer?.setData('application/json', JSON.stringify(row));
  event.dataTransfer!.dropEffect = (this.dddef.dragType ?? 'none') as any;
}
dragEnterOrOver(event: DragEvent, num: number, row: any) {
  event.preventDefault();
  if (this._dd_def.dropType != event.dataTransfer?.effectAllowed) {
    if (event.dataTransfer?.effectAllowed == 'copyMove') {
      event.dataTransfer!.dropEffect = this._dd_def.dropType as any;
    } else {
      event.dataTransfer!.dropEffect = 'none';
    }
  } else {
    event.dataTransfer!.dropEffect = this._dd_def.dropType as any;
  }
}
doDragEnter = dragEnterOrOver;
doDragOver = dragEnterOrOver;

• chkbox: boolean

• lastsp: boolean

• autors: boolean

カラーカスタマイズ

• custom 値を設定するとカラーをカスタマイズできます。

custom = {
  bodySeldColor: "#ffeeee",
  bodyHovrColor: "#eeffee"
}; 

チェックボックス非表示

• chkbox に false を設定するとチェックボックスカラムを非表示にできます。

chkbox = false;

スペースカラム非表示

• lastsp に false を設定するとスペースカラムを非表示にできます。

lastsp = false;

カラムサイズ自動変更

• autors に true を設定すると表示内容に従ってカラムサイズが自動的に変わります。

autors = true;

カラムサイズ変更

• ヘッダー部分にリサイズマークを左右に移動させるとカラムサイズが変わります。
• カラムサイズは，cols を設定するとリセットされます。
• ヘッダー部分をダブルクリックすると表示内容に従ってカラムサイズが変わります。
• ヘッダー部分をシフトキーを押しながらダブルクリックすると全ての列のカラムサイズが変わります。

行選択

• 行頭のチェックボックスによって選択行になります。
• コンテキストアクション時に選択行になります(afnc.doContextで動作を上書きできます)
• 選択された行は，custom.bodySeldColor の色に変化します。
• 選択された行は，ドラッグアンドドロップの対象になります。
• chkbox が false の場合は行選択できません。
  ただし，setSelection 関数では行選択できます。

行フォーカス

• 行にフォーカスが設定されます。
• 上下キーでフォーカスを移動できます。
• フォーカス行は，custom.bodyFocusColor の色に変化します。
• スペースキーで行選択できます。

ソートイベント

• COL の sortable を設定したカラムにはオーダーマークが表示されます。
• オーダーマークが表示されたヘッダー行の文字をクリックすると doOrder がコールバックされます。
• doOrder 内で必要な処理を行い odrmk を設定してください。

ドラッグアンドドロップ

• dddef を適切に設定し行選択すると，行をドロップできます。
• dddef に設定した各関数を利用して必要な処理を実装してください。
• dddef の dragType,dragType は，'none','copy','move','copyMove' だけをサポートします。

公開関数

再描画する関数

drowData(); 

• htmlタグで指定した cols, data, odrmk の値だけを変更した場合，変更が検出されない。
  この関数を呼び出すと再描画が行われる。

• 引数

  • なし

• 戻値

  • なし

選択行を返却する関数

let rownums = getSelection(); 

• 選択された状態になっている行番号(複数)を返却する。

• 引数

  • なし

• 戻値

  • rownums: number[]

選択行をすべてクリアする

clearSelection();

• 選択された状態になっている全ての行の選択状態を解除する。

• 引数

  • なし

• 戻値

  • なし

指定した行番号(複数)を選択状態にする

setSelection(rownums);

• 指定した行番号(複数)を選択状態にする。

• 引数

  • rownums: number[]

• 戻値

  • なし

comments

* supports angular 15, 16 and 17.

ライセンス (License)

The components in tym-ng-ws are released under the MIT license. Read license.

Copyrights belong to shinichi tayama (shinichi.tym).