Skip to main content
Pentaho Documentation

DidUpdate

pentaho.visual.base.events.DidUpdate

This event is emitted when updating the view with Model#update and it occurs without any failures.

Extends

Constructor

Name Description
new DidUpdate(source)

Creates a DidUpdate event.

Members

Name Description
type : string
 
Static

Gets the event type.

cancelReason : Error

Gets the reason why the event was canceled, if any, or null.

isCancelable : boolean

Gets a value that indicates if the event can be canceled.

isCanceled : boolean

Gets a value that indicates if the event has been canceled.

source : pentaho.lang.IEventSource

Gets the source of the event.

type : nonEmptyString

Gets the type of the event.

Methods

Name Description
cancel(reason)

Cancels the event.

clone() : pentaho.lang.Event

Creates a clone of the event object.

Constructor Details

new DidUpdate(source)

Creates a DidUpdate event.

Source: javascript/web/pentaho/visual/base/events/DidUpdate.js, line 23

Parameters:
Name Default Value Summary
source : pentaho.visual.base.View

The view object that is emitting the event.

Members Details

type: string
 
Static

Gets the event type.

Source: javascript/web/pentaho/visual/base/events/DidUpdate.js, line 50

cancelReason: Error

Gets the reason why the event was canceled, if any, or null.

Source: javascript/web/pentaho/lang/Event.js, line 116

Inherited From: pentaho.lang.Event#cancelReason

isCancelable: boolean

Gets a value that indicates if the event can be canceled.

Source: javascript/web/pentaho/lang/Event.js, line 106

Inherited From: pentaho.lang.Event#isCancelable

isCanceled: boolean

Gets a value that indicates if the event has been canceled.

Source: javascript/web/pentaho/lang/Event.js, line 152

Inherited From: pentaho.lang.Event#isCanceled

source: pentaho.lang.IEventSource

Gets the source of the event.

Source: javascript/web/pentaho/lang/Event.js, line 96

Inherited From: pentaho.lang.Event#source

type: nonEmptyString

Gets the type of the event.

Source: javascript/web/pentaho/lang/Event.js, line 86

Inherited From: pentaho.lang.Event#type

Methods Details

cancel(reason)

Cancels the event.

This method has no effect if the event is not cancelable or has already been canceled.

Source: javascript/web/pentaho/lang/Event.js, line 131

Inherited From: pentaho.lang.Event#cancel

Parameters:
Name Default Value Summary
reason : string | Error
 
Optional
"canceled"

The reason why the event is being canceled.

See also:  pentaho.lang.Event#isCancelable , pentaho.lang.Event#isCanceled , pentaho.lang.Event#cancelReason

clone() : pentaho.lang.Event

Creates a clone of the event object.

Source: javascript/web/pentaho/lang/Event.js, line 161

Inherited From: pentaho.lang.Event#clone

Returns:
Name Description
pentaho.lang.Event

The cloned event object.