Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Caplin JavaScript Libraries API Documentation

This documentation contains details of all JavaScript library code that is shipped with CaplinTrader. The following packages are available with BladeRunner:

  • component
  • core
  • dom
  • i18n
  • presenter
  • services
  • testing
  • workbench

Packages

caplin.chart

The chart library provides classes that can be used to obtain chart series data from a backend system (such as Caplin Liberator).

caplin.component BladeRunner

Provides the caplin.component.Component interface that must be implemented by any classes that want to be loaded into a Panel or dialog.

caplin.control

The control library provides various screen controls for use in the Renderer Framework.

caplin.core BladeRunner

The core library is responsible for providing low level language extensions to JavaScript.

caplin.dom BladeRunner

Provides low level utility classes that standardize the interaction with the Document Object Model (DOM), hiding away the intricacies and subtleties of the DOM interaction within different browsers.

caplin.element

The element library provides a flexible means of incorporating screen controls.

caplin.fx

The FX library provides classes specific to FX applications.

caplin.grid

Provides all the necessary classes needed to build real-time grids and integration with other systems.

caplin.i18n BladeRunner

Provides the caplin.i18n.Translator class which is responsible for converting localization tokens into translated text.

caplin.layout

The layout package provides a service to manage layouts in a single page web application.

caplin.menu

The menu library provides all the necessary classes to generate a menu along with a PresenterControl and a menu PresentationNode for presenter integration (see live examples).

caplin.popout

The popout library provides a means for popping out content from the application into a new browser window, and also provides a mechanism for communication between the main application and the popped out content.

caplin.presenter BladeRunner

The Presenter library enables developers to create screen views using standard HTML templates, and then bind these to business logic that is defined within object-oriented JavaScript classes.

caplin.security

Provides the necessary classes for extracting current permissions from the Caplin Permission DataSource.

caplin.services BladeRunner

Provides a service pattern utility class for defining and utilising Services within BladeRunner.

caplin.sl4badapter

Provides classes and services for loading applications that utilise an SL4B connection.

caplin.sljsadapter

Provides classes and services for loading applications that utilise a StreamLink JS connection.

caplin.testing BladeRunner

The Testing library provides the JavaScript infrastructure for executing acceptance tests using the verifier test framework.

caplin.trading

A simple, event based messaging API for communicating domain specific trade events.

caplin.webcentric

The webcentric library provides a rich UI framework for building enterprise applications.

caplin.workbench BladeRunner

The workbench library provides a set of components for building workbench within a bladerunner application.