Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • T

Hierarchy

Index

Constructors

constructor

Properties

Protected _isDestroyed

_isDestroyed: boolean

Protected _mapCallback

_mapCallback: function

Type declaration

Protected _pageSize

_pageSize: number

Protected _queryParams

_queryParams: QueryParameters

app

currIndexEnd

currIndexEnd: Observable<number>

currIndexStart

currIndexStart: Observable<number>

currIndexStartFromOne

currIndexStartFromOne: Observable<number>

currPageNumber

currPageNumber: Observable<number>

firstPageNumber

firstPageNumber: Observable<number>

id

id: string

isInitialized

isInitialized: boolean

Whether or not the document collection is successfully initialized.

items

The items of the current page.

lastPageNumber

lastPageNumber: Observable<number>

libraryId

libraryId: string

numberOfItems

numberOfItems: Observable<number>

The total number of items in the collection.

statusFetching

statusFetching: Observable<boolean>

statusOffline

statusOffline: Observable<boolean>

stopFetching

stopFetching: boolean

Whether or not this collection should stop fetching items from the server.

Methods

Protected _buildQueryParams

  • Build the query parameters with paging related properties.

    Returns QueryParameters

Protected _handlePageChanged

  • _handlePageChanged(): void
  • Returns void

Protected _handleQueryResult

  • Parameters

    Returns void

Protected _populateFromDocStore

  • _populateFromDocStore(): void
  • Returns void

addFilter

  • addFilter(filter: Filter, filterType?: string): void
  • Adds a filter to the query. Removes any previous filters with the same filter.

    Parameters

    • filter: Filter

      The filter to add.

    • Optional filterType: string

      The type of filter.

    Returns void

auto

  • auto(arg0: any, arg1: any, arg2: any): void
  • Binds a handler to an Observable or to a dojo.connect. Binding to an Observable:

    ``` this.auto(someObservable, function (newValue) { });

    with explicit scope:

    this.auto(someObservable, this, function (newValue) { });

    Alternately, pass an event name as a string to use dojo.connect:

    this.auto(window, "onclick", function () { }); ```

    Parameters

    • arg0: any

      Either an Observable (for observable bindings) or a regular object (if arg1 is a string)

    • arg1: any

      If arg0 is an Observable, a function or scope object. Otherwise, an event name (to use with dojo.connect).

    • arg2: any

      If arg0 is an Observable, a function handler.

    Returns void

destroy

  • destroy(): void
  • Disposes any bindings tracked by this object.

    Returns void

destroyBindings

  • destroyBindings(): void

getLength

  • getLength(): number
  • Get the total length of the collection.

    Returns number

getQueryParameters

  • Get the query parameters being used to populate the items.

    Returns QueryParameters

getResource

  • getResource(resourceKey: string, locale?: string): string
  • Gets a language resource from the Application's resource dictionary, given a key, and optional locale. Returns null if the resource does not exist.

    Parameters

    • resourceKey: string
    • Optional locale: string

      The locale of the resource to fetch. Defaults to the current application locale.

    Returns string

initialize

nextPage

  • nextPage(): void
  • Increments the page number.

    Returns void

onDestroy

  • onDestroy(): void
  • Override or attach to provide custom clean-up behaviour.

    Returns void

prevPage

  • prevPage(): void
  • Decrements the page number.

    Returns void

refresh

  • refresh(): void
  • Refreshes the collection.

    Returns void

removeFilter

  • removeFilter(field: string, filterType?: string): void
  • Remove filters using a given field.

    Parameters

    • field: string

      The field of the filters to remove.

    • Optional filterType: string

      The type of filter.

    Returns void

setQueryParameters

  • Set the query parameters used to populate the items.

    Parameters

    Returns void

sortBy

  • Sort the documents.

    Parameters

    Returns void

trackCommandHandler

  • trackCommandHandler(command: any, token: any): void
  • Tracks a subscription to an {@link geocortex.framework.commands.Command}, disposing it when this object is disposed with the destroy method.

    Parameters

    • command: any
    • token: any

    Returns void

trackSubscription

  • trackSubscription(event: any, token: any): void
  • Tracks a subscription to an {@link geocortex.framework.events.Event}, disposing it when this object is disposed with the destroy method.

    Parameters

    • event: any
    • token: any

    Returns void