SpreadJS 14
SpreadJS Designer Component / Getting Started
In This Topic
    Getting Started
    In This Topic

    Installation

    You can install SpreadJS Designer Component by downloading the ZIP file (SpreadJS.Release.xxxx.zip) to a temporary directory on your system, and then unzipping the files to a directory.

    Install Directory File Description
    \SpreadJS.Release.xxxx\Designer\Designer Component Main directory for product
    \SpreadJS.Release.xxxx\Designer\Designer Component\css gc.spread.sheets.designer.14.0.0.min CSS file
    \SpreadJS.Release.xxxx\Designer\Designer Component\definition gc.spread.sheets.designer.d TypeScript API definition file
    \SpreadJS.Release.xxxx\Designer\Designer Component\samples Angular, React, Vue, Purejs support files
    \SpreadJS.Release.xxxx\Designer\Designer Component\scripts gc.spread.sheets.designer.all.14.0.0.min
    gc.spread.sheets.designer.resource.cn.14.0.0.min
    gc.spread.sheets.designer.resource.en.14.0.0.min
    gc.spread.sheets.designer.resource.jp.14.0.0.min
    gc.spread.sheets.designer.resource.ko.14.0.0.min
    Minimized designer and resource js files
    \SpreadJS.Release.xxxx\Designer\Designer Component\default_config.json default_config.json JSON file containing designer components' command tree structure

    License Information

    SpreadJS Designer Component supports following types of licenses:

    Unlicensed

    The unlicensed version allows you to use all features of SpreadJS Designer Component on a local machine. A few example URL's are given below:

    http(s)://localhost
    http(s)://127.0.0.1
    file://xxxx
    http(s)://xxx.local
    http(s)://xxx
    http(s)://[::1]
    http(s)://[0:0:0:0:0:0:0:1]

    However, the 'SpreadJS Designer License' tab in ribbon displays the following message:

     

    If executed on a web server, the ribbon component is destroyed and the following error message is displayed:

    "Deployment License Key not found. Email us.sales@grapecity.com or visit www.grapecity.com to request a testing deployment license."

    Evaluation License

    The evaluation license allows you to use all features of SpreadJS Designer Component on a local machine and web server. However, the 'SpreadJS Designer License' tab in ribbon displays the following message:

    Local Machine

    "Evaluation License. Contact sales at us.sales@grapecity.com to request a testing deployment license."

    Web Server

    "Evaluation License. Contact sales at (+1) 412-681-4343 or us.sales@grapecity.com to purchase a deployment license."

    If you want to deploy a website, a valid evaluation license for sheets component is also required which can be set by using GC.Spread.Sheets.LicenseKey = "xxx".

    Licensed

    The licensed version allows you to use all features of SpreadJS Designer Component on a local machine and web server. If you want to deploy a website, a valid license for sheets component is also required.

    Apply License

    The license key of SpreadJS and SpreadJS Designer Component should be set by using GC.Spread.Sheets.LicenseKey and GC.Spread.Sheets.Designer.LicenseKey respectively, and must be set before creating the designer instance as shown below:

    HTML
    Copy Code
    GC.Spread.Sheets.LicenseKey = "xxxx";
    GC.Spread.Sheets.Designer.LicenseKey = "xxxx";
    var designer = new GC.Spread.Sheets.Designer("designerHost");
    

    SpreadJS Designer Component and Pivot Table Add-on

    As described here, in version 14.1 or later, you can choose to purchase SpreadJS license along with the Pivot table add-on. The following table describes the availability of Pivot Table features while using SpreadJS designer component:

    Usage scenario License Key (SpreadJS, Designer Component and Pivot Table) License Key (SpreadJS and Designer Component)

    Designer Component: No License Key

    SpreadJS Runtime: No License Key

    All Pivot Table features are available and can be run on local machine.

     

     

     

     

     

    No Pivot Table features are available.

    Designer Component: Evaluation License Key

    SpreadJS Runtime: License + No Add On

    Pivot Table features are not available.

    Designer Component: Evaluation License Key

    SpreadJS Runtime: License + Add On

    All Pivot Table features are available till the validity of evaluation license key.

    Designer Component: Production License Key

    SpreadJS Runtime: License + No Add On

    Pivot Table features are not available.

    Designer Component: ProductionLicense Key

    SpreadJS Runtime: License + Add On

    All Pivot Table features are available without any limitations.