npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@txtextcontrol/tx-ng-ds-document-viewer

v3.5.0

Published

This library provides a document viewer compatible with [TX Text Control DS Server](https://dsserver.io/) and documents created using the editor and API of TX Text Control.

Downloads

120

Readme

TX Text Control Document Services Document Viewer (Angular version)

This library provides a document viewer compatible with TX Text Control DS Server and documents created using the editor and API of TX Text Control.

Installation

ng add @txtextcontrol/tx-ng-ds-document-viewer

Important notice: From Angular v17 onwards, "standalone" apps are the new default for the CLI. If you want DocumentViewerModule to be added to your app.module.ts automatically, you have to use the --no-standalone flag when creating a new Angular project with ng new. Standalone applications created without this flag will show the error Bootstrap call not found when using the ng add command.

Usage

Your component.html could look like this, for example (the only mandatory attributes are width, height and serviceURL):

<tx-ds-document-viewer
   width="1280px"
   height="1024px"
   serviceURL="https://your.server.com/documentservices"
   documentData="SGVsbG8gdGhlcmU="
   oauthClientID="dsserver.PdRpDAnzGLRrTPhRnYBU2UAEkzyB4PQ1"
   oauthClientSecret="HgpGyqoFQOVkrzk6ukHtSxUS6XdU39LP"
   [customQueryParams]='{ "param1": "Param1Value", "param2": 42 }'>
</tx-ds-document-viewer>

Possible attributes

  • width (string) - The width of the component (e. g. "1024px").
  • height (string) - The height of the component (e. g. "1024px").
  • serviceURL (string) - The server which is hosting your installation of Text Control DS Server.
  • oauthClientID (string) - The OAuth client ID.
  • oauthClientSecret (string) - The OAuth client secret.
  • documentData (string) - Base64 encoded document data.
  • documentPath (string) - The displayed document name.
  • userNames (string[]) - An array of names specifying users who have access to editable regions.
  • isSelectionActivated (boolean) - Specifies whether text can be selected and copied.
  • dock (string) - Specifies how the control is docked. Possible values are 'Fill' and 'Window'.
  • toolbarDocked (boolean) - Specifies whether the toolbar is docked or floating.
  • resources (Object.<string, string>) - Specifies resources for the displayed strings.
  • accessToken (string) - An (OAuth-) access token acquired through a self implemented workflow. When this attribute is present, oauthClientID and oauthClientSecret are ignored.
  • signatureSettings (object) - The signature settings. See below.
  • customQueryParams (Object.<string, any>) - Specifies user-definable query parameters which are added to the query string of each HTTP request.

Signature settings

The signature settings object has the following properties:

  • ownerName (string) - The owner name.
  • signatureBoxName (string) - The id of the signature box element. Deprecated. Use the signatureBoxes property instead.
  • signerName (string) - The signer name.
  • signerInitials (string) - The signer initials.
  • showSignatureBar (boolean) - Specifies whether to show the signature bar.
  • uniqueId (string) - The unique signature id.
  • redirectUrlAfterSignature (string) - The URL to redirect to after a signature.
  • customSigning (boolean) - Specifies whether the signing process is handled within custom code.
  • signatureBoxes (object[]) - Boxes for signing (see below). Property signatureBoxName has no effect if this array is not empty.

Signature boxes

A signature box object has the following properties:

  • style (string) - The signature box style. Possible values are "Signature" and "Initials". The default value is "Signature".
  • signingRequired (boolean) - Specifies whether signing is required. The default value is true.

Events

Because the script containing the main TXDocumentViewer object is loaded in a deferred manner, the component provides a global event ("dsDocumentViewerLoaded") which is fired as soon as the object is available. The event is dispatched on the document object. You can subscribe to it in your component.ts as follows:

@HostListener('document:dsDocumentViewerLoaded')
onDsDocumentViewerLoaded() {
   console.log('The TXDocumentViewer object exists from now on.');
}

Environment Support