العمل مع GridJs الجانب العميل

قمنا بتطوير GridJs الجانب العميل بناءً على x-spreadsheet.

الخطوات الرئيسية هي:

إنشاء مثيل 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`	نعم
`checkSyntax`	هل تقوم بفحص النحو والتصحيح الإملائي لمدخلات المستخدم لنص المحتوى. يعمل مع setSyntaxCheckUrl. القيمة الافتراضية هي خطأ.	`false`	نعم
`loadingGif`	عنوان URL للصورة المتحركة عند تحميل الصور/الأشكال. القيمة الافتراضية هي content/img/updating.gif.	`content/img/updating.gif`	نعم
`local`	تعيين معلومات التوطين للقوائم وأشرطة الأدوات، مع دعمMultiple اللغات. القيم الممكنة تشمل: - `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`	نعم
`showContextmenu`	هل يظهر قائمة السياق عند النقر بزر الماوس الأيمن على خلية. القيمة الافتراضية هي صحيح.	`true`	نعم
`showFileName`	هل يظهر اسم الملف.	`true`	نعم
`showFormulaExplain`	ما إذا كنت تريد عرض تفسيرات الصيغة المطبقة على هذه الخلية عند تحريك الماوس فوقها. يعمل بالتزامن مع setFormulaExplainUrl. القيمة الافتراضية هي false.	`false`	نعم
`showFormulaTip`	ما إذا كنت تريد عرض الصيغة الموجودة المطبقة على هذه الخلية عند تحريك الماوس فوقها. القيمة الافتراضية هي false.	`false`	نعم
`showNonEditableSymbolInCell`	ما إذا كنت تريد عرض رمز غير قابل للتحرير على جانب العميل في الخلية. إذا تم تعيينه إلى true، بعد النقر على خيار القائمة السياقية اليمنى “تعطيل التحرير”، ستظهر المنطقة المحددة التي تم تعطيلها رمزًا. القيمة الافتراضية هي false.	`false`	نعم
`showToolbar`	ما إذا كنت تريد عرض شريط الأدوات.	`true`	نعم
`updateMode`	يدعم حاليا فقط `الخادم`.	`server`	لا
`updateUrl`	تعيين عنوان URL الخاص بالخادم لإجراءات التحديث استنادًا إلى JSON.	لا شيء	لا
`view`	تعيين حجم العرض للورقة، على سبيل المثال، `{width: () => 1000, height: ()=> 500}`.	`{width: () => عرض النافذة الحالية للمستعرض، height: () => ارتفاع النافذة الحالية للمستعرض}`	نعم

تحميل بيانات 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

تعيين ورقة نشطة حسب الهوية

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);

واجهات برمجة التطبيقات الأخرى المفيدة

عرض العرض

xs.reRender()

الحصول على هوية الورقة النشطة

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., 'example@gmail.com'
			// 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()

الحصول على الصورة/الشكل المحدد، إذا لم يتم تحديد أي شيء سيتم إرجاع قيمة فارغة

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);

            });

حدث فحص مسبق إذا كانت النتيجة خاطئة، فلن تستمر عملية الإدراج/الحذف.

  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()

واجهات برمجة التطبيقات لكائن مربع النص

TextBox هو نوع خاص من الشكل والذي تكون خاصيته نوعه: “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