Skip to main content
Pentaho Documentation

Environment

Environment

The Environment class is an implementation of the IEnvironment interface.

Implements

Constructor

Name Description
new Environment(spec, defaultSpec)
 
Static

Creates an environment given its specification.

Members

Name Description
application : nonEmptyString

Gets the identifier of the client application.

locale : nonEmptyString

Gets the identifier of the locale.

reservedChars : nonEmptyString

Gets the reserved characters for file names, all concatenated in a single string.

server : pentaho.environment.IServer

Gets information about the server web application.

theme : nonEmptyString

Gets the identifier of the theme.

user : pentaho.environment.IUser

Gets information about the user.

Methods

Name Description
createChild(childSpec) : pentaho.environment.IEnvironment

Creates a child context of this one given its specification. Any unspecified information is inherited from this context.

toSpec() : pentaho.environment.spec.IEnvironment

Creates a specification with the information of this context.

Constructor Details

new Environment(spec, defaultSpec)
 
Static

Creates an environment given its specification.

Any absent or undefined-valued properties assume the values of the given default specification, if any, or null, if none.

Source: javascript/web/pentaho/environment/impl/Environment.js, line 42

Parameters:
Name Default Value Summary
spec : pentaho.environment.spec.IEnvironment
 
Optional

The environment specification.

defaultSpec : pentaho.environment.spec.IEnvironment
 
Optional

The environment specification from which unspecified or undefined spec properties are initialized.

Members Details

Implements:
application: nonEmptyString

Gets the identifier of the client application.

Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 34

Implements:
locale: nonEmptyString

Gets the identifier of the locale.

Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 70

Implements:
reservedChars: nonEmptyString

Gets the reserved characters for file names, all concatenated in a single string.

Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 79

Implements:
server: pentaho.environment.IServer

Gets information about the server web application.

Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 52

Implements:
theme: nonEmptyString

Gets the identifier of the theme.

Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 61

Implements:
user: pentaho.environment.IUser

Gets information about the user.

Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 43

Methods Details

Implements:
createChild(childSpec) : pentaho.environment.IEnvironment

Creates a child context of this one given its specification. Any unspecified information is inherited from this context.

Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 88

Parameters:
Name Default Value Summary
childSpec : pentaho.environment.spec.IEnvironment
 
Optional

The child context specification.

Returns:
Name Description
pentaho.environment.IEnvironment

The child context.

Implements:
toSpec() : pentaho.environment.spec.IEnvironment

Creates a specification with the information of this context.

Source: doc-js/pentaho/environment/IEnvironment.jsdoc, line 99

Returns:
Name Description
pentaho.environment.spec.IEnvironment

The context specification.

See also:  pentaho.environment.IEnvironment#toJSON