Options
All
  • Public
  • Public/Protected
  • All
Menu

The class which determines how to sort ranges.

Hierarchy

  • Sort

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates a new instance of Sort with an optional set of options to override the default values.

    Parameters

    • Optional input: SortInput

      The options to apply to the new instance.

    Returns Sort

Properties

ascending

ascending: boolean = false

If the ranges should be in ascending order (small values followed by large values). The default value is in descending order.

classes

classes: SortClassMap

This object describes how ranges of different classes should be sorted by given each class a priority. If a class is not defined here the priority assumed is zero.

type

type: SortType = SortType.MAX

How ranges should be compared when the minimum and maximum values differ.

Methods

extend

  • Returns a Sort instance which matches the desired options. If no options are specified the reference to this instance is returned. If the options are already an instance of Sort its returned. If options are specified a new instance is created with the options of this instance, and the given options applied with Sort.set.

    Parameters

    • Optional input: SortInput

      The options desired.

    Returns Sort

    An instance of this class which matches the desired options.

getSorter

  • Returns a function which can sort ranges based on the options in this instance. Comparison is first done by class, and followed by type.

    Returns Sorter

set

  • Overrides values in this instance ith ones specified in the input. If class sorting options are specified they are merged into this instance as opposed to a complete overwrite.

    Parameters

    Returns this

    The reference to this instance.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc