Skip to main content
Pentaho Documentation

Sort

pentaho.type.changes.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.changes.ListChangeset.

AMD Module

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

Extends

Constructor

Name Description
new Sort(comparer)

Creates an instance.

Members

Name Description
base : function
 
Protected

If a method has been overridden, then the base method provides access to the overridden method.

type : string

Gets the type of change.

Methods

Name Description
_apply(target)
 
Protected

Applies any local primitive changes.

extend(source, keyArgs) : Object

Extend an object with the properties of another.

Constructor Details

new Sort(comparer)

Creates an instance.

Source: javascript/web/pentaho/type/changes/Sort.js, line 22

Parameters:
Name Default Value Summary
comparer : function

The function used for comparing elements in the list.

Members Details

base: function
 
Protected

If a method has been overridden, then the base method provides access to the overridden method.

Can also be called from within a constructor function.

Source: javascript/web/pentaho/lang/Base.js, line 265

Inherited From: pentaho.lang.Base#base

type: string

Gets the type of change.

Source: javascript/web/pentaho/type/changes/Sort.js, line 52

Default Value: "sort"

Overrides: pentaho.type.changes.PrimitiveChange#type

Methods Details

_apply(target)
 
Protected

Applies any local primitive changes.

Source: javascript/web/pentaho/type/changes/Change.js, line 50

Overrides: pentaho.type.changes.PrimitiveChange#_apply

Parameters:
Name Default Value Summary
target : pentaho.type.ContainerMixin

The container to which changes are applied.

extend(source, keyArgs) : Object

Extend an object with the properties of another.

Methods that are overridden are accessible through this.base.

This object is extended, but its class doesn't change.

Can be applied to non-Base instances (e.g. using Base.prototype.extend.call(alien, {a: "hello"})).

Source: javascript/web/pentaho/lang/Base.js, line 808

Inherited From: pentaho.lang.Base#extend

Parameters:
Name Default Value Summary
source : Object

The instance specification.

keyArgs : Object
 
Optional

The keyword arguments.

Parameters:
Name Default Value Summary
exclude : Object
 
Optional

A map of property names to exclude from source.

Returns:
Name Description
Object

This object.