Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VueDatatablePager<TSub>

The component that is used to manage & change pages on a VueDatatable.

Type parameters

Hierarchy

  • object & object & Vue<this>
    • VueDatatablePager

Index

Vue Props

Vue Events

Properties

Accessors

Methods

Vue Props

Const table

table: string

The id of the associated VueDatatable.

Const type

type: EPagerType

The kind of the pager

Const sidesCount

sidesCount: number

The number of pages visible on each side (only for [[EPageType.Abbreviated]])

Vue Events

VueDatatable.vuejs-datatable::pager-bound

  • VueDatatable.vuejs-datatable::pager-bound()

VueDatatable.vuejs-datatable::page-count-changed

  • VueDatatable.vuejs-datatable::page-count-changed()

VueDatatable.vuejs-datatable::page-changed

  • VueDatatable.vuejs-datatable::page-changed()

Properties

$attrs

$attrs: Record<string, string>

$children

$children: Vue[]

$createElement

$createElement: CreateElement

$data

$data: Record<string, any>

$datatables

$datatables: IDict<VueDatatable<any, any>>

$delete

$delete: delete

$el

$el: Element

$isServer

$isServer: boolean

$listeners

$listeners: Record<string, Function | Function[]>

$options

$options: ComponentOptions<Vue>

$parent

$parent: Vue

$props

$props: Record<string, any>

$refs

$refs: object

Type declaration

  • [key: string]: Vue | Element | Vue[] | Element[]

$root

$root: Vue

$scopedSlots

$scopedSlots: object

Type declaration

  • [key: string]: NormalizedScopedSlot | undefined

$set

$set: set

$slots

$slots: object

Type declaration

  • [key: string]: VNode[] | undefined

$ssrContext

$ssrContext: any

$vnode

$vnode: VNode

page

page: number = 1

The current page index in the associated VueDatatable.

Private ptableInstance

ptableInstance: VueDatatable<any, any> | null = null

Protected tableType

tableType: TableType<any>

totalPages

totalPages: number = 0

The total number of pages in the associated VueDatatable.

Static Vue

Vue: VueConstructor

Accessors

identifier

  • get identifier(): string

nextIcon

  • get nextIcon(): string

paginationClass

  • get paginationClass(): string

previousIcon

  • get previousIcon(): string

show

  • get show(): boolean

sidesIndexes

  • get sidesIndexes(): number[]

tableInstance

Private totalRows

  • get totalRows(): number

Methods

$destroy

  • $destroy(): void

  • Returns void

$emit

  • $emit(event: string, ...args: any[]): this

  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns this

$forceUpdate

  • $forceUpdate(): void

  • Returns void

$mount

  • $mount(elementOrSelector?: Element | string, hydrating?: undefined | false | true): this

  • Parameters

    • Optional elementOrSelector: Element | string
    • Optional hydrating: undefined | false | true

    Returns this

$nextTick

  • $nextTick(callback: function): void
  • $nextTick(): Promise<void>

  • Parameters

    • callback: function
        • (this: this): void

        • Parameters

          • this: this

          Returns void

    Returns void

  • Returns Promise<void>

$off

  • $off(event?: string | string[], callback?: Function): this

  • Parameters

    • Optional event: string | string[]
    • Optional callback: Function

    Returns this

$on

  • $on(event: string | string[], callback: Function): this

  • Parameters

    • event: string | string[]
    • callback: Function

    Returns this

$once

  • $once(event: string | string[], callback: Function): this

  • Parameters

    • event: string | string[]
    • callback: Function

    Returns this

$watch

  • $watch(expOrFn: string, callback: function, options?: WatchOptions): function
  • $watch<T>(expOrFn: function, callback: function, options?: WatchOptions): function

  • Parameters

    • expOrFn: string
    • callback: function
        • (this: this, n: any, o: any): void

        • Parameters

          • this: this
          • n: any
          • o: any

          Returns void

    • Optional options: WatchOptions

    Returns function

      • (): void

      • Returns void

  • Type parameters

    • T

    Parameters

    • expOrFn: function
        • (this: this): T

        • Parameters

          • this: this

          Returns T

    • callback: function
        • (this: this, n: T, o: T): void

        • Parameters

          • this: this
          • n: T
          • o: T

          Returns void

    • Optional options: WatchOptions

    Returns function

      • (): void

      • Returns void

created

  • created(): void

Private linkWithTable

  • linkWithTable(tableName: string): boolean

  • Link the pager with the table, assign to the table some properties, and trigger an event on the table.

    Parameters

    • tableName: string

      The name of the table to bind the pager with.

    Returns boolean

    true if the link is succesfull, or false if it could not find a table to associate with.

Private onPageChanged

  • onPageChanged(page: number): void

Private onPageCountChanged

  • onPageCountChanged(totalPages: number): void

Private onSetPage

  • onSetPage(page: number): void

Generated using TypeDoc