@highcharts/dashboards
Version:
Highcharts Dashboards framework
58 lines (57 loc) • 1.42 kB
TypeScript
import type { CreditsOptions } from './Options';
import type Grid from './Grid';
/**
* Represents a credits in the grid.
*/
declare class Credits {
/**
* Default options of the credits.
*/
static defaultOptions: CreditsOptions;
/**
* The Grid instance which the credits belong to.
*/
readonly grid: Grid;
/**
* The credits container HTML element.
*/
readonly containerElement: HTMLElement;
/**
* The credits content HTML element.
*/
textElement: HTMLElement;
/**
* The options for the credits.
*/
options: CreditsOptions;
/**
* Construct the credits.
*
* @param grid
* The Grid instance which the credits belong to.
*
* @param options
* Options for the credits label. Predefined if not provided.
*
*/
constructor(grid: Grid, options?: CreditsOptions);
/**
* Render the credits. If the credits are disabled, they will be removed
* from the container.
*/
render(): void;
private renderAnchor;
/**
* Get the height of the credits container.
*/
getHeight(): number;
/**
* 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.
*/
destroy(): void;
}
declare namespace Credits {
}
export default Credits;