ag-grid-community 32.3.2 → 33.0.0

package/dist/types/core/interfaces/iSparklineCellRendererParams.d.ts

@@ -1,438 +0,0 @@
-import type { ICellRendererParams } from '../rendering/cellRenderers/iCellRenderer';
-export interface ISparklineCellRendererParams<TData = any, TContext = any> extends ICellRendererParams<TData, TContext> {
-    sparklineOptions?: SparklineOptions;
-}
-export type SparklineOptions = LineSparklineOptions | AreaSparklineOptions | ColumnSparklineOptions | BarSparklineOptions;
-export interface BaseSparklineOptions {
-    /** The key to use to retrieve X values from the data. This will only be used if the data array contains objects with key-value pairs.
-     * @default 'x'
-     */
-    xKey?: string;
-    /** The key to use to retrieve Y values from the data. This will only be used if the data array contains objects with key-value pairs.
-     * @default 'y'
-     */
-    yKey?: string;
-    /** Configuration for the padding in pixels shown around the sparklines. */
-    padding?: PaddingOptions;
-    /** The options for the axis line in the sparklines. */
-    axis?: SparklineAxisOptions;
-    /** The configuration for the highlighting used when the items are hovered over. */
-    highlightStyle?: HighlightStyleOptions;
-    /** Configuration for the tooltips. */
-    tooltip?: SparklineTooltipOptions;
-}
-export interface LineSparklineOptions extends BaseSparklineOptions {
-    /** The type of sparklines to create, in this case it would be `'line'`. */
-    type?: 'line';
-    /** The configuration for the line. */
-    line?: SparklineLineOptions;
-    /** The configuration for the marker styles. */
-    marker?: SparklineMarkerOptions;
-    /** The configuration for the crosshairs. */
-    crosshairs?: SparklineCrosshairsOptions;
-}
-export interface AreaSparklineOptions extends BaseSparklineOptions {
-    /** The type of sparklines to create, in this case it would be `'area'`. */
-    type?: 'area';
-    /** The CSS colour value for the fill of the area.
-     * @default 'rgba(124, 181, 236, 0.25)'
-     */
-    fill?: string;
-    /** The configuration for the line. */
-    line?: SparklineLineOptions;
-    /** The configuration for the marker styles. */
-    marker?: SparklineMarkerOptions;
-    /** The configuration for the crosshairs. */
-    crosshairs?: SparklineCrosshairsOptions;
-}
-export interface ColumnSparklineOptions extends BaseSparklineOptions {
-    /** The type of sparklines to create, in this case it would be `'column'`. */
-    type?: 'column';
-    /** The CSS colour value for the fill of the columns.
-     * @default 'rgb(124, 181, 236)'
-     */
-    fill?: string;
-    /** The CSS colour value for the outline of the columns.
-     * @default 'silver'
-     */
-    stroke?: string;
-    /** The thickness in pixels for the stroke of the columns.
-     * @default 0
-     */
-    strokeWidth?: number;
-    /** The size of the gap between the columns as a proportion, between 0 and 1. This value is a fraction of the “step”, which is the interval between the start of a band and the start of the next band.
-     * @default 0.1
-     */
-    paddingInner?: number;
-    /** The padding on the outside i.e. left and right of the first and last columns, to leave some room for the axis. In association with `paddingInner`, this value can be between 0 and 1.
-     * @default 0.2
-     */
-    paddingOuter?: number;
-    /** User override for the automatically determined domain (based on data min and max values). Only applied to `number` axes.
-     * Used to interpolate the numeric pixel values corresponding to each data value.
-     */
-    valueAxisDomain?: [number, number];
-    /** A callback function to return format styles of type ColumnFormat, based on the data represented by individual columns. */
-    formatter?: SparklineColumnFormatter;
-    /** Configuration for the labels. */
-    label?: SparklineLabelOptions;
-}
-export interface BarSparklineOptions extends BaseSparklineOptions {
-    /** The type of sparklines to create, in this case it would be `'bar'`. */
-    type?: 'bar';
-    /** The CSS colour value for the fill of the bars.
-     * @default 'rgb(124, 181, 236)'
-     */
-    fill?: string;
-    /** The CSS colour value for the outline of the bars.
-     * Default `'silver'`
-     */
-    stroke?: string;
-    /** The thickness in pixels for the stroke of the bars.
-     * @default 0
-     */
-    strokeWidth?: number;
-    /** The size of the gap between the bars as a proportion, between 0 and 1. This value is a fraction of the “step”, which is the interval between the start of a band and the start of the next band.
-     * @default 0.1
-     */
-    paddingInner?: number;
-    /** The padding on the outside i.e. left and right of the first and last bars, to leave some room for the axis. In association with `paddingInner`, this value can be between 0 and 1.
-     * @default 0.2
-     */
-    paddingOuter?: number;
-    /** User override for the automatically determined domain (based on data min and max values). Only applied to `number` axes.
-     * Used to interpolate the numeric pixel values corresponding to each data value.
-     */
-    valueAxisDomain?: [number, number];
-    /** A callback function to return format styles of type BarFormat, based on the data represented by individual bars. */
-    formatter?: SparklineBarFormatter;
-    /** Configuration for the labels. */
-    label?: SparklineLabelOptions;
-}
-export interface SparklineLabelOptions {
-    /**
-     * Set to true to enable labels.
-     * @default false
-     */
-    enabled?: boolean;
-    /**
-     * Set size of the font.
-     * @default 8
-     */
-    fontSize?: number;
-    /**
-     * Specify the font for the label text.
-     * @default Verdana, sans-serif
-     */
-    fontFamily?: string;
-    /** Specify the font style for the label text. */
-    fontStyle?: 'normal' | 'italic' | 'oblique';
-    /** Set how thick or thin characters in label text should be displayed. */
-    fontWeight?: 'normal' | 'bold' | 'bolder' | 'lighter' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900';
-    /**
-     * Set the color of the label text. The color can be specified by a color name, a HEX or an RGB value.
-     * @default rgba(70, 70, 70, 1)
-     */
-    color?: string;
-    /**
-     * A callback function to return the text to be displayed as the label, based on the value represented by the column or bar.
-     * By default the values are simply stringified. */
-    formatter?: (params: LabelFormatterParams) => string;
-    /**
-     * Where to render labels relative to the segments.
-     * @default insideEnd
-     */
-    placement?: BarColumnLabelPlacement;
-}
-export interface LabelFormatterParams {
-    /** The Y value of the data point. */
-    value: number | undefined;
-}
-export declare enum BarColumnLabelPlacement {
-    InsideBase = "insideBase",
-    InsideEnd = "insideEnd",
-    Center = "center",
-    OutsideEnd = "outsideEnd"
-}
-export interface PaddingOptions {
-    /** The number of pixels of padding at the top of the sparkline area.
-     * @default 3
-     */
-    top?: number;
-    /** The number of pixels of padding at the right of the sparkline area.
-     * @default 3
-     */
-    right?: number;
-    /** The number of pixels of padding at the bottom of the sparkline area.
-     * @default 3
-     */
-    bottom?: number;
-    /** The number of pixels of padding at the left of the sparkline area.
-     * @default 3
-     */
-    left?: number;
-}
-export interface SparklineAxisOptions {
-    /** The type of axis used to plot the data.
-     * @default 'category'
-     */
-    type?: AxisType;
-    /** The CSS colour value for the outline of the axis line.
-     * @default 'rgb(204, 214, 235)'
-     */
-    stroke?: string;
-    /** The thickness in pixels for the stroke of the axis line.
-     * @default 1
-     */
-    strokeWidth?: number;
-}
-export type AxisType = 'number' | 'category' | 'time';
-export interface SparklineTooltipOptions {
-    /** Set to false to disable tooltips. */
-    enabled?: boolean;
-    /** The element to place the tooltip into. This can be used to confine the tooltip to a specific area which may be outside of the sparkline grid cell. */
-    container?: HTMLElement;
-    /**
-     * The horizontal distance in pixels between the cursor and the top left corner of the tooltip.
-     * @default 10
-     */
-    xOffset?: number;
-    /**
-     * The vertical distance in pixels between the cursor and the top left corner of the tooltip.
-     * @default 0
-     */
-    yOffset?: number;
-    /** A callback function used to create the content for the tooltips. This function should return an object or a HTML string used to render the tooltip. */
-    renderer?: SparklineTooltipRenderer;
-}
-export type SparklineTooltipRenderer = (params: TooltipRendererParams) => TooltipRendererResult;
-export interface TooltipRendererResult {
-    /** Set to false to disable individual tooltip. */
-    enabled?: boolean;
-    /** The content to display in each tooltip. */
-    content?: string;
-    /** The title of the tooltip. */
-    title?: string;
-    /** The CSS color for the title text. */
-    color?: string;
-    /** The CSS color for the background of the tooltip title. */
-    backgroundColor?: string;
-    /** The opacity of the background for the tooltip title. */
-    opacity?: number;
-}
-export interface TooltipRendererParams {
-    /** The grid context, includes row data, giving access to data from other columns in the same row. */
-    context?: any;
-    /** The raw datum associated with the point. */
-    datum: any;
-    /** The X value of the data point. */
-    xValue: any;
-    /** The Y value of the data point. */
-    yValue: any;
-}
-export interface SparklineLineOptions {
-    /** The CSS colour value for the line.
-     *  @default 'rgb(124, 181, 236)'
-     */
-    stroke?: string;
-    /** The thickness in pixels for the stroke of the line.
-     * @default 1
-     */
-    strokeWidth?: number;
-}
-export interface HighlightStyleOptions {
-    /**
-     * The width in pixels of the markers when hovered over. This is only for the Line and Area sparklines as Column and Bar sparklines do not have markers.
-     * @default 6
-     */
-    size?: number;
-    /**
-     * The fill colour of the markers, columns or bars when hovered over. Use `undefined` for no highlight fill.
-     * @default 'yellow'
-     */
-    fill?: string;
-    /**
-     * The CSS colour value for the outline of the markers, columns or bars when hovered over. Use `undefined` for no highlight stroke.
-     * @default 'silver'
-     */
-    stroke?: string;
-    /**
-     * The thickness in pixels for the stroke of the markers, columns or bars when hovered over.
-     * @default 1
-     */
-    strokeWidth?: number;
-}
-export interface SparklineCrosshairsOptions {
-    xLine?: CrosshairLineOptions;
-    yLine?: CrosshairLineOptions;
-}
-export interface CrosshairLineOptions {
-    /**
-     * Set to true to show crosshair line.
-     * @default false
-     */
-    enabled?: boolean;
-    /**
-     * The CSS colour value for the crosshair line.
-     * @default rgba(0,0,0, 0.54)
-     */
-    stroke?: string;
-    /**
-     * The thickness in pixels for the crosshair line.
-     * @default 1
-     */
-    strokeWidth?: number;
-    /**
-     * Defines how the crosshair stroke is rendered. This can be one of the lineDash style options.
-     * The default is `solid`, this renders a solid stroke with no gaps.
-     * @default 'solid'
-     */
-    lineDash?: 'dash' | 'dashDot' | 'dashDotDot' | 'dot' | 'longDash' | 'longDashDot' | 'longDashDotDot' | 'shortDash' | 'shortDashDot' | 'shortDashDotDot' | 'shortDot' | 'solid';
-    /**
-     * The shape used to draw the end points of the crosshair line.
-     * The options include `butt` (the ends of the line are squared off at the endpoints), `round` (the ends of the line are rounded) and `square` (the ends of the line are squared off by adding a box with width equal to the line's strokeWidth and height equal to half the line's strokeWidth).
-     * @default butt
-     */
-    lineCap?: 'round' | 'square' | 'butt';
-}
-export type SparklineColumnFormatter = (params: ColumnFormatterParams) => ColumnFormat;
-export type SparklineBarFormatter = (params: BarFormatterParams) => BarFormat;
-export interface ColumnFormatterParams {
-    /** The raw data associated with the specific column. */
-    datum: any;
-    /** The X value of the data point. */
-    xValue: any;
-    /** The Y value of the data point. */
-    yValue: any;
-    /** The width of the column in pixels. */
-    width: number;
-    /** The height of the column in pixels. */
-    height: number;
-    /** Whether or not the column is a minimum point. */
-    min?: boolean;
-    /** Whether or not the column is a maximum point. */
-    max?: boolean;
-    /** Whether or not the column represents the first data point. */
-    first?: boolean;
-    /** Whether or not the column represents the last data point. */
-    last?: boolean;
-    /** The CSS colour value for the fill of the individual column. */
-    fill?: string;
-    /** The CSS colour value for the outline of the individual column. */
-    stroke?: string;
-    /** The thickness in pixels for the stroke of the individual column. */
-    strokeWidth: number;
-    /** Whether or not the column is highlighted. */
-    highlighted: boolean;
-}
-export interface ColumnFormat {
-    /** The CSS colour value for the fill of the individual column. */
-    fill?: string;
-    /** The CSS colour value for the outline of the individual column. */
-    stroke?: string;
-    /** The thickness in pixels for the stroke of the individual column.*/
-    strokeWidth?: number;
-}
-export interface BarFormatterParams {
-    /** The raw data associated with the specific bar. */
-    datum: any;
-    /** The X value of the data point. */
-    xValue: any;
-    /** The Y value of the data point. */
-    yValue: any;
-    /** The width of the bar in pixels. */
-    width: number;
-    /** The height of the bar in pixels. */
-    height: number;
-    /** Whether or not the bar is a minimum point. */
-    min?: boolean;
-    /** Whether or not the bar is a maximum point. */
-    max?: boolean;
-    /** Whether or not the bar represents the first data point. */
-    first?: boolean;
-    /** Whether or not the bar represents the last data point. */
-    last?: boolean;
-    /** The CSS colour value for the fill of the individual bar. */
-    fill?: string;
-    /** The CSS colour value for the outline of the individual bar. */
-    stroke?: string;
-    /** The thickness in pixels for the stroke of the individual bar. */
-    strokeWidth: number;
-    /** Whether or not the bar is highlighted. */
-    highlighted: boolean;
-}
-export interface BarFormat {
-    /** The CSS colour value for the fill of the individual bar. */
-    fill?: string;
-    /** The CSS colour value for the outline of the individual bar. */
-    stroke?: string;
-    /** The thickness in pixels for the stroke of the individual bar.*/
-    strokeWidth?: number;
-}
-export interface SparklineMarkerOptions {
-    /** By default this is set to `true` whilst marker size is set to `0`, which means the markers are present but not visible.
-     * @default true
-     */
-    enabled?: boolean;
-    /** The shape of the markers.
-     * @default 'circle'
-     */
-    shape?: string;
-    /** The width in pixels of markers. By default this is `0`, increase the size to make markers visible.
-     * @default 0
-     */
-    size?: number;
-    /** The CSS colour value for the fill of the markers.
-     * @default 'rgb(124, 181, 236)'
-     */
-    fill?: string;
-    /** The CSS colour value for the outline of the markers.
-     * @default 'rgb(124, 181, 236)'
-     */
-    stroke?: string;
-    /** The thickness in pixels for the stroke of the markers.
-     * @default 1
-     */
-    strokeWidth?: number;
-    /** A callback function to return format styles for individual markers. */
-    formatter?: SparklineMarkerFormatter;
-}
-export type SparklineMarkerFormatter = (params: MarkerFormatterParams) => MarkerFormat;
-export interface MarkerFormatterParams {
-    /** The raw data associated with the specific marker. */
-    datum: any;
-    /** The X value of the data point. */
-    xValue: any;
-    /** The Y value of the data point. */
-    yValue: any;
-    /** Whether or not the marker is a minimum point. */
-    min?: boolean;
-    /** Whether or not the marker is a maximum point. */
-    max?: boolean;
-    /** Whether or not the marker represents the first data point. */
-    first?: boolean;
-    /** Whether or not the marker represents the last data point. */
-    last?: boolean;
-    /** The CSS colour value for the fill of the individual marker. */
-    fill?: string;
-    /** The CSS colour value for the outline of the individual marker. */
-    stroke?: string;
-    /** The thickness in pixels for the stroke of the individual marker. */
-    strokeWidth: number;
-    /** The width in pixels of the individual marker. */
-    size: number;
-    /** Whether or not the marker is highlighted. */
-    highlighted: boolean;
-}
-export interface MarkerFormat {
-    /** Set to false to make marker invisible. */
-    enabled?: boolean;
-    /** The width in pixels of the individual marker. */
-    size?: number;
-    /** The CSS colour value for the fill of the individual marker. */
-    fill?: string;
-    /** The CSS colour value for the outline of the individual marker. */
-    stroke?: string;
-    /** The thickness in pixels for the stroke of the individual marker.*/
-    strokeWidth?: number;
-}

package/dist/types/core/interfaces/iStatusBarService.d.ts

@@ -1,7 +0,0 @@
-import type { ComponentSelector } from '../widgets/component';
-import type { IStatusPanelComp } from './iStatusPanel';
-export interface IStatusBarService {
-    registerStatusPanel(key: string, component: IStatusPanelComp): void;
-    getStatusPanel(key: string): IStatusPanelComp;
-    getStatusPanelSelector(): ComponentSelector;
-}

package/dist/types/core/interfaces/iToolPanel.d.ts

@@ -1,60 +0,0 @@
-import type { ColumnToolPanelState } from './gridState';
-import type { AgGridCommon } from './iCommon';
-import type { IComponent } from './iComponent';
-export interface BaseToolPanelParams<TData = any, TContext = any, TState = any> extends AgGridCommon<TData, TContext> {
-    /** The tool-panel-specific initial state as provided in grid options if applicable */
-    initialState?: TState | undefined;
-}
-export interface IToolPanelParams<TData = any, TContext = any, TState = any> extends BaseToolPanelParams<TData, TContext, TState> {
-    /** If tool panel is saving and restoring state, this should be called after the state is updated */
-    onStateUpdated: () => void;
-}
-export interface IToolPanel<TData = any, TContext = any, TState = any> {
-    /**
-     * Called when `api.refreshToolPanel()` is called (with the current params).
-     * Also called when the `sideBar` grid option is updated (with the updated params).
-     * When `sideBar` is updated, if this method returns `true`,
-     * then the grid will take no further action.
-     * Otherwise, the tool panel will be destroyed and recreated.
-     */
-    refresh(params: IToolPanelParams<TData, TContext, TState>): boolean | void;
-    /** If saving and restoring state, this should return the current state */
-    getState?(): TState | undefined;
-}
-export interface IToolPanelComp<TData = any, TContext = any, TState = any> extends IToolPanel<TData, TContext, TState>, IComponent<IToolPanelParams<TData, TContext, TState>> {
-}
-/**
- * @deprecated v31.3 - Use `IToolPanelColumnCompParams` instead.
- */
-export interface ToolPanelColumnCompParams<TData = any, TContext = any> extends IToolPanelParams<TData, TContext, ColumnToolPanelState>, IToolPanelColumnCompParams {
-}
-export interface IToolPanelColumnCompParams {
-    /** Suppress Column Move */
-    suppressColumnMove: boolean;
-    /** Suppress Row Groups section */
-    suppressRowGroups: boolean;
-    /** Suppress Values section */
-    suppressValues: boolean;
-    /** Suppress Column Labels (Pivot) section */
-    suppressPivots: boolean;
-    /** Suppress Pivot Mode selection */
-    suppressPivotMode: boolean;
-    /** Suppress Column Filter section */
-    suppressColumnFilter: boolean;
-    /** Suppress Select / Un-select all widget */
-    suppressColumnSelectAll: boolean;
-    /** Suppress Expand / Collapse all widget */
-    suppressColumnExpandAll: boolean;
-    /** By default, column groups start expanded. Pass `true` to default to contracted groups */
-    contractColumnSelection: boolean;
-    /** Suppress updating the layout of columns as they are rearranged in the grid */
-    suppressSyncLayoutWithGrid: boolean;
-}
-export interface IToolPanelFiltersCompParams {
-    /** To suppress Expand / Collapse All */
-    suppressExpandAll: boolean;
-    /** To suppress the Filter Search */
-    suppressFilterSearch: boolean;
-    /** Suppress updating the layout of columns as they are rearranged in the grid */
-    suppressSyncLayoutWithGrid: boolean;
-}

