Skip to main content
Pentaho Documentation

DefaultViewAnnotation

pentaho.visual. DefaultViewAnnotation

The DefaultViewAnnotation marks the existence of a View module and makes it be the default view to use for the annotated model.

By default, the default view is the sibling of the annotated module which is named View. This can be overridden with pentaho.visual.spec.IDefaultViewAnnotation#module.

See also: pentaho.visual.IView

Constructor

Name Description
new DefaultViewAnnotation(forModule, defaultViewModule)

Creates a default view annotation associated with a given module.

Members

Name Description
id :  string
Static

Gets the type of annotation.

module :  pentaho.module.IMeta

Gets the associated default view module.

Methods

Name Description
createAsync(forModule, annotSpec) : Promise.<pentaho.visual.DefaultViewAnnotation>
Static

Creates a default view annotation, given the annotated module and the annotation specification.

Constructor Details

new DefaultViewAnnotation(forModule, defaultViewModule)

Creates a default view annotation associated with a given module.

Source: javascript/web/pentaho/visual/DefaultViewAnnotation.js, line 23

Parameters:
Name Default Value Summary
forModule : pentaho.module.IMeta

The annotated module.

defaultViewModule : pentaho.module.IMeta

The default view module.

See also: pentaho.visual.IView

Members Details

id:  string
Static

Gets the type of annotation.

Source: javascript/web/pentaho/visual/DefaultViewAnnotation.js, line 65

module:  pentaho.module.IMeta

Gets the associated default view module.

Source: javascript/web/pentaho/visual/DefaultViewAnnotation.js, line 54

Methods Details

createAsync(forModule, annotSpec) : Promise.<pentaho.visual.DefaultViewAnnotation>
Static

Creates a default view annotation, given the annotated module and the annotation specification.

Source: javascript/web/pentaho/visual/DefaultViewAnnotation.js, line 77

Parameters:
Name Default Value Summary
forModule : pentaho.module.IMeta

The annotated module.

annotSpec : pentaho.visual.spec.IDefaultViewAnnotation

The annotation specification.

Returns:
Name Description
Promise.<pentaho.visual.DefaultViewAnnotation>

A default view annotation.