Skip to main content
Hitachi Vantara Lumada and Pentaho Documentation

Sort

pentaho.type.action Sort

The Sort class describes the primitive operation that sorts the element in a list.

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

AMD Module

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

Extends

Constructor

Name Description
new Sort(comparer)

Creates an instance.

Members

Name Description
id
Static
eventName
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 Sort(comparer)

Creates an instance.

Source: javascript/web/pentaho/type/action/Sort.js, line 42

Parameters:
Name Default Value Summary
comparer : function

The function used for comparing elements in the list.

Members Details

id:
Static

Source: javascript/web/pentaho/type/action/Sort.js, line 65

eventName:

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

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

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/Sort.js, line 55

Default Value: "sort"

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

Methods Details

_apply()

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

_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.