Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a sort order.

Hierarchy

  • OnmsEnum<string>
    • Order

Index

Constructors

  • new Order(id: string, label: string): API.Order
  • construct an enum object with an id and label

    Parameters

    • id: string
    • label: string

    Returns API.Order

Accessors

  • get id(): T
  • get index(): T
  • get label(): string

Methods

  • matches(label: string): boolean
  • Whether this order matches the given order string.

    Parameters

    • label: string

    Returns boolean

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

    Returns string

  • toJSON(): { id: string; label: string }
  • convert to the JSON representation

    Returns { id: string; label: string }

    • id: string
    • label: string
  • toString(): string
  • forLabel(label: string): any
  • Given a label ('ASC', 'DESC'), return the corresponding order.

    Parameters

    • label: string

    Returns any

Generated using TypeDoc