GridJsクライアントサイドでの作業

GridJsクライアントサイドでの作業

x-spreadsheetをベースにしたGridJsクライアントを開発しました。

主な手順は次のとおりです：

• x_spreadsheetインスタンスの作成

xs = x_spreadsheet(id, options)
    // the parameters are:
    id:the html node id ,for example :'#gridjs-demo' for the html  <div id="gridjs-demo"></div>
    options: the load options


for example the below code init a gridjs_spreadsheet object.
	xs = x_spreadsheet('#gridjs-demo', {
			updateMode:'server',
			updateUrl:'/GridJs2/UpdateCell',
			mode: 'edit',
			showToolbar: true,
                        local: 'en',
			showContextmenu: true
			})

ロードオプションのパラメータ：

パラメータ	説明	デフォルト値	任意
allowSelectTextInTextBoxInReadMode	読み取りモード中にテキストボックスでテキスト選択を許可するかどうか。 デフォルト値はfalse。	false	はい
checkSyntax	ユーザー入力の文法チェックとスペル訂正を行うかどうか。 setSyntaxCheckUrlとの連携。 デフォルト値はfalse。	false	はい
loadingGif	画像や図形を読み込むときのローディングGIFのURL。 デフォルトはcontent/img/updating.gif。	content/img/updating.gif	はい
local	メニューやツールバーのローカリゼーション情報を設定し、多言語対応。 可能な値は： - en, zh, es, pt, de, ru, nl（英語、中国語、スペイン語、ポルトガル語、ドイツ語、ロシア語、オランダ語） - ar, fr, id, it, ja（アラビア語、フランス語、インドネシア語、イタリア語、日本語） - ko, th, tr, vi, cht（韓国語、タイ語、トルコ語、ベトナム語、繁体字中国語）	en	はい
mode	readまたはeditが設定可能です。readは読み取り専用のスプレッドシートを意味し、editは編集可能。	なし	いいえ
searchHighlightColor	検索語のハイライト背景色。 色はアルファチャネルを含む必要があります。	#dbe71338	はい
showCheckSyntaxButton	文法チェック＆スペル訂正ボタンをツールバーに表示するかどうか。 デフォルトはfalse。	false	はい
showContextmenu	セルの右クリック時にコンテキストメニューを表示するかどうか。 デフォルトはtrue。	true	はい
showFileName	ファイル名を表示するかどうか。	true	はい
showFormulaExplain	マウスがセル上にあるときに、そのセルに適用された式の説明を表示するかどうか。 setFormulaExplainUrlと連携。 デフォルトはfalse。	false	はい
showFormulaTip	マウスがセル上にあるときに、そのセルに適用された既存の式を表示するかどうか。 デフォルトはfalse。	false	はい
showNonEditableSymbolInCell	セルにクライアント側の編集不可記号を表示するかどうか。 trueに設定すると、「編集無効化」コンテキストメニューのクリック後に選択範囲に記号が表示されます。 デフォルト値はfalseです。	false	Yes
showToolbar	ツールバーを表示するかどうか。	true	Yes
updateMode	現在、server のみサポートされています。	server	No
updateUrl	JSONに基づいたサーバーサイドの更新アクション用URLを設定します。	なし	No
view	シートのビュサイズを設定します。例：{width: () => 1000, height: ()=> 500}。	{width: () => document.documentElement.clientWidth, height: () => document.documentElement.clientHeight }	Yes

• JSONデータでロード

xs.loadData(data)
// the parameters is:
	data: the json data which describ the data structure for the worksheets

• シート名でアクティブシートを設定

xs.setActiveSheetByName(sheetname)
// the parameters is:
	sheetname: the sheet name 

• IDでアクティブシートを設定

xs.setActiveSheet(id)
// the parameters is:
	sheetname: the sheet id 

• アクティブセルを設定

xs.setActiveCell(row,col);
// the parameters are:
	row: the cell row
	col: the cell column

• 複数インスタンスのアクティブ設定

xs.setActiveForMultipleInstance(isacitve);
// the parameters are:
	isacitve: whether need to do edit operation at this xs instanse 
// when there are more than one GridJs instances in one page, we need to call this method.
// we only support do edit operation for one instances at a page.
// for example,if we have two instances: xs1 and xs2 in one html page.
// if we need to keep edit operation in xs1,
// we shall call:
xs1.setActiveForMultipleInstance(true);
xs2.setActiveForMultipleInstance(false);

// if we need not do any edit operation for both,
// we shall call:
xs1.setActiveForMultipleInstance(false);
xs2.setActiveForMultipleInstance(false);

