@lineup-lite/hooks

Index

References

Namespaces

Interfaces

Variables

Functions

References

LineUpLiteGroupByFunction

Renames and re-exports UseGroupingOptionGroupingFunction

UseColumnGroupByColumnOptions

Renames and re-exports UseGroupingOptionsColumnOptions

Type Aliases

AnyObject

AnyObject: object

ArrayAxisRendererOptions

ArrayAxisRendererOptions: ArrayAxisProps | CommonProps

DateGroupByGranularity

DeriveColumnResult

DeriveColumnResult<D>: DeriveCategoricalColumnResult<D> | DeriveDateColumnResult<D> | DeriveNumberColumnResult<D> | DeriveTextColumnResult<D>

Type Parameters

D extends AnyObject = UnknownObject

GroupingOptions

GroupingOptions<D>: { id: IdType<D>; value: GroupingOptionsValue }[]

Type Parameters

D extends AnyObject

GroupingOptionsCellProps

GroupingOptionsCellProps<D>: CellProps<D> & { column: UseGroupingOptionsColumnProps }

Type Parameters

D extends AnyObject = UnknownObject

GroupingOptionsProps

GroupingOptionsProps<D>: HeaderProps<D> & { column: UseGroupingOptionsColumnProps }

Type Parameters

D extends AnyObject = UnknownObject

GroupingOptionsValue

GroupingOptionsValue: any

LineUpLiteColumn

LineUpLiteColumn<D>: Column<D> & UseFiltersColumnOptions<D> & UseGroupByColumnOptions<D> & UseSortByColumnOptions<D> & UseStatsColumnOptions<D> & UseResizeColumnsColumnOptions<D> & UseGroupingOptionsColumnOptions<D> & { canHide?: boolean; className?: string; isSupport?: boolean; tooltip?: string }

a lineup lite column description

Type Parameters

D extends AnyObject = UnknownObject

NumberArrayWithStats

NumberArrayWithStats: number[] & { _stats?: INumberStats }

RowCompareFunction

RowCompareFunction<O>: ((a: Row<UnknownObject>, b: Row<UnknownObject>, columnId: string, options?: O) => number)

Type Parameters

O extends AnyObject = UnknownObject

Type declaration

- (a: Row<UnknownObject>, b: Row<UnknownObject>, columnId: string, options?: O): number
- Parameters
 - a: Row<UnknownObject>
 - b: Row<UnknownObject>
 - columnId: string
 - Optional options: O
 Returns number

SortingOptions

SortingOptions<D>: { id: IdType<D>; value: SortingOptionsValue }[]

Type Parameters

D extends AnyObject

SortingOptionsCellProps

SortingOptionsCellProps<D>: CellProps<D> & { column: UseSortingOptionsColumnProps }

Type Parameters

D extends AnyObject = UnknownObject

SortingOptionsProps

SortingOptionsProps<D>: HeaderProps<D> & { column: UseSortingOptionsColumnProps }

Type Parameters

D extends AnyObject = UnknownObject

SortingOptionsValue

SortingOptionsValue: any

StatsAggregateArray

StatsAggregateArray<T>: T[] & { _aggregate?: any }

Type Parameters

StatsCellProps

StatsCellProps<D>: CellProps<D> & { column: UseStatsColumnProps; i18n?: Record<string, string> }

Type Parameters

D extends AnyObject = UnknownObject

StatsProps

StatsProps<D>: HeaderProps<D> & { column: UseStatsColumnProps; i18n?: Record<string, string> }

Type Parameters

D extends AnyObject = UnknownObject

StatsValue

StatsValue: any

TextGroupByOptions

TextGroupByOptions: TextGroupByValueOptions | TextGroupByStartsWithOptions | TextGroupByRegexOptions

UnknownObject

UnknownObject: {}

lineup-lite/hooks

https://github.com/sgratzl/lineup-lite

Type declaration

[key: string]: unknown

Variables

Const IndeterminateCheckbox

IndeterminateCheckbox: ForwardRefExoticComponent<HTMLAttributes<HTMLInputElement> & { indeterminate?: boolean } & RefAttributes<HTMLInputElement>> = ...

Const USE_EXPAND_COLUMN_I18N_EN

USE_EXPAND_COLUMN_I18N_EN: { collapseAllGroups: string; collapseGroup: string; expandAllGroups: string; expandGroup: string } = ...

Type declaration

collapseAllGroups: string
collapseGroup: string
expandAllGroups: string
expandGroup: string

Const USE_ROW_SELECT_COLUMN_I18N_EN

USE_ROW_SELECT_COLUMN_I18N_EN: { selectAll: string; selectGroup: string; selectRow: string; unselectAll: string; unselectGroup: string; unselectRow: string } = ...

Type declaration

selectAll: string
selectGroup: string
selectRow: string
unselectAll: string
unselectGroup: string
unselectRow: string

Functions

ArrayAxisRenderer

ArrayAxisRenderer<D, P>(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/ArrayAxisRenderer.tsx:17
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, any>; column: ColumnInstance<D>; row: Row<D>; value: any } & { column: UseStatsColumnProps; i18n?: Record<string, string> }
Parameters
- props: P
Returns JSX.Element

ArrayAxisRendererFactory

ArrayAxisRendererFactory<D, P>(options?: ArrayAxisRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/ArrayAxisRenderer.tsx:34
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, any>; column: ColumnInstance<D>; row: Row<D>; value: any } & { column: UseStatsColumnProps; i18n?: Record<string, string> }
Parameters
- options: ArrayAxisRendererOptions = {}
Returns Renderer

BarRenderer

BarRenderer<D, P>(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/BarRenderer.tsx:24
Cell renderer for a number to be rendered as a a bar

Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, number>; column: ColumnInstance<D>; row: Row<D>; value: number }
Parameters
- props: P
Returns JSX.Element

BarRendererFactory

BarRendererFactory<D, P>(options?: BarRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/BarRenderer.tsx:40
factory for rendering numbers as a bar

Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, number>; column: ColumnInstance<D>; row: Row<D>; value: number }
Parameters
- options: BarRendererOptions = {}
Returns Renderer

BoxPlotArrayRenderer

BoxPlotArrayRenderer(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/BoxPlotArrayRenderer.tsx:19
Type Parameters
- P extends StatsPropsLike<number>
Parameters
- props: P
Returns JSX.Element

BoxPlotArrayRendererFactory

BoxPlotArrayRendererFactory(options?: BoxPlotArrayRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/BoxPlotArrayRenderer.tsx:40
Type Parameters
- P extends StatsPropsLike<number>
Parameters
- options: BoxPlotArrayRendererOptions = {}
Returns Renderer

BoxPlotRenderer

BoxPlotRenderer(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/BoxPlotRenderer.tsx:35
Type Parameters
- P extends StatsPropsLike<number>
Parameters
- props: P
Returns JSX.Element

BoxPlotRendererFactory

BoxPlotRendererFactory(options?: BoxPlotRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/BoxPlotRenderer.tsx:71
Type Parameters
- P extends StatsPropsLike<number>
Parameters
- options: BoxPlotRendererOptions = {}
Returns Renderer

CategoricalHistogramRenderer

CategoricalHistogramRenderer(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/CategoricalHistogramRenderer.tsx:19
Type Parameters
- P extends StatsPropsLike<string>
Parameters
- props: P
Returns JSX.Element

CategoricalHistogramRendererFactory

CategoricalHistogramRendererFactory(options?: CategoricalHistogramRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/CategoricalHistogramRenderer.tsx:49
Type Parameters
- P extends StatsPropsLike<string>
Parameters
- options: CategoricalHistogramRendererOptions = {}
Returns Renderer

CategoricalRenderer

CategoricalRenderer<D, P>(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/CategoricalRenderer.tsx:32
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, string>; column: ColumnInstance<D>; row: Row<D>; value: string }
Parameters
- props: P
Returns JSX.Element

CategoricalRendererFactory

CategoricalRendererFactory<D, P>(options?: CategoricalRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/CategoricalRenderer.tsx:45
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, string>; column: ColumnInstance<D>; row: Row<D>; value: string }
Parameters
- options: CategoricalRendererOptions = {}
Returns Renderer

CategoricalSetHistogramRenderer

CategoricalSetHistogramRenderer(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/CategoricalSetHistogramRenderer.tsx:19
Type Parameters
- P extends StatsPropsLike<string>
Parameters
- props: P
Returns JSX.Element

CategoricalSetHistogramRendererFactory

CategoricalSetHistogramRendererFactory(options?: CategoricalSetHistogramRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/CategoricalSetHistogramRenderer.tsx:47
Type Parameters
- P extends StatsPropsLike<string>
Parameters
- options: CategoricalSetHistogramRendererOptions = {}
Returns Renderer

CategoricalSetRenderer

CategoricalSetRenderer<D, P>(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/CategoricalSetRenderer.tsx:33
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, CategoricalSetValue>; column: ColumnInstance<D>; row: Row<D>; value: CategoricalSetValue }
Parameters
- props: P
Returns JSX.Element

CategoricalSetRendererFactory

CategoricalSetRendererFactory<D, P>(options?: CategoricalSetRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/CategoricalSetRenderer.tsx:41
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, CategoricalSetValue>; column: ColumnInstance<D>; row: Row<D>; value: CategoricalSetValue }
Parameters
- options: CategoricalSetRendererOptions = {}
Returns Renderer

ColorRenderer

ColorRenderer<D, P>(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/ColorRenderer.tsx:16
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, number>; column: ColumnInstance<D>; row: Row<D>; value: number }
Parameters
- props: P
Returns JSX.Element

ColorRendererFactory

ColorRendererFactory<D, P>(options?: BarRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/ColorRenderer.tsx:29
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, number>; column: ColumnInstance<D>; row: Row<D>; value: number }
Parameters
- options: BarRendererOptions = {}
Returns Renderer

DateHistogramRenderer

DateHistogramRenderer(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/DateHistogramRenderer.tsx:38
Type Parameters
- P extends StatsPropsLike<null | Date>
Parameters
- props: P
Returns JSX.Element

DateHistogramRendererFactory

DateHistogramRendererFactory(options?: HistogramRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/DateHistogramRenderer.tsx:66
Type Parameters
- P extends StatsPropsLike<null | Date>
Parameters
- options: HistogramRendererOptions = {}
Returns Renderer

DateRenderer

DateRenderer<D, P>(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/DateRenderer.tsx:30
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, Date>; column: ColumnInstance<D>; row: Row<D>; value: Date }
Parameters
- props: P
Returns JSX.Element

DateRendererFactory

DateRendererFactory<D, P>(options?: DateRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/DateRenderer.tsx:50
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, Date>; column: ColumnInstance<D>; row: Row<D>; value: Date }
Parameters
- options: DateRendererOptions = {}
Returns Renderer

DivergingBarRenderer

DivergingBarRenderer<D, P>(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/BarRenderer.tsx:57
Cell renderer for a number to be rendered as a a bar

Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, number>; column: ColumnInstance<D>; row: Row<D>; value: number }
Parameters
- props: P
Returns JSX.Element

DivergingBarRendererFactory

DivergingBarRendererFactory<D, P>(options?: DivergingBarRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/BarRenderer.tsx:73
factory for rendering numbers as a bar

Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, number>; column: ColumnInstance<D>; row: Row<D>; value: number }
Parameters
- options: DivergingBarRendererOptions = {}
Returns Renderer

GroupValueRenderer

GroupValueRenderer<D, P>(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/GroupValueRenderer.tsx:12
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, unknown>; column: ColumnInstance<D>; row: Row<D>; value: unknown }
Parameters
- props: P
Returns JSX.Element

HeatMap1DRenderer

HeatMap1DRenderer<D, P>(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/HeatMap1DRenderer.tsx:24
Cell renderer for a number to be rendered as a a HeatMap1D

Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, number[]>; column: ColumnInstance<D>; row: Row<D>; value: number[] }
Parameters
- props: P
Returns JSX.Element

HeatMap1DRendererFactory

HeatMap1DRendererFactory<D, P>(options?: HeatMap1DRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/HeatMap1DRenderer.tsx:40
factory for rendering numbers as a HeatMap1D

Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, number[]>; column: ColumnInstance<D>; row: Row<D>; value: number[] }
Parameters
- options: HeatMap1DRendererOptions = {}
Returns Renderer

LineChartRenderer

LineChartRenderer<D, P>(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/LineChartRenderer.tsx:21
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, (undefined | null | number)[]>; column: ColumnInstance<D>; row: Row<D>; value: (undefined | null | number)[] }
Parameters
- props: P
Returns JSX.Element

LineChartRendererFactory

LineChartRendererFactory<D, P>(options?: LineChartRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/LineChartRenderer.tsx:38
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, (undefined | null | number)[]>; column: ColumnInstance<D>; row: Row<D>; value: (undefined | null | number)[] }
Parameters
- options: LineChartRendererOptions = {}
Returns Renderer

MultiLineChartRenderer

MultiLineChartRenderer<D, P>(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/MultiLineChartRenderer.tsx:16
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, (undefined | null | number)[][]>; column: ColumnInstance<D>; row: Row<D>; value: (undefined | null | number)[][] }
Parameters
- props: P
Returns JSX.Element

MultiLineChartRendererFactory

MultiLineChartRendererFactory<D, P>(options?: LineChartRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/MultiLineChartRenderer.tsx:34
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, (undefined | null | number)[][]>; column: ColumnInstance<D>; row: Row<D>; value: (undefined | null | number)[][] }
Parameters
- options: LineChartRendererOptions = {}
Returns Renderer

NumberHistogramRenderer

NumberHistogramRenderer(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/NumberHistogramRenderer.tsx:38
Type Parameters
- P extends StatsPropsLike<number>
Parameters
- props: P
Returns JSX.Element

NumberHistogramRendererFactory

NumberHistogramRendererFactory(options?: NumberHistogramRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/NumberHistogramRenderer.tsx:66
Type Parameters
- P extends StatsPropsLike<number>
Parameters
- options: NumberHistogramRendererOptions = {}
Returns Renderer

ProportionalSymbolRenderer

ProportionalSymbolRenderer<D, P>(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/ProportionalSymbolRenderer.tsx:16
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, number>; column: ColumnInstance<D>; row: Row<D>; value: number }
Parameters
- props: P
Returns JSX.Element

ProportionalSymbolRendererFactory

ProportionalSymbolRendererFactory<D, P>(options?: BarRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/ProportionalSymbolRenderer.tsx:31
Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, number>; column: ColumnInstance<D>; row: Row<D>; value: number }
Parameters
- options: BarRendererOptions = {}
Returns Renderer

StackedBarRenderer

StackedBarRenderer<D, P>(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/StackedBarRenderer.tsx:50
Cell renderer for a number to be rendered as a a bar

Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, StackedValue>; column: ColumnInstance<D>; row: Row<D>; value: StackedValue }
Parameters
- props: P
Returns JSX.Element

StackedBarRendererFactory

StackedBarRendererFactory<D, P>(options?: StackedBarRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/StackedBarRenderer.tsx:68
factory for rendering numbers as a stacked bar

Type Parameters
- D extends UnknownObject
- P extends TableInstance<D, P> & { cell: Cell<D, StackedValue>; column: ColumnInstance<D>; row: Row<D>; value: StackedValue }
Parameters
- options: StackedBarRendererOptions = {}
Returns Renderer

TextRenderer

TextRenderer<D, P>(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/TextRenderer.tsx:30
Type Parameters
- D extends object
- P extends TableInstance<D, P> & { cell: Cell<D, string>; column: ColumnInstance<D>; row: Row<D>; value: string }
Parameters
- props: P
Returns JSX.Element

TextRendererFactory

TextRendererFactory<D, P>(options?: TextRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/TextRenderer.tsx:43
Type Parameters
- D extends object
- P extends TableInstance<D, P> & { cell: Cell<D, string>; column: ColumnInstance<D>; row: Row<D>; value: string }
Parameters
- options: TextRendererOptions = {}
Returns Renderer

TextSummaryRenderer

TextSummaryRenderer(props: P): JSX.Element

- Defined in build/repo/packages/hooks/src/renderers/TextSummaryRenderer.tsx:48
Type Parameters
- P extends StatsPropsLike<string>
Parameters
- props: P
Returns JSX.Element

TextSummaryRendererFactory

TextSummaryRendererFactory(options?: TextSummaryRendererOptions): Renderer

- Defined in build/repo/packages/hooks/src/renderers/TextSummaryRenderer.tsx:85
Type Parameters
- P extends StatsPropsLike<string>
Parameters
- options: TextSummaryRendererOptions = {}
Returns Renderer

asCategoricalColumn

asCategoricalColumn<D, C>(col: keyof D | C, options?: CategoricalStatsOptions): LineUpLiteColumn<D>

- Defined in build/repo/packages/hooks/src/builder.ts:237
defines a categorical column

Type Parameters
- D extends object = UnknownObject
- C extends ColumnInterface<D> & ColumnGroupInterface<D> & { Header: string } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnGroupInterface<D> & { id: IdType<D> } & { Header: Renderer<HeaderProps<D>> } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { Header: string } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { id: IdType<D> } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { accessor: keyof D extends never ? IdType<D> : never } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & { accessor: keyof D } & ColumnInterfaceBasedOnValue<D, D[keyof D]> = Column<D>
Parameters
- col: keyof D | C
 
 property key or partial column Header and accessor
- Optional options: CategoricalStatsOptions
 
 additional options for statistics
Returns LineUpLiteColumn<D>

asCategoricalSetColumn

asCategoricalSetColumn<D, C>(col: keyof D | C, options?: CategoricalStatsOptions): LineUpLiteColumn<D>

- Defined in build/repo/packages/hooks/src/builder.ts:265
defines a categorical set column

Type Parameters
- D extends object = UnknownObject
- C extends ColumnInterface<D> & ColumnGroupInterface<D> & { Header: string } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnGroupInterface<D> & { id: IdType<D> } & { Header: Renderer<HeaderProps<D>> } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { Header: string } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { id: IdType<D> } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { accessor: keyof D extends never ? IdType<D> : never } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & { accessor: keyof D } & ColumnInterfaceBasedOnValue<D, D[keyof D]> = Column<D>
Parameters
- col: keyof D | C
 
 property key or partial column Header and accessor
- Optional options: CategoricalStatsOptions
 
 additional options for statistics
Returns LineUpLiteColumn<D>

asColumn

asColumn<D, C>(col: keyof D | C): C

- Defined in build/repo/packages/hooks/src/builder.ts:67
Type Parameters
- D extends object = UnknownObject
- C extends ColumnInterface<D> & ColumnGroupInterface<D> & { Header: string } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnGroupInterface<D> & { id: IdType<D> } & { Header: Renderer<HeaderProps<D>> } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { Header: string } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { id: IdType<D> } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { accessor: keyof D extends never ? IdType<D> : never } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & { accessor: keyof D } & ColumnInterfaceBasedOnValue<D, D[keyof D]> = Column<D>
Parameters
- col: keyof D | C
Returns C

asDateColumn

asDateColumn<D, C>(col: keyof D | C, options?: DateStatsOptions): LineUpLiteColumn<D>

- Defined in build/repo/packages/hooks/src/builder.ts:293
defines a date column

Type Parameters
- D extends object = UnknownObject
- C extends ColumnInterface<D> & ColumnGroupInterface<D> & { Header: string } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnGroupInterface<D> & { id: IdType<D> } & { Header: Renderer<HeaderProps<D>> } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { Header: string } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { id: IdType<D> } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { accessor: keyof D extends never ? IdType<D> : never } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & { accessor: keyof D } & ColumnInterfaceBasedOnValue<D, D[keyof D]> = Column<D>
Parameters
- col: keyof D | C
 
 property key or partial column Header and accessor
- Optional options: DateStatsOptions
 
 additional options for statistics
Returns LineUpLiteColumn<D>

asDivergingNumberColumn

asDivergingNumberColumn<D, C>(col: C | keyof D, options?: NumberStatsOptions & { center?: number }): LineUpLiteColumn<D>

- Defined in build/repo/packages/hooks/src/builder.ts:133
defines a diverging number column

Type Parameters
- D extends object = UnknownObject
- C extends ColumnInterface<D> & ColumnGroupInterface<D> & { Header: string } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnGroupInterface<D> & { id: IdType<D> } & { Header: Renderer<HeaderProps<D>> } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { Header: string } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { id: IdType<D> } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { accessor: keyof D extends never ? IdType<D> : never } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & { accessor: keyof D } & ColumnInterfaceBasedOnValue<D, D[keyof D]> = Column<D>
Parameters
- col: C | keyof D
 
 property key or partial column Header and accessor
- options: NumberStatsOptions & { center?: number } = {}
 
 additional options for statistics
Returns LineUpLiteColumn<D>

asNumberBoxPlotColumn

asNumberBoxPlotColumn<D, C>(col: keyof D | C, options?: NumberStatsOptions): LineUpLiteColumn<D>

- Defined in build/repo/packages/hooks/src/builder.ts:211
defines a number column that is rendered as boxplot

Type Parameters
- D extends object = UnknownObject
- C extends ColumnInterface<D> & ColumnGroupInterface<D> & { Header: string } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnGroupInterface<D> & { id: IdType<D> } & { Header: Renderer<HeaderProps<D>> } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { Header: string } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { id: IdType<D> } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { accessor: keyof D extends never ? IdType<D> : never } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & { accessor: keyof D } & ColumnInterfaceBasedOnValue<D, D[keyof D]> = Column<D>
Parameters
- col: keyof D | C
 
 property key or partial column Header and accessor
- Optional options: NumberStatsOptions
 
 additional options for statistics
Returns LineUpLiteColumn<D>

asNumberColumn

asNumberColumn<D, C>(col: keyof D | C, options?: NumberStatsOptions): LineUpLiteColumn<D>

- Defined in build/repo/packages/hooks/src/builder.ts:107
defines a number column

Type Parameters
- D extends object = UnknownObject
- C extends ColumnInterface<D> & ColumnGroupInterface<D> & { Header: string } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnGroupInterface<D> & { id: IdType<D> } & { Header: Renderer<HeaderProps<D>> } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { Header: string } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { id: IdType<D> } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { accessor: keyof D extends never ? IdType<D> : never } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & { accessor: keyof D } & ColumnInterfaceBasedOnValue<D, D[keyof D]> = Column<D>
Parameters
- col: keyof D | C
 
 property key or partial column Header and accessor
- Optional options: NumberStatsOptions
 
 additional options for statistics
Returns LineUpLiteColumn<D>

asNumbersColumn

asNumbersColumn<D, C>(col: keyof D | C, options?: NumberStatsOptions): LineUpLiteColumn<D>

- Defined in build/repo/packages/hooks/src/builder.ts:158
defines a number array column, each value is a number array

Type Parameters
- D extends object = UnknownObject
- C extends ColumnInterface<D> & ColumnGroupInterface<D> & { Header: string } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnGroupInterface<D> & { id: IdType<D> } & { Header: Renderer<HeaderProps<D>> } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { Header: string } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { id: IdType<D> } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { accessor: keyof D extends never ? IdType<D> : never } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & { accessor: keyof D } & ColumnInterfaceBasedOnValue<D, D[keyof D]> = Column<D>
Parameters
- col: keyof D | C
 
 property key or partial column Header and accessor
- Optional options: NumberStatsOptions
 
 additional options for statistics
Returns LineUpLiteColumn<D>

asNumbersLineChartColumn

asNumbersLineChartColumn<D, C>(col: keyof D | C, options?: NumberStatsOptions & CommonProps & NumberStatsOptions & DateAxisProps & NumberStatsOptions & NumberAxisProps & NumberStatsOptions & TextAxisProps): LineUpLiteColumn<D>

- Defined in build/repo/packages/hooks/src/builder.ts:188
defines a number array column, each value is a number array shown as a line chart x = index, y=value

Type Parameters
- D extends object = UnknownObject
- C extends ColumnInterface<D> & ColumnGroupInterface<D> & { Header: string } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnGroupInterface<D> & { id: IdType<D> } & { Header: Renderer<HeaderProps<D>> } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { Header: string } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { id: IdType<D> } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { accessor: keyof D extends never ? IdType<D> : never } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & { accessor: keyof D } & ColumnInterfaceBasedOnValue<D, D[keyof D]> = Column<D>
Parameters
- col: keyof D | C
 
 property key or partial column Header and accessor
- Optional options: NumberStatsOptions & CommonProps & NumberStatsOptions & DateAxisProps & NumberStatsOptions & NumberAxisProps & NumberStatsOptions & TextAxisProps
 
 additional options for statistics
Returns LineUpLiteColumn<D>

asStackedNumberColumn

asStackedNumberColumn<D, C>(col: string | C, stack: readonly { col: keyof D | Accessor<D>; color?: string; weight: number }[], options?: NumberStatsOptions & { colors?: any }): LineUpLiteColumn<D>

- Defined in build/repo/packages/hooks/src/builder.ts:318
defines a number column

Type Parameters
- D extends object = UnknownObject
- C extends ColumnInterface<D> & ColumnGroupInterface<D> & { Header: string } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnGroupInterface<D> & { id: IdType<D> } & { Header: Renderer<HeaderProps<D>> } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { Header: string } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { id: IdType<D> } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { accessor: keyof D extends never ? IdType<D> : never } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & { accessor: keyof D } & ColumnInterfaceBasedOnValue<D, D[keyof D]> = Column<D>
Parameters
- col: string | C
 
 property key or partial column Header and accessor
- stack: readonly { col: keyof D | Accessor<D>; color?: string; weight: number }[]
- Optional options: NumberStatsOptions & { colors?: any }
 
 additional options for statistics
Returns LineUpLiteColumn<D>

asTextColumn

asTextColumn<D, C>(col: keyof D | C, options?: TextStatsOptions): LineUpLiteColumn<D>

- Defined in build/repo/packages/hooks/src/builder.ts:82
defines a text column

Type Parameters
- D extends object = UnknownObject
- C extends ColumnInterface<D> & ColumnGroupInterface<D> & { Header: string } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnGroupInterface<D> & { id: IdType<D> } & { Header: Renderer<HeaderProps<D>> } & { accessor?: Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { Header: string } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { id: IdType<D> } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & ColumnInterfaceBasedOnValue<D, any> & { accessor: keyof D extends never ? IdType<D> : never } & { accessor?: keyof D extends never ? IdType<D> | Accessor<D> : Accessor<D> } | ColumnInterface<D> & { accessor: keyof D } & ColumnInterfaceBasedOnValue<D, D[keyof D]> = Column<D>
Parameters
- col: keyof D | C
 
 property key or partial column Header and accessor
- Optional options: TextStatsOptions
 
 additional options for statistics
Returns LineUpLiteColumn<D>

categoricalFilter

categoricalFilter<D>(rows: readonly Row<D>[], ids: readonly IdType<D>[], filterValue: readonly string[]): Row<D>[]

- Defined in build/repo/packages/hooks/src/filters/categoricalFilter.ts:18
filter function by a set of filter values

Type Parameters
- D extends object = UnknownObject
Parameters
- rows: readonly Row<D>[]
- ids: readonly IdType<D>[]
- filterValue: readonly string[]
Returns Row<D>[]

categoricalGroupBy

categoricalGroupBy<D>(rows: readonly Row<D>[], column: ColumnInstance<D>): Record<string, Row<D>[]>

- Defined in build/repo/packages/hooks/src/grouping/categoricalGroupBy.ts:14
Type Parameters
- D extends object = UnknownObject
Parameters
- rows: readonly Row<D>[]
- column: ColumnInstance<D>
Returns Record<string, Row<D>[]>

categoricalGroupCompare

categoricalGroupCompare(a: Row<UnknownObject>, b: Row<UnknownObject>, columnId: string): number

- Defined in build/repo/packages/hooks/src/sort/categoricalSort.ts:14
Parameters
- a: Row<UnknownObject>
- b: Row<UnknownObject>
- columnId: string
Returns number

categoricalSetCompare

categoricalSetCompare(categories?: readonly string[]): RowCompareFunction

- Defined in build/repo/packages/hooks/src/sort/categoricalSetSort.ts:63
generates a comparator that sorts by the given set of category order

Parameters
- Optional categories: readonly string[]
Returns RowCompareFunction

categoricalSetFilter

categoricalSetFilter<D>(rows: readonly Row<D>[], ids: readonly IdType<D>[], filterValue: readonly FilterSetValue<string>[]): Row<D>[]

- Defined in build/repo/packages/hooks/src/filters/categoricalSetFilter.ts:18
filter function by a set of filter values

Type Parameters
- D extends object = UnknownObject
Parameters
- rows: readonly Row<D>[]
- ids: readonly IdType<D>[]
- filterValue: readonly FilterSetValue<string>[]
Returns Row<D>[]

categoricalSetGroupBy

categoricalSetGroupBy<D>(rows: readonly Row<D>[], column: ColumnInstance<D>): Record<string, Row<D>[]>

- Defined in build/repo/packages/hooks/src/grouping/categoricalSetGroupBy.ts:15
Type Parameters
- D extends object = UnknownObject
Parameters
- rows: readonly Row<D>[]
- column: ColumnInstance<D>
Returns Record<string, Row<D>[]>

categoricalSetGroupCompare

categoricalSetGroupCompare(a: Row<UnknownObject>, b: Row<UnknownObject>, columnId: string): number

- Defined in build/repo/packages/hooks/src/sort/categoricalSetSort.ts:35
Parameters
- a: Row<UnknownObject>
- b: Row<UnknownObject>
- columnId: string
Returns number

categoricalSort

categoricalSort(categories: readonly string[]): RowCompareFunction

- Defined in build/repo/packages/hooks/src/sort/categoricalSort.ts:29
generates a comparator that sorts by the given set of category order

Parameters
- categories: readonly string[]
Returns RowCompareFunction

categoricalStats

categoricalStats(options?: CategoricalStatsOptions): ((arr: readonly string[], preFilter?: ICategoricalStats) => ICategoricalStats)

- Defined in build/repo/packages/hooks/src/stats/categoricalStats.ts:32
generator for computing categorical stats

Parameters
- options: CategoricalStatsOptions = {}
Returns ((arr: readonly string[], preFilter?: ICategoricalStats) => ICategoricalStats)
- - (arr: readonly string[], preFilter?: ICategoricalStats): ICategoricalStats
  - generator for computing categorical stats
    
    Parameters
    - arr: readonly string[]
    - Optional preFilter: ICategoricalStats
    Returns ICategoricalStats

cleanCategories

cleanCategories(categories: Set<undefined | null | string>): string[]

- Defined in build/repo/packages/hooks/src/derive.ts:22
clears a set of categories of small invalid n/a values

Parameters
- categories: Set<undefined | null | string>
Returns string[]

columnSpecificGroupByFn

columnSpecificGroupByFn<D>(rows: Row<D>[], columnId: IdType<D>): Record<string, Row<D>[]>

- Defined in build/repo/packages/hooks/src/grouping/columnSpecificGroupByFn.ts:26
helper function to defer the grouping logic to the column

Type Parameters
- D extends object = UnknownObject
Parameters
- rows: Row<D>[]
- columnId: IdType<D>
Returns Record<string, Row<D>[]>

computeArrayNumberStats

computeArrayNumberStats(arr: NumberArrayWithStats, column?: ColumnInstance<UnknownObject> & Partial<UseStatsColumnOptions<UnknownObject> & UseStatsColumnProps>): INumberStats | null

- Defined in build/repo/packages/hooks/src/stats/numberStats.ts:44
Parameters
- arr: NumberArrayWithStats
- Optional column: ColumnInstance<UnknownObject> & Partial<UseStatsColumnOptions<UnknownObject> & UseStatsColumnProps>
Returns INumberStats | null

computeStackedValue

computeStackedValue<D>(stack: readonly { col: Accessor<D> | keyof D; color?: string; weight: number }[], colors?: ((v: string) => string)): Accessor<D>

- Defined in build/repo/packages/hooks/src/renderers/StackedBarRenderer.tsx:23
Type Parameters
- D extends object = UnknownObject
Parameters
- stack: readonly { col: Accessor<D> | keyof D; color?: string; weight: number }[]
- colors: ((v: string) => string) = ...
 - - (v: string): string
 - Parameters
 - v: string
 Returns string
Returns Accessor<D>

dateGroupBy

dateGroupBy<D>(rows: readonly Row<D>[], column: ColumnInstance<D>, options?: DateGroupByOptions): Record<string, Row<D>[]>

- Defined in build/repo/packages/hooks/src/grouping/dateGroupBy.ts:233
Type Parameters
- D extends object = UnknownObject
Parameters
- rows: readonly Row<D>[]
- column: ColumnInstance<D>
- Optional options: DateGroupByOptions
Returns Record<string, Row<D>[]>

dateGroupByFactory

dateGroupByFactory<D>(options: DateGroupByOptions): ((rows: readonly Row<D>[], column: ColumnInstance<D>, options?: DateGroupByOptions) => Record<string, Row<D>[]>)

- Defined in build/repo/packages/hooks/src/grouping/dateGroupBy.ts:269
Type Parameters
- D extends object = UnknownObject
Parameters
- options: DateGroupByOptions
Returns ((rows: readonly Row<D>[], column: ColumnInstance<D>, options?: DateGroupByOptions) => Record<string, Row<D>[]>)
- - (rows: readonly Row<D>[], column: ColumnInstance<D>, options?: DateGroupByOptions): Record<string, Row<D>[]>
 - Parameters
 - rows: readonly Row<D>[]
 - column: ColumnInstance<D>
 - Optional options: DateGroupByOptions
 Returns Record<string, Row<D>[]>

dateGroupCompare

dateGroupCompare(a: Row<UnknownObject>, b: Row<UnknownObject>, columnId: string, options?: DateSortOptions): number

- Defined in build/repo/packages/hooks/src/sort/dateGroupCompare.ts:18
Parameters
- a: Row<UnknownObject>
- b: Row<UnknownObject>
- columnId: string
- Optional options: DateSortOptions
Returns number

dateGroupCompareFactory

dateGroupCompareFactory(options: DateSortOptions): RowCompareFunction<DateSortOptions>

- Defined in build/repo/packages/hooks/src/sort/dateGroupCompare.ts:33
Parameters
- options: DateSortOptions
Returns RowCompareFunction<DateSortOptions>

dateStats

dateStats(options?: DateStatsOptions): ((arr: readonly (Date | null)[], preFilter?: IDateStats) => IDateStats)

- Defined in build/repo/packages/hooks/src/stats/dateStats.ts:31
generator for computing date stats

Parameters
- options: DateStatsOptions = {}
Returns ((arr: readonly (Date | null)[], preFilter?: IDateStats) => IDateStats)
- - (arr: readonly (Date | null)[], preFilter?: IDateStats): IDateStats
  - generator for computing date stats
    
    Parameters
    - arr: readonly (Date | null)[]
    - Optional preFilter: IDateStats
    Returns IDateStats

deriveColumn

deriveColumn<D>(data: D[], accessor: keyof D): DeriveColumnResult<D>

- Defined in build/repo/packages/hooks/src/derive.ts:64
guesses the column type based on the values

Type Parameters
- D extends object = UnknownObject
Parameters
- data: D[]
- accessor: keyof D
Returns DeriveColumnResult<D>

deriveColumns

deriveColumns<D>(data: D[], columns?: (keyof D)[]): (Column<D> & Partial<LineUpLiteColumn<D>>)[]

- Defined in build/repo/packages/hooks/src/derive.ts:128
derive the columns within the given data

Type Parameters
- D extends object = UnknownObject
Parameters
- data: D[]
 
 the data array
- Optional columns: (keyof D)[]
 
 optional list of column names to generate
Returns (Column<D> & Partial<LineUpLiteColumn<D>>)[]

isMissing

isMissing(v: unknown): boolean

- Defined in build/repo/packages/hooks/src/renderers/utils.ts:156
checks whether the given value is missing

Parameters
- v: unknown
  
  value to check
Returns boolean

numberGroupBy

numberGroupBy<D>(rows: readonly Row<D>[], column: ColumnInstance<D>, options?: NumberGroupByOptions): Record<string, Row<D>[]>

- Defined in build/repo/packages/hooks/src/grouping/numberGroupBy.ts:18
Type Parameters
- D extends object = UnknownObject
Parameters
- rows: readonly Row<D>[]
- column: ColumnInstance<D>
- Optional options: NumberGroupByOptions
Returns Record<string, Row<D>[]>

numberGroupByFactory

numberGroupByFactory<D>(options: NumberGroupByOptions): ((rows: readonly Row<D>[], column: ColumnInstance<D>, options?: NumberGroupByOptions) => Record<string, Row<D>[]>)

- Defined in build/repo/packages/hooks/src/grouping/numberGroupBy.ts:85
Type Parameters
- D extends object = UnknownObject
Parameters
- options: NumberGroupByOptions
Returns ((rows: readonly Row<D>[], column: ColumnInstance<D>, options?: NumberGroupByOptions) => Record<string, Row<D>[]>)
- - (rows: readonly Row<D>[], column: ColumnInstance<D>, options?: NumberGroupByOptions): Record<string, Row<D>[]>
 - Parameters
 - rows: readonly Row<D>[]
 - column: ColumnInstance<D>
 - Optional options: NumberGroupByOptions
 Returns Record<string, Row<D>[]>

numberGroupCompare

numberGroupCompare(a: Row<UnknownObject>, b: Row<UnknownObject>, columnId: string, options?: NumberSortOptions): number

- Defined in build/repo/packages/hooks/src/sort/numberSort.ts:20
Parameters
- a: Row<UnknownObject>
- b: Row<UnknownObject>
- columnId: string
- Optional options: NumberSortOptions
Returns number

numberGroupCompareFactory

numberGroupCompareFactory(options: NumberSortOptions): RowCompareFunction<NumberSortOptions>

- Defined in build/repo/packages/hooks/src/sort/numberSort.ts:51
Parameters
- options: NumberSortOptions
Returns RowCompareFunction<NumberSortOptions>

numberStats

numberStats(options?: NumberStatsOptions): ((arr: readonly number[], preFilter?: INumberStats) => INumberStats)

- Defined in build/repo/packages/hooks/src/stats/numberStats.ts:35
generator for computing number stats

Parameters
- options: NumberStatsOptions = {}
Returns ((arr: readonly number[], preFilter?: INumberStats) => INumberStats)
- - (arr: readonly number[], preFilter?: INumberStats): INumberStats
  - generator for computing number stats
    
    Parameters
    - arr: readonly number[]
    - Optional preFilter: INumberStats
    Returns INumberStats

numbersCompare

numbersCompare(a: Row<UnknownObject>, b: Row<UnknownObject>, columnId: string, options?: NumberSortOptions): number

- Defined in build/repo/packages/hooks/src/sort/numberSort.ts:35
Parameters
- a: Row<UnknownObject>
- b: Row<UnknownObject>
- columnId: string
- Optional options: NumberSortOptions
Returns number

numbersCompareFactory

numbersCompareFactory(options: NumberSortOptions): RowCompareFunction<NumberSortOptions>

- Defined in build/repo/packages/hooks/src/sort/numberSort.ts:55
Parameters
- options: NumberSortOptions
Returns RowCompareFunction<NumberSortOptions>

rangeFilter

rangeFilter<D, T>(rows: readonly Row<D>[], ids: readonly string[], filterValue: readonly [T, T]): Row<D>[]

- Defined in build/repo/packages/hooks/src/filters/rangeFilter.ts:15
a range numeric filter

Type Parameters
- D extends object = UnknownObject
- T = unknown
Parameters
- rows: readonly Row<D>[]
- ids: readonly string[]
- filterValue: readonly [T, T]
Returns Row<D>[]

sortCompare

sortCompare(a: Row<UnknownObject>, b: Row<UnknownObject>, columnId: string): number

- Defined in build/repo/packages/hooks/src/sort/sortCompare.ts:18
sort helper to compare by a given column id

Parameters
- a: Row<UnknownObject>
 
 first row
- b: Row<UnknownObject>
 
 second row
- columnId: string
 
 column id
Returns number

sortSplitter

sortSplitter<O>(rows: RowCompareFunction<O>, group: RowCompareFunction<O>): RowCompareFunction

- Defined in build/repo/packages/hooks/src/sort/sortSplitter.ts:41
sort helper to compare by a given column id

Type Parameters
- O extends object = UnknownObject
Parameters
- rows: RowCompareFunction<O>
- group: RowCompareFunction<O>
Returns RowCompareFunction

statsAggregate

statsAggregate<T>(v: T[]): T[]

- Defined in build/repo/packages/hooks/src/hooks/useStats.ts:68
Type Parameters
- T
Parameters
- v: T[]
Returns T[]

statsAggregateArray

statsAggregateArray<T>(v: T[]): T[]

- Defined in build/repo/packages/hooks/src/hooks/useStats.ts:79
Type Parameters
- T
Parameters
- v: T[]
Returns T[]

textGroupBy

textGroupBy<D>(rows: readonly Row<D>[], column: ColumnInstance<D>, options?: TextGroupByOptions): Record<string, Row<D>[]>

- Defined in build/repo/packages/hooks/src/grouping/textGroupBy.ts:28
Type Parameters
- D extends object = UnknownObject
Parameters
- rows: readonly Row<D>[]
- column: ColumnInstance<D>
- Optional options: TextGroupByOptions
Returns Record<string, Row<D>[]>

textGroupByFactory

textGroupByFactory<D>(options: TextGroupByOptions): ((rows: readonly Row<D>[], column: ColumnInstance<D>, options?: TextGroupByOptions) => Record<string, Row<D>[]>)

- Defined in build/repo/packages/hooks/src/grouping/textGroupBy.ts:64
Type Parameters
- D extends object = UnknownObject
Parameters
- options: TextGroupByOptions
Returns ((rows: readonly Row<D>[], column: ColumnInstance<D>, options?: TextGroupByOptions) => Record<string, Row<D>[]>)
- - (rows: readonly Row<D>[], column: ColumnInstance<D>, options?: TextGroupByOptions): Record<string, Row<D>[]>
 - Parameters
 - rows: readonly Row<D>[]
 - column: ColumnInstance<D>
 - Optional options: TextGroupByOptions
 Returns Record<string, Row<D>[]>

textGroupCompare

textGroupCompare(a: Row<UnknownObject>, b: Row<UnknownObject>, columnId: string): number

- Defined in build/repo/packages/hooks/src/sort/textGroupCompare.ts:13
Parameters
- a: Row<UnknownObject>
- b: Row<UnknownObject>
- columnId: string
Returns number

textStats

textStats(options?: TextStatsOptions): ((arr: readonly string[], preFilter?: ITextStats) => ITextStats)

- Defined in build/repo/packages/hooks/src/stats/textStats.ts:16
generator for computing text stats

Parameters
- options: TextStatsOptions = {}
Returns ((arr: readonly string[], preFilter?: ITextStats) => ITextStats)
- - (arr: readonly string[], preFilter?: ITextStats): ITextStats
  - generator for computing text stats
    
    Parameters
    - arr: readonly string[]
    - Optional preFilter: ITextStats
    Returns ITextStats

useGroupingOptions

useGroupingOptions<D>(hooks: Hooks<D>): void

- Defined in build/repo/packages/hooks/src/hooks/useGroupingOptions.ts:64
Type Parameters
- D extends object = UnknownObject
Parameters
- hooks: Hooks<D>
Returns void

useRowExpandColumn

useRowExpandColumn<D>(hooks: Hooks<D>): void

- Defined in build/repo/packages/hooks/src/hooks/useRowExpandColumn.tsx:50
Type Parameters
- D extends object = UnknownObject
Parameters
- hooks: Hooks<D>
Returns void

useRowRankColumn

useRowRankColumn<D>(hooks: Hooks<D>): void

- Defined in build/repo/packages/hooks/src/hooks/useRowRankColumn.tsx:29
Type Parameters
- D extends object = UnknownObject
Parameters
- hooks: Hooks<D>
Returns void

useRowSelectColumn

useRowSelectColumn<D>(hooks: Hooks<D>): void

- Defined in build/repo/packages/hooks/src/hooks/useRowSelectColumn.tsx:22
Type Parameters
- D extends object = UnknownObject
Parameters
- hooks: Hooks<D>
Returns void

useSortingOptions

useSortingOptions<D>(hooks: Hooks<D>): void

- Defined in build/repo/packages/hooks/src/hooks/useSortingOptions.ts:37
Type Parameters
- D extends object = UnknownObject
Parameters
- hooks: Hooks<D>
Returns void

useStats

useStats<D>(hooks: Hooks<D>): void

- Defined in build/repo/packages/hooks/src/hooks/useStats.ts:105
Type Parameters
- D extends object = UnknownObject
Parameters
- hooks: Hooks<D>
Returns void

Index

References

Namespaces

Interfaces

Type Aliases

Variables

Functions

References

LineUpLiteGroupByFunction

UseColumnGroupByColumnOptions

Type Aliases

AnyObject

ArrayAxisRendererOptions

DateGroupByGranularity

DeriveColumnResult

Type Parameters

D extends AnyObject = UnknownObject

GroupingOptions

Type Parameters

D extends AnyObject

GroupingOptionsCellProps

Type Parameters

D extends AnyObject = UnknownObject

GroupingOptionsProps

Type Parameters

D extends AnyObject = UnknownObject

GroupingOptionsValue

LineUpLiteColumn

Type Parameters

D extends AnyObject = UnknownObject

NumberArrayWithStats

RowCompareFunction

Type Parameters

O extends AnyObject = UnknownObject

Type declaration

Parameters

a: Row<UnknownObject>

b: Row<UnknownObject>

columnId: string

Optional options: O

Returns number

SortingOptions

Type Parameters

D extends AnyObject

SortingOptionsCellProps

Type Parameters

D extends AnyObject = UnknownObject

SortingOptionsProps

Type Parameters

D extends AnyObject = UnknownObject

SortingOptionsValue

StatsAggregateArray

Type Parameters

T

StatsCellProps

Type Parameters

D extends AnyObject = UnknownObject

StatsProps

Type Parameters

D extends AnyObject = UnknownObject

StatsValue

TextGroupByOptions

UnknownObject

Type declaration

[key: string]: unknown

Variables

Const IndeterminateCheckbox

Const USE_EXPAND_COLUMN_I18N_EN

Type declaration

collapseAllGroups: string

collapseGroup: string

expandAllGroups: string

expandGroup: string

Const USE_ROW_SELECT_COLUMN_I18N_EN

Type declaration

selectAll: string

selectGroup: string

selectRow: string

unselectAll: string

unselectGroup: string