Class Order

Represents a sort order.

Hierarchy

OnmsEnum<string>
- Order

Index

Constructors

Accessors

Methods

matches replace toDisplayString toJSON toString forLabel fromString

Constructors

constructor

new Order(id: string, label: string): Order
construct an enum object with an id and label
Parameters
- id: string
- label: string
Returns Order
Inherited from OnmsEnum<string>.constructor
- Defined in src/internal/OnmsEnum.ts:30

Accessors

id

get id(): T
get the index/id of this enum entry

Returns T
Inherited from OnmsEnum.id
- Defined in src/internal/OnmsEnum.ts:15

index

get index(): T
an alias for [[OnmsEnum.id]]

Returns T
Inherited from OnmsEnum.index
- Defined in src/internal/OnmsEnum.ts:20

label

get label(): string
get the label of this enum entry

Returns string
Inherited from OnmsEnum.label
- Defined in src/internal/OnmsEnum.ts:25

Methods

matches

matches(label: string): boolean
Whether this order matches the given order string.
Parameters
- label: string
Returns boolean
- Defined in src/api/OrderBy.ts:27

replace

replace(pattern: string | RegExp, replaceWith: string): string
Parameters
- pattern: string | RegExp
- replaceWith: string
Returns string
Inherited from OnmsEnum.replace
- Defined in src/internal/OnmsEnum.ts:54

toDisplayString

toDisplayString(): string
convert this enum to a string suitable for display

Returns string
Inherited from OnmsEnum.toDisplayString
- Defined in src/internal/OnmsEnum.ts:36

toJSON

toJSON(): {
    id: string;
    label: string;
    replace: (pattern: string | RegExp, replaceWith: string) => string;
}
convert to the JSON representation

Returns {
    id: string;
    label: string;
    replace: (pattern: string | RegExp, replaceWith: string) => string;
}
Inherited from OnmsEnum.toJSON
- Defined in src/internal/OnmsEnum.ts:46

toString

toString(): string
convert this enum to a string

Returns string
Inherited from OnmsEnum.toString
- Defined in src/internal/OnmsEnum.ts:41

`Static`forLabel

forLabel(label: string): any
Given a label ('ASC', 'DESC'), return the corresponding order.
Parameters
- label: string
Returns any
- Defined in src/api/OrderBy.ts:12

`Static`fromString

fromString(order: string): Order
given an order spec (order=DESC), return an [[Order]] object
Parameters
- order: string
Returns Order
- Defined in src/api/OrderBy.ts:17