• サーバーサイドアクションのための形状/画像操作の情報を設定

xs.setImageInfo(imageGetActionUrl, imageAddByUploadActionUrl, imageAddByUrlActionUrl, imageCopyActionUrl, zindex, loadingGif);
// the parameters are:
	imageGetActionUrl: the get image action URL in the server side controller
	imageAddByUploadActionUrl: the upload image action  URL in the server side controller
	imageAddByUrlActionUrl: the add image from URL action  URL in the server side controller
	imageCopyActionUrl: the copy image action  URL in the server side controller
	zindex: the minimum zindex of the image in the canvas
	loadingGif (optional): the loading gif url when loading the image/shape .it is optional,the default value is:content/img/updating.gif
    for example: 
            const imageurl = "/GridJs2/imageurl";
            const imageuploadurl1 = "/GridJs2/AddImage";
            const imageuploadurl2 = "/GridJs2/AddImageByURL";
            const imagecopyurl = "/GridJs2/CopyImage";  
	    const basiczorder = 5678;
    xs.setImageInfo(imageurl, imageuploadurl1, imageuploadurl2, imagecopyurl, basiczorder);

• サーバーサイドアクションのためのダウンロード操作の情報を設定

xs.setFileDownloadInfo(downloadActionUrl);
// the parameters are:
	downloadActionUrl: the get download file action URL in the server side controller

    for example: 
            const fileDownloadUrl = "/GridJs2/Download";
            xs.setFileDownloadInfo(fileDownloadUrl);

• サーバーサイドアクションのためのOLEオブジェクト操作の情報を設定

xs.setOleDownloadInfo(oleActionUrl);
// the parameters are:
	oleActionUrl: the ole object file action URL in the server side controller
    for example: 
            const oleDownloadUrl = "/GridJs2/Ole";
            xs.setOleDownloadInfo(oleDownloadUrl);

• サーバーサイドの構文チェック＆スペル修正操作の情報設定

xs.setSyntaxCheckUrl(checkUrl);
// the parameters are:
	checkUrl: the  syntax checking & spell correction operation action URL in the server side controller
    for example: 
            const checkurl = "/GridJs2/CheckSyntax";
            xs.setSyntaxCheckUrl(checkurl);

• サーバーサイドの数式説明の情報設定

xs.setFormulaExplainUrl(formulaExplainUrl);
// the parameters are:
	formulaExplainUrl: the  formula explanation  action URL in the server side controller
    for example: 
            const formulaExplainUrl = "/GridJs2/FormulaExplain";
            xs.setFormulaExplainUrl(formulaExplainUrl);

---

その他の便利なAPI

• ビューをレンダリング

xs.reRender()

• アクティブなシートのIDを取得

xs.getActiveSheet()

• ズームレベルを設定

xs.setZoomLevel(zoom)
// the parameters is:
	zoom:the zoom level ,can be number ,for example 0.5 for zoom out, or 2 for zoom in

• ファイル名を設定

xs.setFileName(name)
// the parameters is:
	name:the file name with extension ,for example trip.xlsx

• メール送信機能のためのコールバック関数

xs.setEmailSendCallFunction(callback)
// the parameters is:
	callback: the callback function to handle email sending, receives a mailObj parameter
		callback: function(mailObj) {
			// mailObj properties:
			// mailObj.receiver: the email address of the receiver, e.g., '[e-mail]'
			// mailObj.type: the format of the file to be sent, can be 'html', 'xlsx', or 'pdf'
		}

• GridJsのウィンドウキーイベントを有効にするかどうか

xs.enableKeyEvent(isenable)
// the parameters is:
	isenable:whether the window key event is active for GridJs
//when has other controls in the same page, you may want to ignore the key event in GridJs 

• ウィンドウリサイズイベントやウィンドウキーイベントなど、GridJsにアタッチされたすべてのイベントを解除します。

xs.destroy()

• 画像/形状の可視フィルタを設定

xs.setVisibleFilter((sheet,s) =>{})
    //  to set a function which return true(for visible) or false(for invisible) for the visible filter with the below parameters :
	sheet:the sheet instance
	s:the image or shape instance
    for example: 
	//this will make visible for image/shape in sheet with name 'Sheet3' and 'Sheet1' except for the 'Rectangle' type
		xs.setVisibleFilter((sheet,s) => { if (sheet.data.name==='Sheet3'||sheet.data.name==='Sheet1') return s.type!=='Rectangle';  return false; })
	//this will make visible for image/shape in sheet with name  'Sheet1' 
		xs.setVisibleFilter((sheet,s) => { if (sheet.data.name==='Sheet1') return true;  return false; })
	//this will make invisible for image/shape in all sheets 
		xs.setVisibleFilter((sheet,s) => {  return false; })
	//if all the image/shape is already loaded and you want to change the visible filter at runtime,you can call the below code to trigger a reload for image/shape
		xs.reRender()

