Options
All
  • Public
  • Public/Protected
  • All
Menu

@lineup-lite/table

Index

References

Namespaces

Interfaces

Type Aliases

Variables

Functions

References

default

Renames and re-exports LineUpLite

Type Aliases

AnyObject

AnyObject: object

Column

Column<D>: ColumnGroup<D> | ColumnWithLooseAccessor<D> | ColumnWithStrictAccessor<D>

Type Parameters

  • D extends object = {}

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

LineUpLiteComponentLike

LineUpLiteComponentLike: ComponentType<DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>>

LineUpLiteI18N

LineUpLiteI18N: typeof LINEUP_LITE_I18N_EN

MultiCustomizeKeys

MultiCustomizeKeys: "tbody" | "tr" | "thead" | "th" | "thGroup" | "td" | "header"

MultiCustomizePanelKeys

MultiCustomizePanelKeys: "dataSummary" | "tableSummary" | "th" | "header"

SizeEstimator

SizeEstimator: number | [number, number] | ((index: number) => number)

UnknownObject

UnknownObject: {}
lineup-lite/hooks

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

Copyright (c) 2021 Samuel Gratzl sam@sgratzl.com

Type declaration

  • [key: string]: unknown

UseLineUpLiteTableOptions

UseLineUpLiteTableOptions<D>: TableOptions<D> & UseFiltersOptions<D> & UseExpandedOptions<D> & UseGroupByOptions<D> & UseRowSelectOptions<D> & UseSortByOptions<D> & UseRowExpandColumnTableOptions & UseSelectColumnTableOptions & UseRowRankColumnTableOptions

Type Parameters

Variables

Const DATA_SUMMARY_I18N_EN

DATA_SUMMARY_I18N_EN: { dataSummary: string; dataSummaryClearSelection: string; dataSummaryFiltered: string; dataSummaryResetFilter: string; dataSummarySelected: string } = ...

Type declaration

  • dataSummary: string
  • dataSummaryClearSelection: string
  • dataSummaryFiltered: string
  • dataSummaryResetFilter: string
  • dataSummarySelected: string

Const LINEUP_LITE_I18N_EN

LINEUP_LITE_I18N_EN: { filterColumn: string; groupByAnotherColumn: string; groupByColumn: string; groupByRemoveColumn: string; hideColumn: string; sortByAnotherColumn: string; sortByAnotherColumnDesc: string; sortByColumn: string; sortByColumnDesc: string; sortByRemoveColumn: string } = ...
lineup-lite/table

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

Copyright (c) 2021 Samuel Gratzl sam@sgratzl.com

Type declaration

  • filterColumn: string
  • groupByAnotherColumn: string
  • groupByColumn: string
  • groupByRemoveColumn: string
  • hideColumn: string
  • sortByAnotherColumn: string
  • sortByAnotherColumnDesc: string
  • sortByColumn: string
  • sortByColumnDesc: string
  • sortByRemoveColumn: string

Const LINEUP_LITE_TEXT_ICONS

LINEUP_LITE_TEXT_ICONS: PaginationIcons & ActionIcons = ...

Const LineUpLitePanelContext

LineUpLitePanelContext: Context<undefined | LineUpLitePanelContextProps> = ...

Const LineUpLiteStateContext

LineUpLiteStateContext: Context<undefined | LineUpLiteStateContextProps<any>> = ...

Const LineUpLiteStateSetterContext

LineUpLiteStateSetterContext: Context<undefined | LineUpLiteStateContextSetter<any>> = ...

Const LineUpLiteTableContext

LineUpLiteTableContext: Context<undefined | LineUpLiteTableContextProps> = ...

Functions

LineUpLite

  • LineUpLite<D>(p: LineUpLiteProps<D> & RefAttributes<HTMLElement>): ReactElement<any, string | JSXElementConstructor<any>>

  • Type Parameters

    Parameters

    Returns ReactElement<any, string | JSXElementConstructor<any>>

LineUpLiteDataSummary

  • Type Parameters

    Parameters

    Returns Element

LineUpLiteFilterAction

  • LineUpLiteFilterAction<D>(props: CommonProps & { children?: ReactNode; column: ColumnInstance<D> & UseFiltersColumnProps<D>; icon: ComponentType<{}>; outerChildren?: ReactNode; onClick?: any }): JSX.Element

  • Type Parameters

    Parameters

    Returns JSX.Element

