compareSymb MethodStatic

Compares two gradient symbologies. Used for ordering Gradient.Symb objects.

compareSymb(lhs: Gradient.Symb, rhs: Gradient.Symb): number

@returns 0 if lhs is equivalent to rhs, a negative number if lhs compares less than rhs, or a positive number if lhs compares greater than rhs.

Parameter Type Description
lhs Gradient.Symb First gradient to compare
rhs Gradient.Symb Second gradient to compare

Returns - number

0 if lhs is equivalent to rhs, a negative number if lhs compares less than rhs, or a positive number if lhs compares greater than rhs.

Defined in

Last Updated: 14 May, 2024