• 選択された画像/形状を取得し、何も選択されていない場合はnullを返します

xs.sheet.selector.getObj()

• 指定セル位置にHTMLノードを表示または非表示

xs.sheet.showHtmlAtCell(isShow, html, ri, ci, deltaX, deltaY)

    //the parameters are:
    // - isShow: Boolean value indicating whether to show or hide the HTML content.
    // - html: The HTML string to be displayed.
    // - ri: Row index of the target cell.
    // - ci: Column index of the target cell.
    // - deltaX: (Optional) Relative X-position adjustment from the top-left corner of the cell.
    // - deltaY: (Optional) Relative Y-position adjustment from the top-left corner of the cell.

    // Example usage:
    // Show HTML at cell A1
    xs.sheet.showHtmlAtCell(true, "<span>html span</span><input length='30' id='myinput'>test</input>", 0, 0);

    // Hide the HTML node
    xs.sheet.showHtmlAtCell(false);

    // Note: When an HTML node is shown, the default GridJS event handling is disabled to allow interaction with the HTML content.
    // This means you cannot select any cells or perform edit operations until the HTML node is hidden.

• 画像/シェイプの選択可能状態設定

const shape=xs.sheet.selector.getObj();
shape.setControlable(isenable)
     // the parameter is:
      isenable: when set to true,the image or shape can be selectable and movable/resizeable

• セルオブジェクトを取得

xs.sheet.data.getCell(ri,ci)
    // the parameters are:
	ri:row index 
	ci:column index

• セルスタイルを取得

xs.sheet.data.getCellStyle(ri,ci)
    // the parameters are:
	ri:row index 
	ci:column index

• セル値を設定

xs.sheet.data.setCellText(ri,ci,value,state)
    // the parameters are:
	ri:row index 
	ci:column index
	value:the cell value
	state: input | finished ,if finished ,it will do update action to servside

• 選択されたセル範囲の取得/設定

xs.sheet.data.selector.range

• 選択されたセルまたはセル領域のセル値を設定します

xs.sheet.data.setSelectedCellText(value)
    // the parameters are:
	value:the  value for the cell

• 選択されたセルまたはセル領域のスタイルを設定します

xs.sheet.data.setSelectedCellAttr(attributename,value)
    // the parameters are:
	attributename:font-name | font-bold | font-italic | font-size  | format|border|merge|formula |strike|textwrap |underline |align |valign |color|bgcolor|pattern
	value:the  value for the attribute

• 選択されたセル領域を結合します

xs.sheet.data.merge()

• 選択されたセル領域の結合を解除します

xs.sheet.data.unmerge()

• 選択されたセルを削除します

xs.sheet.data.deleteCell(type)
    // the parameters are:
	type:all|format  all: means delete the cell and clear the style ;format means delete the cell value and keep the cell style

• 固定ペインを設定します

xs.sheet.data.setFreeze(ri,ci)
    // the parameters are:
	ri:row index 
	ci:column index

• 選択されたセルで行または列を挿入します

xs.sheet.data.insert(type, n)
    // the parameters are:
	type: row | column
	n:the row or column number

• 選択されたセルで行または列を削除します

xs.sheet.data.delete(type)
    // the parameters are:
	type: row | column

• 列の幅を設定します

xs.sheet.data.setColWidth(ci,width)
    // the parameters are:
	ci:column index
	width:the width for the column

• 列の幅を設定します

xs.sheet.data.setColsWidth(sci,eci,width)
    // the parameters are:
	sci:the start column index
	eci:the end column index
	width:the width for the column

• すべての列の幅を設定します

xs.sheet.data.setAllColsWidth(width)
    // the parameters are:
	width:the width for the columns

• 列の幅を取得します

xs.sheet.data.cols.sumWidth(min,max)
    // the parameters are:
	min:the start column index
	max:the end column index,not include

• 行の高さを設定します

xs.sheet.data.setRowHeight(ri,height)
    // the parameters are:
	ri:row index
	height:the height for the row

• 行の高さを設定します

xs.sheet.data.setRowsHeight(sri,eri,height)
    // the parameters are:
	sri:start row index
	eri:end row index
	height:the height for the rows

• すべての行の高さを設定します

