SpreadJS 13
GC.Spread.Sheets Namespace / Workbook type / hitTest Method
The x-coordinate, x relative to spread horizontal axis.
The y-coordinate, y relative to spread vertical axis.
In This Topic
    hitTest Method
    In This Topic
    Performs a hit test.
    Syntax
    var instance = new GC.Spread.Sheets.Workbook(host,
                                                options,
                                                options.sheetCount,
                                                options.font,
                                                options.allowUserDragMerge,
                                                options.allowUserDragDrop,
                                                options.allowUserDragFill,
                                                options.allowUserZoom,
                                                options.allowUserResize,
                                                options.allowUndo,
                                                options.allowSheetReorder,
                                                options.allowContextMenu,
                                                options.allowUserDeselect,
                                                options.defaultDragFillType,
                                                options.showDragFillSmartTag,
                                                options.showHorizontalScrollbar,
                                                options.showVerticalScrollbar,
                                                options.scrollbarShowMax,
                                                options.scrollbarMaxAlign,
                                                options.tabStripVisible,
                                                options.tabStripRatio,
                                                options.tabEditable,
                                                options.newTabVisible,
                                                options.tabNavigationVisible,
                                                options.cutCopyIndicatorVisible,
                                                options.cutCopyIndicatorBorderColor,
                                                options.backColor,
                                                options.backgroundImage,
                                                options.backgroundImageLayout,
                                                options.grayAreaBackColor,
                                                options.showResizeTip,
                                                options.showDragDropTip,
                                                options.showDragFillTip,
                                                options.showScrollTip,
                                                options.scrollIgnoreHidden,
                                                options.highlightInvalidData,
                                                options.useTouchLayout,
                                                options.hideSelection,
                                                options.resizeZeroIndicator,
                                                options.allowUserEditFormula,
                                                options.enableFormulaTextbox,
                                                options.autoFitType,
                                                options.referenceStyle,
                                                options.calcOnDemand,
                                                options.allowCopyPasteExcelStyle,
                                                options.allowExtendPasteRange,
                                                options.copyPasteHeaderOptions,
                                                options.scrollByPixel,
                                                options.scrollPixel,
                                                options.allowAutoCreateHyperlink,
                                                options.columnResizeMode,
                                                options.rowResizeMode,
                                                options.customList,
                                                options.scrollbarAppearance);
    var value; // Type: Object
    value = instance.hitTest(x, y);
    function hitTest( 
       x : number,
       y : number
    ) : Object;

    Parameters

    x
    The x-coordinate, x relative to spread horizontal axis.
    y
    The y-coordinate, y relative to spread vertical axis.

    Return Value

    The hit test information. If selecting the worksheet, the worksheet information is returned. The information contains x, y, and worksheetHitInfo; If selecting the sheetsTabStrip, the sheetsTabStrip information is returned. This information contains x, y, and tabStripHitInfo; If selecting the horizontalScrollbar, the horizontalScrollbar information is returned. This information contains x, y, and horizontalScrollBarHitInfo; If selecting the verticalScrollbar, the verticalScrollbar information is returned. This information contains x, y, and verticalScrollBarHitInfo; If selecting the footerCorner, the footerCorner information is returned. This information contains x, y, and footerCornerHitInfo.
    Example
    //This example uses the hitTest method.
          window.onload = function(){
              var spread = new GC.Spread.Sheets.Workbook(document.getElementById("ss"),{sheetCount:3});
              var activeeSheet = spread.getActiveSheet();
              $("#ss").click(function (e) {
                  //Acquire cell index from mouse-clicked point of regular cells which are neither fixed rows/columns nor row/column headers.
                  var offset = $("#ss").offset();
                  var x = e.pageX - offset.left;
                  var y = e.pageY - offset.top;
                  var target = spread.hitTest(x, y);
                  if(target.worksheetHitInfo) {
                      if(target.worksheetHitInfo.hitTestType === 0) {
                          str = 'corner';
                      } else if (target.worksheetHitInfo.hitTestType === 1) {
                          str = 'colHeader';
                      } else if (target.worksheetHitInfo.hitTestType === 2) {
                          str = 'rowHeader';
                      } else {
                          str = 'viewport';
                      }
                  } else if(target.tabStripHitInfo) {
                      if(target.tabStripHitInfo.navButton){
                          str = target.tabStripHitInfo.navButton;
                      } else if(target.tabStripHitInfo.sheetTab) {
                          str = target.tabStripHitInfo.sheetTab.sheetName;
                      } else if(target.tabStripHitInfo.resize === true) {
                          str = "resize";
                      } else {
                          str = "blank";
                      }
                  } else if(target.horizontalScrollBarHitInfo) {
                      str = target.horizontalScrollBarHitInfo.element;
                  } else if(target.verticalScrollBarHitInfo) {
                      str = target.verticalScrollBarHitInfo.element;
                  } else if(target.footerCornerHitInfo) {
                      str = target.footerCornerHitInfo.element;
                  }
            alert(str);
    });
    }
    See Also

    Reference

    Workbook type