LineUpLiteGroupByAction

  • LineUpLiteGroupByAction<D>(props: CommonProps & { children?: ReactNode; column: UseGroupByColumnProps<D> & ColumnInstance<D>; icon: ComponentType<{}>; outerChildren?: ReactNode; onClick?: any }): JSX.Element

  • Type Parameters

    Parameters

    Returns JSX.Element

LineUpLiteHideAction

  • LineUpLiteHideAction<D>(props: CommonProps & { canHide?: boolean; canResize?: boolean; children?: ReactNode; column: ColumnInstance<D>; icon: ComponentType<{}>; outerChildren?: ReactNode }): JSX.Element

  • Type Parameters

    Parameters

    • props: CommonProps & { canHide?: boolean; canResize?: boolean; children?: ReactNode; column: ColumnInstance<D>; icon: ComponentType<{}>; outerChildren?: ReactNode }

    Returns JSX.Element

LineUpLitePaginated

  • Type Parameters

    Parameters

    Returns JSX.Element

LineUpLitePagination

  • Parameters

    Returns JSX.Element

LineUpLitePanel

  • Type Parameters

    Parameters

    Returns Element

LineUpLitePanelContextProvider

LineUpLiteSortByAction

  • LineUpLiteSortByAction<D>(props: CommonProps & { children?: ReactNode; column: ColumnInstance<D> & UseSortByColumnProps<D>; iconAsc: ComponentType<{}>; iconDesc: ComponentType<{}>; outerChildren?: ReactNode; onClick?: any }): JSX.Element

  • Type Parameters

    Parameters

    • props: CommonProps & { children?: ReactNode; column: ColumnInstance<D> & UseSortByColumnProps<D>; iconAsc: ComponentType<{}>; iconDesc: ComponentType<{}>; outerChildren?: ReactNode; onClick?: any }

    Returns JSX.Element

LineUpLiteStateContextProvider

  • LineUpLiteStateContextProvider<D>(props: { children: ReactNode }): JSX.Element

  • Type Parameters

    Parameters

    • props: { children: ReactNode }
      • children: ReactNode

    Returns JSX.Element

LineUpLiteTD

  • LineUpLiteTD<D>(p: LineUpLiteTDProps<D> & RefAttributes<HTMLElement>): ReactElement<any, string | JSXElementConstructor<any>>

  • Type Parameters

    Parameters

    Returns ReactElement<any, string | JSXElementConstructor<any>>

LineUpLiteTH

  • LineUpLiteTH<D>(p: LineUpLiteTHProps<D> & RefAttributes<HTMLElement>): ReactElement<any, string | JSXElementConstructor<any>>

  • Type Parameters

    Parameters

    Returns ReactElement<any, string | JSXElementConstructor<any>>

LineUpLiteTHead

  • LineUpLiteTHead<D>(p: LineUpLiteTHeadProps<D> & RefAttributes<HTMLElement>): ReactElement<any, string | JSXElementConstructor<any>>

  • Type Parameters

    Parameters

    Returns ReactElement<any, string | JSXElementConstructor<any>>

LineUpLiteTR

  • LineUpLiteTR<D>(p: LineUpLiteTRProps<D> & RefAttributes<HTMLElement>): ReactElement<any, string | JSXElementConstructor<any>>

  • Type Parameters

    Parameters

    Returns ReactElement<any, string | JSXElementConstructor<any>>

LineUpLiteTRMemo

  • LineUpLiteTRMemo<D>(p: LineUpLiteTRProps<D> & RefAttributes<HTMLElement>): ReactElement<any, string | JSXElementConstructor<any>>

  • Type Parameters

    Parameters

    Returns ReactElement<any, string | JSXElementConstructor<any>>

