Class CreditsPro

Represents a credits in the data grid.

Hierarchy

Credits
- CreditsPro

Index

Constructors

Properties

containerElement grid options textElement defaultOptions

Methods

destroy getHeight render update

Constructors

constructor

new CreditsPro(grid: Grid, options?: CreditsOptions): CreditsPro
Construct the credits.
Parameters
- grid: Grid
  The Grid instance which the credits belong to.
- Optionaloptions: CreditsOptions
  Options for the credits label. Predefined if not provided.
Returns CreditsPro
Inherited from Credits.constructor

Properties

`Readonly`containerElement

containerElement: HTMLElement

The credits container HTML element.

`Readonly`grid

grid: Grid

The Grid instance which the credits belong to.

options

options: CreditsOptions

The options for the credits.

textElement

textElement: HTMLElement

The credits content HTML element.

`Static`defaultOptions

defaultOptions: CreditsOptions = ...

Default options of the credits.

Methods

destroy

destroy(): void
Destroy the credits. The credits will be removed from the container and the reference to the credits will be deleted from the Grid instance it belongs to.

Returns void
Overrides Credits.destroy

getHeight

getHeight(): number
Get the height of the credits container.

Returns number
Inherited from Credits.getHeight

render

render(): void
Render the credits. If the credits are disabled, they will be removed from the container. If also reflows the viewport dimensions.

Returns void
Overrides Credits.render

update

update(options: Partial<CreditsOptions> | undefined, render?: boolean): void
Update the credits with new options.
Parameters
- options: Partial<CreditsOptions> | undefined
  The new options for the credits.
- render: boolean = true
  Whether to render the credits after the update.
Returns void