getTypeFromString Method

Gets the type from the type string. This method is used for supporting the serialization of the custom object.

Syntax

Javascript (Usage)
Javascript (Specification)

var value; // Type: Object
value = GcSpread.Sheets.getTypeFromString(typeString);

function getTypeFromString( 
   typeString : string
) : Object;

Parameters

typeString: The type string.

Return Value

The type.

Example

This example gets the type for a custom tag.

Javascript

<!DOCTYPE html>
<html>
<head>
    <title>SpreadJS Sample</title>
    <script src="./external/jquery-2.0.2.js" type="text/javascript"></script>
    <link href="./css/gcspread.sheets.3.20151.16.css" rel="stylesheet" type="text/css" />
    <script src="./scripts/gcspread.sheets.all.3.20151.16.min.js"></script>
   
    <script type="text/javascript">
        $(function () {
            //Custom tag
            function MyTag(name, age) {
                this.name = name;
                this.age = age;
                this.typeName = "GcSpread.Sheets.MyTag";
            }
            MyTag.prototype.toJSON = function () {
                var settings = {};
                for (var p in this) {
                    if (this.hasOwnProperty(p)) {
                        settings[p] = this[p];
                    }
                }
                return settings;
            };
            MyTag.prototype.fromJSON = function (settings) {
                if (!settings) {
                    return;
                }
                for (var p in settings) {
                    if (settings[p] !== undefined) {
                        this[p] = settings[p];
                    }
                }
            };

            var oldFun = GcSpread.Sheets.getTypeFromString;
            GcSpread.Sheets.getTypeFromString = function (typeString) {
                if (typeString === "GcSpread.Sheets.MyTag") {
                    return MyTag;
                } else {
                    return oldFun.apply(this, arguments);
                }
            };

var spread1 = new GcSpread.Sheets.Spread($("#ss").get(0),{sheetCount:3});
var spread2 = new GcSpread.Sheets.Spread($("#ss1").get(0),{sheetCount:3});

           
            var sheet1 = spread1.getActiveSheet();
            sheet1.tag(new MyTag("Ivy", 24));
            sheet1.setTag(0, 0, new MyTag("Yang", 25));

            $("#btn1").click(function () {
                //Serialize ss to ss1.
                var jsonStr = JSON.stringify(spread1.toJSON());                
                spread2.fromJSON(JSON.parse(jsonStr));

                var sheet2 = spread2.getActiveSheet();
                alert("Tag of sheet:" + JSON.stringify(sheet2.tag()));
                alert("Tag of Cell[0,0]: " + JSON.stringify(sheet2.getTag(0, 0)));
            });
        });
    </script>
</head>
<body>
    <div>
        <div id="ss" style="height: 200px; width: 500px"></div>
        <div id="ss1" style="height: 200px; width: 500px"></div>
    </div>
    <input type="button" id="btn1" value="Serialization" />
</body>
</html>

Reference

Sheets type