Skip to main content
Pentaho Documentation

environment

pentaho.environment

The context namespace contains types that allow access to environmental information of the Pentaho Platform.

Overview

The IEnvironment interface is the top interface that represents the environment. Part of its information is described by the contained IServer and IUser interfaces.

pentaho.environment.main is the main environment instance of the Pentaho Platform. Secondary environments can be derived from the main environment, by using its IEnvironment#createChild method.

The specification classes, in the pentaho.environment.spec namespace, expose the raw environmental data in plain JavaScript objects or JSON format. These can be used in IEnvironment#createChild or result from IEnvironment#toSpec.

Source: doc-js/pentaho/environment/_namespace.jsdoc, line 17

Child Namespaces

Name Summary
spec

The context.spec namespace contains specification interfaces.

Interfaces

Name Summary
IEnvironment

The IEnvironment interface allows access to environmental information of the Pentaho Platform. For example, it allows access to user, theme, locale, application and server.

IServer

The IServer interface allows access to the Pentaho Platform’s environmental information that pertains to the server application.

IUser

The IUser interface allows access to the Pentaho Platform's environmental information that pertains to the user.

Members

Name Description
main : pentaho.environment.IEnvironment

The main environment of the JavaScript Pentaho Platform.

Members Details

main: pentaho.environment.IEnvironment

The main environment of the JavaScript Pentaho Platform.

This instance is initialized with the environment specification which is the value of this module's AMD configuration.

Source: javascript/web/pentaho/environment.js, line 26

See also:  pentaho.environment.spec.IEnvironment