Global
The following methods and their details are global.
Methods
_revert()
Revert the width of a column.
constructor(config)
Constructor for creating Evented object.
`emit(event, eventObj) : boolean
JSON`
on(event, listener) : object
Registers listeners via custom event strings which can be executed in order of registration.
testAddKnownFieldKinds(report, vizModel, roleName) : analyzer.visual.ICanAddFieldInfo
Tests the addition of each of the known field kinds to a visual role.
Methods Details
_revert()
Revert the width of a column.- Source
constructor(config)
Constructor for creating Evented object.- Source
javascript/scripts/AnalyzerEvented.js, line 41
Parameters
Name
Default Value
Summary
config : JSON
A JSON used for configuring the evented object.|Name|Default Value|Summary| |----|-------------|-------| |onPropagationStopped : function| |Used to execute code once propagation has been stopped.| |onListenerExecuted : function| |Used to execute code when a listener has been executed.|
Name
Default Value
Summary
config : JSON
A JSON used for configuring the evented object.|Name|Default Value|Summary| |----|-------------|-------| |onPropagationStopped : function| |Used to execute code once propagation has been stopped.| |onListenerExecuted : function| |Used to execute code when a listener has been executed.|
emit(event, eventObj) : boolean | JSON
Executes a sequence of registered event listeners by the custom event string.- Source
javascript/scripts/AnalyzerEvented.js, line 118
Parameters
NameDefault ValueSummaryevent : string
The custom name for event listeners being executed.
eventObj : JSON
The JSON object which has the configuration for event emitting
{ bubbles: true, cancelable: true }Returns
NameDescription`boolean
JSON`
Name
Default Value
Summary
event : string
The custom name for event listeners being executed.
eventObj : JSON
The JSON object which has the configuration for event emitting { bubbles: true, cancelable: true }
Name
Description
`boolean
JSON`
on(event, listener) : object
Registers listeners via custom event strings which can be executed in order of registration.
Source
javascript/scripts/AnalyzerEvented.js, line 100
Parameters
NameDefault ValueSummaryevent : stringThe custom name for event listeners being executed.
listener : functionThe function which is to be executed when the emit event is called.
Returns
NameDescriptionobjectA dojo object which can be used to remove the listener from being executed by calling
obj.remove().
Name
Default Value
Summary
event : string
The custom name for event listeners being executed.
listener : function
The function which is to be executed when the emit event is called.
Name
Description
object
A dojo object which can be used to remove the listener from being executed by calling obj.remove().
testAddKnownFieldKinds(report, vizModel, roleName) : analyzer.visual.ICanAddFieldInfo
Tests the addition of each of the known field kinds to a visual role.
Source
javascript/scripts/visual/utils.js, line 94
Parameters
NameDefault ValueSummaryreport : cv.ReportThe Analyzer report.
vizModel : pentaho.visual.base.AbstractModelThe visualization model.
roleName : stringThe name of the visual role.
Returns
NameDescriptionanalyzer.visual.ICanAddFieldInfoThe test result.
Name
Default Value
Summary
report : cv.Report
The Analyzer report.
vizModel : pentaho.visual.base.AbstractModel
The visualization model.
roleName : string
The name of the visual role.
Name
Description
analyzer.visual.ICanAddFieldInfo
The test result.
Last updated

