Skip to main content

Pentaho+ documentation is moving!

The new product documentation portal is here. Check it out now at docs.hitachivantara.com

 

Hitachi Vantara Lumada and Pentaho Documentation

Move

pentaho.type.action Move

The Move class describes the primitive operation that changes an element position inside a list.

This type of change is always part of a pentaho.type.action.ListChangeset.

AMD Module

require(["pentaho/type/action/Move"], function(Move) { /* code goes here */ });

Extends

Constructor

Name Description
new Move(elem, indexOld, indexNew)

Creates an instance.

Members

Name Description
id
Static
element :  pentaho.type.Element

Gets the element that is about to be moved in the list.

eventName
indexNew :  number

Gets the new index of the element in the list.

indexOld :  number

Gets the old index of the element in the list.

transactionVersion
type :  string

Gets the type of change.

Methods

Name Description
_apply()
_cancel(changeset)
Protected

Unregisters reference changes caused by this change.

_prepare(changeset)
Protected

Registers reference changes caused by this change.

_setTransactionVersion(txnVersion)
Protected

Sets the new transaction version of this change.

Constructor Details

new Move(elem, indexOld, indexNew)

Creates an instance.

Source: javascript/web/pentaho/type/action/Move.js, line 54

Parameters:
Name Default Value Summary
elem : Array.<pentaho.type.Element>

The element to be moved in the list.

indexOld : number

The old index of the element in the list.

indexNew : number

The new index of the element in the list.

Members Details

id:
Static

Source: javascript/web/pentaho/type/action/Move.js, line 100

element:  pentaho.type.Element

Gets the element that is about to be moved in the list.

Source: javascript/web/pentaho/type/action/Move.js, line 62

eventName:

Source: javascript/web/pentaho/type/action/Change.js, line 40

Inherited From: pentaho.type.action.Change#eventName

indexNew:  number

Gets the new index of the element in the list.

Source: javascript/web/pentaho/type/action/Move.js, line 78

indexOld:  number

Gets the old index of the element in the list.

Source: javascript/web/pentaho/type/action/Move.js, line 70

transactionVersion:

Source: javascript/web/pentaho/type/action/PrimitiveChange.js, line 49

Inherited From: pentaho.type.action.PrimitiveChange#transactionVersion

type:  string

Gets the type of change.

Source: javascript/web/pentaho/type/action/Move.js, line 90

Default Value: "move"

See also: pentaho.type.action.Change#type

Methods Details

_apply()

Source: javascript/web/pentaho/type/action/Move.js, line 95

_cancel(changeset)
Protected

Unregisters reference changes caused by this change.

Source: javascript/web/pentaho/type/action/PrimitiveChange.js, line 83

Inherited From: pentaho.type.action.PrimitiveChange#_cancel

Parameters:
Name Default Value Summary
changeset : pentaho.type.action.Changeset

The changeset.

_prepare(changeset)
Protected

Registers reference changes caused by this change.

Source: javascript/web/pentaho/type/action/PrimitiveChange.js, line 72

Inherited From: pentaho.type.action.PrimitiveChange#_prepare

Parameters:
Name Default Value Summary
changeset : pentaho.type.action.Changeset

The changeset.

_setTransactionVersion(txnVersion)
Protected

Sets the new transaction version of this change.

Source: javascript/web/pentaho/type/action/PrimitiveChange.js, line 60

Inherited From: pentaho.type.action.PrimitiveChange#_setTransactionVersion

Parameters:
Name Default Value Summary
txnVersion : number

The transaction version.