LineUpLiteTVirtualBody

  • LineUpLiteTVirtualBody<D>(__namedParameters: { estimatedSize: SizeEstimator; getTableBodyProps: ((propGetter?: TableBodyPropGetter<D>) => TableBodyProps); overscan?: number; rowSpacing: number; rows: Row<D>[]; theadRef: RefObject<HTMLElement>; prepareRow: any }): JSX.Element

  • Type Parameters

    Parameters

    • __namedParameters: { estimatedSize: SizeEstimator; getTableBodyProps: ((propGetter?: TableBodyPropGetter<D>) => TableBodyProps); overscan?: number; rowSpacing: number; rows: Row<D>[]; theadRef: RefObject<HTMLElement>; prepareRow: any }
      • estimatedSize: SizeEstimator
      • getTableBodyProps: ((propGetter?: TableBodyPropGetter<D>) => TableBodyProps)
          • (propGetter?: TableBodyPropGetter<D>): TableBodyProps

          • Parameters

            • Optional propGetter: TableBodyPropGetter<D>

            Returns TableBodyProps

      • Optional overscan?: number
      • rowSpacing: number
      • rows: Row<D>[]
      • theadRef: RefObject<HTMLElement>
      • prepareRow:function
        • prepareRow(row: Row<D>): void

        • Parameters

          Returns void

    Returns JSX.Element

LineUpLiteTableContextProvider

LineUpLiteTableSummary

  • Type Parameters

    Parameters

    Returns Element

LineUpLiteToolbar

  • Type Parameters

    Parameters

    Returns JSX.Element

LineUpLiteVirtual

  • LineUpLiteVirtual<D>(p: LineUpLiteVirtualProps<D> & RefAttributes<HTMLElement>): ReactElement<any, string | JSXElementConstructor<any>>

  • Type Parameters

    Parameters

    Returns ReactElement<any, string | JSXElementConstructor<any>>

actionIconsRemixicon

  • Returns ActionIcons

asCategoricalColumn

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

  • 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>

  • 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
  • lineup-lite/hooks

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

    Copyright (c) 2021 Samuel Gratzl sam@sgratzl.com

    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>

  • 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: keyof D | C, options?: NumberStatsOptions & { center?: number }): LineUpLiteColumn<D>

  • 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: keyof D | C

      property key or partial column Header and accessor

    • Optional options: NumberStatsOptions & { center?: number }

      additional options for statistics

    Returns LineUpLiteColumn<D>

asNumberBoxPlotColumn

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

  • 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>

  • 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>

  • 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>

  • 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>

  • 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>

  • 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>

deriveColumn

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

  • guesses the column type based on the values

    Type Parameters

    Parameters

    • data: D[]
    • accessor: keyof D

    Returns DeriveColumnResult<D>

deriveColumns

  • derive the columns within the given data

    Type Parameters

    Parameters

    • data: D[]

      the data array

    • Optional columns: (keyof D)[]

      optional list of column names to generate

    Returns (Column<D> & Partial<LineUpLiteColumn<D>>)[]

featureDefault

  • featureDefault<D>(): PluginHook<D>[]

  • default feature set including: filters, sorting, grouping, row select, row rank, and default layout

    Type Parameters

    Returns PluginHook<D>[]

featureDefaultLayout

  • featureDefaultLayout<D>(hooks: Hooks<D>): void

  • Type Parameters

    • D extends object = {}

    Parameters

    • hooks: Hooks<D>

    Returns void

featureFilterColumns

  • featureFilterColumns<D>(hooks: Hooks<D>): void

  • Type Parameters

    • D extends object = {}

    Parameters

    • hooks: Hooks<D>

    Returns void

featureFlexLayout

  • featureFlexLayout<D>(hooks: Hooks<D>): void

  • Type Parameters

    • D extends object = {}

    Parameters

    • hooks: Hooks<D>

    Returns void

featureResizeColumns

  • featureResizeColumns<D>(hooks: Hooks<D>): void

  • Type Parameters

    • D extends object = {}

    Parameters

    • hooks: Hooks<D>

    Returns void

featureRowRank

  • featureRowRank<D>(hooks: Hooks<D>): void

  • Type Parameters

    Parameters

    • hooks: Hooks<D>

    Returns void

featureRowSelect

  • featureRowSelect<D>(): PluginHook<D>[]

  • Type Parameters

    Returns PluginHook<D>[]

featureSortAndGroupBy

  • featureSortAndGroupBy<D>(): PluginHook<D>[]

  • Type Parameters

    Returns PluginHook<D>[]

featureSortBy

  • featureSortBy<D>(): PluginHook<D>[]

  • Type Parameters

    Returns PluginHook<D>[]

paginationIconsRemixicon

useLineUpLite

useLineUpLitePanelContext

useLineUpLiteStateContext

useLineUpLiteTableContext

useStateListener

Generated using TypeDoc