documentationfor yFiles for HTML 2.6

IComparable

Provides a method by which implementors can be compared to each other.

Inheritance Hierarchy

IComparable

ColumnDescriptor

PartitionCellIdEntry

SwimlaneDescriptor

Type Details

yfiles module: lang
yfiles-umd modules: All modules
Legacy UMD name: yfiles.lang.IComparable

See Also

Sorting Child Nodes

Methods

compareTo

(obj: Object) : number

Compares this object to the given object of the same type.

Parameters

options - Object
A map of options to pass to the method.

obj - Object: The object to compare this to.

Returns

↪number

-1: this is less than obj
0: this is equal to obj
1: this is greater than obj