@adaptabletools/adaptable/src/Api/Internal/FormatColumnInternalApi.d.ts

Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements

import { AdaptableColumn, AdaptableFormat, AdaptablePredicateDef, ColumnScope, FormatColumn, StringFormatterOptions } from '../../types';
import { ApiBase } from '../Implementation/ApiBase';
import { IRowNode } from 'ag-grid-enterprise';
export declare class FormatColumnInternalApi extends ApiBase {
    /**
     * Retrieves all Format Columns in Adaptable State with the `Style` property set
     * @returns format columns
     */
    getAllFormatColumnWithStyle(): FormatColumn[];
    /**
     * Retrieves all Format Columns in Adaptable State with the `Style` or the `CellAlignment` property set
     * @returns format columns
     */
    getAllFormatColumnWithStyleAndCellAlignment(): FormatColumn[];
    /**
     * Retrieves all Format Columns in Adaptable State with `DisplayFormat` property set
     * @returns format columns
     */
    getAllFormatColumnWithDisplayFormat(): FormatColumn[];
    /**
     * Retrieves all Format Columns in Adaptable State with `CellAlignment` property set
     * @returns format columns
     */
    getAllFormatColumnWithCellAlignment(): FormatColumn[];
    /**
     * Get all FormatColumns which are defined for this column and have a custom AdaptableStyle
     * @param column
     * @param config
     * @returns list of FormatColumn
     */
    getFormatColumnsWithStyleForColumn(column: AdaptableColumn, config?: {
        includeSuspended?: boolean;
    }): FormatColumn[];
    /**
     * Gets Format Column if any for given Column which includes Style element with ClassName
     * @param column The Column for which to retrieve the Format Column
     * @returns format columns
     */
    getFormatColumnWithStyleClassNameForColumn(column: AdaptableColumn, config?: {
        includeSuspended?: boolean;
    }): FormatColumn[];
    getFormatColumnWithColumnInScope(formatColumns: FormatColumn[], column: AdaptableColumn): FormatColumn[];
    private getFormatColumnInColumnScope;
    /**
     * Get all FormatColumns which are defined for this column and have a custom DisplayFormat
     * @param column
     * @param config
     * @returns list of FormatColumn
     */
    getFormatColumnsWithDisplayFormatForColumn(column: AdaptableColumn, config?: {
        includeSuspended?: boolean;
    }): FormatColumn[];
    /**
     * Format value according to format options.
     *
     * @param customDisplayFormatterContext context that includes value to format
     * @param options formatter options
     */
    getNumberFormattedValue(value: any, node: IRowNode, column: AdaptableColumn, options: AdaptableFormat['Options']): any;
    /**
     * Format value according to format options.
     *
     * @param value  context that includes value to format
     * @param options formatter options
     */
    getStringFormattedValue(value: any, node: IRowNode, column: AdaptableColumn, options: StringFormatterOptions): string;
    /**
     * Format value according to format options.
     *
     * @param customDisplayFormatterContext  context that includes value to format
     * @param options formatter options
     */
    getDateFormattedValue(value: any, node: IRowNode, abColumn: AdaptableColumn, options: AdaptableFormat['Options']): string;
    private applyCustomFormatters;
    /**
     * Returns all Predicates appropriate for the given Scope
     * @param scope Scope to check
     */
    getFormatColumnDefsForScope(scope: ColumnScope): AdaptablePredicateDef[];
    /**
     * Checks if format column is relevant for a given cell (intersection of given AdaptableColumn and RowNode)
     *
     * @param formatColumn
     * @param column
     * @param params
     */
    formatColumnShouldRender(formatColumn: FormatColumn, column: AdaptableColumn, rowNode: IRowNode, cellValue: any): boolean;
    private evaluatePredicate;
    private evaluateExpression;
    /**
     * Extract from the given FormatColumns only the ones which are relevant for a given cell (intersection of given AdaptableColumn and RowNode)
     *
     * @param formatColumns
     * @param column
     * @param params
     */
    getFormatColumnsRelevantForColumn(formatColumns: FormatColumn[], column: AdaptableColumn, params: {
        node: IRowNode;
        value: any;
    }): FormatColumn[];
    /**
     * Extract from the given FormatColumns the one which is the most relevant  for a given cell (intersection of given AdaptableColumn and RowNode)
     *
     * @param formatColumns
     * @param column
     * @param params
     */
    getMostRelevantFormatColumnForColumn(formatColumns: FormatColumn[], column: AdaptableColumn, params: {
        node: IRowNode;
        value: any;
    }): FormatColumn | undefined;
    /**
     * Retrieves all Format Columns which have an Expression
     * @returns Format Columns with Expression
     */
    getFormatColumnsWithExpression(): FormatColumn[];
    getFormatColumnsDependentOnColumns(columnSet: Set<string>): FormatColumn[];
    /**
     * Retrieves the columns that need rerendering based on format column predicates.
     */
    getFormatColumnColumnsDependentOnColumnChange(column: AdaptableColumn): string[];
}