Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LinkSorter

LinkSorter renders a list of sort links for the given sort definition.

LinkSorter will generate a hyperlink for every attribute declared in sort.

For more details and usage information on LinkSorter, see the guide article on sorting.

author

Mahesh S Warrier https://github.com/codespede

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

attributes

attributes: any = {}

List of the attributes that support sorting. If not set, it will be determined using Sort.attributes.

enablePjax

enablePjax: boolean = true

Whether to enable Pjax on this widget.

initialization

initialization: Promise<void>

A Promise which resolves when this Component has been successfully initialized.

linkOptions

linkOptions: {} = {}

HTML attributes for the link in a sorter container tag which are passed to Sort.link.

see

[[Html.renderTagAttribute]]s for details on how attributes are being rendered.

Type declaration

  • [key: string]: any

options

options: {} = ...

HTML attributes for the sorter container tag.

see

Html.ul for special attributes.

see

Html.renderTagAttributes for details on how attributes are being rendered.

Type declaration

  • [key: string]: any

sort

sort: Sort

the sort definition

Static autoIdPrefix

autoIdPrefix: string = 'w'

The prefix to the automatically generated widget IDs.

see

getId

Static counter

counter: number = 0

A counter used to generate id for widgets.

internal

Methods

getId

  • getId(autogenerate?: boolean): string

  • Returns the ID of the widget.

    Parameters

    • autogenerate: boolean = true

    Returns string

    ID of the widget.

init

  • init(): Promise<void>

registerAssets

  • registerAssets(): void

render

  • render(): Promise<string>

  • Renders a widget.

    throws

    InvalidArgumentException if the view file does not exist.

    Returns Promise<string>

    string the rendering result.

Protected renderSortLinks

  • renderSortLinks(): string

run

  • run(): Promise<string>

Generated using TypeDoc