The lang namespace contains classes and interfaces used as type system building blocks to form other classes and interfaces of the Pentaho Platform JavaScript APIs.
Source: doc-js/pentaho/lang/_namespace.jsdoc, line 17
Child Namespaces
| Name | Summary |
| spec | The specifications sub-namespace of the pentaho.lang namespace. |
Classes
| Name | Summary |
| ArgumentError | The ArgumentError class is the base class of error objects associated with a function argument. |
| ArgumentInvalidError | The ArgumentInvalidError class is the class of errors for a function's argument that has been specified, although with an invalid value. |
| ArgumentInvalidTypeError | The ArgumentInvalidTypeError class is the class of errors for a function's argument that has been specified, although with a value of an unsupported type, according to the documented contract. |
| ArgumentRangeError | The ArgumentRangeError class is the class of errors for a function's argument that was specified with a value of one of the expected types, albeit not within the expected range. |
| ArgumentRequiredError | The ArgumentRequiredError class is the class of errors for a function's argument that was required but was not specified, or was specified but with a nully or empty value. |
| Base | Base Class for JavaScript Inheritance.
|
| Collection | The Collection class is an abstract base class for typed, ordered maps. |
| EventSource | The EventSource class is an implementation IEventSource that can be used as mixin class for classes that emit events. |
| List | The List class is an abstract base class for typed arrays. |
| NotImplementedError | The NotImplementedError class is the class of errors that signals that a method that is either abstract and has not been overridden, or is not abstract but has not been implemented, and is being called. |
| OperationInvalidError | The OperationInvalidError class is the class of errors that signals that performing an operation is considered invalid. |
| RuntimeError | The RuntimeError class represents a runtime error that is, nonetheless, handled and whose message can be shown to the user. |
| SortedList | The SortedList class is an abstract base class for ordered arrays. |
| UserError | The UserError class is the base class of error objects associated with the logic of a given operation. |
Interfaces
| Name | Summary |
| IAnnotatable | The IAnnotatable interface represents the class of objects whose instances can be freely augmented with annotations. |
| ICollectionElement | The ICollectionElement interface describes the minimum requirements of elements of a pentaho.lang.Collection. |
| IConfigurable | The IConfigurable interface represents the class of objects that can be configured. |
| IDisposable | The IDisposable interface represents a resource that can be explicitly and deterministically disposed. |
| IEventObserver | An IEventObserver contains properties named after event phase names and whose values are event listeners. |
| IEventRegistrationHandle | The IEventRegistrationHandle interface represents an event registration and provides a means to explicitly unregister from the event. |
| IEventSource | The IEventSource interface represents objects that emit events. |
| IListElement | The IListElement interface describes the minimum requirements of elements of a pentaho.lang.List. |
| ISpecifiable | The ISpecifiable interface represents the class of objects that can be described by a specification. |
| IWithKey | The IWithKey interface describes an object for which a key exists, valid under some implied domain, and is made available. |
Type Definitions
| EventListener(event) |
| An event phase listener function. The event listener function is called with a this context being the object where the listener registered for the event. This type can be used generically by specifying the type of event in angle brackets: pentaho.lang.EventListener<MyEvent>. Usually, the event payload is of type pentaho.lang.Event, but other object types are acceptable. Source: doc-js/pentaho/lang/EventListener.jsdoc, line 17 Parameters: | Name | Default Value | Summary | event : object | | The event payload. | See also: pentaho.lang.IEventObserver , pentaho.lang.EventListenerAsync |
EventListenerAsync(event) : Promise |
| An event phase listener asynchronous function. The event listener function is called with a this context being the object where the listener registered for the event. This type can be used generically by specifying the type of event in angle brackets: pentaho.lang.EventListenerAsync<MyEvent>. Usually, the event payload is of type pentaho.lang.Event, but other object types are acceptable. Source: doc-js/pentaho/lang/EventListenerAsync.jsdoc, line 17 Parameters: | Name | Default Value | Summary | event : object | | The event payload. | Returns: | Name | Description | Promise | null | A promise for the listener's completion. The actual meaning of the promise's result and rejected reason is specific to each event. | See also: pentaho.lang.IEventObserver , pentaho.lang.EventListener |