xs.sheet.data.setAllRowsHeight(height)
    // the parameters are:
	height:the height for the rows

• 行の高さを取得します

xs.sheet.data.rows.sumHeight(min,max)
    // the parameters are:
	min:the start row index
	max:the end row index,not include

• 表示方向の取得/設定をします

xs.sheet.data.displayRight2Left

イベントコールバック

• 以下のイベントを追跡できます

 xs.on('cell-selected', (cell, ri, ci) => {
                console.log('cell selected:', cell, ', ri:', ri, ', ci:', ci);
                if (ci === -1) {
                    console.log('ci === -1 means a row selected ',ri);
                }
                if (ri === -1) {
                    console.log('ri === -1 means a column selected',ci);
                }
            }).on('cells-selected', (cell, range) => {
                console.log('range   selected:', cell, ', rang:', range);
            }).on('object-selected', (shapeOrImageObj) => {
                console.log('shape or image selected id:', shapeOrImageObj.id, ', type: ', shapeOrImageObj.type);
            }).on('sheet-selected', (id,name) => {
                console.log('sheet selected id:', id, ', name: ',name);
            }).on('sheet-loaded', (id,name) => {
                console.log('sheet load finished:', id, ', name: ',name);
            }).on('cell-edited', (text, ri, ci) => {
	        //just edit the cell
                console.log('text:', text, ', ri: ', ri, ', ci:', ci);
            }).on('cells-updated', (name, cells) => {
	       //cell value got updated
                console.log('cells updated for sheet name:', name);
                cells.forEach((acell, index, array) => {
                console.log('acell got updated:', acell);
            })
            }).on('cells-deleted', (range) => {
                console.log('cells deleted :', range);
            }).on('rows-deleted', (ri, n) => {
                console.log('rows-deleted :', ri, ",size", n);

            }).on('columns-deleted', (ci, n) => {
                console.log('columns-deleted :', ci, ",size", n);

            }).on('rows-inserted', (ri, n) => {
                console.log('rows-inserted :', ri, ",size", n);

            }).on('columns-inserted', (ci, n) => {
                console.log('columns-inserted :', ci, ",size", n);

            });

• 事前チェックイベント falseを返すと、挿入/削除操作は実行されません。

  xs.checkRowInsert = (ri, size) => { if (ri % 2 == 1) return true; else return false; };
  xs.checkColumnInsert = (ci, size) => { if (ci % 2 == 1) return true; else return false; };
  xs.checkRowDelete = (ri, size) => { if (ri % 2 == 1) return true; else return false; };
  xs.checkColumnDelete = (ci, size) => { if (ci % 2 == 1) return true; else return false; };

カスタマイズ

• ホームアイコンとリンクを設定します

xs.sheet.menubar.icon.setHomeIcon(iconUrl,targetUrl)
    // the parameters are:
	iconUrl:the home icon URL
	targetUrl:the target link URL
	for example ,the below code will set the new logo and with link to google.com
	xs.sheet.menubar.icon.setHomeIcon('https://forum.aspose.com/letter_avatar_proxy/v4/letter/y/3e96dc/45.png','https://www.google.com')

• メニューバーを表示します

xs.sheet.menubar.show()

• メニューバーを非表示にします

xs.sheet.menubar.hide()

テキストボックスオブジェクト用のAPI

TextBoxはTypeプロパティが"TextBox"である特別な種類のシェイプです たとえば: 以下のコードは、どの形状がテキストボックスであるかを示します

for (let shape of xs.sheet.data.shapes) {
    if (shape.type === 'TextBox') {
        console.log(shape.id + ' is a textbox');
    }
}

• テキストボックスオブジェクトの背景色を変更する

    setBackgroundColor(color)
    // the parameters are:
        color: the html color value in hex string value
    //for example,we assume shape 0 is a textbox object,this will set the background color to Yellow 
     const textbox=xs.sheet.data.shapes[0];
     textbox.setBackgroundColor('#FFFF00');

• 視覚的なアクティブ効果を得るために、自動で背景色とテキスト色を変更する

    setActiveEffect(boolvalue)
    // the parameters are:
        boolvalue: if true,will change background color and the text color of the textbox object;if false,restore to original appearence

• テキストボックスオブジェクトのテキストコンテンツを非表示/表示します

    hideText(boolvalue)
    // the parameters are:
        boolvalue: if true,will not display the text in the textbox object;if false,restore to original appearence

詳細情報については、こちらの例を確認してください https://github.com/aspose-cells/Aspose.Cells-for-.NET/tree/master/Examples_GridJs