Skip to main content
Hitachi Vantara Lumada and Pentaho Documentation

InstanceMeta

.module. InstanceMeta

The InstanceMeta class implements the module.IInstanceMeta interface.

Extends

Implements

Constructor

Name Description
new InstanceMeta(id, spec, resolver)

Constructs the metadata of an instance module.

Members

Name Description
_isLoaded : boolean
Protected

Indicates the value has been loaded or was specified.

alias : nonEmptyString

Gets the alias of the module.

config : Object

Gets the configuration of the module.

id : nonEmptyString

Gets the identifier of the module.

isConfigLoaded : boolean

Gets a value that indicates if the module's configuration has been loaded.

isLoaded : boolean

Gets a value that indicates if the module's value is directly available through the value property.

kind : nonEmptyString

Gets the kind of module.

ranking : number

Gets the ranking of the module.

resolveId

Resolves a module identifier as if it were a dependency of this one.

type : pentaho.module.ITypeMeta

Gets the type module of which this one is an instance, or null, if the instance is of an unknown type.

value : any

Gets the value of the module, if it has been loaded already, or undefined, otherwise.

Methods

Name Description
loadAsync() : Promise

Loads the module and returns a promise for its value.

loadConfigAsync() : Promise.<Object>

Loads the configuration of the module and returns a promise for it.

Constructor Details

new InstanceMeta(id, spec, resolver)

Constructs the metadata of an instance module.

Source: javascript/web/pentaho/_core/module/InstanceMeta.js, line 43

Parameters:
Name Default Value Summary
id : nonEmptyString

The identifier of the instance module.

spec : pentaho.module.spec.IInstanceMeta

The specification of the metadata of the instance module.

resolver : pentaho._core.module.Resolver

The module resolver function.

Members Details

_isLoaded: boolean
Protected

Indicates the value has been loaded or was specified.

Source: javascript/web/pentaho/_core/module/Meta.js, line 89

Inherited From: pentaho._core.module.Meta#_isLoaded

Implements:
alias: nonEmptyString

Gets the alias of the module.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 49

Inherited From: pentaho._core.module.Meta#alias

Implements:

See also: pentaho.module.IMeta#isConfigLoaded , pentaho.module.IMeta#loadConfigAsync

config: Object

Gets the configuration of the module.

When not yet loaded, or if the module has no configuration, returns null.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 116

Inherited From: pentaho._core.module.Meta#config

Implements:
id: nonEmptyString

Gets the identifier of the module.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 30

Inherited From: pentaho._core.module.Meta#id

Implements:

See also: pentaho.module.IMeta#config

isConfigLoaded: boolean

Gets a value that indicates if the module's configuration has been loaded.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 131

Inherited From: pentaho._core.module.Meta#isConfigLoaded

Implements:

See also: pentaho.module.IMeta#value

isLoaded: boolean

Gets a value that indicates if the module's value is directly available through the value property.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 93

Inherited From: pentaho._core.module.Meta#isLoaded

Implements:
kind: nonEmptyString

Gets the kind of module.

One of the strings "type" or "instance".

Source: doc-js/pentaho/module/IMeta.jsdoc, line 39

Inherited From: pentaho.module.IMeta#kind

Implements:
ranking: number

Gets the ranking of the module.

The ranking determines the order of the module amongst other modules.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 58

Inherited From: pentaho._core.module.Meta#ranking

Implements:

See also: pentaho.module.util.resolveModuleId

resolveId:

Resolves a module identifier as if it were a dependency of this one.

Resolving makes moduleId absolute, relative to this one.

Afterwards, any applicable RequireJS contextual mapping configuration is applied.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 142

Inherited From: pentaho._core.module.Meta#resolveId

Implements:
type: pentaho.module.ITypeMeta

Gets the type module of which this one is an instance, or null, if the instance is of an unknown type.

Source: doc-js/pentaho/module/IInstanceMeta.jsdoc, line 26

Implements:

See also: pentaho.module.IMeta#isLoaded , pentaho.module.IMeta#loadAsync

value: any

Gets the value of the module, if it has been loaded already, or undefined, otherwise.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 80

Inherited From: pentaho._core.module.Meta#value

Methods Details

Implements:
loadAsync() : Promise

Loads the module and returns a promise for its value.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 69

Inherited From: pentaho._core.module.Meta#loadAsync

Returns:
Name Description
Promise

A promise for the value of the module.

See also: pentaho.module.IMeta#value

Implements:
loadConfigAsync() : Promise.<Object>

Loads the configuration of the module and returns a promise for it.

Source: doc-js/pentaho/module/IMeta.jsdoc, line 105

Inherited From: pentaho._core.module.Meta#loadConfigAsync

Returns:
Name Description
Promise.<Object>

A promise for the configuration of the module.

See also: pentaho.module.IMeta#config