module

The pentaho/module/instanceOf! module is an AMD/RequireJS loader plugin that allows loading a module which provides an instance of a specified type.

AMD Plugin Usage: "pentaho/module/instanceOf!{typeId}"

1. {typeId} — The identifier or alias of the type of the desired instance.

Example

The following AMD/RequireJS configuration registers two instances, mine/homeScreen and yours/proHomeScreen, of the abstract type IHomeScreen:

require.config({
  config: {"pentaho/modules": {"IHomeScreen":         {base: null, isAbstract: true},"mine/homeScreen":     {type:"IHomeScreen"},"yours/proHomeScreen": {type:"IHomeScreen", ranking: 2}
    }
  }
});

Later, some other component can request for a registered instance of the type IHomeScreen:

define(["pentaho/module/instanceOf!IHomeScreen"], function(homeScreen) {

});

The highest ranking instance is chosen.

Source: javascript/web/pentaho/module/instanceOf.js, line 22

See also: pentaho.module.service , pentaho.module.IService#getInstanceOfAsync

The pentaho/module/instancesOf! module is an AMD/RequireJS loader plugin that allows loading modules which provide instances of a specified type.

AMD Plugin Usage: "pentaho/module/instancesOf!{typeId}"

1. {typeId} — The identifier or alias of the type of the desired instances.

Example

The following AMD/RequireJS configuration registers two instances, mine/homeScreen and yours/proHomeScreen, of the abstract type IHomeScreen:

require.config({
  config: {"pentaho/modules": {"IHomeScreen":         {base: null, isAbstract: true},"mine/homeScreen":     {type:"IHomeScreen"},"yours/proHomeScreen": {type:"IHomeScreen", ranking: 2}
    }
  }
});

Later, some other component can request for all registered instances of the type IHomeScreen:

define(["pentaho/module/instancesOf!IHomeScreen"], function(arrayOfHomeScreens) {

  arrayOfHomeScreens.forEach(function(homeScreen) {
    // ...
  });
});

Source: javascript/web/pentaho/module/instancesOf.js, line 22

See also: pentaho.module.service , pentaho.module.IService#getInstancesOfAsync

The pentaho/module! module is an AMD/RequireJS loader plugin that obtains the metadata object of a module given its identifier. The configuration of the module is also loaded.

If the requested module is not defined (through pentaho.modules), it is defined as an instance module having a null type.

AMD Plugin Usage: "pentaho/module!{moduleId}"

1. {moduleId} — The identifier of the desired module. To refer to the requesting module, use the special value _.

Source: javascript/web/pentaho/module/metaOf.js, line 31

See also: pentaho.module.IMeta , pentaho.module.metaService , pentaho.module.IMetaService#get

// Obtain the self module.
define(["pentaho/module!_"], function(module) {

 if(module.config) {
 // Do something.
 }
});

The main modules metadata service of the Pentaho Modules API.

If instead of the metadata of modules, the modules themselves are needed, use pentaho.module.service directly, or one of the following AMD loader plugins:

• pentaho/module!
• pentaho/module/instanceOf!
• pentaho/module/instancesOf!
• pentaho/module/typeOf!
• pentaho/module/typesOf!

The modules metadata service is first initialized with the AMD configuration of the pentaho.modules module. Secondly, the environmental configuration of pentaho/modules also contributes with additional modules' metadata.

Source: javascript/web/pentaho/module/metaService.js, line 22

The main modules service of the Pentaho Modules API.

To obtain the values of modules as a dependency of an AMD/RequireJS module, use one of the following AMD loader plugins instead:

• pentaho/module!
• pentaho/module/instanceOf!
• pentaho/module/instancesOf!
• pentaho/module/typeOf!
• pentaho/module/typesOf!

Source: javascript/web/pentaho/module/service.js, line 22

See also: pentaho.module.metaService

The pentaho/module/subtypeOf! module is an AMD/RequireJS loader plugin that allows loading a module which provides a subtype of a specified base type.

AMD Plugin Usage: "pentaho/module/instanceOf!{baseTypeId}"

1. {baseTypeId} — The identifier or alias of the base type of the desired subtype.

Example

The following AMD/RequireJS configuration registers two subtypes, mine/HomeScreen and yours/ProHomeScreen, of the abstract type IHomeScreen:

require.config({
  config: {"pentaho/modules": {"IHomeScreen":         {base: null, isAbstract: true},"mine/HomeScreen":     {base:"IHomeScreen"},"yours/ProHomeScreen": {base:"IHomeScreen", ranking: 2}
    }
  }
});

Later, some other component can request for a registered subtype of the type IHomeScreen:

define(["pentaho/module/subtypeOf!IHomeScreen"], function(HomeScreen) {

});

The highest ranking subtype is chosen.

Source: javascript/web/pentaho/module/subtypeOf.js, line 22

See also: pentaho.module.service , pentaho.module.IService#getSubtypeOfAsync

The pentaho/module/subtypesOf! module is an AMD/RequireJS loader plugin that allows loading modules which provide subtypes of a specified type.

AMD Plugin Usage: "pentaho/module/subtypesOf!{baseTypeId}"

1. {baseTypeId} — The identifier or alias of the base type of the desired subtypes.

Example

The following AMD/RequireJS configuration registers two subtypes, mine/HomeScreen and yours/ProHomeScreen, of the abstract type IHomeScreen:

require.config({
  config: {"pentaho/modules": {"IHomeScreen":         {base: null, isAbstract: true},"mine/HomeScreen":     {base:"IHomeScreen"},"yours/ProHomeScreen": {base:"IHomeScreen", ranking: 2}
    }
  }
});

Later, some other component can request for all registered subtypes of the type IHomeScreen:

define(["pentaho/module/subtypesOf!IHomeScreen"], function(arrayOfHomeScreens) {

  arrayOfHomeScreens.forEach(function(HomeScreen) {
    // ...
  });
});

Source: javascript/web/pentaho/module/subtypesOf.js, line 22

See also: pentaho.module.service , pentaho.module.IService#getSubtypesOfAsync