package/dist/types/core/interfaces/masterDetail.d.ts

@@ -1,49 +0,0 @@
-import type { GridApi } from '../api/gridApi';
-import type { Bean } from '../context/bean';
-import type { GridOptions } from '../entities/gridOptions';
-import type { ICellRendererParams } from '../rendering/cellRenderers/iCellRenderer';
-import type { IRowNode } from './iRowNode';
-export interface IDetailCellRenderer<TData = any> {
-    addOrRemoveCssClass(cssClassName: string, on: boolean): void;
-    addOrRemoveDetailGridCssClass(cssClassName: string, on: boolean): void;
-    setDetailGrid(gridOptions: GridOptions<TData>): void;
-    setRowData(rowData: TData[]): void;
-    getGui(): HTMLElement;
-}
-export interface IDetailCellRendererParams<TData = any, TDetail = any> extends ICellRendererParams<TData> {
-    /**
-     * Provide Grid Options to use for the Detail Grid.
-     */
-    detailGridOptions: GridOptions<TDetail>;
-    /** A function that provides what rows to display in the Detail Grid. */
-    getDetailRowData: GetDetailRowData<TData, TDetail>;
-    /** Defines how to refresh the Detail Grids as data is changing in the Master Grid. */
-    refreshStrategy: 'rows' | 'everything' | 'nothing';
-    /** Allows changing the template used around the Detail Grid. */
-    template: string | TemplateFunc<TData>;
-    /** @deprecated v32.2 This property is no longer used */
-    agGridReact: any;
-    /** @deprecated v32.2 This property is no longer used */
-    frameworkComponentWrapper: any;
-    pinned: 'left' | 'right' | null | undefined;
-}
-export interface GetDetailRowData<TData = any, TDetail = any> {
-    (params: GetDetailRowDataParams<TData, TDetail>): void;
-}
-export interface GetDetailRowDataParams<TData = any, TDetail = any> {
-    /** Row node for the details request. */
-    node: IRowNode<TData>;
-    /** Data for the current row. */
-    data: TData;
-    /** Success callback: pass the rows back for the grid request.  */
-    successCallback(rowData: TDetail[]): void;
-}
-interface TemplateFunc<TData = any> {
-    (params: ICellRendererParams<TData>): string;
-}
-export interface IDetailCellRendererCtrl extends Bean {
-    init(comp: IDetailCellRenderer, params: IDetailCellRendererParams): void;
-    registerDetailWithMaster(api: GridApi): void;
-    refresh(): boolean;
-}
-export {};