IInstanceMeta

Last updated
Save as PDF

pentaho .module. IInstanceMeta

The IInstanceMeta interface contains the metadata of an instance module.

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

Extends

pentaho.module.IMeta

Members

Name	Description
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.

Members Details

alias: `nonEmptyString`
Gets the alias of the module. Source: doc-js/pentaho/module/IMeta.jsdoc, line 49 Inherited From: pentaho.module.IMeta#alias

alias: nonEmptyString

Gets the alias of the module.

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

Inherited From: pentaho.module.IMeta#alias

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.module.IMeta#config 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.module.IMeta#config

id: `nonEmptyString`
Gets the identifier of the module. Source: doc-js/pentaho/module/IMeta.jsdoc, line 30 Inherited From: pentaho.module.IMeta#id

id: nonEmptyString

Gets the identifier of the module.

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

Inherited From: pentaho.module.IMeta#id

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.module.IMeta#isConfigLoaded 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.module.IMeta#isConfigLoaded

See also: pentaho.module.IMeta#config

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.module.IMeta#isLoaded 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.module.IMeta#isLoaded

See also: pentaho.module.IMeta#value

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

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

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.module.IMeta#ranking

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.module.IMeta#ranking

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.module.IMeta#resolveId 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.module.IMeta#resolveId

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

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

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.module.IMeta#value 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.module.IMeta#value

Methods Details

loadAsync() : Promise

Loads the module and returns a promise for its value.

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

Inherited From: pentaho.module.IMeta#loadAsync