meadco-scriptxjs

1.10.1 • Public • Published

MeadCoScriptXJS

GitHub release (latest SemVer) npm Nuget
MIT License

MeadCoScriptXJS is a simple javascript wrapper library for use with MeadCo's ScriptX Add-on/Services to achieve consistent printed output using any browser on any device. This library has been used with our samples system for some time.

The aim of the library is to hide differences between versions of ScriptX and provide easy access to some common functionality. The library works with both free and licensed ScriptX. Some convenience wrappers require licensed ScriptX functionality.

As of version 1.2.0 this library facilitates being able to write the same code for both the ScriptX Add-on for Internet Explorer and MeadCo's ScriptX Services browser agnostic printing services in the cloud, on premise and on Windows PC. The dependency on the ScriptX Service Client Library is required for this to work.

v1.5 and later add support for ScriptX Services on Windows PC.

Packages

NuGet Gallery

MeadCo ScriptX JS Library

NPM Use

npm install meadco-scriptxjs --save

CDN Use


jsDelivr hits (npm)

<script src="https://cdn.jsdelivr.net/npm/meadco-scriptxjs@1/dist/meadco-scriptx.min.js"></script>

Quick start for working with ScriptX Add-on only

  1. Link to meadco-scriptx.js <script src="https://cdn.jsdelivr.net/npm/meadco-scriptxjs@1/dist/meadco-scriptx.min.js"></script>
  2. Initialise the library in the document ready/window loaded event handler, and initialise printing parameters. For example, when using jQuery:
$(window).on('load', function () {
  if (MeadCo.ScriptX.Init()) {
    MeadCo.ScriptX.Printing.header = "MeadCo's ScriptX&b:&p of &P:&bBasic Printing Sample";
    MeadCo.ScriptX.Printing.footer = "The de facto standard for advanced web-based printing";
    MeadCo.ScriptX.Printing.orientation = "landscape";
            
    // link the ui ...
    $("#print_link").click(function (e) { 
      e.preventDefault(); MeadCo.ScriptX.PrintPage(false); 
    });                           
  }
});

Please note that the library is not dependent upon jQuery or any other libraries.

Quick start - ScriptX.Services for any browser

  1. Link to the required libraries with service connection details
  2. Initialise the library
  3. Initilise print parameters

The same code will work when the add-on is present, but the add-on will be used in preference.

A promise polyfill is required if the browser does not support promises (for example Internet Explorer). We recommend (and test with) Promise Polyfill

<script src="https://cdn.jsdelivr.net/npm/meadco-scriptxjs@1/dist/meadco-scriptx.min.js"></script>

<!-- ScriptX Services client emulation libraries - depend on jQuery -->
<script src="/scripts/jquery-3.1.1.js"></script>

<!-- A promise library will be required if also targetting IE 11. -->
<script src="https://cdn.jsdelivr.net/npm/promise-polyfill@8/dist/polyfill.min.js"></script>

<script src="https://cdn.jsdelivr.net/npm/scriptxprint-html@1.7/dist/meadco-scriptxservices.min.js"
        data-meadco-server="https://scriptxservices.meadroid.com" 
        data-meadco-license="xxx-xxx-xxxxxxx-xxx"></script>

<script type="text/javascript">
   $(window).on('load', function () {
     MeadCo.ScriptX.InitAsync().then(function {
       MeadCo.ScriptX.Printing.header = 
          "MeadCo's ScriptX&b:&p of &P:&bBasic Printing Sample";
       MeadCo.ScriptX.Printing.footer = 
          "The de facto standard for advanced web-based printing";
       MeadCo.ScriptX.Printing.orientation = "landscape";
       $("#btnprint").click(function() { 
            MeadCo.ScriptX.PrintPage(false);
       });
     })      
   });
</script>

Resources

Copyright

Copyright © 2013-2021 Mead & Co Ltd.

License

MeadCoScriptXJS is under MIT license - http://www.opensource.org/licenses/mit-license.php

Package Sidebar

Install

npm i meadco-scriptxjs

Weekly Downloads

24

Version

1.10.1

License

MIT

Unpacked Size

84.1 kB

Total Files

5

Last publish

Collaborators

  • cpcjones
  • petecole