TypeScript ListViewModels

In addition to TypeScript ViewModels for interacting with instances of your data classes in TypeScript, Coalesce will also generated a List ViewModel for loading searched, sorted, paginated data from the server.

These ListViewModels, like the ViewModels, are dependent on Knockout and are designed to be used directly from Knockout bindings in your HTML.

Base Members

The following members are defined on BaseListViewModel<> and are available to the ListViewModels for all of your model types:

modelKeyName: string
Name of the primary key of the model that this list represents.
includes: string
String that is used to control loading and serialization on the server. See Includes String for more information.
items: KnockoutObservableArray<TItem>
The collection of items that have been loaded from the server.
addNewItem: (): TItem
Adds a new item to the items collection.
deleteItem: (item: TItem): JQueryPromise<any>
Deletes an item and removes it from the items collection.
queryString: string
Query string to append to the API call when loading the list of items. If query is non-null, this value will not be used. See below for more information about query.
search: KnockoutObservable<string>
Search criteria for the list. This can be easily bound to with a text box for easy search behavior. See [Search] for a detailed look at how searching works in Coalesce.
isLoading: KnockoutObservable<boolean>
True if the list is loading.
isLoaded: KnockoutObservable<boolean>
True once the list has been loaded.
load: (callback?: any): JQueryPromise<any>
Load the list using current parameters for paging, searching, etc Result is placed into the items property.
message: KnockoutObservable<string>
If a load failed, this is a message about why it failed.
getCount: (callback?: any): JQueryPromise<any>
Gets the count of items without getting all the items. Result is placed into the count property.
count: KnockoutObservable<number>
The result of getCount(), or the total on this page.
totalCount: KnockoutObservable<number>
Total count of items, even ones that are not on the page.
nextPage: (): void
Change to the next page.
nextPageEnabled: KnockoutComputed<boolean>
True if there is another page after the current page.
previousPage: (): void
Change to the previous page.
previousPageEnabled: KnockoutComputed<boolean>
True if there is another page before the current page.
page: KnockoutObservable<number>
Page number. This can be set to get a new page.
pageCount: KnockoutObservable<number>
Total page count
pageSize: KnockoutObservable<number>
Number of items on a page.
orderBy: KnockoutObservable<string>

Name of a field by which this list will be loaded in ascending order.

If set to “none”, default sorting behavior, including behavior defined with use of [DefaultOrderBy] in C# POCOs, is suppressed.

orderByDescending: KnockoutObservable<string>
Name of a field by which this list will be loaded in descending order.
orderByToggle: (field: string): void
Toggles sorting between ascending, descending, and no order on the specified field.
csvUploadUi: (callback?: () => void): void
Prompts to the user for a file to upload as a CSV.
downloadAllCsvUrl: KnockoutComputed<string>
Returns URL to download a CSV for the current list with all items.

Model-Specific Members

Configuration

A static configuration object for configuring all instances of the ListViewModel’s type is created, as well as an instance configuration object for configuring specific instances of the ListViewModel. See (see ViewModel Configuration) for more information.

public static coalesceConfig = new Coalesce.ListViewModelConfiguration<PersonList, ViewModels.Person>(Coalesce.GlobalConfiguration.listViewModel);

public coalesceConfig = new Coalesce.ListViewModelConfiguration<PersonList, ViewModels.Person>(PersonList.coalesceConfig);
Filter Object

For each exposed value type instance property on the underlying EF POCO, a property named filter will have a property declaration generated for that property. If the filter object is set, requests made to the server to retrieve data will be passed all the values in this object via the URL’s query string. These parameters will filter the resulting data to only rows where the parameter values match the row’s values. For example, if filter.companyId is set to a value, only people from that company will be returned.

public filter: {
    personId?: string
    firstName?: string
    lastName?: string
    gender?: string
    companyId?: string
} = null;
var list = new ListViewModels.PersonList();
list.filter = {
    lastName: "Erickson",
};
list.load();

These parameters all allow for freeform string values, allowing the server to implement any kind of filtering logic desired. The Standard Data Source will perform simple equality checks, but also the following:

  • Enum properties may have a filter that contains either enum names or integer values. There may be a single such value, or multiple, comma-delimited values where the actual value may match any of the filter values.
  • The same goes for numeric properties - you can specify a comma-delimited list of numbers to match on any of those values.
  • Date properties can specify an exact time, or a date with no time component. In the latter case, any times that fall within that day will be matched.
Static Method Members
For each exposed Static Method on your POCO, the members outlined in Methods - Generated TypeScript will be created.
DataSources

For each of the Data Sources on the class, a corresponding class will be added to a namespace named ListViewModels.<ClassName>DataSources. This namespace can always be accessed on both ViewModel and ListViewModel instances via the dataSources property, and class instances can be assigned to the dataSource property.

module ListViewModels {
    export namespace PersonDataSources {

        export class WithoutCases extends Coalesce.DataSource<ViewModels.Person> { }
        export const Default = WithoutCases;

        export class NamesStartingWithAWithCases extends Coalesce.DataSource<ViewModels.Person> { }

        /** People whose last name starts with B or c */
        export class BorCPeople extends Coalesce.DataSource<ViewModels.Person> { }
    }

    export class PersonList extends Coalesce.BaseListViewModel<PersonList, ViewModels.Person> {
        public dataSources = PersonDataSources;
        public dataSource: PersonDataSources = new this.dataSources.Default();
    }
}