From 3f839930f240f46bda0d7bb1d2b1119e345cd287 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Mon, 28 Oct 2024 04:50:12 +0000 Subject: [PATCH] ci: apply automated fixes --- .../functions/aggregationfn_count.md | 29 + .../functions/aggregationfn_extent.md | 29 + docs/reference/functions/aggregationfn_max.md | 29 + .../reference/functions/aggregationfn_mean.md | 29 + .../functions/aggregationfn_median.md | 29 + docs/reference/functions/aggregationfn_min.md | 29 + docs/reference/functions/aggregationfn_sum.md | 29 + .../functions/aggregationfn_unique.md | 29 + .../functions/aggregationfn_uniquecount.md | 29 + docs/reference/functions/assignapis.md | 38 ++ docs/reference/functions/buildheadergroups.md | 40 ++ .../reference/functions/callmemoorstaticfn.md | 42 ++ docs/reference/functions/cell_getcontext.md | 66 ++ .../functions/cell_getisaggregated.md | 30 + docs/reference/functions/cell_getisgrouped.md | 30 + .../functions/cell_getisplaceholder.md | 30 + docs/reference/functions/cell_getvalue.md | 30 + docs/reference/functions/cell_rendervalue.md | 30 + .../functions/column_clearsorting.md | 30 + docs/reference/functions/column_getafter.md | 32 + .../functions/column_getaggregationfn.md | 40 ++ .../functions/column_getautoaggregationfn.md | 40 ++ .../functions/column_getautofilterfn.md | 30 + .../functions/column_getautosortdir.md | 30 + .../functions/column_getautosortingfn.md | 30 + .../functions/column_getcanfilter.md | 40 ++ .../functions/column_getcanglobalfilter.md | 40 ++ .../reference/functions/column_getcangroup.md | 40 ++ docs/reference/functions/column_getcanhide.md | 40 ++ .../functions/column_getcanmultisort.md | 30 + docs/reference/functions/column_getcanpin.md | 40 ++ .../functions/column_getcanresize.md | 40 ++ docs/reference/functions/column_getcansort.md | 30 + .../column_getfacetedminmaxvalues.md | 36 + .../functions/column_getfacetedrowmodel.md | 36 + .../column_getfaceteduniquevalues.md | 36 + .../reference/functions/column_getfilterfn.md | 40 ++ .../functions/column_getfilterindex.md | 40 ++ .../functions/column_getfiltervalue.md | 40 ++ .../functions/column_getfirstsortdir.md | 30 + .../functions/column_getflatcolumns.md | 30 + .../functions/column_getgroupedindex.md | 40 ++ docs/reference/functions/column_getindex.md | 32 + .../functions/column_getisfiltered.md | 40 ++ .../functions/column_getisfirstcolumn.md | 32 + .../functions/column_getisgrouped.md | 40 ++ .../functions/column_getislastcolumn.md | 32 + .../reference/functions/column_getispinned.md | 30 + .../functions/column_getisresizing.md | 40 ++ .../reference/functions/column_getissorted.md | 30 + .../functions/column_getisvisible.md | 40 ++ .../functions/column_getleafcolumns.md | 30 + .../functions/column_getnextsortingorder.md | 32 + .../functions/column_getpinnedindex.md | 30 + docs/reference/functions/column_getsize.md | 40 ++ .../functions/column_getsortindex.md | 30 + .../functions/column_getsortingfn.md | 30 + docs/reference/functions/column_getstart.md | 42 ++ .../column_gettogglegroupinghandler.md | 44 ++ .../column_gettogglesortinghandler.md | 38 ++ .../column_gettogglevisibilityhandler.md | 48 ++ .../functions/column_getvisibleleafcolumns.md | 30 + docs/reference/functions/column_pin.md | 32 + docs/reference/functions/column_resetsize.md | 30 + .../functions/column_setfiltervalue.md | 42 ++ .../functions/column_togglegrouping.md | 30 + .../functions/column_togglesorting.md | 37 ++ .../functions/column_togglevisibility.md | 42 ++ docs/reference/functions/constructcell.md | 37 ++ docs/reference/functions/constructcolumn.md | 40 ++ docs/reference/functions/constructheader.md | 47 ++ docs/reference/functions/constructrow.md | 47 ++ docs/reference/functions/constructtable.md | 28 + .../functions/constructtablehelper.md | 32 + .../reference/functions/createcolumnhelper.md | 41 ++ .../reference/functions/createcorerowmodel.md | 36 + .../functions/createexpandedrowmodel.md | 36 + .../functions/createfacetedminmaxvalues.md | 38 ++ .../functions/createfacetedrowmodel.md | 38 ++ .../functions/createfaceteduniquevalues.md | 38 ++ .../functions/createfilteredrowmodel.md | 36 + .../functions/creategroupedrowmodel.md | 36 + .../functions/createpaginatedrowmodel.md | 36 + .../functions/createsortedrowmodel.md | 36 + docs/reference/functions/expandrows.md | 46 ++ .../functions/filterfn_arrincludes.md | 32 + .../functions/filterfn_arrincludesall.md | 32 + .../functions/filterfn_arrincludessome.md | 32 + docs/reference/functions/filterfn_equals.md | 32 + .../functions/filterfn_equalsstring.md | 32 + .../functions/filterfn_includesstring.md | 32 + .../filterfn_includesstringsensitive.md | 32 + .../functions/filterfn_innumberrange.md | 32 + .../functions/filterfn_weakequals.md | 32 + docs/reference/functions/flattenby.md | 28 + docs/reference/functions/functionalupdate.md | 28 + .../functions/getdefaultcolumnfiltersstate.md | 18 + .../functions/getdefaultcolumnorderstate.md | 18 + .../functions/getdefaultcolumnpinningstate.md | 18 + .../getdefaultcolumnresizingstate.md | 18 + .../getdefaultcolumnsizingcolumndef.md | 36 + .../functions/getdefaultcolumnsizingstate.md | 18 + .../getdefaultcolumnvisibilitystate.md | 18 + .../functions/getdefaultexpandedstate.md | 18 + .../functions/getdefaultgroupingstate.md | 18 + .../functions/getdefaultpaginationstate.md | 18 + .../functions/getdefaultrowpinningstate.md | 18 + .../functions/getdefaultrowselectionstate.md | 18 + .../functions/getfunctionnameinfo.md | 42 ++ .../functions/getinitialtablestate.md | 28 + docs/reference/functions/header_getcontext.md | 48 ++ .../functions/header_getleafheaders.md | 30 + .../functions/header_getresizehandler.md | 40 ++ docs/reference/functions/header_getsize.md | 30 + docs/reference/functions/header_getstart.md | 30 + docs/reference/functions/isfunction.md | 26 + docs/reference/functions/isnumberarray.md | 22 + docs/reference/functions/isrowselected.md | 28 + docs/reference/functions/issubrowselected.md | 28 + docs/reference/functions/istouchstartevent.md | 22 + docs/reference/functions/makestateupdater.md | 49 ++ docs/reference/functions/memo.md | 38 ++ docs/reference/functions/noop.md | 18 + docs/reference/functions/ordercolumns.md | 30 + .../functions/passiveeventsupported.md | 18 + docs/reference/functions/row_getallcells.md | 28 + .../functions/row_getallcellsbycolumnid.md | 28 + .../functions/row_getallvisiblecells.md | 28 + docs/reference/functions/row_getcanexpand.md | 28 + .../functions/row_getcanmultiselect.md | 28 + docs/reference/functions/row_getcanpin.md | 28 + docs/reference/functions/row_getcanselect.md | 28 + .../functions/row_getcanselectsubrows.md | 28 + .../functions/row_getcentervisiblecells.md | 28 + .../functions/row_getgroupingvalue.md | 37 ++ .../functions/row_getisallparentsexpanded.md | 28 + .../functions/row_getisallsubrowsselected.md | 28 + docs/reference/functions/row_getisexpanded.md | 28 + docs/reference/functions/row_getisgrouped.md | 35 + docs/reference/functions/row_getispinned.md | 28 + docs/reference/functions/row_getisselected.md | 28 + .../functions/row_getissomeselected.md | 28 + docs/reference/functions/row_getleafrows.md | 28 + .../functions/row_getleftvisiblecells.md | 28 + docs/reference/functions/row_getparentrow.md | 28 + docs/reference/functions/row_getparentrows.md | 28 + .../reference/functions/row_getpinnedindex.md | 28 + .../functions/row_getrightvisiblecells.md | 28 + .../functions/row_gettoggleexpandedhandler.md | 32 + .../functions/row_gettoggleselectedhandler.md | 36 + .../functions/row_getuniquevalues.md | 30 + docs/reference/functions/row_getvalue.md | 30 + .../functions/row_getvisiblecells.md | 35 + docs/reference/functions/row_pin.md | 38 ++ docs/reference/functions/row_rendervalue.md | 30 + .../reference/functions/row_toggleexpanded.md | 30 + .../reference/functions/row_toggleselected.md | 37 ++ docs/reference/functions/selectrowsfn.md | 28 + .../functions/shouldautoremovefilter.md | 37 ++ .../functions/sortingfn_alphanumeric.md | 29 + .../sortingfn_alphanumericcasesensitive.md | 29 + docs/reference/functions/sortingfn_basic.md | 29 + .../reference/functions/sortingfn_datetime.md | 29 + docs/reference/functions/sortingfn_text.md | 29 + .../functions/sortingfn_textcasesensitive.md | 29 + .../functions/table_autoresetexpanded.md | 28 + .../functions/table_autoresetpageindex.md | 28 + docs/reference/functions/table_firstpage.md | 28 + .../functions/table_getallcolumns.md | 28 + .../functions/table_getallflatcolumns.md | 28 + .../functions/table_getallflatcolumnsbyid.md | 28 + .../functions/table_getallleafcolumns.md | 28 + .../functions/table_getbottomrows.md | 28 + .../functions/table_getcannextpage.md | 28 + .../functions/table_getcanpreviouspage.md | 28 + .../functions/table_getcansomerowsexpand.md | 28 + .../functions/table_getcenterflatheaders.md | 28 + .../functions/table_getcenterfootergroups.md | 28 + .../functions/table_getcenterheadergroups.md | 28 + .../functions/table_getcenterleafcolumns.md | 28 + .../functions/table_getcenterleafheaders.md | 28 + .../functions/table_getcenterrows.md | 28 + .../functions/table_getcentertotalsize.md | 28 + .../table_getcentervisibleleafcolumns.md | 28 + docs/reference/functions/table_getcolumn.md | 30 + .../functions/table_getcorerowmodel.md | 28 + .../functions/table_getdefaultcolumndef.md | 28 + .../functions/table_getexpandeddepth.md | 28 + .../functions/table_getexpandedrowmodel.md | 28 + .../functions/table_getfilteredrowmodel.md | 28 + .../table_getfilteredselectedrowmodel.md | 28 + .../functions/table_getflatheaders.md | 28 + .../functions/table_getfootergroups.md | 28 + .../functions/table_getglobalautofilterfn.md | 18 + .../table_getglobalfacetedminmaxvalues.md | 32 + .../table_getglobalfacetedrowmodel.md | 32 + .../table_getglobalfaceteduniquevalues.md | 32 + .../functions/table_getglobalfilterfn.md | 28 + .../functions/table_getgroupedrowmodel.md | 28 + .../table_getgroupedselectedrowmodel.md | 28 + .../functions/table_getheadergroups.md | 28 + .../functions/table_getinitialstate.md | 28 + .../functions/table_getisallcolumnsvisible.md | 28 + .../table_getisallpagerowsselected.md | 28 + .../functions/table_getisallrowsexpanded.md | 28 + .../functions/table_getisallrowsselected.md | 28 + .../functions/table_getissomecolumnspinned.md | 30 + .../table_getissomecolumnsvisible.md | 28 + .../table_getissomepagerowsselected.md | 28 + .../functions/table_getissomerowsexpanded.md | 28 + .../functions/table_getissomerowspinned.md | 30 + .../functions/table_getissomerowsselected.md | 28 + .../functions/table_getleafheaders.md | 28 + .../functions/table_getleftflatheaders.md | 28 + .../functions/table_getleftfootergroups.md | 28 + .../functions/table_getleftheadergroups.md | 28 + .../functions/table_getleftleafcolumns.md | 28 + .../functions/table_getleftleafheaders.md | 28 + .../functions/table_getlefttotalsize.md | 28 + .../table_getleftvisibleleafcolumns.md | 28 + .../functions/table_getordercolumnsfn.md | 36 + .../reference/functions/table_getpagecount.md | 28 + .../functions/table_getpageoptions.md | 28 + .../functions/table_getpaginatedrowmodel.md | 28 + .../functions/table_getpreexpandedrowmodel.md | 28 + .../functions/table_getprefilteredrowmodel.md | 28 + .../functions/table_getpregroupedrowmodel.md | 28 + .../table_getprepaginatedrowmodel.md | 28 + .../functions/table_getpreselectedrowmodel.md | 28 + .../functions/table_getpresortedrowmodel.md | 28 + .../functions/table_getrightflatheaders.md | 28 + .../functions/table_getrightfootergroups.md | 28 + .../functions/table_getrightheadergroups.md | 28 + .../functions/table_getrightleafcolumns.md | 28 + .../functions/table_getrightleafheaders.md | 28 + .../functions/table_getrighttotalsize.md | 28 + .../table_getrightvisibleleafcolumns.md | 28 + docs/reference/functions/table_getrow.md | 35 + docs/reference/functions/table_getrowcount.md | 28 + docs/reference/functions/table_getrowid.md | 38 ++ docs/reference/functions/table_getrowmodel.md | 28 + .../functions/table_getselectedrowmodel.md | 28 + .../functions/table_getsortedrowmodel.md | 28 + docs/reference/functions/table_getstate.md | 28 + ...le_gettoggleallcolumnsvisibilityhandler.md | 36 + ...ble_gettoggleallpagerowsselectedhandler.md | 36 + .../table_gettoggleallrowsexpandedhandler.md | 36 + .../table_gettoggleallrowsselectedhandler.md | 36 + docs/reference/functions/table_gettoprows.md | 28 + .../reference/functions/table_gettotalsize.md | 28 + .../functions/table_getvisibleflatcolumns.md | 28 + .../functions/table_getvisibleleafcolumns.md | 28 + docs/reference/functions/table_lastpage.md | 28 + .../reference/functions/table_mergeoptions.md | 30 + docs/reference/functions/table_nextpage.md | 28 + .../reference/functions/table_previouspage.md | 28 + docs/reference/functions/table_reset.md | 28 + .../functions/table_resetcolumnfilters.md | 30 + .../functions/table_resetcolumnorder.md | 30 + .../functions/table_resetcolumnpinning.md | 30 + .../functions/table_resetcolumnsizing.md | 30 + .../functions/table_resetcolumnvisibility.md | 30 + .../functions/table_resetexpanded.md | 30 + .../functions/table_resetglobalfilter.md | 30 + .../functions/table_resetgrouping.md | 30 + .../functions/table_resetheadersizeinfo.md | 30 + .../functions/table_resetpageindex.md | 30 + .../functions/table_resetpagesize.md | 30 + .../functions/table_resetpagination.md | 30 + .../functions/table_resetrowpinning.md | 30 + .../functions/table_resetrowselection.md | 30 + .../reference/functions/table_resetsorting.md | 30 + .../functions/table_setcolumnfilters.md | 30 + .../functions/table_setcolumnorder.md | 30 + .../functions/table_setcolumnpinning.md | 30 + .../functions/table_setcolumnresizing.md | 30 + .../functions/table_setcolumnsizing.md | 30 + .../functions/table_setcolumnvisibility.md | 30 + docs/reference/functions/table_setexpanded.md | 30 + .../functions/table_setglobalfilter.md | 30 + docs/reference/functions/table_setgrouping.md | 30 + docs/reference/functions/table_setoptions.md | 30 + .../reference/functions/table_setpageindex.md | 30 + docs/reference/functions/table_setpagesize.md | 30 + .../functions/table_setpagination.md | 30 + .../functions/table_setrowpinning.md | 30 + .../functions/table_setrowselection.md | 30 + docs/reference/functions/table_setsorting.md | 30 + docs/reference/functions/table_setstate.md | 30 + .../table_toggleallcolumnsvisible.md | 30 + .../table_toggleallpagerowsselected.md | 30 + .../functions/table_toggleallrowsexpanded.md | 30 + .../functions/table_toggleallrowsselected.md | 30 + docs/reference/functions/tablefeatures.md | 34 + docs/reference/functions/tablememo.md | 38 ++ docs/reference/functions/tableoptions.md | 198 ++++++ docs/reference/index.md | 563 ++++++++++++++++ docs/reference/interfaces/aggregationfns.md | 6 + .../interfaces/cachedrowmodel_core.md | 28 + .../interfaces/cachedrowmodel_expanded.md | 28 + .../interfaces/cachedrowmodel_faceted.md | 76 +++ .../interfaces/cachedrowmodel_filtered.md | 28 + .../interfaces/cachedrowmodel_grouped.md | 28 + .../interfaces/cachedrowmodel_paginated.md | 28 + .../interfaces/cachedrowmodel_sorted.md | 28 + docs/reference/interfaces/cell_cell.md | 186 ++++++ .../interfaces/cell_columngrouping.md | 84 +++ .../interfaces/cell_coreproperties.md | 100 +++ docs/reference/interfaces/cellcontext.md | 86 +++ docs/reference/interfaces/column_column.md | 249 +++++++ .../interfaces/column_columnfaceting.md | 12 + .../interfaces/column_columnfiltering.md | 198 ++++++ .../interfaces/column_columngrouping.md | 198 ++++++ .../interfaces/column_columnordering.md | 96 +++ .../interfaces/column_columnpinning.md | 114 ++++ .../interfaces/column_columnresizing.md | 58 ++ .../interfaces/column_columnsizing.md | 110 ++++ .../interfaces/column_columnvisibility.md | 122 ++++ .../interfaces/column_coreproperties.md | 169 +++++ .../interfaces/column_globalfiltering.md | 32 + .../reference/interfaces/column_rowsorting.md | 330 ++++++++++ .../interfaces/columndef_columnfiltering.md | 56 ++ .../interfaces/columndef_columngrouping.md | 110 ++++ .../interfaces/columndef_columnpinning.md | 28 + .../interfaces/columndef_columnresizing.md | 28 + .../interfaces/columndef_columnsizing.md | 72 ++ .../interfaces/columndef_columnvisibility.md | 28 + .../interfaces/columndef_globalfiltering.md | 28 + .../interfaces/columndef_rowsorting.md | 157 +++++ .../interfaces/columndefaultoptions.md | 30 + docs/reference/interfaces/columnfilter.md | 30 + docs/reference/interfaces/columnmeta.md | 14 + .../interfaces/columnorderdefaultoptions.md | 18 + .../interfaces/columnpinningdefaultoptions.md | 18 + .../interfaces/columnpinningstate.md | 30 + .../interfaces/columnresizingstate.md | 78 +++ docs/reference/interfaces/columnsort.md | 30 + .../interfaces/createrowmodel_core.md | 46 ++ .../interfaces/createrowmodel_expanded.md | 46 ++ .../interfaces/createrowmodel_faceted.md | 120 ++++ .../interfaces/createrowmodel_filtered.md | 48 ++ .../interfaces/createrowmodel_grouped.md | 46 ++ .../interfaces/createrowmodel_paginated.md | 48 ++ .../interfaces/createrowmodel_sorted.md | 46 ++ docs/reference/interfaces/filterfn.md | 62 ++ docs/reference/interfaces/filterfns.md | 6 + docs/reference/interfaces/filtermeta.md | 6 + .../interfaces/header_columnresizing.md | 48 ++ .../interfaces/header_columnsizing.md | 62 ++ .../interfaces/header_coreproperties.md | 254 +++++++ docs/reference/interfaces/header_header.md | 350 ++++++++++ docs/reference/interfaces/headercontext.md | 56 ++ docs/reference/interfaces/headergroup.md | 64 ++ docs/reference/interfaces/headergroup_core.md | 68 ++ .../interfaces/headergroup_header.md | 54 ++ docs/reference/interfaces/ididentifier.md | 38 ++ .../interfaces/paginationdefaultoptions.md | 18 + docs/reference/interfaces/paginationstate.md | 30 + .../interfaces/resolvedcolumnfilter.md | 48 ++ .../interfaces/row_columnfiltering.md | 56 ++ .../interfaces/row_columngrouping.md | 118 ++++ .../reference/interfaces/row_columnpinning.md | 90 +++ .../interfaces/row_columnvisibility.md | 54 ++ .../interfaces/row_coreproperties.md | 210 ++++++ docs/reference/interfaces/row_row.md | 472 ++++++++++++++ docs/reference/interfaces/row_rowexpanding.md | 144 ++++ docs/reference/interfaces/row_rowpinning.md | 118 ++++ docs/reference/interfaces/row_rowselection.md | 230 +++++++ docs/reference/interfaces/rowmodel.md | 48 ++ .../interfaces/rowpinningdefaultoptions.md | 18 + docs/reference/interfaces/rowpinningstate.md | 30 + docs/reference/interfaces/sortingfn.md | 35 + docs/reference/interfaces/sortingfns.md | 6 + .../interfaces/stringheaderidentifier.md | 30 + .../interfaces/table_columnfiltering.md | 132 ++++ .../interfaces/table_columngrouping.md | 72 ++ .../interfaces/table_columnordering.md | 72 ++ .../interfaces/table_columnpinning.md | 570 ++++++++++++++++ .../interfaces/table_columnresizing.md | 66 ++ docs/reference/interfaces/table_columns.md | 172 +++++ .../interfaces/table_columnsizing.md | 170 +++++ .../interfaces/table_columnvisibility.md | 240 +++++++ .../interfaces/table_coreproperties.md | 126 ++++ .../interfaces/table_globalfaceting.md | 90 +++ .../interfaces/table_globalfiltering.md | 124 ++++ docs/reference/interfaces/table_headers.md | 116 ++++ .../interfaces/table_rowexpanding.md | 256 ++++++++ .../interfaces/table_rowmodels_core.md | 64 ++ .../interfaces/table_rowmodels_expanded.md | 64 ++ .../interfaces/table_rowmodels_faceted.md | 93 +++ .../interfaces/table_rowmodels_filtered.md | 64 ++ .../interfaces/table_rowmodels_grouped.md | 64 ++ .../interfaces/table_rowmodels_paginated.md | 64 ++ .../interfaces/table_rowmodels_sorted.md | 64 ++ .../interfaces/table_rowpagination.md | 442 +++++++++++++ docs/reference/interfaces/table_rowpinning.md | 180 +++++ docs/reference/interfaces/table_rows.md | 68 ++ .../interfaces/table_rowselection.md | 408 ++++++++++++ docs/reference/interfaces/table_rowsorting.md | 72 ++ docs/reference/interfaces/table_table.md | 258 ++++++++ docs/reference/interfaces/tablefeature.md | 216 ++++++ .../interfaces/tablefns_columnfiltering.md | 24 + .../interfaces/tablefns_columngrouping.md | 24 + .../interfaces/tablefns_rowsorting.md | 24 + docs/reference/interfaces/tablemeta.md | 12 + .../reference/interfaces/tableoptions_cell.md | 54 ++ .../tableoptions_columnfiltering.md | 148 +++++ .../interfaces/tableoptions_columngrouping.md | 94 +++ .../interfaces/tableoptions_columnordering.md | 28 + .../interfaces/tableoptions_columnpinning.md | 50 ++ .../interfaces/tableoptions_columnresizing.md | 94 +++ .../interfaces/tableoptions_columns.md | 84 +++ .../interfaces/tableoptions_columnsizing.md | 28 + .../tableoptions_columnvisibility.md | 50 ++ .../reference/interfaces/tableoptions_core.md | 617 ++++++++++++++++++ .../tableoptions_globalfiltering.md | 121 ++++ .../interfaces/tableoptions_headers.md | 32 + .../interfaces/tableoptions_rowexpanding.md | 182 ++++++ .../interfaces/tableoptions_rowpagination.md | 116 ++++ .../interfaces/tableoptions_rowpinning.md | 78 +++ .../reference/interfaces/tableoptions_rows.md | 116 ++++ .../interfaces/tableoptions_rowselection.md | 103 +++ .../interfaces/tableoptions_rowsorting.md | 214 ++++++ .../interfaces/tableoptions_table.md | 301 +++++++++ .../interfaces/tablestate_columnfiltering.md | 18 + .../interfaces/tablestate_columngrouping.md | 18 + .../interfaces/tablestate_columnordering.md | 18 + .../interfaces/tablestate_columnpinning.md | 18 + .../interfaces/tablestate_columnresizing.md | 18 + .../interfaces/tablestate_columnsizing.md | 18 + .../interfaces/tablestate_columnvisibility.md | 18 + .../interfaces/tablestate_globalfiltering.md | 18 + .../interfaces/tablestate_rowexpanding.md | 18 + .../interfaces/tablestate_rowpagination.md | 18 + .../interfaces/tablestate_rowpinning.md | 18 + .../interfaces/tablestate_rowselection.md | 18 + .../interfaces/tablestate_rowsorting.md | 18 + .../type-aliases/accessorcolumndef.md | 22 + docs/reference/type-aliases/accessorfn.md | 30 + .../type-aliases/accessorfncolumndef.md | 22 + .../type-aliases/accessorfncolumndefbase.md | 30 + .../type-aliases/accessorkeycolumndef.md | 22 + .../type-aliases/accessorkeycolumndefbase.md | 36 + docs/reference/type-aliases/aggregationfn.md | 32 + .../type-aliases/aggregationfnoption.md | 20 + .../type-aliases/builtinaggregationfn.md | 14 + .../reference/type-aliases/builtinfilterfn.md | 14 + .../type-aliases/builtinsortingfn.md | 14 + .../type-aliases/cachedrowmodel_all.md | 20 + .../reference/type-aliases/cachedrowmodels.md | 38 ++ docs/reference/type-aliases/cell.md | 22 + docs/reference/type-aliases/celldata.md | 14 + docs/reference/type-aliases/column.md | 32 + .../reference/type-aliases/column_internal.md | 30 + docs/reference/type-aliases/columndef.md | 22 + docs/reference/type-aliases/columndefbase.md | 30 + .../type-aliases/columndefbase_all.md | 22 + .../type-aliases/columndefresolved.md | 30 + .../type-aliases/columndeftemplate.md | 18 + .../columnfilterautoremovetestfn.md | 32 + .../type-aliases/columnfiltersstate.md | 14 + docs/reference/type-aliases/columnhelper.md | 72 ++ .../type-aliases/columnorderstate.md | 14 + .../type-aliases/columnpinningposition.md | 14 + .../type-aliases/columnresizedirection.md | 14 + .../type-aliases/columnresizemode.md | 14 + .../columnresizingdefaultoptions.md | 14 + .../columnsizingdefaultoptions.md | 14 + .../type-aliases/columnsizingstate.md | 14 + .../type-aliases/columnvisibilitystate.md | 14 + .../type-aliases/coretablefeatures.md | 14 + .../reference/type-aliases/createrowmodels.md | 26 + .../type-aliases/createrowmodels_all.md | 20 + .../type-aliases/customaggregationfns.md | 20 + .../reference/type-aliases/customfilterfns.md | 20 + .../type-aliases/customsortingfns.md | 20 + docs/reference/type-aliases/deepkeys.md | 20 + docs/reference/type-aliases/deepvalue.md | 20 + .../type-aliases/displaycolumndef.md | 22 + docs/reference/type-aliases/expandedstate.md | 14 + .../type-aliases/expandedstatelist.md | 14 + docs/reference/type-aliases/filterfnoption.md | 20 + docs/reference/type-aliases/getter.md | 26 + docs/reference/type-aliases/groupcolumndef.md | 22 + .../type-aliases/groupingcolumnmode.md | 14 + docs/reference/type-aliases/groupingstate.md | 14 + docs/reference/type-aliases/header.md | 22 + .../type-aliases/identifiedcolumndef.md | 36 + docs/reference/type-aliases/noinfer.md | 18 + docs/reference/type-aliases/onchangefn.md | 26 + docs/reference/type-aliases/partialkeys.md | 20 + docs/reference/type-aliases/requiredkeys.md | 20 + docs/reference/type-aliases/row.md | 27 + docs/reference/type-aliases/row_internal.md | 20 + docs/reference/type-aliases/rowdata.md | 14 + .../type-aliases/rowpinningposition.md | 14 + .../type-aliases/rowselectionstate.md | 14 + docs/reference/type-aliases/sortdirection.md | 14 + .../reference/type-aliases/sortingfnoption.md | 20 + docs/reference/type-aliases/sortingstate.md | 14 + .../type-aliases/stringortemplateheader.md | 22 + docs/reference/type-aliases/table.md | 36 + docs/reference/type-aliases/table_core.md | 23 + docs/reference/type-aliases/table_internal.md | 60 ++ .../reference/type-aliases/table_rowmodels.md | 20 + docs/reference/type-aliases/tablefeatures.md | 14 + .../type-aliases/tablehelper_core.md | 56 ++ .../type-aliases/tablehelperoptions.md | 37 ++ docs/reference/type-aliases/tableoptions.md | 33 + .../type-aliases/tableoptions_all.md | 20 + docs/reference/type-aliases/tablestate.md | 18 + docs/reference/type-aliases/tablestate_all.md | 14 + .../type-aliases/transformfiltervaluefn.md | 32 + .../type-aliases/uniontointersection.md | 18 + docs/reference/type-aliases/updater.md | 18 + .../type-aliases/visibilitydefaultoptions.md | 14 + docs/reference/variables/aggregationfns.md | 70 ++ docs/reference/variables/cells.md | 14 + docs/reference/variables/columnfaceting.md | 16 + docs/reference/variables/columnfiltering.md | 26 + docs/reference/variables/columngrouping.md | 24 + docs/reference/variables/columnordering.md | 24 + docs/reference/variables/columnpinning.md | 24 + docs/reference/variables/columnresizing.md | 26 + docs/reference/variables/columns.md | 14 + docs/reference/variables/columnsizing.md | 26 + docs/reference/variables/columnvisibility.md | 20 + docs/reference/variables/corefeatures.md | 52 ++ docs/reference/variables/filterfns.md | 70 ++ docs/reference/variables/globalfaceting.md | 24 + docs/reference/variables/globalfiltering.md | 26 + docs/reference/variables/headers.md | 14 + docs/reference/variables/isdev.md | 14 + .../variables/resplitalphanumeric.md | 14 + docs/reference/variables/rowexpanding.md | 24 + docs/reference/variables/rowmodels.md | 14 + docs/reference/variables/rowpagination.md | 24 + docs/reference/variables/rowpinning.md | 24 + docs/reference/variables/rows.md | 14 + docs/reference/variables/rowselection.md | 24 + docs/reference/variables/rowsorting.md | 24 + docs/reference/variables/sortingfns.md | 52 ++ docs/reference/variables/stockfeatures.md | 106 +++ docs/reference/variables/tables.md | 14 + 544 files changed, 26015 insertions(+) create mode 100644 docs/reference/functions/aggregationfn_count.md create mode 100644 docs/reference/functions/aggregationfn_extent.md create mode 100644 docs/reference/functions/aggregationfn_max.md create mode 100644 docs/reference/functions/aggregationfn_mean.md create mode 100644 docs/reference/functions/aggregationfn_median.md create mode 100644 docs/reference/functions/aggregationfn_min.md create mode 100644 docs/reference/functions/aggregationfn_sum.md create mode 100644 docs/reference/functions/aggregationfn_unique.md create mode 100644 docs/reference/functions/aggregationfn_uniquecount.md create mode 100644 docs/reference/functions/assignapis.md create mode 100644 docs/reference/functions/buildheadergroups.md create mode 100644 docs/reference/functions/callmemoorstaticfn.md create mode 100644 docs/reference/functions/cell_getcontext.md create mode 100644 docs/reference/functions/cell_getisaggregated.md create mode 100644 docs/reference/functions/cell_getisgrouped.md create mode 100644 docs/reference/functions/cell_getisplaceholder.md create mode 100644 docs/reference/functions/cell_getvalue.md create mode 100644 docs/reference/functions/cell_rendervalue.md create mode 100644 docs/reference/functions/column_clearsorting.md create mode 100644 docs/reference/functions/column_getafter.md create mode 100644 docs/reference/functions/column_getaggregationfn.md create mode 100644 docs/reference/functions/column_getautoaggregationfn.md create mode 100644 docs/reference/functions/column_getautofilterfn.md create mode 100644 docs/reference/functions/column_getautosortdir.md create mode 100644 docs/reference/functions/column_getautosortingfn.md create mode 100644 docs/reference/functions/column_getcanfilter.md create mode 100644 docs/reference/functions/column_getcanglobalfilter.md create mode 100644 docs/reference/functions/column_getcangroup.md create mode 100644 docs/reference/functions/column_getcanhide.md create mode 100644 docs/reference/functions/column_getcanmultisort.md create mode 100644 docs/reference/functions/column_getcanpin.md create mode 100644 docs/reference/functions/column_getcanresize.md create mode 100644 docs/reference/functions/column_getcansort.md create mode 100644 docs/reference/functions/column_getfacetedminmaxvalues.md create mode 100644 docs/reference/functions/column_getfacetedrowmodel.md create mode 100644 docs/reference/functions/column_getfaceteduniquevalues.md create mode 100644 docs/reference/functions/column_getfilterfn.md create mode 100644 docs/reference/functions/column_getfilterindex.md create mode 100644 docs/reference/functions/column_getfiltervalue.md create mode 100644 docs/reference/functions/column_getfirstsortdir.md create mode 100644 docs/reference/functions/column_getflatcolumns.md create mode 100644 docs/reference/functions/column_getgroupedindex.md create mode 100644 docs/reference/functions/column_getindex.md create mode 100644 docs/reference/functions/column_getisfiltered.md create mode 100644 docs/reference/functions/column_getisfirstcolumn.md create mode 100644 docs/reference/functions/column_getisgrouped.md create mode 100644 docs/reference/functions/column_getislastcolumn.md create mode 100644 docs/reference/functions/column_getispinned.md create mode 100644 docs/reference/functions/column_getisresizing.md create mode 100644 docs/reference/functions/column_getissorted.md create mode 100644 docs/reference/functions/column_getisvisible.md create mode 100644 docs/reference/functions/column_getleafcolumns.md create mode 100644 docs/reference/functions/column_getnextsortingorder.md create mode 100644 docs/reference/functions/column_getpinnedindex.md create mode 100644 docs/reference/functions/column_getsize.md create mode 100644 docs/reference/functions/column_getsortindex.md create mode 100644 docs/reference/functions/column_getsortingfn.md create mode 100644 docs/reference/functions/column_getstart.md create mode 100644 docs/reference/functions/column_gettogglegroupinghandler.md create mode 100644 docs/reference/functions/column_gettogglesortinghandler.md create mode 100644 docs/reference/functions/column_gettogglevisibilityhandler.md create mode 100644 docs/reference/functions/column_getvisibleleafcolumns.md create mode 100644 docs/reference/functions/column_pin.md create mode 100644 docs/reference/functions/column_resetsize.md create mode 100644 docs/reference/functions/column_setfiltervalue.md create mode 100644 docs/reference/functions/column_togglegrouping.md create mode 100644 docs/reference/functions/column_togglesorting.md create mode 100644 docs/reference/functions/column_togglevisibility.md create mode 100644 docs/reference/functions/constructcell.md create mode 100644 docs/reference/functions/constructcolumn.md create mode 100644 docs/reference/functions/constructheader.md create mode 100644 docs/reference/functions/constructrow.md create mode 100644 docs/reference/functions/constructtable.md create mode 100644 docs/reference/functions/constructtablehelper.md create mode 100644 docs/reference/functions/createcolumnhelper.md create mode 100644 docs/reference/functions/createcorerowmodel.md create mode 100644 docs/reference/functions/createexpandedrowmodel.md create mode 100644 docs/reference/functions/createfacetedminmaxvalues.md create mode 100644 docs/reference/functions/createfacetedrowmodel.md create mode 100644 docs/reference/functions/createfaceteduniquevalues.md create mode 100644 docs/reference/functions/createfilteredrowmodel.md create mode 100644 docs/reference/functions/creategroupedrowmodel.md create mode 100644 docs/reference/functions/createpaginatedrowmodel.md create mode 100644 docs/reference/functions/createsortedrowmodel.md create mode 100644 docs/reference/functions/expandrows.md create mode 100644 docs/reference/functions/filterfn_arrincludes.md create mode 100644 docs/reference/functions/filterfn_arrincludesall.md create mode 100644 docs/reference/functions/filterfn_arrincludessome.md create mode 100644 docs/reference/functions/filterfn_equals.md create mode 100644 docs/reference/functions/filterfn_equalsstring.md create mode 100644 docs/reference/functions/filterfn_includesstring.md create mode 100644 docs/reference/functions/filterfn_includesstringsensitive.md create mode 100644 docs/reference/functions/filterfn_innumberrange.md create mode 100644 docs/reference/functions/filterfn_weakequals.md create mode 100644 docs/reference/functions/flattenby.md create mode 100644 docs/reference/functions/functionalupdate.md create mode 100644 docs/reference/functions/getdefaultcolumnfiltersstate.md create mode 100644 docs/reference/functions/getdefaultcolumnorderstate.md create mode 100644 docs/reference/functions/getdefaultcolumnpinningstate.md create mode 100644 docs/reference/functions/getdefaultcolumnresizingstate.md create mode 100644 docs/reference/functions/getdefaultcolumnsizingcolumndef.md create mode 100644 docs/reference/functions/getdefaultcolumnsizingstate.md create mode 100644 docs/reference/functions/getdefaultcolumnvisibilitystate.md create mode 100644 docs/reference/functions/getdefaultexpandedstate.md create mode 100644 docs/reference/functions/getdefaultgroupingstate.md create mode 100644 docs/reference/functions/getdefaultpaginationstate.md create mode 100644 docs/reference/functions/getdefaultrowpinningstate.md create mode 100644 docs/reference/functions/getdefaultrowselectionstate.md create mode 100644 docs/reference/functions/getfunctionnameinfo.md create mode 100644 docs/reference/functions/getinitialtablestate.md create mode 100644 docs/reference/functions/header_getcontext.md create mode 100644 docs/reference/functions/header_getleafheaders.md create mode 100644 docs/reference/functions/header_getresizehandler.md create mode 100644 docs/reference/functions/header_getsize.md create mode 100644 docs/reference/functions/header_getstart.md create mode 100644 docs/reference/functions/isfunction.md create mode 100644 docs/reference/functions/isnumberarray.md create mode 100644 docs/reference/functions/isrowselected.md create mode 100644 docs/reference/functions/issubrowselected.md create mode 100644 docs/reference/functions/istouchstartevent.md create mode 100644 docs/reference/functions/makestateupdater.md create mode 100644 docs/reference/functions/memo.md create mode 100644 docs/reference/functions/noop.md create mode 100644 docs/reference/functions/ordercolumns.md create mode 100644 docs/reference/functions/passiveeventsupported.md create mode 100644 docs/reference/functions/row_getallcells.md create mode 100644 docs/reference/functions/row_getallcellsbycolumnid.md create mode 100644 docs/reference/functions/row_getallvisiblecells.md create mode 100644 docs/reference/functions/row_getcanexpand.md create mode 100644 docs/reference/functions/row_getcanmultiselect.md create mode 100644 docs/reference/functions/row_getcanpin.md create mode 100644 docs/reference/functions/row_getcanselect.md create mode 100644 docs/reference/functions/row_getcanselectsubrows.md create mode 100644 docs/reference/functions/row_getcentervisiblecells.md create mode 100644 docs/reference/functions/row_getgroupingvalue.md create mode 100644 docs/reference/functions/row_getisallparentsexpanded.md create mode 100644 docs/reference/functions/row_getisallsubrowsselected.md create mode 100644 docs/reference/functions/row_getisexpanded.md create mode 100644 docs/reference/functions/row_getisgrouped.md create mode 100644 docs/reference/functions/row_getispinned.md create mode 100644 docs/reference/functions/row_getisselected.md create mode 100644 docs/reference/functions/row_getissomeselected.md create mode 100644 docs/reference/functions/row_getleafrows.md create mode 100644 docs/reference/functions/row_getleftvisiblecells.md create mode 100644 docs/reference/functions/row_getparentrow.md create mode 100644 docs/reference/functions/row_getparentrows.md create mode 100644 docs/reference/functions/row_getpinnedindex.md create mode 100644 docs/reference/functions/row_getrightvisiblecells.md create mode 100644 docs/reference/functions/row_gettoggleexpandedhandler.md create mode 100644 docs/reference/functions/row_gettoggleselectedhandler.md create mode 100644 docs/reference/functions/row_getuniquevalues.md create mode 100644 docs/reference/functions/row_getvalue.md create mode 100644 docs/reference/functions/row_getvisiblecells.md create mode 100644 docs/reference/functions/row_pin.md create mode 100644 docs/reference/functions/row_rendervalue.md create mode 100644 docs/reference/functions/row_toggleexpanded.md create mode 100644 docs/reference/functions/row_toggleselected.md create mode 100644 docs/reference/functions/selectrowsfn.md create mode 100644 docs/reference/functions/shouldautoremovefilter.md create mode 100644 docs/reference/functions/sortingfn_alphanumeric.md create mode 100644 docs/reference/functions/sortingfn_alphanumericcasesensitive.md create mode 100644 docs/reference/functions/sortingfn_basic.md create mode 100644 docs/reference/functions/sortingfn_datetime.md create mode 100644 docs/reference/functions/sortingfn_text.md create mode 100644 docs/reference/functions/sortingfn_textcasesensitive.md create mode 100644 docs/reference/functions/table_autoresetexpanded.md create mode 100644 docs/reference/functions/table_autoresetpageindex.md create mode 100644 docs/reference/functions/table_firstpage.md create mode 100644 docs/reference/functions/table_getallcolumns.md create mode 100644 docs/reference/functions/table_getallflatcolumns.md create mode 100644 docs/reference/functions/table_getallflatcolumnsbyid.md create mode 100644 docs/reference/functions/table_getallleafcolumns.md create mode 100644 docs/reference/functions/table_getbottomrows.md create mode 100644 docs/reference/functions/table_getcannextpage.md create mode 100644 docs/reference/functions/table_getcanpreviouspage.md create mode 100644 docs/reference/functions/table_getcansomerowsexpand.md create mode 100644 docs/reference/functions/table_getcenterflatheaders.md create mode 100644 docs/reference/functions/table_getcenterfootergroups.md create mode 100644 docs/reference/functions/table_getcenterheadergroups.md create mode 100644 docs/reference/functions/table_getcenterleafcolumns.md create mode 100644 docs/reference/functions/table_getcenterleafheaders.md create mode 100644 docs/reference/functions/table_getcenterrows.md create mode 100644 docs/reference/functions/table_getcentertotalsize.md create mode 100644 docs/reference/functions/table_getcentervisibleleafcolumns.md create mode 100644 docs/reference/functions/table_getcolumn.md create mode 100644 docs/reference/functions/table_getcorerowmodel.md create mode 100644 docs/reference/functions/table_getdefaultcolumndef.md create mode 100644 docs/reference/functions/table_getexpandeddepth.md create mode 100644 docs/reference/functions/table_getexpandedrowmodel.md create mode 100644 docs/reference/functions/table_getfilteredrowmodel.md create mode 100644 docs/reference/functions/table_getfilteredselectedrowmodel.md create mode 100644 docs/reference/functions/table_getflatheaders.md create mode 100644 docs/reference/functions/table_getfootergroups.md create mode 100644 docs/reference/functions/table_getglobalautofilterfn.md create mode 100644 docs/reference/functions/table_getglobalfacetedminmaxvalues.md create mode 100644 docs/reference/functions/table_getglobalfacetedrowmodel.md create mode 100644 docs/reference/functions/table_getglobalfaceteduniquevalues.md create mode 100644 docs/reference/functions/table_getglobalfilterfn.md create mode 100644 docs/reference/functions/table_getgroupedrowmodel.md create mode 100644 docs/reference/functions/table_getgroupedselectedrowmodel.md create mode 100644 docs/reference/functions/table_getheadergroups.md create mode 100644 docs/reference/functions/table_getinitialstate.md create mode 100644 docs/reference/functions/table_getisallcolumnsvisible.md create mode 100644 docs/reference/functions/table_getisallpagerowsselected.md create mode 100644 docs/reference/functions/table_getisallrowsexpanded.md create mode 100644 docs/reference/functions/table_getisallrowsselected.md create mode 100644 docs/reference/functions/table_getissomecolumnspinned.md create mode 100644 docs/reference/functions/table_getissomecolumnsvisible.md create mode 100644 docs/reference/functions/table_getissomepagerowsselected.md create mode 100644 docs/reference/functions/table_getissomerowsexpanded.md create mode 100644 docs/reference/functions/table_getissomerowspinned.md create mode 100644 docs/reference/functions/table_getissomerowsselected.md create mode 100644 docs/reference/functions/table_getleafheaders.md create mode 100644 docs/reference/functions/table_getleftflatheaders.md create mode 100644 docs/reference/functions/table_getleftfootergroups.md create mode 100644 docs/reference/functions/table_getleftheadergroups.md create mode 100644 docs/reference/functions/table_getleftleafcolumns.md create mode 100644 docs/reference/functions/table_getleftleafheaders.md create mode 100644 docs/reference/functions/table_getlefttotalsize.md create mode 100644 docs/reference/functions/table_getleftvisibleleafcolumns.md create mode 100644 docs/reference/functions/table_getordercolumnsfn.md create mode 100644 docs/reference/functions/table_getpagecount.md create mode 100644 docs/reference/functions/table_getpageoptions.md create mode 100644 docs/reference/functions/table_getpaginatedrowmodel.md create mode 100644 docs/reference/functions/table_getpreexpandedrowmodel.md create mode 100644 docs/reference/functions/table_getprefilteredrowmodel.md create mode 100644 docs/reference/functions/table_getpregroupedrowmodel.md create mode 100644 docs/reference/functions/table_getprepaginatedrowmodel.md create mode 100644 docs/reference/functions/table_getpreselectedrowmodel.md create mode 100644 docs/reference/functions/table_getpresortedrowmodel.md create mode 100644 docs/reference/functions/table_getrightflatheaders.md create mode 100644 docs/reference/functions/table_getrightfootergroups.md create mode 100644 docs/reference/functions/table_getrightheadergroups.md create mode 100644 docs/reference/functions/table_getrightleafcolumns.md create mode 100644 docs/reference/functions/table_getrightleafheaders.md create mode 100644 docs/reference/functions/table_getrighttotalsize.md create mode 100644 docs/reference/functions/table_getrightvisibleleafcolumns.md create mode 100644 docs/reference/functions/table_getrow.md create mode 100644 docs/reference/functions/table_getrowcount.md create mode 100644 docs/reference/functions/table_getrowid.md create mode 100644 docs/reference/functions/table_getrowmodel.md create mode 100644 docs/reference/functions/table_getselectedrowmodel.md create mode 100644 docs/reference/functions/table_getsortedrowmodel.md create mode 100644 docs/reference/functions/table_getstate.md create mode 100644 docs/reference/functions/table_gettoggleallcolumnsvisibilityhandler.md create mode 100644 docs/reference/functions/table_gettoggleallpagerowsselectedhandler.md create mode 100644 docs/reference/functions/table_gettoggleallrowsexpandedhandler.md create mode 100644 docs/reference/functions/table_gettoggleallrowsselectedhandler.md create mode 100644 docs/reference/functions/table_gettoprows.md create mode 100644 docs/reference/functions/table_gettotalsize.md create mode 100644 docs/reference/functions/table_getvisibleflatcolumns.md create mode 100644 docs/reference/functions/table_getvisibleleafcolumns.md create mode 100644 docs/reference/functions/table_lastpage.md create mode 100644 docs/reference/functions/table_mergeoptions.md create mode 100644 docs/reference/functions/table_nextpage.md create mode 100644 docs/reference/functions/table_previouspage.md create mode 100644 docs/reference/functions/table_reset.md create mode 100644 docs/reference/functions/table_resetcolumnfilters.md create mode 100644 docs/reference/functions/table_resetcolumnorder.md create mode 100644 docs/reference/functions/table_resetcolumnpinning.md create mode 100644 docs/reference/functions/table_resetcolumnsizing.md create mode 100644 docs/reference/functions/table_resetcolumnvisibility.md create mode 100644 docs/reference/functions/table_resetexpanded.md create mode 100644 docs/reference/functions/table_resetglobalfilter.md create mode 100644 docs/reference/functions/table_resetgrouping.md create mode 100644 docs/reference/functions/table_resetheadersizeinfo.md create mode 100644 docs/reference/functions/table_resetpageindex.md create mode 100644 docs/reference/functions/table_resetpagesize.md create mode 100644 docs/reference/functions/table_resetpagination.md create mode 100644 docs/reference/functions/table_resetrowpinning.md create mode 100644 docs/reference/functions/table_resetrowselection.md create mode 100644 docs/reference/functions/table_resetsorting.md create mode 100644 docs/reference/functions/table_setcolumnfilters.md create mode 100644 docs/reference/functions/table_setcolumnorder.md create mode 100644 docs/reference/functions/table_setcolumnpinning.md create mode 100644 docs/reference/functions/table_setcolumnresizing.md create mode 100644 docs/reference/functions/table_setcolumnsizing.md create mode 100644 docs/reference/functions/table_setcolumnvisibility.md create mode 100644 docs/reference/functions/table_setexpanded.md create mode 100644 docs/reference/functions/table_setglobalfilter.md create mode 100644 docs/reference/functions/table_setgrouping.md create mode 100644 docs/reference/functions/table_setoptions.md create mode 100644 docs/reference/functions/table_setpageindex.md create mode 100644 docs/reference/functions/table_setpagesize.md create mode 100644 docs/reference/functions/table_setpagination.md create mode 100644 docs/reference/functions/table_setrowpinning.md create mode 100644 docs/reference/functions/table_setrowselection.md create mode 100644 docs/reference/functions/table_setsorting.md create mode 100644 docs/reference/functions/table_setstate.md create mode 100644 docs/reference/functions/table_toggleallcolumnsvisible.md create mode 100644 docs/reference/functions/table_toggleallpagerowsselected.md create mode 100644 docs/reference/functions/table_toggleallrowsexpanded.md create mode 100644 docs/reference/functions/table_toggleallrowsselected.md create mode 100644 docs/reference/functions/tablefeatures.md create mode 100644 docs/reference/functions/tablememo.md create mode 100644 docs/reference/functions/tableoptions.md create mode 100644 docs/reference/index.md create mode 100644 docs/reference/interfaces/aggregationfns.md create mode 100644 docs/reference/interfaces/cachedrowmodel_core.md create mode 100644 docs/reference/interfaces/cachedrowmodel_expanded.md create mode 100644 docs/reference/interfaces/cachedrowmodel_faceted.md create mode 100644 docs/reference/interfaces/cachedrowmodel_filtered.md create mode 100644 docs/reference/interfaces/cachedrowmodel_grouped.md create mode 100644 docs/reference/interfaces/cachedrowmodel_paginated.md create mode 100644 docs/reference/interfaces/cachedrowmodel_sorted.md create mode 100644 docs/reference/interfaces/cell_cell.md create mode 100644 docs/reference/interfaces/cell_columngrouping.md create mode 100644 docs/reference/interfaces/cell_coreproperties.md create mode 100644 docs/reference/interfaces/cellcontext.md create mode 100644 docs/reference/interfaces/column_column.md create mode 100644 docs/reference/interfaces/column_columnfaceting.md create mode 100644 docs/reference/interfaces/column_columnfiltering.md create mode 100644 docs/reference/interfaces/column_columngrouping.md create mode 100644 docs/reference/interfaces/column_columnordering.md create mode 100644 docs/reference/interfaces/column_columnpinning.md create mode 100644 docs/reference/interfaces/column_columnresizing.md create mode 100644 docs/reference/interfaces/column_columnsizing.md create mode 100644 docs/reference/interfaces/column_columnvisibility.md create mode 100644 docs/reference/interfaces/column_coreproperties.md create mode 100644 docs/reference/interfaces/column_globalfiltering.md create mode 100644 docs/reference/interfaces/column_rowsorting.md create mode 100644 docs/reference/interfaces/columndef_columnfiltering.md create mode 100644 docs/reference/interfaces/columndef_columngrouping.md create mode 100644 docs/reference/interfaces/columndef_columnpinning.md create mode 100644 docs/reference/interfaces/columndef_columnresizing.md create mode 100644 docs/reference/interfaces/columndef_columnsizing.md create mode 100644 docs/reference/interfaces/columndef_columnvisibility.md create mode 100644 docs/reference/interfaces/columndef_globalfiltering.md create mode 100644 docs/reference/interfaces/columndef_rowsorting.md create mode 100644 docs/reference/interfaces/columndefaultoptions.md create mode 100644 docs/reference/interfaces/columnfilter.md create mode 100644 docs/reference/interfaces/columnmeta.md create mode 100644 docs/reference/interfaces/columnorderdefaultoptions.md create mode 100644 docs/reference/interfaces/columnpinningdefaultoptions.md create mode 100644 docs/reference/interfaces/columnpinningstate.md create mode 100644 docs/reference/interfaces/columnresizingstate.md create mode 100644 docs/reference/interfaces/columnsort.md create mode 100644 docs/reference/interfaces/createrowmodel_core.md create mode 100644 docs/reference/interfaces/createrowmodel_expanded.md create mode 100644 docs/reference/interfaces/createrowmodel_faceted.md create mode 100644 docs/reference/interfaces/createrowmodel_filtered.md create mode 100644 docs/reference/interfaces/createrowmodel_grouped.md create mode 100644 docs/reference/interfaces/createrowmodel_paginated.md create mode 100644 docs/reference/interfaces/createrowmodel_sorted.md create mode 100644 docs/reference/interfaces/filterfn.md create mode 100644 docs/reference/interfaces/filterfns.md create mode 100644 docs/reference/interfaces/filtermeta.md create mode 100644 docs/reference/interfaces/header_columnresizing.md create mode 100644 docs/reference/interfaces/header_columnsizing.md create mode 100644 docs/reference/interfaces/header_coreproperties.md create mode 100644 docs/reference/interfaces/header_header.md create mode 100644 docs/reference/interfaces/headercontext.md create mode 100644 docs/reference/interfaces/headergroup.md create mode 100644 docs/reference/interfaces/headergroup_core.md create mode 100644 docs/reference/interfaces/headergroup_header.md create mode 100644 docs/reference/interfaces/ididentifier.md create mode 100644 docs/reference/interfaces/paginationdefaultoptions.md create mode 100644 docs/reference/interfaces/paginationstate.md create mode 100644 docs/reference/interfaces/resolvedcolumnfilter.md create mode 100644 docs/reference/interfaces/row_columnfiltering.md create mode 100644 docs/reference/interfaces/row_columngrouping.md create mode 100644 docs/reference/interfaces/row_columnpinning.md create mode 100644 docs/reference/interfaces/row_columnvisibility.md create mode 100644 docs/reference/interfaces/row_coreproperties.md create mode 100644 docs/reference/interfaces/row_row.md create mode 100644 docs/reference/interfaces/row_rowexpanding.md create mode 100644 docs/reference/interfaces/row_rowpinning.md create mode 100644 docs/reference/interfaces/row_rowselection.md create mode 100644 docs/reference/interfaces/rowmodel.md create mode 100644 docs/reference/interfaces/rowpinningdefaultoptions.md create mode 100644 docs/reference/interfaces/rowpinningstate.md create mode 100644 docs/reference/interfaces/sortingfn.md create mode 100644 docs/reference/interfaces/sortingfns.md create mode 100644 docs/reference/interfaces/stringheaderidentifier.md create mode 100644 docs/reference/interfaces/table_columnfiltering.md create mode 100644 docs/reference/interfaces/table_columngrouping.md create mode 100644 docs/reference/interfaces/table_columnordering.md create mode 100644 docs/reference/interfaces/table_columnpinning.md create mode 100644 docs/reference/interfaces/table_columnresizing.md create mode 100644 docs/reference/interfaces/table_columns.md create mode 100644 docs/reference/interfaces/table_columnsizing.md create mode 100644 docs/reference/interfaces/table_columnvisibility.md create mode 100644 docs/reference/interfaces/table_coreproperties.md create mode 100644 docs/reference/interfaces/table_globalfaceting.md create mode 100644 docs/reference/interfaces/table_globalfiltering.md create mode 100644 docs/reference/interfaces/table_headers.md create mode 100644 docs/reference/interfaces/table_rowexpanding.md create mode 100644 docs/reference/interfaces/table_rowmodels_core.md create mode 100644 docs/reference/interfaces/table_rowmodels_expanded.md create mode 100644 docs/reference/interfaces/table_rowmodels_faceted.md create mode 100644 docs/reference/interfaces/table_rowmodels_filtered.md create mode 100644 docs/reference/interfaces/table_rowmodels_grouped.md create mode 100644 docs/reference/interfaces/table_rowmodels_paginated.md create mode 100644 docs/reference/interfaces/table_rowmodels_sorted.md create mode 100644 docs/reference/interfaces/table_rowpagination.md create mode 100644 docs/reference/interfaces/table_rowpinning.md create mode 100644 docs/reference/interfaces/table_rows.md create mode 100644 docs/reference/interfaces/table_rowselection.md create mode 100644 docs/reference/interfaces/table_rowsorting.md create mode 100644 docs/reference/interfaces/table_table.md create mode 100644 docs/reference/interfaces/tablefeature.md create mode 100644 docs/reference/interfaces/tablefns_columnfiltering.md create mode 100644 docs/reference/interfaces/tablefns_columngrouping.md create mode 100644 docs/reference/interfaces/tablefns_rowsorting.md create mode 100644 docs/reference/interfaces/tablemeta.md create mode 100644 docs/reference/interfaces/tableoptions_cell.md create mode 100644 docs/reference/interfaces/tableoptions_columnfiltering.md create mode 100644 docs/reference/interfaces/tableoptions_columngrouping.md create mode 100644 docs/reference/interfaces/tableoptions_columnordering.md create mode 100644 docs/reference/interfaces/tableoptions_columnpinning.md create mode 100644 docs/reference/interfaces/tableoptions_columnresizing.md create mode 100644 docs/reference/interfaces/tableoptions_columns.md create mode 100644 docs/reference/interfaces/tableoptions_columnsizing.md create mode 100644 docs/reference/interfaces/tableoptions_columnvisibility.md create mode 100644 docs/reference/interfaces/tableoptions_core.md create mode 100644 docs/reference/interfaces/tableoptions_globalfiltering.md create mode 100644 docs/reference/interfaces/tableoptions_headers.md create mode 100644 docs/reference/interfaces/tableoptions_rowexpanding.md create mode 100644 docs/reference/interfaces/tableoptions_rowpagination.md create mode 100644 docs/reference/interfaces/tableoptions_rowpinning.md create mode 100644 docs/reference/interfaces/tableoptions_rows.md create mode 100644 docs/reference/interfaces/tableoptions_rowselection.md create mode 100644 docs/reference/interfaces/tableoptions_rowsorting.md create mode 100644 docs/reference/interfaces/tableoptions_table.md create mode 100644 docs/reference/interfaces/tablestate_columnfiltering.md create mode 100644 docs/reference/interfaces/tablestate_columngrouping.md create mode 100644 docs/reference/interfaces/tablestate_columnordering.md create mode 100644 docs/reference/interfaces/tablestate_columnpinning.md create mode 100644 docs/reference/interfaces/tablestate_columnresizing.md create mode 100644 docs/reference/interfaces/tablestate_columnsizing.md create mode 100644 docs/reference/interfaces/tablestate_columnvisibility.md create mode 100644 docs/reference/interfaces/tablestate_globalfiltering.md create mode 100644 docs/reference/interfaces/tablestate_rowexpanding.md create mode 100644 docs/reference/interfaces/tablestate_rowpagination.md create mode 100644 docs/reference/interfaces/tablestate_rowpinning.md create mode 100644 docs/reference/interfaces/tablestate_rowselection.md create mode 100644 docs/reference/interfaces/tablestate_rowsorting.md create mode 100644 docs/reference/type-aliases/accessorcolumndef.md create mode 100644 docs/reference/type-aliases/accessorfn.md create mode 100644 docs/reference/type-aliases/accessorfncolumndef.md create mode 100644 docs/reference/type-aliases/accessorfncolumndefbase.md create mode 100644 docs/reference/type-aliases/accessorkeycolumndef.md create mode 100644 docs/reference/type-aliases/accessorkeycolumndefbase.md create mode 100644 docs/reference/type-aliases/aggregationfn.md create mode 100644 docs/reference/type-aliases/aggregationfnoption.md create mode 100644 docs/reference/type-aliases/builtinaggregationfn.md create mode 100644 docs/reference/type-aliases/builtinfilterfn.md create mode 100644 docs/reference/type-aliases/builtinsortingfn.md create mode 100644 docs/reference/type-aliases/cachedrowmodel_all.md create mode 100644 docs/reference/type-aliases/cachedrowmodels.md create mode 100644 docs/reference/type-aliases/cell.md create mode 100644 docs/reference/type-aliases/celldata.md create mode 100644 docs/reference/type-aliases/column.md create mode 100644 docs/reference/type-aliases/column_internal.md create mode 100644 docs/reference/type-aliases/columndef.md create mode 100644 docs/reference/type-aliases/columndefbase.md create mode 100644 docs/reference/type-aliases/columndefbase_all.md create mode 100644 docs/reference/type-aliases/columndefresolved.md create mode 100644 docs/reference/type-aliases/columndeftemplate.md create mode 100644 docs/reference/type-aliases/columnfilterautoremovetestfn.md create mode 100644 docs/reference/type-aliases/columnfiltersstate.md create mode 100644 docs/reference/type-aliases/columnhelper.md create mode 100644 docs/reference/type-aliases/columnorderstate.md create mode 100644 docs/reference/type-aliases/columnpinningposition.md create mode 100644 docs/reference/type-aliases/columnresizedirection.md create mode 100644 docs/reference/type-aliases/columnresizemode.md create mode 100644 docs/reference/type-aliases/columnresizingdefaultoptions.md create mode 100644 docs/reference/type-aliases/columnsizingdefaultoptions.md create mode 100644 docs/reference/type-aliases/columnsizingstate.md create mode 100644 docs/reference/type-aliases/columnvisibilitystate.md create mode 100644 docs/reference/type-aliases/coretablefeatures.md create mode 100644 docs/reference/type-aliases/createrowmodels.md create mode 100644 docs/reference/type-aliases/createrowmodels_all.md create mode 100644 docs/reference/type-aliases/customaggregationfns.md create mode 100644 docs/reference/type-aliases/customfilterfns.md create mode 100644 docs/reference/type-aliases/customsortingfns.md create mode 100644 docs/reference/type-aliases/deepkeys.md create mode 100644 docs/reference/type-aliases/deepvalue.md create mode 100644 docs/reference/type-aliases/displaycolumndef.md create mode 100644 docs/reference/type-aliases/expandedstate.md create mode 100644 docs/reference/type-aliases/expandedstatelist.md create mode 100644 docs/reference/type-aliases/filterfnoption.md create mode 100644 docs/reference/type-aliases/getter.md create mode 100644 docs/reference/type-aliases/groupcolumndef.md create mode 100644 docs/reference/type-aliases/groupingcolumnmode.md create mode 100644 docs/reference/type-aliases/groupingstate.md create mode 100644 docs/reference/type-aliases/header.md create mode 100644 docs/reference/type-aliases/identifiedcolumndef.md create mode 100644 docs/reference/type-aliases/noinfer.md create mode 100644 docs/reference/type-aliases/onchangefn.md create mode 100644 docs/reference/type-aliases/partialkeys.md create mode 100644 docs/reference/type-aliases/requiredkeys.md create mode 100644 docs/reference/type-aliases/row.md create mode 100644 docs/reference/type-aliases/row_internal.md create mode 100644 docs/reference/type-aliases/rowdata.md create mode 100644 docs/reference/type-aliases/rowpinningposition.md create mode 100644 docs/reference/type-aliases/rowselectionstate.md create mode 100644 docs/reference/type-aliases/sortdirection.md create mode 100644 docs/reference/type-aliases/sortingfnoption.md create mode 100644 docs/reference/type-aliases/sortingstate.md create mode 100644 docs/reference/type-aliases/stringortemplateheader.md create mode 100644 docs/reference/type-aliases/table.md create mode 100644 docs/reference/type-aliases/table_core.md create mode 100644 docs/reference/type-aliases/table_internal.md create mode 100644 docs/reference/type-aliases/table_rowmodels.md create mode 100644 docs/reference/type-aliases/tablefeatures.md create mode 100644 docs/reference/type-aliases/tablehelper_core.md create mode 100644 docs/reference/type-aliases/tablehelperoptions.md create mode 100644 docs/reference/type-aliases/tableoptions.md create mode 100644 docs/reference/type-aliases/tableoptions_all.md create mode 100644 docs/reference/type-aliases/tablestate.md create mode 100644 docs/reference/type-aliases/tablestate_all.md create mode 100644 docs/reference/type-aliases/transformfiltervaluefn.md create mode 100644 docs/reference/type-aliases/uniontointersection.md create mode 100644 docs/reference/type-aliases/updater.md create mode 100644 docs/reference/type-aliases/visibilitydefaultoptions.md create mode 100644 docs/reference/variables/aggregationfns.md create mode 100644 docs/reference/variables/cells.md create mode 100644 docs/reference/variables/columnfaceting.md create mode 100644 docs/reference/variables/columnfiltering.md create mode 100644 docs/reference/variables/columngrouping.md create mode 100644 docs/reference/variables/columnordering.md create mode 100644 docs/reference/variables/columnpinning.md create mode 100644 docs/reference/variables/columnresizing.md create mode 100644 docs/reference/variables/columns.md create mode 100644 docs/reference/variables/columnsizing.md create mode 100644 docs/reference/variables/columnvisibility.md create mode 100644 docs/reference/variables/corefeatures.md create mode 100644 docs/reference/variables/filterfns.md create mode 100644 docs/reference/variables/globalfaceting.md create mode 100644 docs/reference/variables/globalfiltering.md create mode 100644 docs/reference/variables/headers.md create mode 100644 docs/reference/variables/isdev.md create mode 100644 docs/reference/variables/resplitalphanumeric.md create mode 100644 docs/reference/variables/rowexpanding.md create mode 100644 docs/reference/variables/rowmodels.md create mode 100644 docs/reference/variables/rowpagination.md create mode 100644 docs/reference/variables/rowpinning.md create mode 100644 docs/reference/variables/rows.md create mode 100644 docs/reference/variables/rowselection.md create mode 100644 docs/reference/variables/rowsorting.md create mode 100644 docs/reference/variables/sortingfns.md create mode 100644 docs/reference/variables/stockfeatures.md create mode 100644 docs/reference/variables/tables.md diff --git a/docs/reference/functions/aggregationfn_count.md b/docs/reference/functions/aggregationfn_count.md new file mode 100644 index 0000000000..c3a3d1f08d --- /dev/null +++ b/docs/reference/functions/aggregationfn_count.md @@ -0,0 +1,29 @@ +--- +id: aggregationFn_count +title: aggregationFn_count +--- + +# Function: aggregationFn\_count() + +```ts +function aggregationFn_count( + columnId, + leafRows, + childRows): any +``` + +## Parameters + +• **columnId**: `string` + +• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +## Returns + +`any` + +## Defined in + +[fns/aggregationFns.ts:162](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L162) diff --git a/docs/reference/functions/aggregationfn_extent.md b/docs/reference/functions/aggregationfn_extent.md new file mode 100644 index 0000000000..df9ef01280 --- /dev/null +++ b/docs/reference/functions/aggregationfn_extent.md @@ -0,0 +1,29 @@ +--- +id: aggregationFn_extent +title: aggregationFn_extent +--- + +# Function: aggregationFn\_extent() + +```ts +function aggregationFn_extent( + columnId, + leafRows, + childRows): any +``` + +## Parameters + +• **columnId**: `string` + +• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +## Returns + +`any` + +## Defined in + +[fns/aggregationFns.ts:70](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L70) diff --git a/docs/reference/functions/aggregationfn_max.md b/docs/reference/functions/aggregationfn_max.md new file mode 100644 index 0000000000..88c47565b9 --- /dev/null +++ b/docs/reference/functions/aggregationfn_max.md @@ -0,0 +1,29 @@ +--- +id: aggregationFn_max +title: aggregationFn_max +--- + +# Function: aggregationFn\_max() + +```ts +function aggregationFn_max( + columnId, + leafRows, + childRows): any +``` + +## Parameters + +• **columnId**: `string` + +• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +## Returns + +`any` + +## Defined in + +[fns/aggregationFns.ts:47](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L47) diff --git a/docs/reference/functions/aggregationfn_mean.md b/docs/reference/functions/aggregationfn_mean.md new file mode 100644 index 0000000000..133d6a6a5e --- /dev/null +++ b/docs/reference/functions/aggregationfn_mean.md @@ -0,0 +1,29 @@ +--- +id: aggregationFn_mean +title: aggregationFn_mean +--- + +# Function: aggregationFn\_mean() + +```ts +function aggregationFn_mean( + columnId, + leafRows, + childRows): any +``` + +## Parameters + +• **columnId**: `string` + +• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +## Returns + +`any` + +## Defined in + +[fns/aggregationFns.ts:96](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L96) diff --git a/docs/reference/functions/aggregationfn_median.md b/docs/reference/functions/aggregationfn_median.md new file mode 100644 index 0000000000..e11ec90332 --- /dev/null +++ b/docs/reference/functions/aggregationfn_median.md @@ -0,0 +1,29 @@ +--- +id: aggregationFn_median +title: aggregationFn_median +--- + +# Function: aggregationFn\_median() + +```ts +function aggregationFn_median( + columnId, + leafRows, + childRows): any +``` + +## Parameters + +• **columnId**: `string` + +• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +## Returns + +`any` + +## Defined in + +[fns/aggregationFns.ts:118](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L118) diff --git a/docs/reference/functions/aggregationfn_min.md b/docs/reference/functions/aggregationfn_min.md new file mode 100644 index 0000000000..f03bcb47b9 --- /dev/null +++ b/docs/reference/functions/aggregationfn_min.md @@ -0,0 +1,29 @@ +--- +id: aggregationFn_min +title: aggregationFn_min +--- + +# Function: aggregationFn\_min() + +```ts +function aggregationFn_min( + columnId, + leafRows, + childRows): any +``` + +## Parameters + +• **columnId**: `string` + +• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +## Returns + +`any` + +## Defined in + +[fns/aggregationFns.ts:23](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L23) diff --git a/docs/reference/functions/aggregationfn_sum.md b/docs/reference/functions/aggregationfn_sum.md new file mode 100644 index 0000000000..ed0e81d2e0 --- /dev/null +++ b/docs/reference/functions/aggregationfn_sum.md @@ -0,0 +1,29 @@ +--- +id: aggregationFn_sum +title: aggregationFn_sum +--- + +# Function: aggregationFn\_sum() + +```ts +function aggregationFn_sum( + columnId, + leafRows, + childRows): any +``` + +## Parameters + +• **columnId**: `string` + +• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +## Returns + +`any` + +## Defined in + +[fns/aggregationFns.ts:7](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L7) diff --git a/docs/reference/functions/aggregationfn_unique.md b/docs/reference/functions/aggregationfn_unique.md new file mode 100644 index 0000000000..b99b047a50 --- /dev/null +++ b/docs/reference/functions/aggregationfn_unique.md @@ -0,0 +1,29 @@ +--- +id: aggregationFn_unique +title: aggregationFn_unique +--- + +# Function: aggregationFn\_unique() + +```ts +function aggregationFn_unique( + columnId, + leafRows, + childRows): any +``` + +## Parameters + +• **columnId**: `string` + +• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +## Returns + +`any` + +## Defined in + +[fns/aggregationFns.ts:142](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L142) diff --git a/docs/reference/functions/aggregationfn_uniquecount.md b/docs/reference/functions/aggregationfn_uniquecount.md new file mode 100644 index 0000000000..da137220f8 --- /dev/null +++ b/docs/reference/functions/aggregationfn_uniquecount.md @@ -0,0 +1,29 @@ +--- +id: aggregationFn_uniqueCount +title: aggregationFn_uniqueCount +--- + +# Function: aggregationFn\_uniqueCount() + +```ts +function aggregationFn_uniqueCount( + columnId, + leafRows, + childRows): any +``` + +## Parameters + +• **columnId**: `string` + +• **leafRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +• **childRows**: [`Row`](../type-aliases/row.md)\<`any`, `any`\>[] + +## Returns + +`any` + +## Defined in + +[fns/aggregationFns.ts:152](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L152) diff --git a/docs/reference/functions/assignapis.md b/docs/reference/functions/assignapis.md new file mode 100644 index 0000000000..13e570a06a --- /dev/null +++ b/docs/reference/functions/assignapis.md @@ -0,0 +1,38 @@ +--- +id: assignAPIs +title: assignAPIs +--- + +# Function: assignAPIs() + +```ts +function assignAPIs(obj, apis): void +``` + +Takes a static function, looks at its name and assigns it to an object with optional memoization and debugging. + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TObject** *extends* `Record`\<`string`, `any`\> + +• **TDeps** *extends* readonly `any`[] + +• **TDepArgs** + +## Parameters + +• **obj**: `TObject` *extends* `Record`\<`string`, `U`\> ? `U` : `never` + +• **apis**: `API`\<`TDeps`, [`NoInfer`](../type-aliases/noinfer.md)\<`TDepArgs`\>\>[] + +## Returns + +`void` + +## Defined in + +[utils.ts:201](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L201) diff --git a/docs/reference/functions/buildheadergroups.md b/docs/reference/functions/buildheadergroups.md new file mode 100644 index 0000000000..87a0408917 --- /dev/null +++ b/docs/reference/functions/buildheadergroups.md @@ -0,0 +1,40 @@ +--- +id: buildHeaderGroups +title: buildHeaderGroups +--- + +# Function: buildHeaderGroups() + +```ts +function buildHeaderGroups( + allColumns, + columnsToGroup, + table, + headerFamily?): HeaderGroup[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **allColumns**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\>[] + +• **columnsToGroup**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\>[] + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +• **headerFamily?**: `"left"` \| `"right"` \| `"center"` + +## Returns + +[`HeaderGroup`](../interfaces/headergroup.md)\<`TFeatures`, `TData`\>[] + +## Defined in + +[core/headers/buildHeaderGroups.ts:10](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/buildHeaderGroups.ts#L10) diff --git a/docs/reference/functions/callmemoorstaticfn.md b/docs/reference/functions/callmemoorstaticfn.md new file mode 100644 index 0000000000..dcf76f0dd1 --- /dev/null +++ b/docs/reference/functions/callmemoorstaticfn.md @@ -0,0 +1,42 @@ +--- +id: callMemoOrStaticFn +title: callMemoOrStaticFn +--- + +# Function: callMemoOrStaticFn() + +```ts +function callMemoOrStaticFn( + obj, + staticFn, + args): any +``` + +Looks to run the memoized function with the builder pattern on the object if it exists, otherwise fallback to the static method passed in. + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **obj**: + \| [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + \| [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + \| [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`\> + \| [`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`\> + \| [`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`\> + +• **staticFn**: `AnyFunction` + +• **args**: `any`[] + +## Returns + +`any` + +## Defined in + +[utils.ts:234](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L234) diff --git a/docs/reference/functions/cell_getcontext.md b/docs/reference/functions/cell_getcontext.md new file mode 100644 index 0000000000..5bfea9c473 --- /dev/null +++ b/docs/reference/functions/cell_getcontext.md @@ -0,0 +1,66 @@ +--- +id: cell_getContext +title: cell_getContext +--- + +# Function: cell\_getContext() + +```ts +function cell_getContext(cell): object +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **cell**: [`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`object` + +### cell + +```ts +cell: Cell; +``` + +### column + +```ts +column: Column = cell.column; +``` + +### getValue + +```ts +getValue: Getter = cell.getValue; +``` + +### renderValue + +```ts +renderValue: Getter = cell.renderValue; +``` + +### row + +```ts +row: Row = cell.row; +``` + +### table + +```ts +table: Table_Internal = cell.table; +``` + +## Defined in + +[core/cells/Cells.utils.ts:21](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.utils.ts#L21) diff --git a/docs/reference/functions/cell_getisaggregated.md b/docs/reference/functions/cell_getisaggregated.md new file mode 100644 index 0000000000..e01b0a016d --- /dev/null +++ b/docs/reference/functions/cell_getisaggregated.md @@ -0,0 +1,30 @@ +--- +id: cell_getIsAggregated +title: cell_getIsAggregated +--- + +# Function: cell\_getIsAggregated() + +```ts +function cell_getIsAggregated(cell): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **cell**: [`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`boolean` + +## Defined in + +[features/column-grouping/ColumnGrouping.utils.ts:209](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts#L209) diff --git a/docs/reference/functions/cell_getisgrouped.md b/docs/reference/functions/cell_getisgrouped.md new file mode 100644 index 0000000000..651fd335cb --- /dev/null +++ b/docs/reference/functions/cell_getisgrouped.md @@ -0,0 +1,30 @@ +--- +id: cell_getIsGrouped +title: cell_getIsGrouped +--- + +# Function: cell\_getIsGrouped() + +```ts +function cell_getIsGrouped(cell): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **cell**: [`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`boolean` + +## Defined in + +[features/column-grouping/ColumnGrouping.utils.ts:190](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts#L190) diff --git a/docs/reference/functions/cell_getisplaceholder.md b/docs/reference/functions/cell_getisplaceholder.md new file mode 100644 index 0000000000..5b0f17cac3 --- /dev/null +++ b/docs/reference/functions/cell_getisplaceholder.md @@ -0,0 +1,30 @@ +--- +id: cell_getIsPlaceholder +title: cell_getIsPlaceholder +--- + +# Function: cell\_getIsPlaceholder() + +```ts +function cell_getIsPlaceholder(cell): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **cell**: [`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`boolean` + +## Defined in + +[features/column-grouping/ColumnGrouping.utils.ts:201](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts#L201) diff --git a/docs/reference/functions/cell_getvalue.md b/docs/reference/functions/cell_getvalue.md new file mode 100644 index 0000000000..54cebd3887 --- /dev/null +++ b/docs/reference/functions/cell_getvalue.md @@ -0,0 +1,30 @@ +--- +id: cell_getValue +title: cell_getValue +--- + +# Function: cell\_getValue() + +```ts +function cell_getValue(cell): TValue +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **cell**: [`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`TValue` + +## Defined in + +[core/cells/Cells.utils.ts:5](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.utils.ts#L5) diff --git a/docs/reference/functions/cell_rendervalue.md b/docs/reference/functions/cell_rendervalue.md new file mode 100644 index 0000000000..cbe1e89a1d --- /dev/null +++ b/docs/reference/functions/cell_rendervalue.md @@ -0,0 +1,30 @@ +--- +id: cell_renderValue +title: cell_renderValue +--- + +# Function: cell\_renderValue() + +```ts +function cell_renderValue(cell): any +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **cell**: [`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`any` + +## Defined in + +[core/cells/Cells.utils.ts:13](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.utils.ts#L13) diff --git a/docs/reference/functions/column_clearsorting.md b/docs/reference/functions/column_clearsorting.md new file mode 100644 index 0000000000..80c7afba2f --- /dev/null +++ b/docs/reference/functions/column_clearsorting.md @@ -0,0 +1,30 @@ +--- +id: column_clearSorting +title: column_clearSorting +--- + +# Function: column\_clearSorting() + +```ts +function column_clearSorting(column): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Internal`](../type-aliases/column_internal.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`void` + +## Defined in + +[features/row-sorting/RowSorting.utils.ts:287](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.utils.ts#L287) diff --git a/docs/reference/functions/column_getafter.md b/docs/reference/functions/column_getafter.md new file mode 100644 index 0000000000..6b965395aa --- /dev/null +++ b/docs/reference/functions/column_getafter.md @@ -0,0 +1,32 @@ +--- +id: column_getAfter +title: column_getAfter +--- + +# Function: column\_getAfter() + +```ts +function column_getAfter(column, position?): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +• **position?**: `false` \| `"left"` \| `"right"` \| `"center"` + +## Returns + +`number` + +## Defined in + +[features/column-sizing/ColumnSizing.utils.ts:66](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.utils.ts#L66) diff --git a/docs/reference/functions/column_getaggregationfn.md b/docs/reference/functions/column_getaggregationfn.md new file mode 100644 index 0000000000..4502200ccc --- /dev/null +++ b/docs/reference/functions/column_getaggregationfn.md @@ -0,0 +1,40 @@ +--- +id: column_getAggregationFn +title: column_getAggregationFn +--- + +# Function: column\_getAggregationFn() + +```ts +function column_getAggregationFn(column): undefined | AggregationFn +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`undefined` \| [`AggregationFn`](../type-aliases/aggregationfn.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/column-grouping/ColumnGrouping.utils.ts:118](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts#L118) diff --git a/docs/reference/functions/column_getautoaggregationfn.md b/docs/reference/functions/column_getautoaggregationfn.md new file mode 100644 index 0000000000..340cd96e5d --- /dev/null +++ b/docs/reference/functions/column_getautoaggregationfn.md @@ -0,0 +1,40 @@ +--- +id: column_getAutoAggregationFn +title: column_getAutoAggregationFn +--- + +# Function: column\_getAutoAggregationFn() + +```ts +function column_getAutoAggregationFn(column): undefined | AggregationFn +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`undefined` \| [`AggregationFn`](../type-aliases/aggregationfn.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/column-grouping/ColumnGrouping.utils.ts:92](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts#L92) diff --git a/docs/reference/functions/column_getautofilterfn.md b/docs/reference/functions/column_getautofilterfn.md new file mode 100644 index 0000000000..87c7257a96 --- /dev/null +++ b/docs/reference/functions/column_getautofilterfn.md @@ -0,0 +1,30 @@ +--- +id: column_getAutoFilterFn +title: column_getAutoFilterFn +--- + +# Function: column\_getAutoFilterFn() + +```ts +function column_getAutoFilterFn(column): undefined | FilterFn +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`undefined` \| [`FilterFn`](../interfaces/filterfn.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/column-filtering/ColumnFiltering.utils.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.utils.ts#L16) diff --git a/docs/reference/functions/column_getautosortdir.md b/docs/reference/functions/column_getautosortdir.md new file mode 100644 index 0000000000..8cb98e3973 --- /dev/null +++ b/docs/reference/functions/column_getautosortdir.md @@ -0,0 +1,30 @@ +--- +id: column_getAutoSortDir +title: column_getAutoSortDir +--- + +# Function: column\_getAutoSortDir() + +```ts +function column_getAutoSortDir(column): "asc" | "desc" +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Internal`](../type-aliases/column_internal.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`"asc"` \| `"desc"` + +## Defined in + +[features/row-sorting/RowSorting.utils.ts:70](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.utils.ts#L70) diff --git a/docs/reference/functions/column_getautosortingfn.md b/docs/reference/functions/column_getautosortingfn.md new file mode 100644 index 0000000000..6075404cb9 --- /dev/null +++ b/docs/reference/functions/column_getautosortingfn.md @@ -0,0 +1,30 @@ +--- +id: column_getAutoSortingFn +title: column_getAutoSortingFn +--- + +# Function: column\_getAutoSortingFn() + +```ts +function column_getAutoSortingFn(column): SortingFn +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Internal`](../type-aliases/column_internal.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +[`SortingFn`](../interfaces/sortingfn.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/row-sorting/RowSorting.utils.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.utils.ts#L30) diff --git a/docs/reference/functions/column_getcanfilter.md b/docs/reference/functions/column_getcanfilter.md new file mode 100644 index 0000000000..4761291532 --- /dev/null +++ b/docs/reference/functions/column_getcanfilter.md @@ -0,0 +1,40 @@ +--- +id: column_getCanFilter +title: column_getCanFilter +--- + +# Function: column\_getCanFilter() + +```ts +function column_getCanFilter(column): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`boolean` + +## Defined in + +[features/column-filtering/ColumnFiltering.utils.ts:71](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.utils.ts#L71) diff --git a/docs/reference/functions/column_getcanglobalfilter.md b/docs/reference/functions/column_getcanglobalfilter.md new file mode 100644 index 0000000000..f9947c4fde --- /dev/null +++ b/docs/reference/functions/column_getcanglobalfilter.md @@ -0,0 +1,40 @@ +--- +id: column_getCanGlobalFilter +title: column_getCanGlobalFilter +--- + +# Function: column\_getCanGlobalFilter() + +```ts +function column_getCanGlobalFilter(column): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`boolean` + +## Defined in + +[features/global-filtering/GlobalFiltering.utils.ts:10](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.utils.ts#L10) diff --git a/docs/reference/functions/column_getcangroup.md b/docs/reference/functions/column_getcangroup.md new file mode 100644 index 0000000000..e7dab00c37 --- /dev/null +++ b/docs/reference/functions/column_getcangroup.md @@ -0,0 +1,40 @@ +--- +id: column_getCanGroup +title: column_getCanGroup +--- + +# Function: column\_getCanGroup() + +```ts +function column_getCanGroup(column): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`boolean` + +## Defined in + +[features/column-grouping/ColumnGrouping.utils.ts:35](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts#L35) diff --git a/docs/reference/functions/column_getcanhide.md b/docs/reference/functions/column_getcanhide.md new file mode 100644 index 0000000000..06623d78c6 --- /dev/null +++ b/docs/reference/functions/column_getcanhide.md @@ -0,0 +1,40 @@ +--- +id: column_getCanHide +title: column_getCanHide +--- + +# Function: column\_getCanHide() + +```ts +function column_getCanHide(column): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`boolean` + +## Defined in + +[features/column-visibility/ColumnVisibility.utils.ts:57](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.utils.ts#L57) diff --git a/docs/reference/functions/column_getcanmultisort.md b/docs/reference/functions/column_getcanmultisort.md new file mode 100644 index 0000000000..13d7ac8ffb --- /dev/null +++ b/docs/reference/functions/column_getcanmultisort.md @@ -0,0 +1,30 @@ +--- +id: column_getCanMultiSort +title: column_getCanMultiSort +--- + +# Function: column\_getCanMultiSort() + +```ts +function column_getCanMultiSort(column): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Internal`](../type-aliases/column_internal.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-sorting/RowSorting.utils.ts:253](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.utils.ts#L253) diff --git a/docs/reference/functions/column_getcanpin.md b/docs/reference/functions/column_getcanpin.md new file mode 100644 index 0000000000..384e902a44 --- /dev/null +++ b/docs/reference/functions/column_getcanpin.md @@ -0,0 +1,40 @@ +--- +id: column_getCanPin +title: column_getCanPin +--- + +# Function: column\_getCanPin() + +```ts +function column_getCanPin(column): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`boolean` + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:64](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L64) diff --git a/docs/reference/functions/column_getcanresize.md b/docs/reference/functions/column_getcanresize.md new file mode 100644 index 0000000000..6fb6a87d7f --- /dev/null +++ b/docs/reference/functions/column_getcanresize.md @@ -0,0 +1,40 @@ +--- +id: column_getCanResize +title: column_getCanResize +--- + +# Function: column\_getCanResize() + +```ts +function column_getCanResize(column): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`boolean` + +## Defined in + +[features/column-resizing/ColumnResizing.utils.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.utils.ts#L29) diff --git a/docs/reference/functions/column_getcansort.md b/docs/reference/functions/column_getcansort.md new file mode 100644 index 0000000000..9c5ba10da8 --- /dev/null +++ b/docs/reference/functions/column_getcansort.md @@ -0,0 +1,30 @@ +--- +id: column_getCanSort +title: column_getCanSort +--- + +# Function: column\_getCanSort() + +```ts +function column_getCanSort(column): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Internal`](../type-aliases/column_internal.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-sorting/RowSorting.utils.ts:241](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.utils.ts#L241) diff --git a/docs/reference/functions/column_getfacetedminmaxvalues.md b/docs/reference/functions/column_getfacetedminmaxvalues.md new file mode 100644 index 0000000000..f83cba9beb --- /dev/null +++ b/docs/reference/functions/column_getfacetedminmaxvalues.md @@ -0,0 +1,36 @@ +--- +id: column_getFacetedMinMaxValues +title: column_getFacetedMinMaxValues +--- + +# Function: column\_getFacetedMinMaxValues() + +```ts +function column_getFacetedMinMaxValues(column, table): () => [number, number] | undefined +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`Function` + +### Returns + +[`number`, `number`] \| `undefined` + +## Defined in + +[features/column-faceting/ColumnFaceting.utils.ts:7](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/ColumnFaceting.utils.ts#L7) diff --git a/docs/reference/functions/column_getfacetedrowmodel.md b/docs/reference/functions/column_getfacetedrowmodel.md new file mode 100644 index 0000000000..a3522c796d --- /dev/null +++ b/docs/reference/functions/column_getfacetedrowmodel.md @@ -0,0 +1,36 @@ +--- +id: column_getFacetedRowModel +title: column_getFacetedRowModel +--- + +# Function: column\_getFacetedRowModel() + +```ts +function column_getFacetedRowModel(column, table): () => RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: `undefined` \| [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`Function` + +### Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/column-faceting/ColumnFaceting.utils.ts:21](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/ColumnFaceting.utils.ts#L21) diff --git a/docs/reference/functions/column_getfaceteduniquevalues.md b/docs/reference/functions/column_getfaceteduniquevalues.md new file mode 100644 index 0000000000..336aea4f9c --- /dev/null +++ b/docs/reference/functions/column_getfaceteduniquevalues.md @@ -0,0 +1,36 @@ +--- +id: column_getFacetedUniqueValues +title: column_getFacetedUniqueValues +--- + +# Function: column\_getFacetedUniqueValues() + +```ts +function column_getFacetedUniqueValues(column, table): () => Map +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`Function` + +### Returns + +`Map`\<`any`, `number`\> + +## Defined in + +[features/column-faceting/ColumnFaceting.utils.ts:35](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/ColumnFaceting.utils.ts#L35) diff --git a/docs/reference/functions/column_getfilterfn.md b/docs/reference/functions/column_getfilterfn.md new file mode 100644 index 0000000000..c3a3aaea66 --- /dev/null +++ b/docs/reference/functions/column_getfilterfn.md @@ -0,0 +1,40 @@ +--- +id: column_getFilterFn +title: column_getFilterFn +--- + +# Function: column\_getFilterFn() + +```ts +function column_getFilterFn(column): FilterFn | undefined +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +[`FilterFn`](../interfaces/filterfn.md)\<`TFeatures`, `TData`\> \| `undefined` + +## Defined in + +[features/column-filtering/ColumnFiltering.utils.ts:52](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.utils.ts#L52) diff --git a/docs/reference/functions/column_getfilterindex.md b/docs/reference/functions/column_getfilterindex.md new file mode 100644 index 0000000000..6ca39a3819 --- /dev/null +++ b/docs/reference/functions/column_getfilterindex.md @@ -0,0 +1,40 @@ +--- +id: column_getFilterIndex +title: column_getFilterIndex +--- + +# Function: column\_getFilterIndex() + +```ts +function column_getFilterIndex(column): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`number` + +## Defined in + +[features/column-filtering/ColumnFiltering.utils.ts:114](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.utils.ts#L114) diff --git a/docs/reference/functions/column_getfiltervalue.md b/docs/reference/functions/column_getfiltervalue.md new file mode 100644 index 0000000000..4e3d4a8150 --- /dev/null +++ b/docs/reference/functions/column_getfiltervalue.md @@ -0,0 +1,40 @@ +--- +id: column_getFilterValue +title: column_getFilterValue +--- + +# Function: column\_getFilterValue() + +```ts +function column_getFilterValue(column): unknown +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`unknown` + +## Defined in + +[features/column-filtering/ColumnFiltering.utils.ts:100](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.utils.ts#L100) diff --git a/docs/reference/functions/column_getfirstsortdir.md b/docs/reference/functions/column_getfirstsortdir.md new file mode 100644 index 0000000000..f6a52d49dc --- /dev/null +++ b/docs/reference/functions/column_getfirstsortdir.md @@ -0,0 +1,30 @@ +--- +id: column_getFirstSortDir +title: column_getFirstSortDir +--- + +# Function: column\_getFirstSortDir() + +```ts +function column_getFirstSortDir(column): "asc" | "desc" +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Internal`](../type-aliases/column_internal.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`"asc"` \| `"desc"` + +## Defined in + +[features/row-sorting/RowSorting.utils.ts:207](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.utils.ts#L207) diff --git a/docs/reference/functions/column_getflatcolumns.md b/docs/reference/functions/column_getflatcolumns.md new file mode 100644 index 0000000000..d34b7d48ba --- /dev/null +++ b/docs/reference/functions/column_getflatcolumns.md @@ -0,0 +1,30 @@ +--- +id: column_getFlatColumns +title: column_getFlatColumns +--- + +# Function: column\_getFlatColumns() + +```ts +function column_getFlatColumns(column): Column[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\>[] + +## Defined in + +[core/columns/Columns.utils.ts:13](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.utils.ts#L13) diff --git a/docs/reference/functions/column_getgroupedindex.md b/docs/reference/functions/column_getgroupedindex.md new file mode 100644 index 0000000000..0a142bea3b --- /dev/null +++ b/docs/reference/functions/column_getgroupedindex.md @@ -0,0 +1,40 @@ +--- +id: column_getGroupedIndex +title: column_getGroupedIndex +--- + +# Function: column\_getGroupedIndex() + +```ts +function column_getGroupedIndex(column): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`number` + +## Defined in + +[features/column-grouping/ColumnGrouping.utils.ts:63](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts#L63) diff --git a/docs/reference/functions/column_getindex.md b/docs/reference/functions/column_getindex.md new file mode 100644 index 0000000000..dafd6429f3 --- /dev/null +++ b/docs/reference/functions/column_getindex.md @@ -0,0 +1,32 @@ +--- +id: column_getIndex +title: column_getIndex +--- + +# Function: column\_getIndex() + +```ts +function column_getIndex(column, position?): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +• **position?**: [`ColumnPinningPosition`](../type-aliases/columnpinningposition.md) \| `"center"` + +## Returns + +`number` + +## Defined in + +[features/column-ordering/ColumnOrdering.utils.ts:14](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.utils.ts#L14) diff --git a/docs/reference/functions/column_getisfiltered.md b/docs/reference/functions/column_getisfiltered.md new file mode 100644 index 0000000000..351cf097bf --- /dev/null +++ b/docs/reference/functions/column_getisfiltered.md @@ -0,0 +1,40 @@ +--- +id: column_getIsFiltered +title: column_getIsFiltered +--- + +# Function: column\_getIsFiltered() + +```ts +function column_getIsFiltered(column): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`boolean` + +## Defined in + +[features/column-filtering/ColumnFiltering.utils.ts:88](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.utils.ts#L88) diff --git a/docs/reference/functions/column_getisfirstcolumn.md b/docs/reference/functions/column_getisfirstcolumn.md new file mode 100644 index 0000000000..e8c3abf787 --- /dev/null +++ b/docs/reference/functions/column_getisfirstcolumn.md @@ -0,0 +1,32 @@ +--- +id: column_getIsFirstColumn +title: column_getIsFirstColumn +--- + +# Function: column\_getIsFirstColumn() + +```ts +function column_getIsFirstColumn(column, position?): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +• **position?**: [`ColumnPinningPosition`](../type-aliases/columnpinningposition.md) \| `"center"` + +## Returns + +`boolean` + +## Defined in + +[features/column-ordering/ColumnOrdering.utils.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.utils.ts#L26) diff --git a/docs/reference/functions/column_getisgrouped.md b/docs/reference/functions/column_getisgrouped.md new file mode 100644 index 0000000000..e67d1837c6 --- /dev/null +++ b/docs/reference/functions/column_getisgrouped.md @@ -0,0 +1,40 @@ +--- +id: column_getIsGrouped +title: column_getIsGrouped +--- + +# Function: column\_getIsGrouped() + +```ts +function column_getIsGrouped(column): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`boolean` + +## Defined in + +[features/column-grouping/ColumnGrouping.utils.ts:51](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts#L51) diff --git a/docs/reference/functions/column_getislastcolumn.md b/docs/reference/functions/column_getislastcolumn.md new file mode 100644 index 0000000000..e1aa3f924f --- /dev/null +++ b/docs/reference/functions/column_getislastcolumn.md @@ -0,0 +1,32 @@ +--- +id: column_getIsLastColumn +title: column_getIsLastColumn +--- + +# Function: column\_getIsLastColumn() + +```ts +function column_getIsLastColumn(column, position?): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +• **position?**: [`ColumnPinningPosition`](../type-aliases/columnpinningposition.md) \| `"center"` + +## Returns + +`boolean` + +## Defined in + +[features/column-ordering/ColumnOrdering.utils.ts:38](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.utils.ts#L38) diff --git a/docs/reference/functions/column_getispinned.md b/docs/reference/functions/column_getispinned.md new file mode 100644 index 0000000000..2bca1c998a --- /dev/null +++ b/docs/reference/functions/column_getispinned.md @@ -0,0 +1,30 @@ +--- +id: column_getIsPinned +title: column_getIsPinned +--- + +# Function: column\_getIsPinned() + +```ts +function column_getIsPinned(column): ColumnPinningPosition | false +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +[`ColumnPinningPosition`](../type-aliases/columnpinningposition.md) \| `false` + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:86](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L86) diff --git a/docs/reference/functions/column_getisresizing.md b/docs/reference/functions/column_getisresizing.md new file mode 100644 index 0000000000..9ff41ddc1c --- /dev/null +++ b/docs/reference/functions/column_getisresizing.md @@ -0,0 +1,40 @@ +--- +id: column_getIsResizing +title: column_getIsResizing +--- + +# Function: column\_getIsResizing() + +```ts +function column_getIsResizing(column): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`boolean` + +## Defined in + +[features/column-resizing/ColumnResizing.utils.ts:44](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.utils.ts#L44) diff --git a/docs/reference/functions/column_getissorted.md b/docs/reference/functions/column_getissorted.md new file mode 100644 index 0000000000..5ae3bfdd7d --- /dev/null +++ b/docs/reference/functions/column_getissorted.md @@ -0,0 +1,30 @@ +--- +id: column_getIsSorted +title: column_getIsSorted +--- + +# Function: column\_getIsSorted() + +```ts +function column_getIsSorted(column): false | SortDirection +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Internal`](../type-aliases/column_internal.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`false` \| [`SortDirection`](../type-aliases/sortdirection.md) + +## Defined in + +[features/row-sorting/RowSorting.utils.ts:265](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.utils.ts#L265) diff --git a/docs/reference/functions/column_getisvisible.md b/docs/reference/functions/column_getisvisible.md new file mode 100644 index 0000000000..6493210d6e --- /dev/null +++ b/docs/reference/functions/column_getisvisible.md @@ -0,0 +1,40 @@ +--- +id: column_getIsVisible +title: column_getIsVisible +--- + +# Function: column\_getIsVisible() + +```ts +function column_getIsVisible(column): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`boolean` + +## Defined in + +[features/column-visibility/ColumnVisibility.utils.ts:40](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.utils.ts#L40) diff --git a/docs/reference/functions/column_getleafcolumns.md b/docs/reference/functions/column_getleafcolumns.md new file mode 100644 index 0000000000..aa60d190a8 --- /dev/null +++ b/docs/reference/functions/column_getleafcolumns.md @@ -0,0 +1,30 @@ +--- +id: column_getLeafColumns +title: column_getLeafColumns +--- + +# Function: column\_getLeafColumns() + +```ts +function column_getLeafColumns(column): Column[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\>[] + +## Defined in + +[core/columns/Columns.utils.ts:23](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.utils.ts#L23) diff --git a/docs/reference/functions/column_getnextsortingorder.md b/docs/reference/functions/column_getnextsortingorder.md new file mode 100644 index 0000000000..9589f698d2 --- /dev/null +++ b/docs/reference/functions/column_getnextsortingorder.md @@ -0,0 +1,32 @@ +--- +id: column_getNextSortingOrder +title: column_getNextSortingOrder +--- + +# Function: column\_getNextSortingOrder() + +```ts +function column_getNextSortingOrder(column, multi?): false | "asc" | "desc" +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Internal`](../type-aliases/column_internal.md)\<`TFeatures`, `TData`, `TValue`\> + +• **multi?**: `boolean` + +## Returns + +`false` \| `"asc"` \| `"desc"` + +## Defined in + +[features/row-sorting/RowSorting.utils.ts:219](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.utils.ts#L219) diff --git a/docs/reference/functions/column_getpinnedindex.md b/docs/reference/functions/column_getpinnedindex.md new file mode 100644 index 0000000000..1e343bbc74 --- /dev/null +++ b/docs/reference/functions/column_getpinnedindex.md @@ -0,0 +1,30 @@ +--- +id: column_getPinnedIndex +title: column_getPinnedIndex +--- + +# Function: column\_getPinnedIndex() + +```ts +function column_getPinnedIndex(column): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`number` + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:102](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L102) diff --git a/docs/reference/functions/column_getsize.md b/docs/reference/functions/column_getsize.md new file mode 100644 index 0000000000..0530672f4a --- /dev/null +++ b/docs/reference/functions/column_getsize.md @@ -0,0 +1,40 @@ +--- +id: column_getSize +title: column_getSize +--- + +# Function: column\_getSize() + +```ts +function column_getSize(column): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`number` + +## Defined in + +[features/column-sizing/ColumnSizing.utils.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.utils.ts#L30) diff --git a/docs/reference/functions/column_getsortindex.md b/docs/reference/functions/column_getsortindex.md new file mode 100644 index 0000000000..4be66a8125 --- /dev/null +++ b/docs/reference/functions/column_getsortindex.md @@ -0,0 +1,30 @@ +--- +id: column_getSortIndex +title: column_getSortIndex +--- + +# Function: column\_getSortIndex() + +```ts +function column_getSortIndex(column): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Internal`](../type-aliases/column_internal.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`number` + +## Defined in + +[features/row-sorting/RowSorting.utils.ts:276](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.utils.ts#L276) diff --git a/docs/reference/functions/column_getsortingfn.md b/docs/reference/functions/column_getsortingfn.md new file mode 100644 index 0000000000..22f10417e0 --- /dev/null +++ b/docs/reference/functions/column_getsortingfn.md @@ -0,0 +1,30 @@ +--- +id: column_getSortingFn +title: column_getSortingFn +--- + +# Function: column\_getSortingFn() + +```ts +function column_getSortingFn(column): SortingFn +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Internal`](../type-aliases/column_internal.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +[`SortingFn`](../interfaces/sortingfn.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/row-sorting/RowSorting.utils.ts:86](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.utils.ts#L86) diff --git a/docs/reference/functions/column_getstart.md b/docs/reference/functions/column_getstart.md new file mode 100644 index 0000000000..5b2b545246 --- /dev/null +++ b/docs/reference/functions/column_getstart.md @@ -0,0 +1,42 @@ +--- +id: column_getStart +title: column_getStart +--- + +# Function: column\_getStart() + +```ts +function column_getStart(column, position?): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +• **position?**: `false` \| `"left"` \| `"right"` \| `"center"` + +## Returns + +`number` + +## Defined in + +[features/column-sizing/ColumnSizing.utils.ts:51](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.utils.ts#L51) diff --git a/docs/reference/functions/column_gettogglegroupinghandler.md b/docs/reference/functions/column_gettogglegroupinghandler.md new file mode 100644 index 0000000000..5ecb3a89de --- /dev/null +++ b/docs/reference/functions/column_gettogglegroupinghandler.md @@ -0,0 +1,44 @@ +--- +id: column_getToggleGroupingHandler +title: column_getToggleGroupingHandler +--- + +# Function: column\_getToggleGroupingHandler() + +```ts +function column_getToggleGroupingHandler(column): () => void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`Function` + +### Returns + +`void` + +## Defined in + +[features/column-grouping/ColumnGrouping.utils.ts:75](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts#L75) diff --git a/docs/reference/functions/column_gettogglesortinghandler.md b/docs/reference/functions/column_gettogglesortinghandler.md new file mode 100644 index 0000000000..4d8a5522cd --- /dev/null +++ b/docs/reference/functions/column_gettogglesortinghandler.md @@ -0,0 +1,38 @@ +--- +id: column_getToggleSortingHandler +title: column_getToggleSortingHandler +--- + +# Function: column\_getToggleSortingHandler() + +```ts +function column_getToggleSortingHandler(column): (e) => void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Internal`](../type-aliases/column_internal.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`Function` + +### Parameters + +• **e**: `unknown` + +### Returns + +`void` + +## Defined in + +[features/row-sorting/RowSorting.utils.ts:298](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.utils.ts#L298) diff --git a/docs/reference/functions/column_gettogglevisibilityhandler.md b/docs/reference/functions/column_gettogglevisibilityhandler.md new file mode 100644 index 0000000000..961d5dae3a --- /dev/null +++ b/docs/reference/functions/column_gettogglevisibilityhandler.md @@ -0,0 +1,48 @@ +--- +id: column_getToggleVisibilityHandler +title: column_getToggleVisibilityHandler +--- + +# Function: column\_getToggleVisibilityHandler() + +```ts +function column_getToggleVisibilityHandler(column): (e) => void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +## Returns + +`Function` + +### Parameters + +• **e**: `unknown` + +### Returns + +`void` + +## Defined in + +[features/column-visibility/ColumnVisibility.utils.ts:72](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.utils.ts#L72) diff --git a/docs/reference/functions/column_getvisibleleafcolumns.md b/docs/reference/functions/column_getvisibleleafcolumns.md new file mode 100644 index 0000000000..96a2eec3cc --- /dev/null +++ b/docs/reference/functions/column_getvisibleleafcolumns.md @@ -0,0 +1,30 @@ +--- +id: column_getVisibleLeafColumns +title: column_getVisibleLeafColumns +--- + +# Function: column\_getVisibleLeafColumns() + +```ts +function column_getVisibleLeafColumns(table, position?): Column[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **position?**: [`ColumnPinningPosition`](../type-aliases/columnpinningposition.md) \| `"center"` + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-visibility/ColumnVisibility.utils.ts:89](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.utils.ts#L89) diff --git a/docs/reference/functions/column_pin.md b/docs/reference/functions/column_pin.md new file mode 100644 index 0000000000..9c9737e8bb --- /dev/null +++ b/docs/reference/functions/column_pin.md @@ -0,0 +1,32 @@ +--- +id: column_pin +title: column_pin +--- + +# Function: column\_pin() + +```ts +function column_pin(column, position): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +• **position**: [`ColumnPinningPosition`](../type-aliases/columnpinningposition.md) + +## Returns + +`void` + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L29) diff --git a/docs/reference/functions/column_resetsize.md b/docs/reference/functions/column_resetsize.md new file mode 100644 index 0000000000..224be7a82f --- /dev/null +++ b/docs/reference/functions/column_resetsize.md @@ -0,0 +1,30 @@ +--- +id: column_resetSize +title: column_resetSize +--- + +# Function: column\_resetSize() + +```ts +function column_resetSize(column): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`void` + +## Defined in + +[features/column-sizing/ColumnSizing.utils.ts:79](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.utils.ts#L79) diff --git a/docs/reference/functions/column_setfiltervalue.md b/docs/reference/functions/column_setfiltervalue.md new file mode 100644 index 0000000000..5ce77f3a49 --- /dev/null +++ b/docs/reference/functions/column_setfiltervalue.md @@ -0,0 +1,42 @@ +--- +id: column_setFilterValue +title: column_setFilterValue +--- + +# Function: column\_setFilterValue() + +```ts +function column_setFilterValue(column, value): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +• **value**: `any` + +## Returns + +`void` + +## Defined in + +[features/column-filtering/ColumnFiltering.utils.ts:130](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.utils.ts#L130) diff --git a/docs/reference/functions/column_togglegrouping.md b/docs/reference/functions/column_togglegrouping.md new file mode 100644 index 0000000000..e85ec38c0e --- /dev/null +++ b/docs/reference/functions/column_togglegrouping.md @@ -0,0 +1,30 @@ +--- +id: column_toggleGrouping +title: column_toggleGrouping +--- + +# Function: column\_toggleGrouping() + +```ts +function column_toggleGrouping(column): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`void` + +## Defined in + +[features/column-grouping/ColumnGrouping.utils.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts#L20) diff --git a/docs/reference/functions/column_togglesorting.md b/docs/reference/functions/column_togglesorting.md new file mode 100644 index 0000000000..53a796236c --- /dev/null +++ b/docs/reference/functions/column_togglesorting.md @@ -0,0 +1,37 @@ +--- +id: column_toggleSorting +title: column_toggleSorting +--- + +# Function: column\_toggleSorting() + +```ts +function column_toggleSorting( + column, + desc?, + multi?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Internal`](../type-aliases/column_internal.md)\<`TFeatures`, `TData`, `TValue`\> + +• **desc?**: `boolean` + +• **multi?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/row-sorting/RowSorting.utils.ts:104](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.utils.ts#L104) diff --git a/docs/reference/functions/column_togglevisibility.md b/docs/reference/functions/column_togglevisibility.md new file mode 100644 index 0000000000..c28b27b497 --- /dev/null +++ b/docs/reference/functions/column_togglevisibility.md @@ -0,0 +1,42 @@ +--- +id: column_toggleVisibility +title: column_toggleVisibility +--- + +# Function: column\_toggleVisibility() + +```ts +function column_toggleVisibility(column, visible?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column_Column`](../interfaces/column_column.md)\<`TFeatures`, `TData`, `TValue`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFaceting"` *extends* keyof `TFeatures` ? [`Column_ColumnFaceting`](../interfaces/column_columnfaceting.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Column_ColumnFiltering`](../interfaces/column_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Column_ColumnGrouping`](../interfaces/column_columngrouping.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnOrdering"` *extends* keyof `TFeatures` ? [`Column_ColumnOrdering`](../interfaces/column_columnordering.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Column_ColumnPinning`](../interfaces/column_columnpinning.md) : `never` + \| `"ColumnResizing"` *extends* keyof `TFeatures` ? [`Column_ColumnResizing`](../interfaces/column_columnresizing.md) : `never` + \| `"ColumnSizing"` *extends* keyof `TFeatures` ? [`Column_ColumnSizing`](../interfaces/column_columnsizing.md) : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Column_ColumnVisibility`](../interfaces/column_columnvisibility.md) : `never` + \| `"GlobalFiltering"` *extends* keyof `TFeatures` ? [`Column_GlobalFiltering`](../interfaces/column_globalfiltering.md) : `never` + \| `"RowSorting"` *extends* keyof `TFeatures` ? [`Column_RowSorting`](../interfaces/column_rowsorting.md)\<`TFeatures`, `TData`\> : `never`\> & `object` + +• **visible?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/column-visibility/ColumnVisibility.utils.ts:22](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.utils.ts#L22) diff --git a/docs/reference/functions/constructcell.md b/docs/reference/functions/constructcell.md new file mode 100644 index 0000000000..ae5017104e --- /dev/null +++ b/docs/reference/functions/constructcell.md @@ -0,0 +1,37 @@ +--- +id: constructCell +title: constructCell +--- + +# Function: constructCell() + +```ts +function constructCell( + column, + row, +table): Cell +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `TValue`\> + +## Defined in + +[core/cells/constructCell.ts:9](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/constructCell.ts#L9) diff --git a/docs/reference/functions/constructcolumn.md b/docs/reference/functions/constructcolumn.md new file mode 100644 index 0000000000..9aef93b90c --- /dev/null +++ b/docs/reference/functions/constructcolumn.md @@ -0,0 +1,40 @@ +--- +id: constructColumn +title: constructColumn +--- + +# Function: constructColumn() + +```ts +function constructColumn( + table, + columnDef, + depth, +parent?): Column +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +• **columnDef**: [`ColumnDef`](../type-aliases/columndef.md)\<`TFeatures`, `TData`, `TValue`\> + +• **depth**: `number` + +• **parent?**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +## Defined in + +[core/columns/constructColumn.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/constructColumn.ts#L12) diff --git a/docs/reference/functions/constructheader.md b/docs/reference/functions/constructheader.md new file mode 100644 index 0000000000..7a232cc129 --- /dev/null +++ b/docs/reference/functions/constructheader.md @@ -0,0 +1,47 @@ +--- +id: constructHeader +title: constructHeader +--- + +# Function: constructHeader() + +```ts +function constructHeader( + table, + column, +options): Header +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +• **options** + +• **options.depth**: `number` + +• **options.id?**: `string` + +• **options.index**: `number` + +• **options.isPlaceholder?**: `boolean` + +• **options.placeholderId?**: `string` + +## Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `TValue`\> + +## Defined in + +[core/headers/constructHeader.ts:8](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/constructHeader.ts#L8) diff --git a/docs/reference/functions/constructrow.md b/docs/reference/functions/constructrow.md new file mode 100644 index 0000000000..5e958d02e2 --- /dev/null +++ b/docs/reference/functions/constructrow.md @@ -0,0 +1,47 @@ +--- +id: constructRow +title: constructRow +--- + +# Function: constructRow() + +```ts +function constructRow( + table, + id, + original, + rowIndex, + depth, + subRows?, +parentId?): Row +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +• **id**: `string` + +• **original**: `TData` + +• **rowIndex**: `number` + +• **depth**: `number` + +• **subRows?**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\>[] + +• **parentId?**: `string` + +## Returns + +[`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/rows/constructRow.ts:7](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/constructRow.ts#L7) diff --git a/docs/reference/functions/constructtable.md b/docs/reference/functions/constructtable.md new file mode 100644 index 0000000000..4efe0e287e --- /dev/null +++ b/docs/reference/functions/constructtable.md @@ -0,0 +1,28 @@ +--- +id: constructTable +title: constructTable +--- + +# Function: constructTable() + +```ts +function constructTable(options): Table +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **options**: [`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/table/constructTable.ts:22](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/constructTable.ts#L22) diff --git a/docs/reference/functions/constructtablehelper.md b/docs/reference/functions/constructtablehelper.md new file mode 100644 index 0000000000..741ca6822b --- /dev/null +++ b/docs/reference/functions/constructtablehelper.md @@ -0,0 +1,32 @@ +--- +id: constructTableHelper +title: constructTableHelper +--- + +# Function: constructTableHelper() + +```ts +function constructTableHelper(tableCreator, tableHelperOptions): TableHelper_Core +``` + +Internal function to create a table helper that each adapter package will use to create their own table helper + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **tableCreator** + +• **tableHelperOptions**: [`TableHelperOptions`](../type-aliases/tablehelperoptions.md)\<`TFeatures`, `TData`\> + +## Returns + +[`TableHelper_Core`](../type-aliases/tablehelper_core.md)\<`TFeatures`, `TData`\> + +## Defined in + +[helpers/tableHelper.ts:41](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableHelper.ts#L41) diff --git a/docs/reference/functions/createcolumnhelper.md b/docs/reference/functions/createcolumnhelper.md new file mode 100644 index 0000000000..c52af74344 --- /dev/null +++ b/docs/reference/functions/createcolumnhelper.md @@ -0,0 +1,41 @@ +--- +id: createColumnHelper +title: createColumnHelper +--- + +# Function: createColumnHelper() + +```ts +function createColumnHelper(): ColumnHelper +``` + +A helper utility for creating column definitions with slightly better type inference for each individual column. +The `TValue` generic is inferred based on the accessor key or function provided. + +**Note:** From a JavaScript perspective, the functions in these helpers do not do anything. They are only used to help TypeScript infer the correct types for the column definitions. + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Returns + +[`ColumnHelper`](../type-aliases/columnhelper.md)\<`TFeatures`, `TData`\> + +## Example + +```tsx +const helper = createColumnHelper() // _features is the result of `tableFeatures({})` helper + +const columns = [ + helper.display({ id: 'actions', header: 'Actions' }), + helper.accessor('firstName', {}), + helper.accessor((row) => row.lastName, {} +] +``` + +## Defined in + +[helpers/columnHelper.ts:56](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/columnHelper.ts#L56) diff --git a/docs/reference/functions/createcorerowmodel.md b/docs/reference/functions/createcorerowmodel.md new file mode 100644 index 0000000000..41d006358f --- /dev/null +++ b/docs/reference/functions/createcorerowmodel.md @@ -0,0 +1,36 @@ +--- +id: createCoreRowModel +title: createCoreRowModel +--- + +# Function: createCoreRowModel() + +```ts +function createCoreRowModel(): (table) => () => RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Returns + +`Function` + +### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +### Returns + +`Function` + +#### Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/row-models/createCoreRowModel.ts:10](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/createCoreRowModel.ts#L10) diff --git a/docs/reference/functions/createexpandedrowmodel.md b/docs/reference/functions/createexpandedrowmodel.md new file mode 100644 index 0000000000..fa07e5afed --- /dev/null +++ b/docs/reference/functions/createexpandedrowmodel.md @@ -0,0 +1,36 @@ +--- +id: createExpandedRowModel +title: createExpandedRowModel +--- + +# Function: createExpandedRowModel() + +```ts +function createExpandedRowModel(): (table) => () => RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Returns + +`Function` + +### Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +### Returns + +`Function` + +#### Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/row-expanding/createExpandedRowModel.ts:9](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/createExpandedRowModel.ts#L9) diff --git a/docs/reference/functions/createfacetedminmaxvalues.md b/docs/reference/functions/createfacetedminmaxvalues.md new file mode 100644 index 0000000000..44174cf954 --- /dev/null +++ b/docs/reference/functions/createfacetedminmaxvalues.md @@ -0,0 +1,38 @@ +--- +id: createFacetedMinMaxValues +title: createFacetedMinMaxValues +--- + +# Function: createFacetedMinMaxValues() + +```ts +function createFacetedMinMaxValues(): (table, columnId) => () => undefined | [number, number] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Returns + +`Function` + +### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +• **columnId**: `string` + +### Returns + +`Function` + +#### Returns + +`undefined` \| [`number`, `number`] + +## Defined in + +[features/column-faceting/createFacetedMinMaxValues.ts:8](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/createFacetedMinMaxValues.ts#L8) diff --git a/docs/reference/functions/createfacetedrowmodel.md b/docs/reference/functions/createfacetedrowmodel.md new file mode 100644 index 0000000000..59a7459a0d --- /dev/null +++ b/docs/reference/functions/createfacetedrowmodel.md @@ -0,0 +1,38 @@ +--- +id: createFacetedRowModel +title: createFacetedRowModel +--- + +# Function: createFacetedRowModel() + +```ts +function createFacetedRowModel(): (table, columnId) => () => RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Returns + +`Function` + +### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +• **columnId**: `string` + +### Returns + +`Function` + +#### Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/column-faceting/createFacetedRowModel.ts:13](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/createFacetedRowModel.ts#L13) diff --git a/docs/reference/functions/createfaceteduniquevalues.md b/docs/reference/functions/createfaceteduniquevalues.md new file mode 100644 index 0000000000..55ac93295a --- /dev/null +++ b/docs/reference/functions/createfaceteduniquevalues.md @@ -0,0 +1,38 @@ +--- +id: createFacetedUniqueValues +title: createFacetedUniqueValues +--- + +# Function: createFacetedUniqueValues() + +```ts +function createFacetedUniqueValues(): (table, columnId) => () => Map +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Returns + +`Function` + +### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +• **columnId**: `string` + +### Returns + +`Function` + +#### Returns + +`Map`\<`any`, `number`\> + +## Defined in + +[features/column-faceting/createFacetedUniqueValues.ts:8](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/createFacetedUniqueValues.ts#L8) diff --git a/docs/reference/functions/createfilteredrowmodel.md b/docs/reference/functions/createfilteredrowmodel.md new file mode 100644 index 0000000000..d7a13a758c --- /dev/null +++ b/docs/reference/functions/createfilteredrowmodel.md @@ -0,0 +1,36 @@ +--- +id: createFilteredRowModel +title: createFilteredRowModel +--- + +# Function: createFilteredRowModel() + +```ts +function createFilteredRowModel(): (table) => () => RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Returns + +`Function` + +### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +### Returns + +`Function` + +#### Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/column-filtering/createFilteredRowModel.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/createFilteredRowModel.ts#L20) diff --git a/docs/reference/functions/creategroupedrowmodel.md b/docs/reference/functions/creategroupedrowmodel.md new file mode 100644 index 0000000000..33f0675c67 --- /dev/null +++ b/docs/reference/functions/creategroupedrowmodel.md @@ -0,0 +1,36 @@ +--- +id: createGroupedRowModel +title: createGroupedRowModel +--- + +# Function: createGroupedRowModel() + +```ts +function createGroupedRowModel(): (table) => () => RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Returns + +`Function` + +### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +### Returns + +`Function` + +#### Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/column-grouping/createGroupedRowModel.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/createGroupedRowModel.ts#L18) diff --git a/docs/reference/functions/createpaginatedrowmodel.md b/docs/reference/functions/createpaginatedrowmodel.md new file mode 100644 index 0000000000..c7c691b7f3 --- /dev/null +++ b/docs/reference/functions/createpaginatedrowmodel.md @@ -0,0 +1,36 @@ +--- +id: createPaginatedRowModel +title: createPaginatedRowModel +--- + +# Function: createPaginatedRowModel() + +```ts +function createPaginatedRowModel(): (table) => () => RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Returns + +`Function` + +### Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +### Returns + +`Function` + +#### Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/row-pagination/createPaginatedRowModel.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/createPaginatedRowModel.ts#L11) diff --git a/docs/reference/functions/createsortedrowmodel.md b/docs/reference/functions/createsortedrowmodel.md new file mode 100644 index 0000000000..71ff728239 --- /dev/null +++ b/docs/reference/functions/createsortedrowmodel.md @@ -0,0 +1,36 @@ +--- +id: createSortedRowModel +title: createSortedRowModel +--- + +# Function: createSortedRowModel() + +```ts +function createSortedRowModel(): (table) => () => RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Returns + +`Function` + +### Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +### Returns + +`Function` + +#### Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/row-sorting/createSortedRowModel.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/createSortedRowModel.ts#L12) diff --git a/docs/reference/functions/expandrows.md b/docs/reference/functions/expandrows.md new file mode 100644 index 0000000000..7a88a3b07a --- /dev/null +++ b/docs/reference/functions/expandrows.md @@ -0,0 +1,46 @@ +--- +id: expandRows +title: expandRows +--- + +# Function: expandRows() + +```ts +function expandRows(rowModel): object +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **rowModel**: [`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Returns + +`object` + +### flatRows + +```ts +flatRows: Row[] = rowModel.flatRows; +``` + +### rows + +```ts +rows: Row[] = expandedRows; +``` + +### rowsById + +```ts +rowsById: Record> = rowModel.rowsById; +``` + +## Defined in + +[features/row-expanding/createExpandedRowModel.ts:50](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/createExpandedRowModel.ts#L50) diff --git a/docs/reference/functions/filterfn_arrincludes.md b/docs/reference/functions/filterfn_arrincludes.md new file mode 100644 index 0000000000..e4553321b9 --- /dev/null +++ b/docs/reference/functions/filterfn_arrincludes.md @@ -0,0 +1,32 @@ +--- +id: filterFn_arrIncludes +title: filterFn_arrIncludes +--- + +# Function: filterFn\_arrIncludes() + +```ts +function filterFn_arrIncludes( + row, + columnId, + filterValue, + addMeta): boolean +``` + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **columnId**: `string` + +• **filterValue**: `any` + +• **addMeta** + +## Returns + +`boolean` + +## Defined in + +[fns/filterFns.ts:57](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L57) diff --git a/docs/reference/functions/filterfn_arrincludesall.md b/docs/reference/functions/filterfn_arrincludesall.md new file mode 100644 index 0000000000..43b3e8ba7a --- /dev/null +++ b/docs/reference/functions/filterfn_arrincludesall.md @@ -0,0 +1,32 @@ +--- +id: filterFn_arrIncludesAll +title: filterFn_arrIncludesAll +--- + +# Function: filterFn\_arrIncludesAll() + +```ts +function filterFn_arrIncludesAll( + row, + columnId, + filterValue, + addMeta): boolean +``` + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **columnId**: `string` + +• **filterValue**: `any` + +• **addMeta** + +## Returns + +`boolean` + +## Defined in + +[fns/filterFns.ts:70](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L70) diff --git a/docs/reference/functions/filterfn_arrincludessome.md b/docs/reference/functions/filterfn_arrincludessome.md new file mode 100644 index 0000000000..798ca0598c --- /dev/null +++ b/docs/reference/functions/filterfn_arrincludessome.md @@ -0,0 +1,32 @@ +--- +id: filterFn_arrIncludesSome +title: filterFn_arrIncludesSome +--- + +# Function: filterFn\_arrIncludesSome() + +```ts +function filterFn_arrIncludesSome( + row, + columnId, + filterValue, + addMeta): boolean +``` + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **columnId**: `string` + +• **filterValue**: `any` + +• **addMeta** + +## Returns + +`boolean` + +## Defined in + +[fns/filterFns.ts:86](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L86) diff --git a/docs/reference/functions/filterfn_equals.md b/docs/reference/functions/filterfn_equals.md new file mode 100644 index 0000000000..b6d4c49706 --- /dev/null +++ b/docs/reference/functions/filterfn_equals.md @@ -0,0 +1,32 @@ +--- +id: filterFn_equals +title: filterFn_equals +--- + +# Function: filterFn\_equals() + +```ts +function filterFn_equals( + row, + columnId, + filterValue, + addMeta): boolean +``` + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **columnId**: `string` + +• **filterValue**: `any` + +• **addMeta** + +## Returns + +`boolean` + +## Defined in + +[fns/filterFns.ts:102](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L102) diff --git a/docs/reference/functions/filterfn_equalsstring.md b/docs/reference/functions/filterfn_equalsstring.md new file mode 100644 index 0000000000..0ec228b7cd --- /dev/null +++ b/docs/reference/functions/filterfn_equalsstring.md @@ -0,0 +1,32 @@ +--- +id: filterFn_equalsString +title: filterFn_equalsString +--- + +# Function: filterFn\_equalsString() + +```ts +function filterFn_equalsString( + row, + columnId, + filterValue, + addMeta): boolean +``` + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **columnId**: `string` + +• **filterValue**: `any` + +• **addMeta** + +## Returns + +`boolean` + +## Defined in + +[fns/filterFns.ts:41](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L41) diff --git a/docs/reference/functions/filterfn_includesstring.md b/docs/reference/functions/filterfn_includesstring.md new file mode 100644 index 0000000000..d81acddc24 --- /dev/null +++ b/docs/reference/functions/filterfn_includesstring.md @@ -0,0 +1,32 @@ +--- +id: filterFn_includesString +title: filterFn_includesString +--- + +# Function: filterFn\_includesString() + +```ts +function filterFn_includesString( + row, + columnId, + filterValue, + addMeta): boolean +``` + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **columnId**: `string` + +• **filterValue**: `any` + +• **addMeta** + +## Returns + +`boolean` + +## Defined in + +[fns/filterFns.ts:6](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L6) diff --git a/docs/reference/functions/filterfn_includesstringsensitive.md b/docs/reference/functions/filterfn_includesstringsensitive.md new file mode 100644 index 0000000000..9b94c4a56d --- /dev/null +++ b/docs/reference/functions/filterfn_includesstringsensitive.md @@ -0,0 +1,32 @@ +--- +id: filterFn_includesStringSensitive +title: filterFn_includesStringSensitive +--- + +# Function: filterFn\_includesStringSensitive() + +```ts +function filterFn_includesStringSensitive( + row, + columnId, + filterValue, + addMeta): boolean +``` + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **columnId**: `string` + +• **filterValue**: `any` + +• **addMeta** + +## Returns + +`boolean` + +## Defined in + +[fns/filterFns.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L26) diff --git a/docs/reference/functions/filterfn_innumberrange.md b/docs/reference/functions/filterfn_innumberrange.md new file mode 100644 index 0000000000..32f5b83053 --- /dev/null +++ b/docs/reference/functions/filterfn_innumberrange.md @@ -0,0 +1,32 @@ +--- +id: filterFn_inNumberRange +title: filterFn_inNumberRange +--- + +# Function: filterFn\_inNumberRange() + +```ts +function filterFn_inNumberRange( + row, + columnId, + filterValue, + addMeta): boolean +``` + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **columnId**: `string` + +• **filterValue**: `any` + +• **addMeta** + +## Returns + +`boolean` + +## Defined in + +[fns/filterFns.ts:128](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L128) diff --git a/docs/reference/functions/filterfn_weakequals.md b/docs/reference/functions/filterfn_weakequals.md new file mode 100644 index 0000000000..fc131a5551 --- /dev/null +++ b/docs/reference/functions/filterfn_weakequals.md @@ -0,0 +1,32 @@ +--- +id: filterFn_weakEquals +title: filterFn_weakEquals +--- + +# Function: filterFn\_weakEquals() + +```ts +function filterFn_weakEquals( + row, + columnId, + filterValue, + addMeta): boolean +``` + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **columnId**: `string` + +• **filterValue**: `any` + +• **addMeta** + +## Returns + +`boolean` + +## Defined in + +[fns/filterFns.ts:115](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L115) diff --git a/docs/reference/functions/flattenby.md b/docs/reference/functions/flattenby.md new file mode 100644 index 0000000000..9f0b5acacd --- /dev/null +++ b/docs/reference/functions/flattenby.md @@ -0,0 +1,28 @@ +--- +id: flattenBy +title: flattenBy +--- + +# Function: flattenBy() + +```ts +function flattenBy(arr, getChildren): TNode[] +``` + +## Type Parameters + +• **TNode** + +## Parameters + +• **arr**: `TNode`[] + +• **getChildren** + +## Returns + +`TNode`[] + +## Defined in + +[utils.ts:44](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L44) diff --git a/docs/reference/functions/functionalupdate.md b/docs/reference/functions/functionalupdate.md new file mode 100644 index 0000000000..83a043a4e5 --- /dev/null +++ b/docs/reference/functions/functionalupdate.md @@ -0,0 +1,28 @@ +--- +id: functionalUpdate +title: functionalUpdate +--- + +# Function: functionalUpdate() + +```ts +function functionalUpdate(updater, input): T +``` + +## Type Parameters + +• **T** + +## Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<`T`\> + +• **input**: `T` + +## Returns + +`T` + +## Defined in + +[utils.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L12) diff --git a/docs/reference/functions/getdefaultcolumnfiltersstate.md b/docs/reference/functions/getdefaultcolumnfiltersstate.md new file mode 100644 index 0000000000..b3a41bd8a2 --- /dev/null +++ b/docs/reference/functions/getdefaultcolumnfiltersstate.md @@ -0,0 +1,18 @@ +--- +id: getDefaultColumnFiltersState +title: getDefaultColumnFiltersState +--- + +# Function: getDefaultColumnFiltersState() + +```ts +function getDefaultColumnFiltersState(): ColumnFiltersState +``` + +## Returns + +[`ColumnFiltersState`](../type-aliases/columnfiltersstate.md) + +## Defined in + +[features/column-filtering/ColumnFiltering.utils.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.utils.ts#L12) diff --git a/docs/reference/functions/getdefaultcolumnorderstate.md b/docs/reference/functions/getdefaultcolumnorderstate.md new file mode 100644 index 0000000000..77da2a6477 --- /dev/null +++ b/docs/reference/functions/getdefaultcolumnorderstate.md @@ -0,0 +1,18 @@ +--- +id: getDefaultColumnOrderState +title: getDefaultColumnOrderState +--- + +# Function: getDefaultColumnOrderState() + +```ts +function getDefaultColumnOrderState(): ColumnOrderState +``` + +## Returns + +[`ColumnOrderState`](../type-aliases/columnorderstate.md) + +## Defined in + +[features/column-ordering/ColumnOrdering.utils.ts:10](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.utils.ts#L10) diff --git a/docs/reference/functions/getdefaultcolumnpinningstate.md b/docs/reference/functions/getdefaultcolumnpinningstate.md new file mode 100644 index 0000000000..2a594eaa47 --- /dev/null +++ b/docs/reference/functions/getdefaultcolumnpinningstate.md @@ -0,0 +1,18 @@ +--- +id: getDefaultColumnPinningState +title: getDefaultColumnPinningState +--- + +# Function: getDefaultColumnPinningState() + +```ts +function getDefaultColumnPinningState(): ColumnPinningState +``` + +## Returns + +[`ColumnPinningState`](../interfaces/columnpinningstate.md) + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L20) diff --git a/docs/reference/functions/getdefaultcolumnresizingstate.md b/docs/reference/functions/getdefaultcolumnresizingstate.md new file mode 100644 index 0000000000..8b28bbeada --- /dev/null +++ b/docs/reference/functions/getdefaultcolumnresizingstate.md @@ -0,0 +1,18 @@ +--- +id: getDefaultColumnResizingState +title: getDefaultColumnResizingState +--- + +# Function: getDefaultColumnResizingState() + +```ts +function getDefaultColumnResizingState(): columnResizingState +``` + +## Returns + +[`columnResizingState`](../interfaces/columnresizingstate.md) + +## Defined in + +[features/column-resizing/ColumnResizing.utils.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.utils.ts#L18) diff --git a/docs/reference/functions/getdefaultcolumnsizingcolumndef.md b/docs/reference/functions/getdefaultcolumnsizingcolumndef.md new file mode 100644 index 0000000000..dec5538d13 --- /dev/null +++ b/docs/reference/functions/getdefaultcolumnsizingcolumndef.md @@ -0,0 +1,36 @@ +--- +id: getDefaultColumnSizingColumnDef +title: getDefaultColumnSizingColumnDef +--- + +# Function: getDefaultColumnSizingColumnDef() + +```ts +function getDefaultColumnSizingColumnDef(): object +``` + +## Returns + +`object` + +### maxSize + +```ts +maxSize: number = Number.MAX_SAFE_INTEGER; +``` + +### minSize + +```ts +minSize: number = 20; +``` + +### size + +```ts +size: number = 150; +``` + +## Defined in + +[features/column-sizing/ColumnSizing.utils.ts:22](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.utils.ts#L22) diff --git a/docs/reference/functions/getdefaultcolumnsizingstate.md b/docs/reference/functions/getdefaultcolumnsizingstate.md new file mode 100644 index 0000000000..c5af8156ea --- /dev/null +++ b/docs/reference/functions/getdefaultcolumnsizingstate.md @@ -0,0 +1,18 @@ +--- +id: getDefaultColumnSizingState +title: getDefaultColumnSizingState +--- + +# Function: getDefaultColumnSizingState() + +```ts +function getDefaultColumnSizingState(): ColumnSizingState +``` + +## Returns + +[`ColumnSizingState`](../type-aliases/columnsizingstate.md) + +## Defined in + +[features/column-sizing/ColumnSizing.utils.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.utils.ts#L18) diff --git a/docs/reference/functions/getdefaultcolumnvisibilitystate.md b/docs/reference/functions/getdefaultcolumnvisibilitystate.md new file mode 100644 index 0000000000..309ec5b068 --- /dev/null +++ b/docs/reference/functions/getdefaultcolumnvisibilitystate.md @@ -0,0 +1,18 @@ +--- +id: getDefaultColumnVisibilityState +title: getDefaultColumnVisibilityState +--- + +# Function: getDefaultColumnVisibilityState() + +```ts +function getDefaultColumnVisibilityState(): ColumnVisibilityState +``` + +## Returns + +[`ColumnVisibilityState`](../type-aliases/columnvisibilitystate.md) + +## Defined in + +[features/column-visibility/ColumnVisibility.utils.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.utils.ts#L18) diff --git a/docs/reference/functions/getdefaultexpandedstate.md b/docs/reference/functions/getdefaultexpandedstate.md new file mode 100644 index 0000000000..a2b9e37ed7 --- /dev/null +++ b/docs/reference/functions/getdefaultexpandedstate.md @@ -0,0 +1,18 @@ +--- +id: getDefaultExpandedState +title: getDefaultExpandedState +--- + +# Function: getDefaultExpandedState() + +```ts +function getDefaultExpandedState(): ExpandedState +``` + +## Returns + +[`ExpandedState`](../type-aliases/expandedstate.md) + +## Defined in + +[features/row-expanding/RowExpanding.utils.ts:7](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.utils.ts#L7) diff --git a/docs/reference/functions/getdefaultgroupingstate.md b/docs/reference/functions/getdefaultgroupingstate.md new file mode 100644 index 0000000000..e8e95a25d2 --- /dev/null +++ b/docs/reference/functions/getdefaultgroupingstate.md @@ -0,0 +1,18 @@ +--- +id: getDefaultGroupingState +title: getDefaultGroupingState +--- + +# Function: getDefaultGroupingState() + +```ts +function getDefaultGroupingState(): GroupingState +``` + +## Returns + +[`GroupingState`](../type-aliases/groupingstate.md) + +## Defined in + +[features/column-grouping/ColumnGrouping.utils.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts#L16) diff --git a/docs/reference/functions/getdefaultpaginationstate.md b/docs/reference/functions/getdefaultpaginationstate.md new file mode 100644 index 0000000000..25eb48979b --- /dev/null +++ b/docs/reference/functions/getdefaultpaginationstate.md @@ -0,0 +1,18 @@ +--- +id: getDefaultPaginationState +title: getDefaultPaginationState +--- + +# Function: getDefaultPaginationState() + +```ts +function getDefaultPaginationState(): PaginationState +``` + +## Returns + +[`PaginationState`](../interfaces/paginationstate.md) + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:10](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L10) diff --git a/docs/reference/functions/getdefaultrowpinningstate.md b/docs/reference/functions/getdefaultrowpinningstate.md new file mode 100644 index 0000000000..82e81fa69a --- /dev/null +++ b/docs/reference/functions/getdefaultrowpinningstate.md @@ -0,0 +1,18 @@ +--- +id: getDefaultRowPinningState +title: getDefaultRowPinningState +--- + +# Function: getDefaultRowPinningState() + +```ts +function getDefaultRowPinningState(): RowPinningState +``` + +## Returns + +[`RowPinningState`](../interfaces/rowpinningstate.md) + +## Defined in + +[features/row-pinning/RowPinning.utils.ts:10](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.utils.ts#L10) diff --git a/docs/reference/functions/getdefaultrowselectionstate.md b/docs/reference/functions/getdefaultrowselectionstate.md new file mode 100644 index 0000000000..ceae0adad8 --- /dev/null +++ b/docs/reference/functions/getdefaultrowselectionstate.md @@ -0,0 +1,18 @@ +--- +id: getDefaultRowSelectionState +title: getDefaultRowSelectionState +--- + +# Function: getDefaultRowSelectionState() + +```ts +function getDefaultRowSelectionState(): RowSelectionState +``` + +## Returns + +[`RowSelectionState`](../type-aliases/rowselectionstate.md) + +## Defined in + +[features/row-selection/RowSelection.utils.ts:10](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L10) diff --git a/docs/reference/functions/getfunctionnameinfo.md b/docs/reference/functions/getfunctionnameinfo.md new file mode 100644 index 0000000000..d14c14fdfe --- /dev/null +++ b/docs/reference/functions/getfunctionnameinfo.md @@ -0,0 +1,42 @@ +--- +id: getFunctionNameInfo +title: getFunctionNameInfo +--- + +# Function: getFunctionNameInfo() + +```ts +function getFunctionNameInfo(fn): object +``` + +Assumes that a function name is in the format of `parentName_fnKey` and returns the `fnKey` and `fnName` in the format of `parentName.fnKey`. + +## Parameters + +• **fn**: `AnyFunction` + +## Returns + +`object` + +### fnKey + +```ts +fnKey: string; +``` + +### fnName + +```ts +fnName: string; +``` + +### parentName + +```ts +parentName: string; +``` + +## Defined in + +[utils.ts:183](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L183) diff --git a/docs/reference/functions/getinitialtablestate.md b/docs/reference/functions/getinitialtablestate.md new file mode 100644 index 0000000000..059120db65 --- /dev/null +++ b/docs/reference/functions/getinitialtablestate.md @@ -0,0 +1,28 @@ +--- +id: getInitialTableState +title: getInitialTableState +--- + +# Function: getInitialTableState() + +```ts +function getInitialTableState(features, initialState): TableState +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +## Parameters + +• **features**: `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **initialState**: `undefined` \| `Partial`\<[`TableState`](../type-aliases/tablestate.md)\<`TFeatures`\>\> = `{}` + +## Returns + +[`TableState`](../type-aliases/tablestate.md)\<`TFeatures`\> + +## Defined in + +[core/table/constructTable.ts:10](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/constructTable.ts#L10) diff --git a/docs/reference/functions/header_getcontext.md b/docs/reference/functions/header_getcontext.md new file mode 100644 index 0000000000..8e8a22f9c8 --- /dev/null +++ b/docs/reference/functions/header_getcontext.md @@ -0,0 +1,48 @@ +--- +id: header_getContext +title: header_getContext +--- + +# Function: header\_getContext() + +```ts +function header_getContext(header): object +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** + +## Parameters + +• **header**: [`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`object` + +### column + +```ts +column: Column = header.column; +``` + +### header + +```ts +header: Header; +``` + +### table + +```ts +table: Table_Internal = header.column.table; +``` + +## Defined in + +[core/headers/Headers.utils.ts:34](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.utils.ts#L34) diff --git a/docs/reference/functions/header_getleafheaders.md b/docs/reference/functions/header_getleafheaders.md new file mode 100644 index 0000000000..159eda8808 --- /dev/null +++ b/docs/reference/functions/header_getleafheaders.md @@ -0,0 +1,30 @@ +--- +id: header_getLeafHeaders +title: header_getLeafHeaders +--- + +# Function: header\_getLeafHeaders() + +```ts +function header_getLeafHeaders(header): Header[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** + +## Parameters + +• **header**: [`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `TValue`\>[] + +## Defined in + +[core/headers/Headers.utils.ts:15](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.utils.ts#L15) diff --git a/docs/reference/functions/header_getresizehandler.md b/docs/reference/functions/header_getresizehandler.md new file mode 100644 index 0000000000..fc1598442c --- /dev/null +++ b/docs/reference/functions/header_getresizehandler.md @@ -0,0 +1,40 @@ +--- +id: header_getResizeHandler +title: header_getResizeHandler +--- + +# Function: header\_getResizeHandler() + +```ts +function header_getResizeHandler(header, _contextDocument?): (event) => void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **header**: [`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `TValue`\> + +• **\_contextDocument?**: `Document` + +## Returns + +`Function` + +### Parameters + +• **event**: `unknown` + +### Returns + +`void` + +## Defined in + +[features/column-resizing/ColumnResizing.utils.ts:58](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.utils.ts#L58) diff --git a/docs/reference/functions/header_getsize.md b/docs/reference/functions/header_getsize.md new file mode 100644 index 0000000000..7fcb9fec83 --- /dev/null +++ b/docs/reference/functions/header_getsize.md @@ -0,0 +1,30 @@ +--- +id: header_getSize +title: header_getSize +--- + +# Function: header\_getSize() + +```ts +function header_getSize(header): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **header**: [`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`number` + +## Defined in + +[features/column-sizing/ColumnSizing.utils.ts:89](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.utils.ts#L89) diff --git a/docs/reference/functions/header_getstart.md b/docs/reference/functions/header_getstart.md new file mode 100644 index 0000000000..1d37c100f5 --- /dev/null +++ b/docs/reference/functions/header_getstart.md @@ -0,0 +1,30 @@ +--- +id: header_getStart +title: header_getStart +--- + +# Function: header\_getStart() + +```ts +function header_getStart(header): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **header**: [`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`number` + +## Defined in + +[features/column-sizing/ColumnSizing.utils.ts:109](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.utils.ts#L109) diff --git a/docs/reference/functions/isfunction.md b/docs/reference/functions/isfunction.md new file mode 100644 index 0000000000..986945f38f --- /dev/null +++ b/docs/reference/functions/isfunction.md @@ -0,0 +1,26 @@ +--- +id: isFunction +title: isFunction +--- + +# Function: isFunction() + +```ts +function isFunction(d): d is T +``` + +## Type Parameters + +• **T** *extends* `AnyFunction` + +## Parameters + +• **d**: `any` + +## Returns + +`d is T` + +## Defined in + +[utils.ts:36](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L36) diff --git a/docs/reference/functions/isnumberarray.md b/docs/reference/functions/isnumberarray.md new file mode 100644 index 0000000000..87e3d22076 --- /dev/null +++ b/docs/reference/functions/isnumberarray.md @@ -0,0 +1,22 @@ +--- +id: isNumberArray +title: isNumberArray +--- + +# Function: isNumberArray() + +```ts +function isNumberArray(d): d is number[] +``` + +## Parameters + +• **d**: `any` + +## Returns + +`d is number[]` + +## Defined in + +[utils.ts:40](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L40) diff --git a/docs/reference/functions/isrowselected.md b/docs/reference/functions/isrowselected.md new file mode 100644 index 0000000000..83340aa5da --- /dev/null +++ b/docs/reference/functions/isrowselected.md @@ -0,0 +1,28 @@ +--- +id: isRowSelected +title: isRowSelected +--- + +# Function: isRowSelected() + +```ts +function isRowSelected(row): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:420](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L420) diff --git a/docs/reference/functions/issubrowselected.md b/docs/reference/functions/issubrowselected.md new file mode 100644 index 0000000000..2851197672 --- /dev/null +++ b/docs/reference/functions/issubrowselected.md @@ -0,0 +1,28 @@ +--- +id: isSubRowSelected +title: isSubRowSelected +--- + +# Function: isSubRowSelected() + +```ts +function isSubRowSelected(row): boolean | "some" | "all" +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` \| `"some"` \| `"all"` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:431](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L431) diff --git a/docs/reference/functions/istouchstartevent.md b/docs/reference/functions/istouchstartevent.md new file mode 100644 index 0000000000..0dc32fc4cd --- /dev/null +++ b/docs/reference/functions/istouchstartevent.md @@ -0,0 +1,22 @@ +--- +id: isTouchStartEvent +title: isTouchStartEvent +--- + +# Function: isTouchStartEvent() + +```ts +function isTouchStartEvent(e): e is TouchEvent +``` + +## Parameters + +• **e**: `unknown` + +## Returns + +`e is TouchEvent` + +## Defined in + +[features/column-resizing/ColumnResizing.utils.ts:277](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.utils.ts#L277) diff --git a/docs/reference/functions/makestateupdater.md b/docs/reference/functions/makestateupdater.md new file mode 100644 index 0000000000..4e030efd79 --- /dev/null +++ b/docs/reference/functions/makestateupdater.md @@ -0,0 +1,49 @@ +--- +id: makeStateUpdater +title: makeStateUpdater +--- + +# Function: makeStateUpdater() + +```ts +function makeStateUpdater(key, instance): (updater) => void +``` + +## Type Parameters + +• **K** *extends* + \| `"columnFilters"` + \| `"grouping"` + \| `"columnOrder"` + \| `"columnPinning"` + \| `"columnResizing"` + \| `"columnSizing"` + \| `"columnVisibility"` + \| `"globalFilter"` + \| `"expanded"` + \| `"pagination"` + \| `"rowPinning"` + \| `"rowSelection"` + \| `"sorting"` + +## Parameters + +• **key**: `K` + +• **instance**: `unknown` + +## Returns + +`Function` + +### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`TableState`](../type-aliases/tablestate.md)\<`any`\>\[`K`\]\> + +### Returns + +`void` + +## Defined in + +[utils.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L20) diff --git a/docs/reference/functions/memo.md b/docs/reference/functions/memo.md new file mode 100644 index 0000000000..8b5968f98b --- /dev/null +++ b/docs/reference/functions/memo.md @@ -0,0 +1,38 @@ +--- +id: memo +title: memo +--- + +# Function: memo() + +```ts +function memo(options): (depArgs?) => TResult +``` + +## Type Parameters + +• **TDeps** *extends* readonly `any`[] + +• **TDepArgs** + +• **TResult** + +## Parameters + +• **options**: `MemoOptions`\<`TDeps`, `TDepArgs`, `TResult`\> + +## Returns + +`Function` + +### Parameters + +• **depArgs?**: `TDepArgs` + +### Returns + +`TResult` + +## Defined in + +[utils.ts:74](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L74) diff --git a/docs/reference/functions/noop.md b/docs/reference/functions/noop.md new file mode 100644 index 0000000000..4949ccb8df --- /dev/null +++ b/docs/reference/functions/noop.md @@ -0,0 +1,18 @@ +--- +id: noop +title: noop +--- + +# Function: noop() + +```ts +function noop(): void +``` + +## Returns + +`void` + +## Defined in + +[utils.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L18) diff --git a/docs/reference/functions/ordercolumns.md b/docs/reference/functions/ordercolumns.md new file mode 100644 index 0000000000..ea25505c91 --- /dev/null +++ b/docs/reference/functions/ordercolumns.md @@ -0,0 +1,30 @@ +--- +id: orderColumns +title: orderColumns +--- + +# Function: orderColumns() + +```ts +function orderColumns(table, leafColumns): Column[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **leafColumns**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-ordering/ColumnOrdering.utils.ts:106](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.utils.ts#L106) diff --git a/docs/reference/functions/passiveeventsupported.md b/docs/reference/functions/passiveeventsupported.md new file mode 100644 index 0000000000..f128ec193b --- /dev/null +++ b/docs/reference/functions/passiveeventsupported.md @@ -0,0 +1,18 @@ +--- +id: passiveEventSupported +title: passiveEventSupported +--- + +# Function: passiveEventSupported() + +```ts +function passiveEventSupported(): boolean +``` + +## Returns + +`boolean` + +## Defined in + +[features/column-resizing/ColumnResizing.utils.ts:252](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.utils.ts#L252) diff --git a/docs/reference/functions/row_getallcells.md b/docs/reference/functions/row_getallcells.md new file mode 100644 index 0000000000..ac01ec9954 --- /dev/null +++ b/docs/reference/functions/row_getallcells.md @@ -0,0 +1,28 @@ +--- +id: row_getAllCells +title: row_getAllCells +--- + +# Function: row\_getAllCells() + +```ts +function row_getAllCells(row): Cell[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[core/rows/Rows.utils.ts:92](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.utils.ts#L92) diff --git a/docs/reference/functions/row_getallcellsbycolumnid.md b/docs/reference/functions/row_getallcellsbycolumnid.md new file mode 100644 index 0000000000..aa188eb81e --- /dev/null +++ b/docs/reference/functions/row_getallcellsbycolumnid.md @@ -0,0 +1,28 @@ +--- +id: row_getAllCellsByColumnId +title: row_getAllCellsByColumnId +--- + +# Function: row\_getAllCellsByColumnId() + +```ts +function row_getAllCellsByColumnId(row): Record> +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`Record`\<`string`, [`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `unknown`\>\> + +## Defined in + +[core/rows/Rows.utils.ts:101](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.utils.ts#L101) diff --git a/docs/reference/functions/row_getallvisiblecells.md b/docs/reference/functions/row_getallvisiblecells.md new file mode 100644 index 0000000000..5a712d93e2 --- /dev/null +++ b/docs/reference/functions/row_getallvisiblecells.md @@ -0,0 +1,28 @@ +--- +id: row_getAllVisibleCells +title: row_getAllVisibleCells +--- + +# Function: row\_getAllVisibleCells() + +```ts +function row_getAllVisibleCells(row): Cell[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-visibility/ColumnVisibility.utils.ts:105](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.utils.ts#L105) diff --git a/docs/reference/functions/row_getcanexpand.md b/docs/reference/functions/row_getcanexpand.md new file mode 100644 index 0000000000..9ad1ba0bef --- /dev/null +++ b/docs/reference/functions/row_getcanexpand.md @@ -0,0 +1,28 @@ +--- +id: row_getCanExpand +title: row_getCanExpand +--- + +# Function: row\_getCanExpand() + +```ts +function row_getCanExpand(row): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-expanding/RowExpanding.utils.ts:169](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.utils.ts#L169) diff --git a/docs/reference/functions/row_getcanmultiselect.md b/docs/reference/functions/row_getcanmultiselect.md new file mode 100644 index 0000000000..572832330a --- /dev/null +++ b/docs/reference/functions/row_getcanmultiselect.md @@ -0,0 +1,28 @@ +--- +id: row_getCanMultiSelect +title: row_getCanMultiSelect +--- + +# Function: row\_getCanMultiSelect() + +```ts +function row_getCanMultiSelect(row): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:321](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L321) diff --git a/docs/reference/functions/row_getcanpin.md b/docs/reference/functions/row_getcanpin.md new file mode 100644 index 0000000000..50045f9b60 --- /dev/null +++ b/docs/reference/functions/row_getcanpin.md @@ -0,0 +1,28 @@ +--- +id: row_getCanPin +title: row_getCanPin +--- + +# Function: row\_getCanPin() + +```ts +function row_getCanPin(row): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-pinning/RowPinning.utils.ts:110](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.utils.ts#L110) diff --git a/docs/reference/functions/row_getcanselect.md b/docs/reference/functions/row_getcanselect.md new file mode 100644 index 0000000000..c4cdad8493 --- /dev/null +++ b/docs/reference/functions/row_getcanselect.md @@ -0,0 +1,28 @@ +--- +id: row_getCanSelect +title: row_getCanSelect +--- + +# Function: row\_getCanSelect() + +```ts +function row_getCanSelect(row): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:297](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L297) diff --git a/docs/reference/functions/row_getcanselectsubrows.md b/docs/reference/functions/row_getcanselectsubrows.md new file mode 100644 index 0000000000..df8f06e3e7 --- /dev/null +++ b/docs/reference/functions/row_getcanselectsubrows.md @@ -0,0 +1,28 @@ +--- +id: row_getCanSelectSubRows +title: row_getCanSelectSubRows +--- + +# Function: row\_getCanSelectSubRows() + +```ts +function row_getCanSelectSubRows(row): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:309](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L309) diff --git a/docs/reference/functions/row_getcentervisiblecells.md b/docs/reference/functions/row_getcentervisiblecells.md new file mode 100644 index 0000000000..d500a3a1a3 --- /dev/null +++ b/docs/reference/functions/row_getcentervisiblecells.md @@ -0,0 +1,28 @@ +--- +id: row_getCenterVisibleCells +title: row_getCenterVisibleCells +--- + +# Function: row\_getCenterVisibleCells() + +```ts +function row_getCenterVisibleCells(row): Cell[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:118](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L118) diff --git a/docs/reference/functions/row_getgroupingvalue.md b/docs/reference/functions/row_getgroupingvalue.md new file mode 100644 index 0000000000..091001ac44 --- /dev/null +++ b/docs/reference/functions/row_getgroupingvalue.md @@ -0,0 +1,37 @@ +--- +id: row_getGroupingValue +title: row_getGroupingValue +--- + +# Function: row\_getGroupingValue() + +```ts +function row_getGroupingValue(row, columnId): any +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row_Row`](../interfaces/row_row.md)\<`TFeatures`, `TData`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Row_ColumnFiltering`](../interfaces/row_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Row_ColumnGrouping`](../interfaces/row_columngrouping.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Row_ColumnPinning`](../interfaces/row_columnpinning.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Row_ColumnVisibility`](../interfaces/row_columnvisibility.md)\<`TFeatures`, `TData`\> : `never` + \| `"RowExpanding"` *extends* keyof `TFeatures` ? [`Row_RowExpanding`](../interfaces/row_rowexpanding.md) : `never` + \| `"RowPinning"` *extends* keyof `TFeatures` ? [`Row_RowPinning`](../interfaces/row_rowpinning.md) : `never` + \| `"RowSelection"` *extends* keyof `TFeatures` ? [`Row_RowSelection`](../interfaces/row_rowselection.md) : `never`\> & `Partial`\<[`Row_ColumnGrouping`](../interfaces/row_columngrouping.md)\> + +• **columnId**: `string` + +## Returns + +`any` + +## Defined in + +[features/column-grouping/ColumnGrouping.utils.ts:162](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts#L162) diff --git a/docs/reference/functions/row_getisallparentsexpanded.md b/docs/reference/functions/row_getisallparentsexpanded.md new file mode 100644 index 0000000000..c56758e52f --- /dev/null +++ b/docs/reference/functions/row_getisallparentsexpanded.md @@ -0,0 +1,28 @@ +--- +id: row_getIsAllParentsExpanded +title: row_getIsAllParentsExpanded +--- + +# Function: row\_getIsAllParentsExpanded() + +```ts +function row_getIsAllParentsExpanded(row): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-expanding/RowExpanding.utils.ts:179](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.utils.ts#L179) diff --git a/docs/reference/functions/row_getisallsubrowsselected.md b/docs/reference/functions/row_getisallsubrowsselected.md new file mode 100644 index 0000000000..230bf0f900 --- /dev/null +++ b/docs/reference/functions/row_getisallsubrowsselected.md @@ -0,0 +1,28 @@ +--- +id: row_getIsAllSubRowsSelected +title: row_getIsAllSubRowsSelected +--- + +# Function: row\_getIsAllSubRowsSelected() + +```ts +function row_getIsAllSubRowsSelected(row): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:290](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L290) diff --git a/docs/reference/functions/row_getisexpanded.md b/docs/reference/functions/row_getisexpanded.md new file mode 100644 index 0000000000..35bb0c1ecf --- /dev/null +++ b/docs/reference/functions/row_getisexpanded.md @@ -0,0 +1,28 @@ +--- +id: row_getIsExpanded +title: row_getIsExpanded +--- + +# Function: row\_getIsExpanded() + +```ts +function row_getIsExpanded(row): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-expanding/RowExpanding.utils.ts:157](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.utils.ts#L157) diff --git a/docs/reference/functions/row_getisgrouped.md b/docs/reference/functions/row_getisgrouped.md new file mode 100644 index 0000000000..d91338f37b --- /dev/null +++ b/docs/reference/functions/row_getisgrouped.md @@ -0,0 +1,35 @@ +--- +id: row_getIsGrouped +title: row_getIsGrouped +--- + +# Function: row\_getIsGrouped() + +```ts +function row_getIsGrouped(row): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row_Row`](../interfaces/row_row.md)\<`TFeatures`, `TData`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\< + \| `"ColumnFiltering"` *extends* keyof `TFeatures` ? [`Row_ColumnFiltering`](../interfaces/row_columnfiltering.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Row_ColumnGrouping`](../interfaces/row_columngrouping.md) : `never` + \| `"ColumnPinning"` *extends* keyof `TFeatures` ? [`Row_ColumnPinning`](../interfaces/row_columnpinning.md)\<`TFeatures`, `TData`\> : `never` + \| `"ColumnVisibility"` *extends* keyof `TFeatures` ? [`Row_ColumnVisibility`](../interfaces/row_columnvisibility.md)\<`TFeatures`, `TData`\> : `never` + \| `"RowExpanding"` *extends* keyof `TFeatures` ? [`Row_RowExpanding`](../interfaces/row_rowexpanding.md) : `never` + \| `"RowPinning"` *extends* keyof `TFeatures` ? [`Row_RowPinning`](../interfaces/row_rowpinning.md) : `never` + \| `"RowSelection"` *extends* keyof `TFeatures` ? [`Row_RowSelection`](../interfaces/row_rowselection.md) : `never`\> & `Partial`\<[`Row_ColumnGrouping`](../interfaces/row_columngrouping.md)\> + +## Returns + +`boolean` + +## Defined in + +[features/column-grouping/ColumnGrouping.utils.ts:155](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts#L155) diff --git a/docs/reference/functions/row_getispinned.md b/docs/reference/functions/row_getispinned.md new file mode 100644 index 0000000000..3529419e72 --- /dev/null +++ b/docs/reference/functions/row_getispinned.md @@ -0,0 +1,28 @@ +--- +id: row_getIsPinned +title: row_getIsPinned +--- + +# Function: row\_getIsPinned() + +```ts +function row_getIsPinned(row): RowPinningPosition +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowPinningPosition`](../type-aliases/rowpinningposition.md) + +## Defined in + +[features/row-pinning/RowPinning.utils.ts:121](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.utils.ts#L121) diff --git a/docs/reference/functions/row_getisselected.md b/docs/reference/functions/row_getisselected.md new file mode 100644 index 0000000000..daceaeed36 --- /dev/null +++ b/docs/reference/functions/row_getisselected.md @@ -0,0 +1,28 @@ +--- +id: row_getIsSelected +title: row_getIsSelected +--- + +# Function: row\_getIsSelected() + +```ts +function row_getIsSelected(row): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:276](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L276) diff --git a/docs/reference/functions/row_getissomeselected.md b/docs/reference/functions/row_getissomeselected.md new file mode 100644 index 0000000000..31d5431d22 --- /dev/null +++ b/docs/reference/functions/row_getissomeselected.md @@ -0,0 +1,28 @@ +--- +id: row_getIsSomeSelected +title: row_getIsSomeSelected +--- + +# Function: row\_getIsSomeSelected() + +```ts +function row_getIsSomeSelected(row): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:283](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L283) diff --git a/docs/reference/functions/row_getleafrows.md b/docs/reference/functions/row_getleafrows.md new file mode 100644 index 0000000000..4406f688e1 --- /dev/null +++ b/docs/reference/functions/row_getleafrows.md @@ -0,0 +1,28 @@ +--- +id: row_getLeafRows +title: row_getLeafRows +--- + +# Function: row\_getLeafRows() + +```ts +function row_getLeafRows(row): Row[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\>[] + +## Defined in + +[core/rows/Rows.utils.ts:62](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.utils.ts#L62) diff --git a/docs/reference/functions/row_getleftvisiblecells.md b/docs/reference/functions/row_getleftvisiblecells.md new file mode 100644 index 0000000000..6d0164a8b8 --- /dev/null +++ b/docs/reference/functions/row_getleftvisiblecells.md @@ -0,0 +1,28 @@ +--- +id: row_getLeftVisibleCells +title: row_getLeftVisibleCells +--- + +# Function: row\_getLeftVisibleCells() + +```ts +function row_getLeftVisibleCells(row): Cell_Cell & UnionToIntersection<"ColumnGrouping" extends keyof TFeatures ? Cell_ColumnGrouping : never> & object[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Cell_Cell`](../interfaces/cell_cell.md)\<`TFeatures`, `TData`, `unknown`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\<`"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Cell_ColumnGrouping`](../interfaces/cell_columngrouping.md) : `never`\> & `object`[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:129](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L129) diff --git a/docs/reference/functions/row_getparentrow.md b/docs/reference/functions/row_getparentrow.md new file mode 100644 index 0000000000..e6d08a8abd --- /dev/null +++ b/docs/reference/functions/row_getparentrow.md @@ -0,0 +1,28 @@ +--- +id: row_getParentRow +title: row_getParentRow +--- + +# Function: row\_getParentRow() + +```ts +function row_getParentRow(row): undefined | Row +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`undefined` \| [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/rows/Rows.utils.ts:69](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.utils.ts#L69) diff --git a/docs/reference/functions/row_getparentrows.md b/docs/reference/functions/row_getparentrows.md new file mode 100644 index 0000000000..99b10dbdc9 --- /dev/null +++ b/docs/reference/functions/row_getparentrows.md @@ -0,0 +1,28 @@ +--- +id: row_getParentRows +title: row_getParentRows +--- + +# Function: row\_getParentRows() + +```ts +function row_getParentRows(row): Row[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\>[] + +## Defined in + +[core/rows/Rows.utils.ts:76](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.utils.ts#L76) diff --git a/docs/reference/functions/row_getpinnedindex.md b/docs/reference/functions/row_getpinnedindex.md new file mode 100644 index 0000000000..2b459b1b66 --- /dev/null +++ b/docs/reference/functions/row_getpinnedindex.md @@ -0,0 +1,28 @@ +--- +id: row_getPinnedIndex +title: row_getPinnedIndex +--- + +# Function: row\_getPinnedIndex() + +```ts +function row_getPinnedIndex(row): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`number` + +## Defined in + +[features/row-pinning/RowPinning.utils.ts:135](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.utils.ts#L135) diff --git a/docs/reference/functions/row_getrightvisiblecells.md b/docs/reference/functions/row_getrightvisiblecells.md new file mode 100644 index 0000000000..312040182a --- /dev/null +++ b/docs/reference/functions/row_getrightvisiblecells.md @@ -0,0 +1,28 @@ +--- +id: row_getRightVisibleCells +title: row_getRightVisibleCells +--- + +# Function: row\_getRightVisibleCells() + +```ts +function row_getRightVisibleCells(row): Cell_Cell & UnionToIntersection<"ColumnGrouping" extends keyof TFeatures ? Cell_ColumnGrouping : never> & object[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Cell_Cell`](../interfaces/cell_cell.md)\<`TFeatures`, `TData`, `unknown`\> & [`UnionToIntersection`](../type-aliases/uniontointersection.md)\<`"ColumnGrouping"` *extends* keyof `TFeatures` ? [`Cell_ColumnGrouping`](../interfaces/cell_columngrouping.md) : `never`\> & `object`[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:144](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L144) diff --git a/docs/reference/functions/row_gettoggleexpandedhandler.md b/docs/reference/functions/row_gettoggleexpandedhandler.md new file mode 100644 index 0000000000..7acbc995fa --- /dev/null +++ b/docs/reference/functions/row_gettoggleexpandedhandler.md @@ -0,0 +1,32 @@ +--- +id: row_getToggleExpandedHandler +title: row_getToggleExpandedHandler +--- + +# Function: row\_getToggleExpandedHandler() + +```ts +function row_getToggleExpandedHandler(row): () => void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`Function` + +### Returns + +`void` + +## Defined in + +[features/row-expanding/RowExpanding.utils.ts:194](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.utils.ts#L194) diff --git a/docs/reference/functions/row_gettoggleselectedhandler.md b/docs/reference/functions/row_gettoggleselectedhandler.md new file mode 100644 index 0000000000..6ffcd2c541 --- /dev/null +++ b/docs/reference/functions/row_gettoggleselectedhandler.md @@ -0,0 +1,36 @@ +--- +id: row_getToggleSelectedHandler +title: row_getToggleSelectedHandler +--- + +# Function: row\_getToggleSelectedHandler() + +```ts +function row_getToggleSelectedHandler(row): (e) => void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`Function` + +### Parameters + +• **e**: `unknown` + +### Returns + +`void` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:333](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L333) diff --git a/docs/reference/functions/row_getuniquevalues.md b/docs/reference/functions/row_getuniquevalues.md new file mode 100644 index 0000000000..f9a125ff43 --- /dev/null +++ b/docs/reference/functions/row_getuniquevalues.md @@ -0,0 +1,30 @@ +--- +id: row_getUniqueValues +title: row_getUniqueValues +--- + +# Function: row\_getUniqueValues() + +```ts +function row_getUniqueValues(row, columnId): unknown +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +• **columnId**: `string` + +## Returns + +`unknown` + +## Defined in + +[core/rows/Rows.utils.ts:28](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.utils.ts#L28) diff --git a/docs/reference/functions/row_getvalue.md b/docs/reference/functions/row_getvalue.md new file mode 100644 index 0000000000..58870fb2f8 --- /dev/null +++ b/docs/reference/functions/row_getvalue.md @@ -0,0 +1,30 @@ +--- +id: row_getValue +title: row_getValue +--- + +# Function: row\_getValue() + +```ts +function row_getValue(row, columnId): unknown +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +• **columnId**: `string` + +## Returns + +`unknown` + +## Defined in + +[core/rows/Rows.utils.ts:9](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.utils.ts#L9) diff --git a/docs/reference/functions/row_getvisiblecells.md b/docs/reference/functions/row_getvisiblecells.md new file mode 100644 index 0000000000..23e8fb24fc --- /dev/null +++ b/docs/reference/functions/row_getvisiblecells.md @@ -0,0 +1,35 @@ +--- +id: row_getVisibleCells +title: row_getVisibleCells +--- + +# Function: row\_getVisibleCells() + +```ts +function row_getVisibleCells( + left, + center, + right): Cell[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **left**: [`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `unknown`\>[] + +• **center**: [`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `unknown`\>[] + +• **right**: [`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Returns + +[`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-visibility/ColumnVisibility.utils.ts:112](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.utils.ts#L112) diff --git a/docs/reference/functions/row_pin.md b/docs/reference/functions/row_pin.md new file mode 100644 index 0000000000..c0e2ba3794 --- /dev/null +++ b/docs/reference/functions/row_pin.md @@ -0,0 +1,38 @@ +--- +id: row_pin +title: row_pin +--- + +# Function: row\_pin() + +```ts +function row_pin( + row, + position, + includeLeafRows?, + includeParentRows?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +• **position**: [`RowPinningPosition`](../type-aliases/rowpinningposition.md) + +• **includeLeafRows?**: `boolean` + +• **includeParentRows?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/row-pinning/RowPinning.utils.ts:151](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.utils.ts#L151) diff --git a/docs/reference/functions/row_rendervalue.md b/docs/reference/functions/row_rendervalue.md new file mode 100644 index 0000000000..d30ba959f8 --- /dev/null +++ b/docs/reference/functions/row_rendervalue.md @@ -0,0 +1,30 @@ +--- +id: row_renderValue +title: row_renderValue +--- + +# Function: row\_renderValue() + +```ts +function row_renderValue(row, columnId): any +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +• **columnId**: `string` + +## Returns + +`any` + +## Defined in + +[core/rows/Rows.utils.ts:55](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.utils.ts#L55) diff --git a/docs/reference/functions/row_toggleexpanded.md b/docs/reference/functions/row_toggleexpanded.md new file mode 100644 index 0000000000..2870f39cc9 --- /dev/null +++ b/docs/reference/functions/row_toggleexpanded.md @@ -0,0 +1,30 @@ +--- +id: row_toggleExpanded +title: row_toggleExpanded +--- + +# Function: row\_toggleExpanded() + +```ts +function row_toggleExpanded(row, expanded?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +• **expanded?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/row-expanding/RowExpanding.utils.ts:122](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.utils.ts#L122) diff --git a/docs/reference/functions/row_toggleselected.md b/docs/reference/functions/row_toggleselected.md new file mode 100644 index 0000000000..cd19b9591a --- /dev/null +++ b/docs/reference/functions/row_toggleselected.md @@ -0,0 +1,37 @@ +--- +id: row_toggleSelected +title: row_toggleSelected +--- + +# Function: row\_toggleSelected() + +```ts +function row_toggleSelected( + row, + value?, + opts?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +• **value?**: `boolean` + +• **opts?** + +• **opts.selectChildren?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:243](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L243) diff --git a/docs/reference/functions/selectrowsfn.md b/docs/reference/functions/selectrowsfn.md new file mode 100644 index 0000000000..49b36f5cff --- /dev/null +++ b/docs/reference/functions/selectrowsfn.md @@ -0,0 +1,28 @@ +--- +id: selectRowsFn +title: selectRowsFn +--- + +# Function: selectRowsFn() + +```ts +function selectRowsFn(rowModel): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **rowModel**: [`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/row-selection/RowSelection.utils.ts:378](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L378) diff --git a/docs/reference/functions/shouldautoremovefilter.md b/docs/reference/functions/shouldautoremovefilter.md new file mode 100644 index 0000000000..4da74bfd3e --- /dev/null +++ b/docs/reference/functions/shouldautoremovefilter.md @@ -0,0 +1,37 @@ +--- +id: shouldAutoRemoveFilter +title: shouldAutoRemoveFilter +--- + +# Function: shouldAutoRemoveFilter() + +```ts +function shouldAutoRemoveFilter( + filterFn?, + value?, + column?): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +## Parameters + +• **filterFn?**: [`FilterFn`](../interfaces/filterfn.md)\<`TFeatures`, `TData`\> + +• **value?**: `any` + +• **column?**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`boolean` + +## Defined in + +[features/column-filtering/ColumnFiltering.utils.ts:210](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.utils.ts#L210) diff --git a/docs/reference/functions/sortingfn_alphanumeric.md b/docs/reference/functions/sortingfn_alphanumeric.md new file mode 100644 index 0000000000..259b953131 --- /dev/null +++ b/docs/reference/functions/sortingfn_alphanumeric.md @@ -0,0 +1,29 @@ +--- +id: sortingFn_alphanumeric +title: sortingFn_alphanumeric +--- + +# Function: sortingFn\_alphanumeric() + +```ts +function sortingFn_alphanumeric( + rowA, + rowB, + columnId): number +``` + +## Parameters + +• **rowA**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **rowB**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **columnId**: `string` + +## Returns + +`number` + +## Defined in + +[fns/sortingFns.ts:8](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortingFns.ts#L8) diff --git a/docs/reference/functions/sortingfn_alphanumericcasesensitive.md b/docs/reference/functions/sortingfn_alphanumericcasesensitive.md new file mode 100644 index 0000000000..67487fff26 --- /dev/null +++ b/docs/reference/functions/sortingfn_alphanumericcasesensitive.md @@ -0,0 +1,29 @@ +--- +id: sortingFn_alphanumericCaseSensitive +title: sortingFn_alphanumericCaseSensitive +--- + +# Function: sortingFn\_alphanumericCaseSensitive() + +```ts +function sortingFn_alphanumericCaseSensitive( + rowA, + rowB, + columnId): number +``` + +## Parameters + +• **rowA**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **rowB**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **columnId**: `string` + +## Returns + +`number` + +## Defined in + +[fns/sortingFns.ts:22](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortingFns.ts#L22) diff --git a/docs/reference/functions/sortingfn_basic.md b/docs/reference/functions/sortingfn_basic.md new file mode 100644 index 0000000000..b37efa40c6 --- /dev/null +++ b/docs/reference/functions/sortingfn_basic.md @@ -0,0 +1,29 @@ +--- +id: sortingFn_basic +title: sortingFn_basic +--- + +# Function: sortingFn\_basic() + +```ts +function sortingFn_basic( + rowA, + rowB, + columnId): number +``` + +## Parameters + +• **rowA**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **rowB**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **columnId**: `string` + +## Returns + +`number` + +## Defined in + +[fns/sortingFns.ts:85](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortingFns.ts#L85) diff --git a/docs/reference/functions/sortingfn_datetime.md b/docs/reference/functions/sortingfn_datetime.md new file mode 100644 index 0000000000..567a2c5928 --- /dev/null +++ b/docs/reference/functions/sortingfn_datetime.md @@ -0,0 +1,29 @@ +--- +id: sortingFn_datetime +title: sortingFn_datetime +--- + +# Function: sortingFn\_datetime() + +```ts +function sortingFn_datetime( + rowA, + rowB, + columnId): number +``` + +## Parameters + +• **rowA**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **rowB**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **columnId**: `string` + +## Returns + +`number` + +## Defined in + +[fns/sortingFns.ts:68](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortingFns.ts#L68) diff --git a/docs/reference/functions/sortingfn_text.md b/docs/reference/functions/sortingfn_text.md new file mode 100644 index 0000000000..d25c4620f3 --- /dev/null +++ b/docs/reference/functions/sortingfn_text.md @@ -0,0 +1,29 @@ +--- +id: sortingFn_text +title: sortingFn_text +--- + +# Function: sortingFn\_text() + +```ts +function sortingFn_text( + rowA, + rowB, + columnId): number +``` + +## Parameters + +• **rowA**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **rowB**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **columnId**: `string` + +## Returns + +`number` + +## Defined in + +[fns/sortingFns.ts:38](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortingFns.ts#L38) diff --git a/docs/reference/functions/sortingfn_textcasesensitive.md b/docs/reference/functions/sortingfn_textcasesensitive.md new file mode 100644 index 0000000000..c486dd4fb4 --- /dev/null +++ b/docs/reference/functions/sortingfn_textcasesensitive.md @@ -0,0 +1,29 @@ +--- +id: sortingFn_textCaseSensitive +title: sortingFn_textCaseSensitive +--- + +# Function: sortingFn\_textCaseSensitive() + +```ts +function sortingFn_textCaseSensitive( + rowA, + rowB, + columnId): number +``` + +## Parameters + +• **rowA**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **rowB**: [`Row`](../type-aliases/row.md)\<`any`, `any`\> + +• **columnId**: `string` + +## Returns + +`number` + +## Defined in + +[fns/sortingFns.ts:54](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortingFns.ts#L54) diff --git a/docs/reference/functions/table_autoresetexpanded.md b/docs/reference/functions/table_autoresetexpanded.md new file mode 100644 index 0000000000..8c27a4591a --- /dev/null +++ b/docs/reference/functions/table_autoresetexpanded.md @@ -0,0 +1,28 @@ +--- +id: table_autoResetExpanded +title: table_autoResetExpanded +--- + +# Function: table\_autoResetExpanded() + +```ts +function table_autoResetExpanded(table): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`void` + +## Defined in + +[features/row-expanding/RowExpanding.utils.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.utils.ts#L11) diff --git a/docs/reference/functions/table_autoresetpageindex.md b/docs/reference/functions/table_autoresetpageindex.md new file mode 100644 index 0000000000..6ffd67ef34 --- /dev/null +++ b/docs/reference/functions/table_autoresetpageindex.md @@ -0,0 +1,28 @@ +--- +id: table_autoResetPageIndex +title: table_autoResetPageIndex +--- + +# Function: table\_autoResetPageIndex() + +```ts +function table_autoResetPageIndex(table): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`void` + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L17) diff --git a/docs/reference/functions/table_firstpage.md b/docs/reference/functions/table_firstpage.md new file mode 100644 index 0000000000..3ad939fc2d --- /dev/null +++ b/docs/reference/functions/table_firstpage.md @@ -0,0 +1,28 @@ +--- +id: table_firstPage +title: table_firstPage +--- + +# Function: table\_firstPage() + +```ts +function table_firstPage(table): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`void` + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:173](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L173) diff --git a/docs/reference/functions/table_getallcolumns.md b/docs/reference/functions/table_getallcolumns.md new file mode 100644 index 0000000000..62782128da --- /dev/null +++ b/docs/reference/functions/table_getallcolumns.md @@ -0,0 +1,28 @@ +--- +id: table_getAllColumns +title: table_getAllColumns +--- + +# Function: table\_getAllColumns() + +```ts +function table_getAllColumns(table): Column[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[core/columns/Columns.utils.ts:70](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.utils.ts#L70) diff --git a/docs/reference/functions/table_getallflatcolumns.md b/docs/reference/functions/table_getallflatcolumns.md new file mode 100644 index 0000000000..f7d47ce5b2 --- /dev/null +++ b/docs/reference/functions/table_getallflatcolumns.md @@ -0,0 +1,28 @@ +--- +id: table_getAllFlatColumns +title: table_getAllFlatColumns +--- + +# Function: table\_getAllFlatColumns() + +```ts +function table_getAllFlatColumns(table): Column[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[core/columns/Columns.utils.ts:99](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.utils.ts#L99) diff --git a/docs/reference/functions/table_getallflatcolumnsbyid.md b/docs/reference/functions/table_getallflatcolumnsbyid.md new file mode 100644 index 0000000000..64cdec73cf --- /dev/null +++ b/docs/reference/functions/table_getallflatcolumnsbyid.md @@ -0,0 +1,28 @@ +--- +id: table_getAllFlatColumnsById +title: table_getAllFlatColumnsById +--- + +# Function: table\_getAllFlatColumnsById() + +```ts +function table_getAllFlatColumnsById(table): Record> +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +## Returns + +`Record`\<`string`, [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>\> + +## Defined in + +[core/columns/Columns.utils.ts:106](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.utils.ts#L106) diff --git a/docs/reference/functions/table_getallleafcolumns.md b/docs/reference/functions/table_getallleafcolumns.md new file mode 100644 index 0000000000..77e3db0a03 --- /dev/null +++ b/docs/reference/functions/table_getallleafcolumns.md @@ -0,0 +1,28 @@ +--- +id: table_getAllLeafColumns +title: table_getAllLeafColumns +--- + +# Function: table\_getAllLeafColumns() + +```ts +function table_getAllLeafColumns(table): Column[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[core/columns/Columns.utils.ts:121](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.utils.ts#L121) diff --git a/docs/reference/functions/table_getbottomrows.md b/docs/reference/functions/table_getbottomrows.md new file mode 100644 index 0000000000..7835c41a86 --- /dev/null +++ b/docs/reference/functions/table_getbottomrows.md @@ -0,0 +1,28 @@ +--- +id: table_getBottomRows +title: table_getBottomRows +--- + +# Function: table\_getBottomRows() + +```ts +function table_getBottomRows(table): Row[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\>[] + +## Defined in + +[features/row-pinning/RowPinning.utils.ts:89](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.utils.ts#L89) diff --git a/docs/reference/functions/table_getcannextpage.md b/docs/reference/functions/table_getcannextpage.md new file mode 100644 index 0000000000..41b0733376 --- /dev/null +++ b/docs/reference/functions/table_getcannextpage.md @@ -0,0 +1,28 @@ +--- +id: table_getCanNextPage +title: table_getCanNextPage +--- + +# Function: table\_getCanNextPage() + +```ts +function table_getCanNextPage(table): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:137](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L137) diff --git a/docs/reference/functions/table_getcanpreviouspage.md b/docs/reference/functions/table_getcanpreviouspage.md new file mode 100644 index 0000000000..a771a87f9a --- /dev/null +++ b/docs/reference/functions/table_getcanpreviouspage.md @@ -0,0 +1,28 @@ +--- +id: table_getCanPreviousPage +title: table_getCanPreviousPage +--- + +# Function: table\_getCanPreviousPage() + +```ts +function table_getCanPreviousPage(table): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:130](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L130) diff --git a/docs/reference/functions/table_getcansomerowsexpand.md b/docs/reference/functions/table_getcansomerowsexpand.md new file mode 100644 index 0000000000..48d2f1e914 --- /dev/null +++ b/docs/reference/functions/table_getcansomerowsexpand.md @@ -0,0 +1,28 @@ +--- +id: table_getCanSomeRowsExpand +title: table_getCanSomeRowsExpand +--- + +# Function: table\_getCanSomeRowsExpand() + +```ts +function table_getCanSomeRowsExpand(table): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-expanding/RowExpanding.utils.ts:52](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.utils.ts#L52) diff --git a/docs/reference/functions/table_getcenterflatheaders.md b/docs/reference/functions/table_getcenterflatheaders.md new file mode 100644 index 0000000000..d3c48942e0 --- /dev/null +++ b/docs/reference/functions/table_getcenterflatheaders.md @@ -0,0 +1,28 @@ +--- +id: table_getCenterFlatHeaders +title: table_getCenterFlatHeaders +--- + +# Function: table\_getCenterFlatHeaders() + +```ts +function table_getCenterFlatHeaders(table): Header[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:298](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L298) diff --git a/docs/reference/functions/table_getcenterfootergroups.md b/docs/reference/functions/table_getcenterfootergroups.md new file mode 100644 index 0000000000..6efd073d6b --- /dev/null +++ b/docs/reference/functions/table_getcenterfootergroups.md @@ -0,0 +1,28 @@ +--- +id: table_getCenterFooterGroups +title: table_getCenterFooterGroups +--- + +# Function: table\_getCenterFooterGroups() + +```ts +function table_getCenterFooterGroups(table): HeaderGroup[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`HeaderGroup`](../interfaces/headergroup.md)\<`TFeatures`, `TData`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:264](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L264) diff --git a/docs/reference/functions/table_getcenterheadergroups.md b/docs/reference/functions/table_getcenterheadergroups.md new file mode 100644 index 0000000000..711f094ddf --- /dev/null +++ b/docs/reference/functions/table_getcenterheadergroups.md @@ -0,0 +1,28 @@ +--- +id: table_getCenterHeaderGroups +title: table_getCenterHeaderGroups +--- + +# Function: table\_getCenterHeaderGroups() + +```ts +function table_getCenterHeaderGroups(table): HeaderGroup[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`HeaderGroup`](../interfaces/headergroup.md)\<`TFeatures`, `TData`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:230](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L230) diff --git a/docs/reference/functions/table_getcenterleafcolumns.md b/docs/reference/functions/table_getcenterleafcolumns.md new file mode 100644 index 0000000000..7905f0e791 --- /dev/null +++ b/docs/reference/functions/table_getcenterleafcolumns.md @@ -0,0 +1,28 @@ +--- +id: table_getCenterLeafColumns +title: table_getCenterLeafColumns +--- + +# Function: table\_getCenterLeafColumns() + +```ts +function table_getCenterLeafColumns(table): Column[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:369](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L369) diff --git a/docs/reference/functions/table_getcenterleafheaders.md b/docs/reference/functions/table_getcenterleafheaders.md new file mode 100644 index 0000000000..59ef15853c --- /dev/null +++ b/docs/reference/functions/table_getcenterleafheaders.md @@ -0,0 +1,28 @@ +--- +id: table_getCenterLeafHeaders +title: table_getCenterLeafHeaders +--- + +# Function: table\_getCenterLeafHeaders() + +```ts +function table_getCenterLeafHeaders(table): Header[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:330](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L330) diff --git a/docs/reference/functions/table_getcenterrows.md b/docs/reference/functions/table_getcenterrows.md new file mode 100644 index 0000000000..48d8340a20 --- /dev/null +++ b/docs/reference/functions/table_getcenterrows.md @@ -0,0 +1,28 @@ +--- +id: table_getCenterRows +title: table_getCenterRows +--- + +# Function: table\_getCenterRows() + +```ts +function table_getCenterRows(table): Row[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\>[] + +## Defined in + +[features/row-pinning/RowPinning.utils.ts:96](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.utils.ts#L96) diff --git a/docs/reference/functions/table_getcentertotalsize.md b/docs/reference/functions/table_getcentertotalsize.md new file mode 100644 index 0000000000..9a510c1f4d --- /dev/null +++ b/docs/reference/functions/table_getcentertotalsize.md @@ -0,0 +1,28 @@ +--- +id: table_getCenterTotalSize +title: table_getCenterTotalSize +--- + +# Function: table\_getCenterTotalSize() + +```ts +function table_getCenterTotalSize(table): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`number` + +## Defined in + +[features/column-sizing/ColumnSizing.utils.ts:170](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.utils.ts#L170) diff --git a/docs/reference/functions/table_getcentervisibleleafcolumns.md b/docs/reference/functions/table_getcentervisibleleafcolumns.md new file mode 100644 index 0000000000..2461e325ef --- /dev/null +++ b/docs/reference/functions/table_getcentervisibleleafcolumns.md @@ -0,0 +1,28 @@ +--- +id: table_getCenterVisibleLeafColumns +title: table_getCenterVisibleLeafColumns +--- + +# Function: table\_getCenterVisibleLeafColumns() + +```ts +function table_getCenterVisibleLeafColumns(table): Column[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:399](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L399) diff --git a/docs/reference/functions/table_getcolumn.md b/docs/reference/functions/table_getcolumn.md new file mode 100644 index 0000000000..a9d6581170 --- /dev/null +++ b/docs/reference/functions/table_getcolumn.md @@ -0,0 +1,30 @@ +--- +id: table_getColumn +title: table_getColumn +--- + +# Function: table\_getColumn() + +```ts +function table_getColumn(table, columnId): Column | undefined +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +• **columnId**: `string` + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\> \| `undefined` + +## Defined in + +[core/columns/Columns.utils.ts:131](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.utils.ts#L131) diff --git a/docs/reference/functions/table_getcorerowmodel.md b/docs/reference/functions/table_getcorerowmodel.md new file mode 100644 index 0000000000..71ce7da199 --- /dev/null +++ b/docs/reference/functions/table_getcorerowmodel.md @@ -0,0 +1,28 @@ +--- +id: table_getCoreRowModel +title: table_getCoreRowModel +--- + +# Function: table\_getCoreRowModel() + +```ts +function table_getCoreRowModel(table): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/row-models/RowModels.utils.ts:7](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.utils.ts#L7) diff --git a/docs/reference/functions/table_getdefaultcolumndef.md b/docs/reference/functions/table_getdefaultcolumndef.md new file mode 100644 index 0000000000..00427de1a8 --- /dev/null +++ b/docs/reference/functions/table_getdefaultcolumndef.md @@ -0,0 +1,28 @@ +--- +id: table_getDefaultColumnDef +title: table_getDefaultColumnDef +--- + +# Function: table\_getDefaultColumnDef() + +```ts +function table_getDefaultColumnDef(table): Partial> +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +## Returns + +`Partial`\<[`ColumnDef`](../type-aliases/columndef.md)\<`TFeatures`, `TData`, `unknown`\>\> + +## Defined in + +[core/columns/Columns.utils.ts:41](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.utils.ts#L41) diff --git a/docs/reference/functions/table_getexpandeddepth.md b/docs/reference/functions/table_getexpandeddepth.md new file mode 100644 index 0000000000..dd424ced90 --- /dev/null +++ b/docs/reference/functions/table_getexpandeddepth.md @@ -0,0 +1,28 @@ +--- +id: table_getExpandedDepth +title: table_getExpandedDepth +--- + +# Function: table\_getExpandedDepth() + +```ts +function table_getExpandedDepth(table): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`number` + +## Defined in + +[features/row-expanding/RowExpanding.utils.ts:103](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.utils.ts#L103) diff --git a/docs/reference/functions/table_getexpandedrowmodel.md b/docs/reference/functions/table_getexpandedrowmodel.md new file mode 100644 index 0000000000..2d2677310f --- /dev/null +++ b/docs/reference/functions/table_getexpandedrowmodel.md @@ -0,0 +1,28 @@ +--- +id: table_getExpandedRowModel +title: table_getExpandedRowModel +--- + +# Function: table\_getExpandedRowModel() + +```ts +function table_getExpandedRowModel(table): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/row-models/RowModels.utils.ts:80](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.utils.ts#L80) diff --git a/docs/reference/functions/table_getfilteredrowmodel.md b/docs/reference/functions/table_getfilteredrowmodel.md new file mode 100644 index 0000000000..ec7538cd61 --- /dev/null +++ b/docs/reference/functions/table_getfilteredrowmodel.md @@ -0,0 +1,28 @@ +--- +id: table_getFilteredRowModel +title: table_getFilteredRowModel +--- + +# Function: table\_getFilteredRowModel() + +```ts +function table_getFilteredRowModel(table): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/row-models/RowModels.utils.ts:34](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.utils.ts#L34) diff --git a/docs/reference/functions/table_getfilteredselectedrowmodel.md b/docs/reference/functions/table_getfilteredselectedrowmodel.md new file mode 100644 index 0000000000..ff5cc147bd --- /dev/null +++ b/docs/reference/functions/table_getfilteredselectedrowmodel.md @@ -0,0 +1,28 @@ +--- +id: table_getFilteredSelectedRowModel +title: table_getFilteredSelectedRowModel +--- + +# Function: table\_getFilteredSelectedRowModel() + +```ts +function table_getFilteredSelectedRowModel(table): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/row-selection/RowSelection.utils.ts:111](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L111) diff --git a/docs/reference/functions/table_getflatheaders.md b/docs/reference/functions/table_getflatheaders.md new file mode 100644 index 0000000000..4b6fcd55db --- /dev/null +++ b/docs/reference/functions/table_getflatheaders.md @@ -0,0 +1,28 @@ +--- +id: table_getFlatHeaders +title: table_getFlatHeaders +--- + +# Function: table\_getFlatHeaders() + +```ts +function table_getFlatHeaders(table): Header[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[core/headers/Headers.utils.ts:84](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.utils.ts#L84) diff --git a/docs/reference/functions/table_getfootergroups.md b/docs/reference/functions/table_getfootergroups.md new file mode 100644 index 0000000000..bcc9cac126 --- /dev/null +++ b/docs/reference/functions/table_getfootergroups.md @@ -0,0 +1,28 @@ +--- +id: table_getFooterGroups +title: table_getFooterGroups +--- + +# Function: table\_getFooterGroups() + +```ts +function table_getFooterGroups(table): HeaderGroup[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +## Returns + +[`HeaderGroup`](../interfaces/headergroup.md)\<`TFeatures`, `TData`\>[] + +## Defined in + +[core/headers/Headers.utils.ts:76](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.utils.ts#L76) diff --git a/docs/reference/functions/table_getglobalautofilterfn.md b/docs/reference/functions/table_getglobalautofilterfn.md new file mode 100644 index 0000000000..ab96254477 --- /dev/null +++ b/docs/reference/functions/table_getglobalautofilterfn.md @@ -0,0 +1,18 @@ +--- +id: table_getGlobalAutoFilterFn +title: table_getGlobalAutoFilterFn +--- + +# Function: table\_getGlobalAutoFilterFn() + +```ts +function table_getGlobalAutoFilterFn(): FilterFn +``` + +## Returns + +[`FilterFn`](../interfaces/filterfn.md)\<`any`, `any`\> + +## Defined in + +[features/global-filtering/GlobalFiltering.utils.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.utils.ts#L29) diff --git a/docs/reference/functions/table_getglobalfacetedminmaxvalues.md b/docs/reference/functions/table_getglobalfacetedminmaxvalues.md new file mode 100644 index 0000000000..032e7f90e8 --- /dev/null +++ b/docs/reference/functions/table_getglobalfacetedminmaxvalues.md @@ -0,0 +1,32 @@ +--- +id: table_getGlobalFacetedMinMaxValues +title: table_getGlobalFacetedMinMaxValues +--- + +# Function: table\_getGlobalFacetedMinMaxValues() + +```ts +function table_getGlobalFacetedMinMaxValues(table): () => undefined | [number, number] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`Function` + +### Returns + +`undefined` \| [`number`, `number`] + +## Defined in + +[features/global-faceting/GlobalFaceting.utils.ts:6](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-faceting/GlobalFaceting.utils.ts#L6) diff --git a/docs/reference/functions/table_getglobalfacetedrowmodel.md b/docs/reference/functions/table_getglobalfacetedrowmodel.md new file mode 100644 index 0000000000..a484f00331 --- /dev/null +++ b/docs/reference/functions/table_getglobalfacetedrowmodel.md @@ -0,0 +1,32 @@ +--- +id: table_getGlobalFacetedRowModel +title: table_getGlobalFacetedRowModel +--- + +# Function: table\_getGlobalFacetedRowModel() + +```ts +function table_getGlobalFacetedRowModel(table): () => RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`Function` + +### Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/global-faceting/GlobalFaceting.utils.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-faceting/GlobalFaceting.utils.ts#L16) diff --git a/docs/reference/functions/table_getglobalfaceteduniquevalues.md b/docs/reference/functions/table_getglobalfaceteduniquevalues.md new file mode 100644 index 0000000000..df9449cde6 --- /dev/null +++ b/docs/reference/functions/table_getglobalfaceteduniquevalues.md @@ -0,0 +1,32 @@ +--- +id: table_getGlobalFacetedUniqueValues +title: table_getGlobalFacetedUniqueValues +--- + +# Function: table\_getGlobalFacetedUniqueValues() + +```ts +function table_getGlobalFacetedUniqueValues(table): () => Map +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`Function` + +### Returns + +`Map`\<`any`, `number`\> + +## Defined in + +[features/global-faceting/GlobalFaceting.utils.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-faceting/GlobalFaceting.utils.ts#L26) diff --git a/docs/reference/functions/table_getglobalfilterfn.md b/docs/reference/functions/table_getglobalfilterfn.md new file mode 100644 index 0000000000..a80d9f4bfe --- /dev/null +++ b/docs/reference/functions/table_getglobalfilterfn.md @@ -0,0 +1,28 @@ +--- +id: table_getGlobalFilterFn +title: table_getGlobalFilterFn +--- + +# Function: table\_getGlobalFilterFn() + +```ts +function table_getGlobalFilterFn(table): FilterFn | FilterFn | undefined +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`FilterFn`](../interfaces/filterfn.md)\<`TFeatures`, `TData`\> \| [`FilterFn`](../interfaces/filterfn.md)\<`TFeatures`, `TData`\> \| `undefined` + +## Defined in + +[features/global-filtering/GlobalFiltering.utils.ts:33](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.utils.ts#L33) diff --git a/docs/reference/functions/table_getgroupedrowmodel.md b/docs/reference/functions/table_getgroupedrowmodel.md new file mode 100644 index 0000000000..e2692b937f --- /dev/null +++ b/docs/reference/functions/table_getgroupedrowmodel.md @@ -0,0 +1,28 @@ +--- +id: table_getGroupedRowModel +title: table_getGroupedRowModel +--- + +# Function: table\_getGroupedRowModel() + +```ts +function table_getGroupedRowModel(table): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/row-models/RowModels.utils.ts:57](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.utils.ts#L57) diff --git a/docs/reference/functions/table_getgroupedselectedrowmodel.md b/docs/reference/functions/table_getgroupedselectedrowmodel.md new file mode 100644 index 0000000000..ec84bdda51 --- /dev/null +++ b/docs/reference/functions/table_getgroupedselectedrowmodel.md @@ -0,0 +1,28 @@ +--- +id: table_getGroupedSelectedRowModel +title: table_getGroupedSelectedRowModel +--- + +# Function: table\_getGroupedSelectedRowModel() + +```ts +function table_getGroupedSelectedRowModel(table): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/row-selection/RowSelection.utils.ts:128](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L128) diff --git a/docs/reference/functions/table_getheadergroups.md b/docs/reference/functions/table_getheadergroups.md new file mode 100644 index 0000000000..7b9ed34f7c --- /dev/null +++ b/docs/reference/functions/table_getheadergroups.md @@ -0,0 +1,28 @@ +--- +id: table_getHeaderGroups +title: table_getHeaderGroups +--- + +# Function: table\_getHeaderGroups() + +```ts +function table_getHeaderGroups(table): HeaderGroup[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +## Returns + +[`HeaderGroup`](../interfaces/headergroup.md)\<`TFeatures`, `TData`\>[] + +## Defined in + +[core/headers/Headers.utils.ts:46](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.utils.ts#L46) diff --git a/docs/reference/functions/table_getinitialstate.md b/docs/reference/functions/table_getinitialstate.md new file mode 100644 index 0000000000..d79acbb3b4 --- /dev/null +++ b/docs/reference/functions/table_getinitialstate.md @@ -0,0 +1,28 @@ +--- +id: table_getInitialState +title: table_getInitialState +--- + +# Function: table\_getInitialState() + +```ts +function table_getInitialState(table): TableState +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`TableState`](../type-aliases/tablestate.md)\<`TFeatures`\> + +## Defined in + +[core/table/Tables.utils.ts:43](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.utils.ts#L43) diff --git a/docs/reference/functions/table_getisallcolumnsvisible.md b/docs/reference/functions/table_getisallcolumnsvisible.md new file mode 100644 index 0000000000..7481f71703 --- /dev/null +++ b/docs/reference/functions/table_getisallcolumnsvisible.md @@ -0,0 +1,28 @@ +--- +id: table_getIsAllColumnsVisible +title: table_getIsAllColumnsVisible +--- + +# Function: table\_getIsAllColumnsVisible() + +```ts +function table_getIsAllColumnsVisible(table): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/column-visibility/ColumnVisibility.utils.ts:179](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.utils.ts#L179) diff --git a/docs/reference/functions/table_getisallpagerowsselected.md b/docs/reference/functions/table_getisallpagerowsselected.md new file mode 100644 index 0000000000..bb80c17836 --- /dev/null +++ b/docs/reference/functions/table_getisallpagerowsselected.md @@ -0,0 +1,28 @@ +--- +id: table_getIsAllPageRowsSelected +title: table_getIsAllPageRowsSelected +--- + +# Function: table\_getIsAllPageRowsSelected() + +```ts +function table_getIsAllPageRowsSelected(table): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:170](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L170) diff --git a/docs/reference/functions/table_getisallrowsexpanded.md b/docs/reference/functions/table_getisallrowsexpanded.md new file mode 100644 index 0000000000..d2ab40c955 --- /dev/null +++ b/docs/reference/functions/table_getisallrowsexpanded.md @@ -0,0 +1,28 @@ +--- +id: table_getIsAllRowsExpanded +title: table_getIsAllRowsExpanded +--- + +# Function: table\_getIsAllRowsExpanded() + +```ts +function table_getIsAllRowsExpanded(table): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-expanding/RowExpanding.utils.ts:79](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.utils.ts#L79) diff --git a/docs/reference/functions/table_getisallrowsselected.md b/docs/reference/functions/table_getisallrowsselected.md new file mode 100644 index 0000000000..bf7699c386 --- /dev/null +++ b/docs/reference/functions/table_getisallrowsselected.md @@ -0,0 +1,28 @@ +--- +id: table_getIsAllRowsSelected +title: table_getIsAllRowsSelected +--- + +# Function: table\_getIsAllRowsSelected() + +```ts +function table_getIsAllRowsSelected(table): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:145](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L145) diff --git a/docs/reference/functions/table_getissomecolumnspinned.md b/docs/reference/functions/table_getissomecolumnspinned.md new file mode 100644 index 0000000000..fedaba23d3 --- /dev/null +++ b/docs/reference/functions/table_getissomecolumnspinned.md @@ -0,0 +1,30 @@ +--- +id: table_getIsSomeColumnsPinned +title: table_getIsSomeColumnsPinned +--- + +# Function: table\_getIsSomeColumnsPinned() + +```ts +function table_getIsSomeColumnsPinned(table, position?): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **position?**: [`ColumnPinningPosition`](../type-aliases/columnpinningposition.md) + +## Returns + +`boolean` + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:184](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L184) diff --git a/docs/reference/functions/table_getissomecolumnsvisible.md b/docs/reference/functions/table_getissomecolumnsvisible.md new file mode 100644 index 0000000000..a22bffcc64 --- /dev/null +++ b/docs/reference/functions/table_getissomecolumnsvisible.md @@ -0,0 +1,28 @@ +--- +id: table_getIsSomeColumnsVisible +title: table_getIsSomeColumnsVisible +--- + +# Function: table\_getIsSomeColumnsVisible() + +```ts +function table_getIsSomeColumnsVisible(table): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/column-visibility/ColumnVisibility.utils.ts:188](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.utils.ts#L188) diff --git a/docs/reference/functions/table_getissomepagerowsselected.md b/docs/reference/functions/table_getissomepagerowsselected.md new file mode 100644 index 0000000000..727e2f8e2a --- /dev/null +++ b/docs/reference/functions/table_getissomepagerowsselected.md @@ -0,0 +1,28 @@ +--- +id: table_getIsSomePageRowsSelected +title: table_getIsSomePageRowsSelected +--- + +# Function: table\_getIsSomePageRowsSelected() + +```ts +function table_getIsSomePageRowsSelected(table): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:205](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L205) diff --git a/docs/reference/functions/table_getissomerowsexpanded.md b/docs/reference/functions/table_getissomerowsexpanded.md new file mode 100644 index 0000000000..a3e662860a --- /dev/null +++ b/docs/reference/functions/table_getissomerowsexpanded.md @@ -0,0 +1,28 @@ +--- +id: table_getIsSomeRowsExpanded +title: table_getIsSomeRowsExpanded +--- + +# Function: table\_getIsSomeRowsExpanded() + +```ts +function table_getIsSomeRowsExpanded(table): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-expanding/RowExpanding.utils.ts:71](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.utils.ts#L71) diff --git a/docs/reference/functions/table_getissomerowspinned.md b/docs/reference/functions/table_getissomerowspinned.md new file mode 100644 index 0000000000..e59ed0b735 --- /dev/null +++ b/docs/reference/functions/table_getissomerowspinned.md @@ -0,0 +1,30 @@ +--- +id: table_getIsSomeRowsPinned +title: table_getIsSomeRowsPinned +--- + +# Function: table\_getIsSomeRowsPinned() + +```ts +function table_getIsSomeRowsPinned(table, position?): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **position?**: [`RowPinningPosition`](../type-aliases/rowpinningposition.md) + +## Returns + +`boolean` + +## Defined in + +[features/row-pinning/RowPinning.utils.ts:41](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.utils.ts#L41) diff --git a/docs/reference/functions/table_getissomerowsselected.md b/docs/reference/functions/table_getissomerowsselected.md new file mode 100644 index 0000000000..12c24608af --- /dev/null +++ b/docs/reference/functions/table_getissomerowsselected.md @@ -0,0 +1,28 @@ +--- +id: table_getIsSomeRowsSelected +title: table_getIsSomeRowsSelected +--- + +# Function: table\_getIsSomeRowsSelected() + +```ts +function table_getIsSomeRowsSelected(table): boolean +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`boolean` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:192](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L192) diff --git a/docs/reference/functions/table_getleafheaders.md b/docs/reference/functions/table_getleafheaders.md new file mode 100644 index 0000000000..0942d9219e --- /dev/null +++ b/docs/reference/functions/table_getleafheaders.md @@ -0,0 +1,28 @@ +--- +id: table_getLeafHeaders +title: table_getLeafHeaders +--- + +# Function: table\_getLeafHeaders() + +```ts +function table_getLeafHeaders(table): Header[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[core/headers/Headers.utils.ts:96](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.utils.ts#L96) diff --git a/docs/reference/functions/table_getleftflatheaders.md b/docs/reference/functions/table_getleftflatheaders.md new file mode 100644 index 0000000000..950a7de426 --- /dev/null +++ b/docs/reference/functions/table_getleftflatheaders.md @@ -0,0 +1,28 @@ +--- +id: table_getLeftFlatHeaders +title: table_getLeftFlatHeaders +--- + +# Function: table\_getLeftFlatHeaders() + +```ts +function table_getLeftFlatHeaders(table): Header[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:274](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L274) diff --git a/docs/reference/functions/table_getleftfootergroups.md b/docs/reference/functions/table_getleftfootergroups.md new file mode 100644 index 0000000000..1f17c46882 --- /dev/null +++ b/docs/reference/functions/table_getleftfootergroups.md @@ -0,0 +1,28 @@ +--- +id: table_getLeftFooterGroups +title: table_getLeftFooterGroups +--- + +# Function: table\_getLeftFooterGroups() + +```ts +function table_getLeftFooterGroups(table): HeaderGroup[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`HeaderGroup`](../interfaces/headergroup.md)\<`TFeatures`, `TData`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:248](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L248) diff --git a/docs/reference/functions/table_getleftheadergroups.md b/docs/reference/functions/table_getleftheadergroups.md new file mode 100644 index 0000000000..a059d84f21 --- /dev/null +++ b/docs/reference/functions/table_getleftheadergroups.md @@ -0,0 +1,28 @@ +--- +id: table_getLeftHeaderGroups +title: table_getLeftHeaderGroups +--- + +# Function: table\_getLeftHeaderGroups() + +```ts +function table_getLeftHeaderGroups(table): HeaderGroup[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`HeaderGroup`](../interfaces/headergroup.md)\<`TFeatures`, `TData`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:198](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L198) diff --git a/docs/reference/functions/table_getleftleafcolumns.md b/docs/reference/functions/table_getleftleafcolumns.md new file mode 100644 index 0000000000..66ba1b6b97 --- /dev/null +++ b/docs/reference/functions/table_getleftleafcolumns.md @@ -0,0 +1,28 @@ +--- +id: table_getLeftLeafColumns +title: table_getLeftLeafColumns +--- + +# Function: table\_getLeftLeafColumns() + +```ts +function table_getLeftLeafColumns(table): Column[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:341](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L341) diff --git a/docs/reference/functions/table_getleftleafheaders.md b/docs/reference/functions/table_getleftleafheaders.md new file mode 100644 index 0000000000..0d0644384d --- /dev/null +++ b/docs/reference/functions/table_getleftleafheaders.md @@ -0,0 +1,28 @@ +--- +id: table_getLeftLeafHeaders +title: table_getLeftLeafHeaders +--- + +# Function: table\_getLeftLeafHeaders() + +```ts +function table_getLeftLeafHeaders(table): Header[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:312](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L312) diff --git a/docs/reference/functions/table_getlefttotalsize.md b/docs/reference/functions/table_getlefttotalsize.md new file mode 100644 index 0000000000..f0db42956f --- /dev/null +++ b/docs/reference/functions/table_getlefttotalsize.md @@ -0,0 +1,28 @@ +--- +id: table_getLeftTotalSize +title: table_getLeftTotalSize +--- + +# Function: table\_getLeftTotalSize() + +```ts +function table_getLeftTotalSize(table): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`number` + +## Defined in + +[features/column-sizing/ColumnSizing.utils.ts:159](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.utils.ts#L159) diff --git a/docs/reference/functions/table_getleftvisibleleafcolumns.md b/docs/reference/functions/table_getleftvisibleleafcolumns.md new file mode 100644 index 0000000000..96ab69254e --- /dev/null +++ b/docs/reference/functions/table_getleftvisibleleafcolumns.md @@ -0,0 +1,28 @@ +--- +id: table_getLeftVisibleLeafColumns +title: table_getLeftVisibleLeafColumns +--- + +# Function: table\_getLeftVisibleLeafColumns() + +```ts +function table_getLeftVisibleLeafColumns(table): Column[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:381](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L381) diff --git a/docs/reference/functions/table_getordercolumnsfn.md b/docs/reference/functions/table_getordercolumnsfn.md new file mode 100644 index 0000000000..a800299fb6 --- /dev/null +++ b/docs/reference/functions/table_getordercolumnsfn.md @@ -0,0 +1,36 @@ +--- +id: table_getOrderColumnsFn +title: table_getOrderColumnsFn +--- + +# Function: table\_getOrderColumnsFn() + +```ts +function table_getOrderColumnsFn(table): (columns) => Column[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`Function` + +### Parameters + +• **columns**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +### Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-ordering/ColumnOrdering.utils.ts:67](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.utils.ts#L67) diff --git a/docs/reference/functions/table_getpagecount.md b/docs/reference/functions/table_getpagecount.md new file mode 100644 index 0000000000..8a0cb8a391 --- /dev/null +++ b/docs/reference/functions/table_getpagecount.md @@ -0,0 +1,28 @@ +--- +id: table_getPageCount +title: table_getPageCount +--- + +# Function: table\_getPageCount() + +```ts +function table_getPageCount(table): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`number` + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:187](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L187) diff --git a/docs/reference/functions/table_getpageoptions.md b/docs/reference/functions/table_getpageoptions.md new file mode 100644 index 0000000000..7f88d32cae --- /dev/null +++ b/docs/reference/functions/table_getpageoptions.md @@ -0,0 +1,28 @@ +--- +id: table_getPageOptions +title: table_getPageOptions +--- + +# Function: table\_getPageOptions() + +```ts +function table_getPageOptions(table): number[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`number`[] + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:118](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L118) diff --git a/docs/reference/functions/table_getpaginatedrowmodel.md b/docs/reference/functions/table_getpaginatedrowmodel.md new file mode 100644 index 0000000000..de3a33ffdd --- /dev/null +++ b/docs/reference/functions/table_getpaginatedrowmodel.md @@ -0,0 +1,28 @@ +--- +id: table_getPaginatedRowModel +title: table_getPaginatedRowModel +--- + +# Function: table\_getPaginatedRowModel() + +```ts +function table_getPaginatedRowModel(table): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/row-models/RowModels.utils.ts:103](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.utils.ts#L103) diff --git a/docs/reference/functions/table_getpreexpandedrowmodel.md b/docs/reference/functions/table_getpreexpandedrowmodel.md new file mode 100644 index 0000000000..91dab14c21 --- /dev/null +++ b/docs/reference/functions/table_getpreexpandedrowmodel.md @@ -0,0 +1,28 @@ +--- +id: table_getPreExpandedRowModel +title: table_getPreExpandedRowModel +--- + +# Function: table\_getPreExpandedRowModel() + +```ts +function table_getPreExpandedRowModel(table): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/row-models/RowModels.utils.ts:73](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.utils.ts#L73) diff --git a/docs/reference/functions/table_getprefilteredrowmodel.md b/docs/reference/functions/table_getprefilteredrowmodel.md new file mode 100644 index 0000000000..21e28a3107 --- /dev/null +++ b/docs/reference/functions/table_getprefilteredrowmodel.md @@ -0,0 +1,28 @@ +--- +id: table_getPreFilteredRowModel +title: table_getPreFilteredRowModel +--- + +# Function: table\_getPreFilteredRowModel() + +```ts +function table_getPreFilteredRowModel(table): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/row-models/RowModels.utils.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.utils.ts#L27) diff --git a/docs/reference/functions/table_getpregroupedrowmodel.md b/docs/reference/functions/table_getpregroupedrowmodel.md new file mode 100644 index 0000000000..e0dfb65018 --- /dev/null +++ b/docs/reference/functions/table_getpregroupedrowmodel.md @@ -0,0 +1,28 @@ +--- +id: table_getPreGroupedRowModel +title: table_getPreGroupedRowModel +--- + +# Function: table\_getPreGroupedRowModel() + +```ts +function table_getPreGroupedRowModel(table): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/row-models/RowModels.utils.ts:50](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.utils.ts#L50) diff --git a/docs/reference/functions/table_getprepaginatedrowmodel.md b/docs/reference/functions/table_getprepaginatedrowmodel.md new file mode 100644 index 0000000000..ac0eb4e450 --- /dev/null +++ b/docs/reference/functions/table_getprepaginatedrowmodel.md @@ -0,0 +1,28 @@ +--- +id: table_getPrePaginatedRowModel +title: table_getPrePaginatedRowModel +--- + +# Function: table\_getPrePaginatedRowModel() + +```ts +function table_getPrePaginatedRowModel(table): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/row-models/RowModels.utils.ts:96](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.utils.ts#L96) diff --git a/docs/reference/functions/table_getpreselectedrowmodel.md b/docs/reference/functions/table_getpreselectedrowmodel.md new file mode 100644 index 0000000000..60782cdf78 --- /dev/null +++ b/docs/reference/functions/table_getpreselectedrowmodel.md @@ -0,0 +1,28 @@ +--- +id: table_getPreSelectedRowModel +title: table_getPreSelectedRowModel +--- + +# Function: table\_getPreSelectedRowModel() + +```ts +function table_getPreSelectedRowModel(table): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/row-selection/RowSelection.utils.ts:87](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L87) diff --git a/docs/reference/functions/table_getpresortedrowmodel.md b/docs/reference/functions/table_getpresortedrowmodel.md new file mode 100644 index 0000000000..8a536f5321 --- /dev/null +++ b/docs/reference/functions/table_getpresortedrowmodel.md @@ -0,0 +1,28 @@ +--- +id: table_getPreSortedRowModel +title: table_getPreSortedRowModel +--- + +# Function: table\_getPreSortedRowModel() + +```ts +function table_getPreSortedRowModel(table): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/row-models/RowModels.utils.ts:119](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.utils.ts#L119) diff --git a/docs/reference/functions/table_getrightflatheaders.md b/docs/reference/functions/table_getrightflatheaders.md new file mode 100644 index 0000000000..55c3d6779c --- /dev/null +++ b/docs/reference/functions/table_getrightflatheaders.md @@ -0,0 +1,28 @@ +--- +id: table_getRightFlatHeaders +title: table_getRightFlatHeaders +--- + +# Function: table\_getRightFlatHeaders() + +```ts +function table_getRightFlatHeaders(table): Header[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:286](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L286) diff --git a/docs/reference/functions/table_getrightfootergroups.md b/docs/reference/functions/table_getrightfootergroups.md new file mode 100644 index 0000000000..09de612afb --- /dev/null +++ b/docs/reference/functions/table_getrightfootergroups.md @@ -0,0 +1,28 @@ +--- +id: table_getRightFooterGroups +title: table_getRightFooterGroups +--- + +# Function: table\_getRightFooterGroups() + +```ts +function table_getRightFooterGroups(table): HeaderGroup[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`HeaderGroup`](../interfaces/headergroup.md)\<`TFeatures`, `TData`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:256](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L256) diff --git a/docs/reference/functions/table_getrightheadergroups.md b/docs/reference/functions/table_getrightheadergroups.md new file mode 100644 index 0000000000..5f589e0a4d --- /dev/null +++ b/docs/reference/functions/table_getrightheadergroups.md @@ -0,0 +1,28 @@ +--- +id: table_getRightHeaderGroups +title: table_getRightHeaderGroups +--- + +# Function: table\_getRightHeaderGroups() + +```ts +function table_getRightHeaderGroups(table): HeaderGroup[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`HeaderGroup`](../interfaces/headergroup.md)\<`TFeatures`, `TData`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:214](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L214) diff --git a/docs/reference/functions/table_getrightleafcolumns.md b/docs/reference/functions/table_getrightleafcolumns.md new file mode 100644 index 0000000000..0bed852137 --- /dev/null +++ b/docs/reference/functions/table_getrightleafcolumns.md @@ -0,0 +1,28 @@ +--- +id: table_getRightLeafColumns +title: table_getRightLeafColumns +--- + +# Function: table\_getRightLeafColumns() + +```ts +function table_getRightLeafColumns(table): Column[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:355](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L355) diff --git a/docs/reference/functions/table_getrightleafheaders.md b/docs/reference/functions/table_getrightleafheaders.md new file mode 100644 index 0000000000..aa24f4ef5c --- /dev/null +++ b/docs/reference/functions/table_getrightleafheaders.md @@ -0,0 +1,28 @@ +--- +id: table_getRightLeafHeaders +title: table_getRightLeafHeaders +--- + +# Function: table\_getRightLeafHeaders() + +```ts +function table_getRightLeafHeaders(table): Header[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:321](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L321) diff --git a/docs/reference/functions/table_getrighttotalsize.md b/docs/reference/functions/table_getrighttotalsize.md new file mode 100644 index 0000000000..89d01bc243 --- /dev/null +++ b/docs/reference/functions/table_getrighttotalsize.md @@ -0,0 +1,28 @@ +--- +id: table_getRightTotalSize +title: table_getRightTotalSize +--- + +# Function: table\_getRightTotalSize() + +```ts +function table_getRightTotalSize(table): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`number` + +## Defined in + +[features/column-sizing/ColumnSizing.utils.ts:181](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.utils.ts#L181) diff --git a/docs/reference/functions/table_getrightvisibleleafcolumns.md b/docs/reference/functions/table_getrightvisibleleafcolumns.md new file mode 100644 index 0000000000..009e2ac0af --- /dev/null +++ b/docs/reference/functions/table_getrightvisibleleafcolumns.md @@ -0,0 +1,28 @@ +--- +id: table_getRightVisibleLeafColumns +title: table_getRightVisibleLeafColumns +--- + +# Function: table\_getRightVisibleLeafColumns() + +```ts +function table_getRightVisibleLeafColumns(table): Column[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:390](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L390) diff --git a/docs/reference/functions/table_getrow.md b/docs/reference/functions/table_getrow.md new file mode 100644 index 0000000000..40eea2ad22 --- /dev/null +++ b/docs/reference/functions/table_getrow.md @@ -0,0 +1,35 @@ +--- +id: table_getRow +title: table_getRow +--- + +# Function: table\_getRow() + +```ts +function table_getRow( + table, + rowId, +searchAll?): Row +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +• **rowId**: `string` + +• **searchAll?**: `boolean` + +## Returns + +[`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/rows/Rows.utils.ts:129](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.utils.ts#L129) diff --git a/docs/reference/functions/table_getrowcount.md b/docs/reference/functions/table_getrowcount.md new file mode 100644 index 0000000000..6628ce40ac --- /dev/null +++ b/docs/reference/functions/table_getrowcount.md @@ -0,0 +1,28 @@ +--- +id: table_getRowCount +title: table_getRowCount +--- + +# Function: table\_getRowCount() + +```ts +function table_getRowCount(table): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`number` + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:200](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L200) diff --git a/docs/reference/functions/table_getrowid.md b/docs/reference/functions/table_getrowid.md new file mode 100644 index 0000000000..2c2cc8c07c --- /dev/null +++ b/docs/reference/functions/table_getrowid.md @@ -0,0 +1,38 @@ +--- +id: table_getRowId +title: table_getRowId +--- + +# Function: table\_getRowId() + +```ts +function table_getRowId( + originalRow, + table, + index, + parent?): string +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **originalRow**: `TData` + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +• **index**: `number` + +• **parent?**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +## Returns + +`string` + +## Defined in + +[core/rows/Rows.utils.ts:114](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.utils.ts#L114) diff --git a/docs/reference/functions/table_getrowmodel.md b/docs/reference/functions/table_getrowmodel.md new file mode 100644 index 0000000000..886d24e99a --- /dev/null +++ b/docs/reference/functions/table_getrowmodel.md @@ -0,0 +1,28 @@ +--- +id: table_getRowModel +title: table_getRowModel +--- + +# Function: table\_getRowModel() + +```ts +function table_getRowModel(table): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/row-models/RowModels.utils.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.utils.ts#L20) diff --git a/docs/reference/functions/table_getselectedrowmodel.md b/docs/reference/functions/table_getselectedrowmodel.md new file mode 100644 index 0000000000..fa2b9345e0 --- /dev/null +++ b/docs/reference/functions/table_getselectedrowmodel.md @@ -0,0 +1,28 @@ +--- +id: table_getSelectedRowModel +title: table_getSelectedRowModel +--- + +# Function: table\_getSelectedRowModel() + +```ts +function table_getSelectedRowModel(table): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[features/row-selection/RowSelection.utils.ts:94](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L94) diff --git a/docs/reference/functions/table_getsortedrowmodel.md b/docs/reference/functions/table_getsortedrowmodel.md new file mode 100644 index 0000000000..383b4c5c44 --- /dev/null +++ b/docs/reference/functions/table_getsortedrowmodel.md @@ -0,0 +1,28 @@ +--- +id: table_getSortedRowModel +title: table_getSortedRowModel +--- + +# Function: table\_getSortedRowModel() + +```ts +function table_getSortedRowModel(table): RowModel +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/row-models/RowModels.utils.ts:126](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.utils.ts#L126) diff --git a/docs/reference/functions/table_getstate.md b/docs/reference/functions/table_getstate.md new file mode 100644 index 0000000000..161ecf746f --- /dev/null +++ b/docs/reference/functions/table_getstate.md @@ -0,0 +1,28 @@ +--- +id: table_getState +title: table_getState +--- + +# Function: table\_getState() + +```ts +function table_getState(table): TableState +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`TableState`](../type-aliases/tablestate.md)\<`TFeatures`\> + +## Defined in + +[core/table/Tables.utils.ts:50](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.utils.ts#L50) diff --git a/docs/reference/functions/table_gettoggleallcolumnsvisibilityhandler.md b/docs/reference/functions/table_gettoggleallcolumnsvisibilityhandler.md new file mode 100644 index 0000000000..91be94028a --- /dev/null +++ b/docs/reference/functions/table_gettoggleallcolumnsvisibilityhandler.md @@ -0,0 +1,36 @@ +--- +id: table_getToggleAllColumnsVisibilityHandler +title: table_getToggleAllColumnsVisibilityHandler +--- + +# Function: table\_getToggleAllColumnsVisibilityHandler() + +```ts +function table_getToggleAllColumnsVisibilityHandler(table): (e) => void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`Function` + +### Parameters + +• **e**: `unknown` + +### Returns + +`void` + +## Defined in + +[features/column-visibility/ColumnVisibility.utils.ts:195](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.utils.ts#L195) diff --git a/docs/reference/functions/table_gettoggleallpagerowsselectedhandler.md b/docs/reference/functions/table_gettoggleallpagerowsselectedhandler.md new file mode 100644 index 0000000000..73cc0c60de --- /dev/null +++ b/docs/reference/functions/table_gettoggleallpagerowsselectedhandler.md @@ -0,0 +1,36 @@ +--- +id: table_getToggleAllPageRowsSelectedHandler +title: table_getToggleAllPageRowsSelectedHandler +--- + +# Function: table\_getToggleAllPageRowsSelectedHandler() + +```ts +function table_getToggleAllPageRowsSelectedHandler(table): (e) => void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`Function` + +### Parameters + +• **e**: `unknown` + +### Returns + +`void` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:229](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L229) diff --git a/docs/reference/functions/table_gettoggleallrowsexpandedhandler.md b/docs/reference/functions/table_gettoggleallrowsexpandedhandler.md new file mode 100644 index 0000000000..05fd56a1e1 --- /dev/null +++ b/docs/reference/functions/table_gettoggleallrowsexpandedhandler.md @@ -0,0 +1,36 @@ +--- +id: table_getToggleAllRowsExpandedHandler +title: table_getToggleAllRowsExpandedHandler +--- + +# Function: table\_getToggleAllRowsExpandedHandler() + +```ts +function table_getToggleAllRowsExpandedHandler(table): (e) => void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`Function` + +### Parameters + +• **e**: `unknown` + +### Returns + +`void` + +## Defined in + +[features/row-expanding/RowExpanding.utils.ts:61](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.utils.ts#L61) diff --git a/docs/reference/functions/table_gettoggleallrowsselectedhandler.md b/docs/reference/functions/table_gettoggleallrowsselectedhandler.md new file mode 100644 index 0000000000..540a79b955 --- /dev/null +++ b/docs/reference/functions/table_gettoggleallrowsselectedhandler.md @@ -0,0 +1,36 @@ +--- +id: table_getToggleAllRowsSelectedHandler +title: table_getToggleAllRowsSelectedHandler +--- + +# Function: table\_getToggleAllRowsSelectedHandler() + +```ts +function table_getToggleAllRowsSelectedHandler(table): (e) => void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`Function` + +### Parameters + +• **e**: `unknown` + +### Returns + +`void` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:217](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L217) diff --git a/docs/reference/functions/table_gettoprows.md b/docs/reference/functions/table_gettoprows.md new file mode 100644 index 0000000000..1ea81c336d --- /dev/null +++ b/docs/reference/functions/table_gettoprows.md @@ -0,0 +1,28 @@ +--- +id: table_getTopRows +title: table_getTopRows +--- + +# Function: table\_getTopRows() + +```ts +function table_getTopRows(table): Row[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\>[] + +## Defined in + +[features/row-pinning/RowPinning.utils.ts:82](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.utils.ts#L82) diff --git a/docs/reference/functions/table_gettotalsize.md b/docs/reference/functions/table_gettotalsize.md new file mode 100644 index 0000000000..f4970f4660 --- /dev/null +++ b/docs/reference/functions/table_gettotalsize.md @@ -0,0 +1,28 @@ +--- +id: table_getTotalSize +title: table_getTotalSize +--- + +# Function: table\_getTotalSize() + +```ts +function table_getTotalSize(table): number +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`number` + +## Defined in + +[features/column-sizing/ColumnSizing.utils.ts:148](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.utils.ts#L148) diff --git a/docs/reference/functions/table_getvisibleflatcolumns.md b/docs/reference/functions/table_getvisibleflatcolumns.md new file mode 100644 index 0000000000..e8b4d14419 --- /dev/null +++ b/docs/reference/functions/table_getvisibleflatcolumns.md @@ -0,0 +1,28 @@ +--- +id: table_getVisibleFlatColumns +title: table_getVisibleFlatColumns +--- + +# Function: table\_getVisibleFlatColumns() + +```ts +function table_getVisibleFlatColumns(table): Column[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-visibility/ColumnVisibility.utils.ts:123](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.utils.ts#L123) diff --git a/docs/reference/functions/table_getvisibleleafcolumns.md b/docs/reference/functions/table_getvisibleleafcolumns.md new file mode 100644 index 0000000000..84483eda87 --- /dev/null +++ b/docs/reference/functions/table_getvisibleleafcolumns.md @@ -0,0 +1,28 @@ +--- +id: table_getVisibleLeafColumns +title: table_getVisibleLeafColumns +--- + +# Function: table\_getVisibleLeafColumns() + +```ts +function table_getVisibleLeafColumns(table): Column[] +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +## Defined in + +[features/column-visibility/ColumnVisibility.utils.ts:132](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.utils.ts#L132) diff --git a/docs/reference/functions/table_lastpage.md b/docs/reference/functions/table_lastpage.md new file mode 100644 index 0000000000..1856ef4355 --- /dev/null +++ b/docs/reference/functions/table_lastpage.md @@ -0,0 +1,28 @@ +--- +id: table_lastPage +title: table_lastPage +--- + +# Function: table\_lastPage() + +```ts +function table_lastPage(table): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`void` + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:180](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L180) diff --git a/docs/reference/functions/table_mergeoptions.md b/docs/reference/functions/table_mergeoptions.md new file mode 100644 index 0000000000..c9371d673a --- /dev/null +++ b/docs/reference/functions/table_mergeoptions.md @@ -0,0 +1,30 @@ +--- +id: table_mergeOptions +title: table_mergeOptions +--- + +# Function: table\_mergeOptions() + +```ts +function table_mergeOptions(table, newOptions): TableOptions +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **newOptions**: [`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\> + +## Returns + +[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\> + +## Defined in + +[core/table/Tables.utils.ts:15](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.utils.ts#L15) diff --git a/docs/reference/functions/table_nextpage.md b/docs/reference/functions/table_nextpage.md new file mode 100644 index 0000000000..dac1b764af --- /dev/null +++ b/docs/reference/functions/table_nextpage.md @@ -0,0 +1,28 @@ +--- +id: table_nextPage +title: table_nextPage +--- + +# Function: table\_nextPage() + +```ts +function table_nextPage(table): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`void` + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:164](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L164) diff --git a/docs/reference/functions/table_previouspage.md b/docs/reference/functions/table_previouspage.md new file mode 100644 index 0000000000..5bd6458025 --- /dev/null +++ b/docs/reference/functions/table_previouspage.md @@ -0,0 +1,28 @@ +--- +id: table_previousPage +title: table_previousPage +--- + +# Function: table\_previousPage() + +```ts +function table_previousPage(table): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`void` + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:157](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L157) diff --git a/docs/reference/functions/table_reset.md b/docs/reference/functions/table_reset.md new file mode 100644 index 0000000000..7dae412678 --- /dev/null +++ b/docs/reference/functions/table_reset.md @@ -0,0 +1,28 @@ +--- +id: table_reset +title: table_reset +--- + +# Function: table\_reset() + +```ts +function table_reset(table): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +## Returns + +`void` + +## Defined in + +[core/table/Tables.utils.ts:8](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.utils.ts#L8) diff --git a/docs/reference/functions/table_resetcolumnfilters.md b/docs/reference/functions/table_resetcolumnfilters.md new file mode 100644 index 0000000000..0832a819f2 --- /dev/null +++ b/docs/reference/functions/table_resetcolumnfilters.md @@ -0,0 +1,30 @@ +--- +id: table_resetColumnFilters +title: table_resetColumnFilters +--- + +# Function: table\_resetColumnFilters() + +```ts +function table_resetColumnFilters(table, defaultState?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **defaultState?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/column-filtering/ColumnFiltering.utils.ts:200](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.utils.ts#L200) diff --git a/docs/reference/functions/table_resetcolumnorder.md b/docs/reference/functions/table_resetcolumnorder.md new file mode 100644 index 0000000000..400ef47f48 --- /dev/null +++ b/docs/reference/functions/table_resetcolumnorder.md @@ -0,0 +1,30 @@ +--- +id: table_resetColumnOrder +title: table_resetColumnOrder +--- + +# Function: table\_resetColumnOrder() + +```ts +function table_resetColumnOrder(table, defaultState?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **defaultState?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/column-ordering/ColumnOrdering.utils.ts:57](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.utils.ts#L57) diff --git a/docs/reference/functions/table_resetcolumnpinning.md b/docs/reference/functions/table_resetcolumnpinning.md new file mode 100644 index 0000000000..5937dafc8b --- /dev/null +++ b/docs/reference/functions/table_resetcolumnpinning.md @@ -0,0 +1,30 @@ +--- +id: table_resetColumnPinning +title: table_resetColumnPinning +--- + +# Function: table\_resetColumnPinning() + +```ts +function table_resetColumnPinning(table, defaultState?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **defaultState?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:171](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L171) diff --git a/docs/reference/functions/table_resetcolumnsizing.md b/docs/reference/functions/table_resetcolumnsizing.md new file mode 100644 index 0000000000..434593dfa5 --- /dev/null +++ b/docs/reference/functions/table_resetcolumnsizing.md @@ -0,0 +1,30 @@ +--- +id: table_resetColumnSizing +title: table_resetColumnSizing +--- + +# Function: table\_resetColumnSizing() + +```ts +function table_resetColumnSizing(table, defaultState?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **defaultState?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/column-sizing/ColumnSizing.utils.ts:138](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.utils.ts#L138) diff --git a/docs/reference/functions/table_resetcolumnvisibility.md b/docs/reference/functions/table_resetcolumnvisibility.md new file mode 100644 index 0000000000..27daa87900 --- /dev/null +++ b/docs/reference/functions/table_resetcolumnvisibility.md @@ -0,0 +1,30 @@ +--- +id: table_resetColumnVisibility +title: table_resetColumnVisibility +--- + +# Function: table\_resetColumnVisibility() + +```ts +function table_resetColumnVisibility(table, defaultState?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **defaultState?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/column-visibility/ColumnVisibility.utils.ts:151](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.utils.ts#L151) diff --git a/docs/reference/functions/table_resetexpanded.md b/docs/reference/functions/table_resetexpanded.md new file mode 100644 index 0000000000..0334a32987 --- /dev/null +++ b/docs/reference/functions/table_resetexpanded.md @@ -0,0 +1,30 @@ +--- +id: table_resetExpanded +title: table_resetExpanded +--- + +# Function: table\_resetExpanded() + +```ts +function table_resetExpanded(table, defaultState?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **defaultState?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/row-expanding/RowExpanding.utils.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.utils.ts#L42) diff --git a/docs/reference/functions/table_resetglobalfilter.md b/docs/reference/functions/table_resetglobalfilter.md new file mode 100644 index 0000000000..566bf5dde9 --- /dev/null +++ b/docs/reference/functions/table_resetglobalfilter.md @@ -0,0 +1,30 @@ +--- +id: table_resetGlobalFilter +title: table_resetGlobalFilter +--- + +# Function: table\_resetGlobalFilter() + +```ts +function table_resetGlobalFilter(table, defaultState?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **defaultState?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/global-filtering/GlobalFiltering.utils.ts:58](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.utils.ts#L58) diff --git a/docs/reference/functions/table_resetgrouping.md b/docs/reference/functions/table_resetgrouping.md new file mode 100644 index 0000000000..c1a5d8b461 --- /dev/null +++ b/docs/reference/functions/table_resetgrouping.md @@ -0,0 +1,30 @@ +--- +id: table_resetGrouping +title: table_resetGrouping +--- + +# Function: table\_resetGrouping() + +```ts +function table_resetGrouping(table, defaultState?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **defaultState?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/column-grouping/ColumnGrouping.utils.ts:145](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts#L145) diff --git a/docs/reference/functions/table_resetheadersizeinfo.md b/docs/reference/functions/table_resetheadersizeinfo.md new file mode 100644 index 0000000000..59988c8b98 --- /dev/null +++ b/docs/reference/functions/table_resetheadersizeinfo.md @@ -0,0 +1,30 @@ +--- +id: table_resetHeaderSizeInfo +title: table_resetHeaderSizeInfo +--- + +# Function: table\_resetHeaderSizeInfo() + +```ts +function table_resetHeaderSizeInfo(table, defaultState?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **defaultState?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/column-resizing/ColumnResizing.utils.ts:239](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.utils.ts#L239) diff --git a/docs/reference/functions/table_resetpageindex.md b/docs/reference/functions/table_resetpageindex.md new file mode 100644 index 0000000000..48d554645f --- /dev/null +++ b/docs/reference/functions/table_resetpageindex.md @@ -0,0 +1,30 @@ +--- +id: table_resetPageIndex +title: table_resetPageIndex +--- + +# Function: table\_resetPageIndex() + +```ts +function table_resetPageIndex(table, defaultState?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **defaultState?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:77](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L77) diff --git a/docs/reference/functions/table_resetpagesize.md b/docs/reference/functions/table_resetpagesize.md new file mode 100644 index 0000000000..0d1bba1548 --- /dev/null +++ b/docs/reference/functions/table_resetpagesize.md @@ -0,0 +1,30 @@ +--- +id: table_resetPageSize +title: table_resetPageSize +--- + +# Function: table\_resetPageSize() + +```ts +function table_resetPageSize(table, defaultState?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **defaultState?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:89](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L89) diff --git a/docs/reference/functions/table_resetpagination.md b/docs/reference/functions/table_resetpagination.md new file mode 100644 index 0000000000..4b34e8e3e4 --- /dev/null +++ b/docs/reference/functions/table_resetpagination.md @@ -0,0 +1,30 @@ +--- +id: table_resetPagination +title: table_resetPagination +--- + +# Function: table\_resetPagination() + +```ts +function table_resetPagination(table, defaultState?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **defaultState?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:43](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L43) diff --git a/docs/reference/functions/table_resetrowpinning.md b/docs/reference/functions/table_resetrowpinning.md new file mode 100644 index 0000000000..ffa254b795 --- /dev/null +++ b/docs/reference/functions/table_resetrowpinning.md @@ -0,0 +1,30 @@ +--- +id: table_resetRowPinning +title: table_resetRowPinning +--- + +# Function: table\_resetRowPinning() + +```ts +function table_resetRowPinning(table, defaultState?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **defaultState?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/row-pinning/RowPinning.utils.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.utils.ts#L27) diff --git a/docs/reference/functions/table_resetrowselection.md b/docs/reference/functions/table_resetrowselection.md new file mode 100644 index 0000000000..9f511e597f --- /dev/null +++ b/docs/reference/functions/table_resetrowselection.md @@ -0,0 +1,30 @@ +--- +id: table_resetRowSelection +title: table_resetRowSelection +--- + +# Function: table\_resetRowSelection() + +```ts +function table_resetRowSelection(table, defaultState?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **defaultState?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:24](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L24) diff --git a/docs/reference/functions/table_resetsorting.md b/docs/reference/functions/table_resetsorting.md new file mode 100644 index 0000000000..2f1a3c2229 --- /dev/null +++ b/docs/reference/functions/table_resetsorting.md @@ -0,0 +1,30 @@ +--- +id: table_resetSorting +title: table_resetSorting +--- + +# Function: table\_resetSorting() + +```ts +function table_resetSorting(table, defaultState?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **defaultState?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/row-sorting/RowSorting.utils.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.utils.ts#L18) diff --git a/docs/reference/functions/table_setcolumnfilters.md b/docs/reference/functions/table_setcolumnfilters.md new file mode 100644 index 0000000000..aadcebbdb5 --- /dev/null +++ b/docs/reference/functions/table_setcolumnfilters.md @@ -0,0 +1,30 @@ +--- +id: table_setColumnFilters +title: table_setColumnFilters +--- + +# Function: table\_setColumnFilters() + +```ts +function table_setColumnFilters(table, updater): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`ColumnFiltersState`](../type-aliases/columnfiltersstate.md)\> + +## Returns + +`void` + +## Defined in + +[features/column-filtering/ColumnFiltering.utils.ts:172](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.utils.ts#L172) diff --git a/docs/reference/functions/table_setcolumnorder.md b/docs/reference/functions/table_setcolumnorder.md new file mode 100644 index 0000000000..6f1887bed3 --- /dev/null +++ b/docs/reference/functions/table_setcolumnorder.md @@ -0,0 +1,30 @@ +--- +id: table_setColumnOrder +title: table_setColumnOrder +--- + +# Function: table\_setColumnOrder() + +```ts +function table_setColumnOrder(table, updater): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`ColumnOrderState`](../type-aliases/columnorderstate.md)\> + +## Returns + +`void` + +## Defined in + +[features/column-ordering/ColumnOrdering.utils.ts:50](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.utils.ts#L50) diff --git a/docs/reference/functions/table_setcolumnpinning.md b/docs/reference/functions/table_setcolumnpinning.md new file mode 100644 index 0000000000..e0c81de558 --- /dev/null +++ b/docs/reference/functions/table_setcolumnpinning.md @@ -0,0 +1,30 @@ +--- +id: table_setColumnPinning +title: table_setColumnPinning +--- + +# Function: table\_setColumnPinning() + +```ts +function table_setColumnPinning(table, updater): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`ColumnPinningState`](../interfaces/columnpinningstate.md)\> + +## Returns + +`void` + +## Defined in + +[features/column-pinning/ColumnPinning.utils.ts:161](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.utils.ts#L161) diff --git a/docs/reference/functions/table_setcolumnresizing.md b/docs/reference/functions/table_setcolumnresizing.md new file mode 100644 index 0000000000..cf4ba3b88f --- /dev/null +++ b/docs/reference/functions/table_setcolumnresizing.md @@ -0,0 +1,30 @@ +--- +id: table_setColumnResizing +title: table_setColumnResizing +--- + +# Function: table\_setColumnResizing() + +```ts +function table_setColumnResizing(table, updater): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`columnResizingState`](../interfaces/columnresizingstate.md)\> + +## Returns + +`void` + +## Defined in + +[features/column-resizing/ColumnResizing.utils.ts:229](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.utils.ts#L229) diff --git a/docs/reference/functions/table_setcolumnsizing.md b/docs/reference/functions/table_setcolumnsizing.md new file mode 100644 index 0000000000..b5c087771e --- /dev/null +++ b/docs/reference/functions/table_setcolumnsizing.md @@ -0,0 +1,30 @@ +--- +id: table_setColumnSizing +title: table_setColumnSizing +--- + +# Function: table\_setColumnSizing() + +```ts +function table_setColumnSizing(table, updater): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`ColumnSizingState`](../type-aliases/columnsizingstate.md)\> + +## Returns + +`void` + +## Defined in + +[features/column-sizing/ColumnSizing.utils.ts:128](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.utils.ts#L128) diff --git a/docs/reference/functions/table_setcolumnvisibility.md b/docs/reference/functions/table_setcolumnvisibility.md new file mode 100644 index 0000000000..9ca6dc4aab --- /dev/null +++ b/docs/reference/functions/table_setcolumnvisibility.md @@ -0,0 +1,30 @@ +--- +id: table_setColumnVisibility +title: table_setColumnVisibility +--- + +# Function: table\_setColumnVisibility() + +```ts +function table_setColumnVisibility(table, updater): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`ColumnVisibilityState`](../type-aliases/columnvisibilitystate.md)\> + +## Returns + +`void` + +## Defined in + +[features/column-visibility/ColumnVisibility.utils.ts:141](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.utils.ts#L141) diff --git a/docs/reference/functions/table_setexpanded.md b/docs/reference/functions/table_setexpanded.md new file mode 100644 index 0000000000..a1d1da342b --- /dev/null +++ b/docs/reference/functions/table_setexpanded.md @@ -0,0 +1,30 @@ +--- +id: table_setExpanded +title: table_setExpanded +--- + +# Function: table\_setExpanded() + +```ts +function table_setExpanded(table, updater): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`ExpandedState`](../type-aliases/expandedstate.md)\> + +## Returns + +`void` + +## Defined in + +[features/row-expanding/RowExpanding.utils.ts:24](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.utils.ts#L24) diff --git a/docs/reference/functions/table_setglobalfilter.md b/docs/reference/functions/table_setglobalfilter.md new file mode 100644 index 0000000000..fcd818fcf3 --- /dev/null +++ b/docs/reference/functions/table_setglobalfilter.md @@ -0,0 +1,30 @@ +--- +id: table_setGlobalFilter +title: table_setGlobalFilter +--- + +# Function: table\_setGlobalFilter() + +```ts +function table_setGlobalFilter(table, updater): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: `any` + +## Returns + +`void` + +## Defined in + +[features/global-filtering/GlobalFiltering.utils.ts:51](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.utils.ts#L51) diff --git a/docs/reference/functions/table_setgrouping.md b/docs/reference/functions/table_setgrouping.md new file mode 100644 index 0000000000..4d20d068d3 --- /dev/null +++ b/docs/reference/functions/table_setgrouping.md @@ -0,0 +1,30 @@ +--- +id: table_setGrouping +title: table_setGrouping +--- + +# Function: table\_setGrouping() + +```ts +function table_setGrouping(table, updater): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`GroupingState`](../type-aliases/groupingstate.md)\> + +## Returns + +`void` + +## Defined in + +[features/column-grouping/ColumnGrouping.utils.ts:138](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.utils.ts#L138) diff --git a/docs/reference/functions/table_setoptions.md b/docs/reference/functions/table_setoptions.md new file mode 100644 index 0000000000..d1ece3cc0e --- /dev/null +++ b/docs/reference/functions/table_setoptions.md @@ -0,0 +1,30 @@ +--- +id: table_setOptions +title: table_setOptions +--- + +# Function: table\_setOptions() + +```ts +function table_setOptions(table, updater): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>\> + +## Returns + +`void` + +## Defined in + +[core/table/Tables.utils.ts:32](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.utils.ts#L32) diff --git a/docs/reference/functions/table_setpageindex.md b/docs/reference/functions/table_setpageindex.md new file mode 100644 index 0000000000..5e94099c24 --- /dev/null +++ b/docs/reference/functions/table_setpageindex.md @@ -0,0 +1,30 @@ +--- +id: table_setPageIndex +title: table_setPageIndex +--- + +# Function: table\_setPageIndex() + +```ts +function table_setPageIndex(table, updater): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: [`Updater`](../type-aliases/updater.md)\<`number`\> + +## Returns + +`void` + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:55](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L55) diff --git a/docs/reference/functions/table_setpagesize.md b/docs/reference/functions/table_setpagesize.md new file mode 100644 index 0000000000..96bd561394 --- /dev/null +++ b/docs/reference/functions/table_setpagesize.md @@ -0,0 +1,30 @@ +--- +id: table_setPageSize +title: table_setPageSize +--- + +# Function: table\_setPageSize() + +```ts +function table_setPageSize(table, updater): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: [`Updater`](../type-aliases/updater.md)\<`number`\> + +## Returns + +`void` + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:101](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L101) diff --git a/docs/reference/functions/table_setpagination.md b/docs/reference/functions/table_setpagination.md new file mode 100644 index 0000000000..1fddc303a4 --- /dev/null +++ b/docs/reference/functions/table_setpagination.md @@ -0,0 +1,30 @@ +--- +id: table_setPagination +title: table_setPagination +--- + +# Function: table\_setPagination() + +```ts +function table_setPagination(table, updater): undefined | void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`PaginationState`](../interfaces/paginationstate.md)\> + +## Returns + +`undefined` \| `void` + +## Defined in + +[features/row-pagination/RowPagination.utils.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.utils.ts#L30) diff --git a/docs/reference/functions/table_setrowpinning.md b/docs/reference/functions/table_setrowpinning.md new file mode 100644 index 0000000000..00e68edbf3 --- /dev/null +++ b/docs/reference/functions/table_setrowpinning.md @@ -0,0 +1,30 @@ +--- +id: table_setRowPinning +title: table_setRowPinning +--- + +# Function: table\_setRowPinning() + +```ts +function table_setRowPinning(table, updater): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`RowPinningState`](../interfaces/rowpinningstate.md)\> + +## Returns + +`void` + +## Defined in + +[features/row-pinning/RowPinning.utils.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.utils.ts#L17) diff --git a/docs/reference/functions/table_setrowselection.md b/docs/reference/functions/table_setrowselection.md new file mode 100644 index 0000000000..34ac6ac2e9 --- /dev/null +++ b/docs/reference/functions/table_setrowselection.md @@ -0,0 +1,30 @@ +--- +id: table_setRowSelection +title: table_setRowSelection +--- + +# Function: table\_setRowSelection() + +```ts +function table_setRowSelection(table, updater): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`RowSelectionState`](../type-aliases/rowselectionstate.md)\> + +## Returns + +`void` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:14](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L14) diff --git a/docs/reference/functions/table_setsorting.md b/docs/reference/functions/table_setsorting.md new file mode 100644 index 0000000000..3e8d66af84 --- /dev/null +++ b/docs/reference/functions/table_setsorting.md @@ -0,0 +1,30 @@ +--- +id: table_setSorting +title: table_setSorting +--- + +# Function: table\_setSorting() + +```ts +function table_setSorting(table, updater): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`SortingState`](../type-aliases/sortingstate.md)\> + +## Returns + +`void` + +## Defined in + +[features/row-sorting/RowSorting.utils.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.utils.ts#L11) diff --git a/docs/reference/functions/table_setstate.md b/docs/reference/functions/table_setstate.md new file mode 100644 index 0000000000..c304af44f4 --- /dev/null +++ b/docs/reference/functions/table_setstate.md @@ -0,0 +1,30 @@ +--- +id: table_setState +title: table_setState +--- + +# Function: table\_setState() + +```ts +function table_setState(table, updater): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`TableState`](../type-aliases/tablestate.md)\<`TFeatures`\>\> + +## Returns + +`void` + +## Defined in + +[core/table/Tables.utils.ts:57](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.utils.ts#L57) diff --git a/docs/reference/functions/table_toggleallcolumnsvisible.md b/docs/reference/functions/table_toggleallcolumnsvisible.md new file mode 100644 index 0000000000..d818219aab --- /dev/null +++ b/docs/reference/functions/table_toggleallcolumnsvisible.md @@ -0,0 +1,30 @@ +--- +id: table_toggleAllColumnsVisible +title: table_toggleAllColumnsVisible +--- + +# Function: table\_toggleAllColumnsVisible() + +```ts +function table_toggleAllColumnsVisible(table, value?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **value?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/column-visibility/ColumnVisibility.utils.ts:161](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.utils.ts#L161) diff --git a/docs/reference/functions/table_toggleallpagerowsselected.md b/docs/reference/functions/table_toggleallpagerowsselected.md new file mode 100644 index 0000000000..d0403f4f27 --- /dev/null +++ b/docs/reference/functions/table_toggleallpagerowsselected.md @@ -0,0 +1,30 @@ +--- +id: table_toggleAllPageRowsSelected +title: table_toggleAllPageRowsSelected +--- + +# Function: table\_toggleAllPageRowsSelected() + +```ts +function table_toggleAllPageRowsSelected(table, value?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **value?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:67](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L67) diff --git a/docs/reference/functions/table_toggleallrowsexpanded.md b/docs/reference/functions/table_toggleallrowsexpanded.md new file mode 100644 index 0000000000..1c611d828a --- /dev/null +++ b/docs/reference/functions/table_toggleallrowsexpanded.md @@ -0,0 +1,30 @@ +--- +id: table_toggleAllRowsExpanded +title: table_toggleAllRowsExpanded +--- + +# Function: table\_toggleAllRowsExpanded() + +```ts +function table_toggleAllRowsExpanded(table, expanded?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **expanded?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/row-expanding/RowExpanding.utils.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.utils.ts#L31) diff --git a/docs/reference/functions/table_toggleallrowsselected.md b/docs/reference/functions/table_toggleallrowsselected.md new file mode 100644 index 0000000000..14d2aca05f --- /dev/null +++ b/docs/reference/functions/table_toggleallrowsselected.md @@ -0,0 +1,30 @@ +--- +id: table_toggleAllRowsSelected +title: table_toggleAllRowsSelected +--- + +# Function: table\_toggleAllRowsSelected() + +```ts +function table_toggleAllRowsSelected(table, value?): void +``` + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Parameters + +• **table**: [`Table_Internal`](../type-aliases/table_internal.md)\<`TFeatures`, `TData`\> + +• **value?**: `boolean` + +## Returns + +`void` + +## Defined in + +[features/row-selection/RowSelection.utils.ts:36](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.utils.ts#L36) diff --git a/docs/reference/functions/tablefeatures.md b/docs/reference/functions/tablefeatures.md new file mode 100644 index 0000000000..bbe8148785 --- /dev/null +++ b/docs/reference/functions/tablefeatures.md @@ -0,0 +1,34 @@ +--- +id: tableFeatures +title: tableFeatures +--- + +# Function: tableFeatures() + +```ts +function tableFeatures(features): TFeatures +``` + +A helper function to help define the features that are to be imported and applied to a table instance. + +Use this utility to make it easier to have the correct type inference for the features that are being imported. + +**Note:** It is recommended to use this utility statically outside of a component. + +## Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +## Parameters + +• **features**: `TFeatures` + +## Returns + +`TFeatures` + +## Example + +## Defined in + +[helpers/tableFeatures.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableFeatures.ts#L18) diff --git a/docs/reference/functions/tablememo.md b/docs/reference/functions/tablememo.md new file mode 100644 index 0000000000..f9631e127d --- /dev/null +++ b/docs/reference/functions/tablememo.md @@ -0,0 +1,38 @@ +--- +id: tableMemo +title: tableMemo +--- + +# Function: tableMemo() + +```ts +function tableMemo(__namedParameters): (depArgs?) => TResult +``` + +## Type Parameters + +• **TDeps** *extends* readonly `any`[] + +• **TDepArgs** + +• **TResult** + +## Parameters + +• **\_\_namedParameters**: `TableMemoOptions`\<`TDeps`, `TDepArgs`, `TResult`\> + +## Returns + +`Function` + +### Parameters + +• **depArgs?**: `TDepArgs` + +### Returns + +`TResult` + +## Defined in + +[utils.ts:126](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L126) diff --git a/docs/reference/functions/tableoptions.md b/docs/reference/functions/tableoptions.md new file mode 100644 index 0000000000..d196716f8f --- /dev/null +++ b/docs/reference/functions/tableoptions.md @@ -0,0 +1,198 @@ +--- +id: tableOptions +title: tableOptions +--- + +# Function: tableOptions() + +## tableOptions(options) + +```ts +function tableOptions(options): Omit, "columns" | "_features"> & object +``` + +### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) = `any` + +### Parameters + +• **options**: `Omit`\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>, `"columns"`\> & `object` + +### Returns + +`Omit`\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>, `"columns"` \| `"_features"`\> & `object` + +### Defined in + +[helpers/tableOptions.ts:5](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L5) + +## tableOptions(options) + +```ts +function tableOptions(options): Omit, "data" | "_features"> & object +``` + +### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) = `any` + +### Parameters + +• **options**: `Omit`\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>, `"data"`\> & `object` + +### Returns + +`Omit`\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>, `"data"` \| `"_features"`\> & `object` + +### Defined in + +[helpers/tableOptions.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L16) + +## tableOptions(options) + +```ts +function tableOptions(options): Omit, "_features"> +``` + +### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) = `any` + +### Parameters + +• **options**: `Omit`\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>, `"_features"`\> + +### Returns + +`Omit`\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>, `"_features"`\> + +### Defined in + +[helpers/tableOptions.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L27) + +## tableOptions(options) + +```ts +function tableOptions(options): Omit, "data" | "columns" | "_features"> & object +``` + +### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) = `any` + +### Parameters + +• **options**: `Omit`\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>, `"data"` \| `"columns"`\> & `object` + +### Returns + +`Omit`\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>, `"data"` \| `"columns"` \| `"_features"`\> & `object` + +### Defined in + +[helpers/tableOptions.ts:34](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L34) + +## tableOptions(options) + +```ts +function tableOptions(options): Omit, "data" | "_features"> +``` + +### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) = `any` + +### Parameters + +• **options**: `Omit`\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>, `"_features"` \| `"data"`\> + +### Returns + +`Omit`\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>, `"data"` \| `"_features"`\> + +### Defined in + +[helpers/tableOptions.ts:45](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L45) + +## tableOptions(options) + +```ts +function tableOptions(options): Omit, "columns" | "_features"> +``` + +### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) = `any` + +### Parameters + +• **options**: `Omit`\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>, `"_features"` \| `"columns"`\> + +### Returns + +`Omit`\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>, `"columns"` \| `"_features"`\> + +### Defined in + +[helpers/tableOptions.ts:52](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L52) + +## tableOptions(options) + +```ts +function tableOptions(options): Omit, "data" | "columns" | "_features"> +``` + +### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) = `any` + +### Parameters + +• **options**: `Omit`\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>, `"_features"` \| `"data"` \| `"columns"`\> + +### Returns + +`Omit`\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>, `"data"` \| `"columns"` \| `"_features"`\> + +### Defined in + +[helpers/tableOptions.ts:59](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L59) + +## tableOptions(options) + +```ts +function tableOptions(options): TableOptions +``` + +### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](../interfaces/tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) = `any` + +### Parameters + +• **options**: [`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\> + +### Returns + +[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\> + +### Defined in + +[helpers/tableOptions.ts:69](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableOptions.ts#L69) diff --git a/docs/reference/index.md b/docs/reference/index.md new file mode 100644 index 0000000000..733624900e --- /dev/null +++ b/docs/reference/index.md @@ -0,0 +1,563 @@ +--- +id: "@tanstack/table-core" +title: "@tanstack/table-core" +--- + +# @tanstack/table-core + +## Interfaces + +- [AggregationFns](interfaces/aggregationfns.md) +- [CachedRowModel\_Core](interfaces/cachedrowmodel_core.md) +- [CachedRowModel\_Expanded](interfaces/cachedrowmodel_expanded.md) +- [CachedRowModel\_Faceted](interfaces/cachedrowmodel_faceted.md) +- [CachedRowModel\_Filtered](interfaces/cachedrowmodel_filtered.md) +- [CachedRowModel\_Grouped](interfaces/cachedrowmodel_grouped.md) +- [CachedRowModel\_Paginated](interfaces/cachedrowmodel_paginated.md) +- [CachedRowModel\_Sorted](interfaces/cachedrowmodel_sorted.md) +- [Cell\_Cell](interfaces/cell_cell.md) +- [Cell\_ColumnGrouping](interfaces/cell_columngrouping.md) +- [Cell\_CoreProperties](interfaces/cell_coreproperties.md) +- [CellContext](interfaces/cellcontext.md) +- [Column\_Column](interfaces/column_column.md) +- [Column\_ColumnFaceting](interfaces/column_columnfaceting.md) +- [Column\_ColumnFiltering](interfaces/column_columnfiltering.md) +- [Column\_ColumnGrouping](interfaces/column_columngrouping.md) +- [Column\_ColumnOrdering](interfaces/column_columnordering.md) +- [Column\_ColumnPinning](interfaces/column_columnpinning.md) +- [Column\_ColumnResizing](interfaces/column_columnresizing.md) +- [Column\_ColumnSizing](interfaces/column_columnsizing.md) +- [Column\_ColumnVisibility](interfaces/column_columnvisibility.md) +- [Column\_CoreProperties](interfaces/column_coreproperties.md) +- [Column\_GlobalFiltering](interfaces/column_globalfiltering.md) +- [Column\_RowSorting](interfaces/column_rowsorting.md) +- [ColumnDef\_ColumnFiltering](interfaces/columndef_columnfiltering.md) +- [ColumnDef\_ColumnGrouping](interfaces/columndef_columngrouping.md) +- [ColumnDef\_ColumnPinning](interfaces/columndef_columnpinning.md) +- [ColumnDef\_ColumnResizing](interfaces/columndef_columnresizing.md) +- [ColumnDef\_ColumnSizing](interfaces/columndef_columnsizing.md) +- [ColumnDef\_ColumnVisibility](interfaces/columndef_columnvisibility.md) +- [ColumnDef\_GlobalFiltering](interfaces/columndef_globalfiltering.md) +- [ColumnDef\_RowSorting](interfaces/columndef_rowsorting.md) +- [ColumnDefaultOptions](interfaces/columndefaultoptions.md) +- [ColumnFilter](interfaces/columnfilter.md) +- [ColumnMeta](interfaces/columnmeta.md) +- [ColumnOrderDefaultOptions](interfaces/columnorderdefaultoptions.md) +- [ColumnPinningDefaultOptions](interfaces/columnpinningdefaultoptions.md) +- [ColumnPinningState](interfaces/columnpinningstate.md) +- [columnResizingState](interfaces/columnresizingstate.md) +- [ColumnSort](interfaces/columnsort.md) +- [CreateRowModel\_Core](interfaces/createrowmodel_core.md) +- [CreateRowModel\_Expanded](interfaces/createrowmodel_expanded.md) +- [CreateRowModel\_Faceted](interfaces/createrowmodel_faceted.md) +- [CreateRowModel\_Filtered](interfaces/createrowmodel_filtered.md) +- [CreateRowModel\_Grouped](interfaces/createrowmodel_grouped.md) +- [CreateRowModel\_Paginated](interfaces/createrowmodel_paginated.md) +- [CreateRowModel\_Sorted](interfaces/createrowmodel_sorted.md) +- [FilterFn](interfaces/filterfn.md) +- [FilterFns](interfaces/filterfns.md) +- [FilterMeta](interfaces/filtermeta.md) +- [Header\_ColumnResizing](interfaces/header_columnresizing.md) +- [Header\_ColumnSizing](interfaces/header_columnsizing.md) +- [Header\_CoreProperties](interfaces/header_coreproperties.md) +- [Header\_Header](interfaces/header_header.md) +- [HeaderContext](interfaces/headercontext.md) +- [HeaderGroup](interfaces/headergroup.md) +- [HeaderGroup\_Core](interfaces/headergroup_core.md) +- [HeaderGroup\_Header](interfaces/headergroup_header.md) +- [IdIdentifier](interfaces/ididentifier.md) +- [PaginationDefaultOptions](interfaces/paginationdefaultoptions.md) +- [PaginationState](interfaces/paginationstate.md) +- [ResolvedColumnFilter](interfaces/resolvedcolumnfilter.md) +- [Row\_ColumnFiltering](interfaces/row_columnfiltering.md) +- [Row\_ColumnGrouping](interfaces/row_columngrouping.md) +- [Row\_ColumnPinning](interfaces/row_columnpinning.md) +- [Row\_ColumnVisibility](interfaces/row_columnvisibility.md) +- [Row\_CoreProperties](interfaces/row_coreproperties.md) +- [Row\_Row](interfaces/row_row.md) +- [Row\_RowExpanding](interfaces/row_rowexpanding.md) +- [Row\_RowPinning](interfaces/row_rowpinning.md) +- [Row\_RowSelection](interfaces/row_rowselection.md) +- [RowModel](interfaces/rowmodel.md) +- [RowPinningDefaultOptions](interfaces/rowpinningdefaultoptions.md) +- [RowPinningState](interfaces/rowpinningstate.md) +- [SortingFn](interfaces/sortingfn.md) +- [SortingFns](interfaces/sortingfns.md) +- [StringHeaderIdentifier](interfaces/stringheaderidentifier.md) +- [Table\_ColumnFiltering](interfaces/table_columnfiltering.md) +- [Table\_ColumnGrouping](interfaces/table_columngrouping.md) +- [Table\_ColumnOrdering](interfaces/table_columnordering.md) +- [Table\_ColumnPinning](interfaces/table_columnpinning.md) +- [Table\_ColumnResizing](interfaces/table_columnresizing.md) +- [Table\_Columns](interfaces/table_columns.md) +- [Table\_ColumnSizing](interfaces/table_columnsizing.md) +- [Table\_ColumnVisibility](interfaces/table_columnvisibility.md) +- [Table\_CoreProperties](interfaces/table_coreproperties.md) +- [Table\_GlobalFaceting](interfaces/table_globalfaceting.md) +- [Table\_GlobalFiltering](interfaces/table_globalfiltering.md) +- [Table\_Headers](interfaces/table_headers.md) +- [Table\_RowExpanding](interfaces/table_rowexpanding.md) +- [Table\_RowModels\_Core](interfaces/table_rowmodels_core.md) +- [Table\_RowModels\_Expanded](interfaces/table_rowmodels_expanded.md) +- [Table\_RowModels\_Faceted](interfaces/table_rowmodels_faceted.md) +- [Table\_RowModels\_Filtered](interfaces/table_rowmodels_filtered.md) +- [Table\_RowModels\_Grouped](interfaces/table_rowmodels_grouped.md) +- [Table\_RowModels\_Paginated](interfaces/table_rowmodels_paginated.md) +- [Table\_RowModels\_Sorted](interfaces/table_rowmodels_sorted.md) +- [Table\_RowPagination](interfaces/table_rowpagination.md) +- [Table\_RowPinning](interfaces/table_rowpinning.md) +- [Table\_Rows](interfaces/table_rows.md) +- [Table\_RowSelection](interfaces/table_rowselection.md) +- [Table\_RowSorting](interfaces/table_rowsorting.md) +- [Table\_Table](interfaces/table_table.md) +- [TableFeature](interfaces/tablefeature.md) +- [TableFns\_ColumnFiltering](interfaces/tablefns_columnfiltering.md) +- [TableFns\_ColumnGrouping](interfaces/tablefns_columngrouping.md) +- [TableFns\_RowSorting](interfaces/tablefns_rowsorting.md) +- [TableMeta](interfaces/tablemeta.md) +- [TableOptions\_Cell](interfaces/tableoptions_cell.md) +- [TableOptions\_ColumnFiltering](interfaces/tableoptions_columnfiltering.md) +- [TableOptions\_ColumnGrouping](interfaces/tableoptions_columngrouping.md) +- [TableOptions\_ColumnOrdering](interfaces/tableoptions_columnordering.md) +- [TableOptions\_ColumnPinning](interfaces/tableoptions_columnpinning.md) +- [TableOptions\_ColumnResizing](interfaces/tableoptions_columnresizing.md) +- [TableOptions\_Columns](interfaces/tableoptions_columns.md) +- [TableOptions\_ColumnSizing](interfaces/tableoptions_columnsizing.md) +- [TableOptions\_ColumnVisibility](interfaces/tableoptions_columnvisibility.md) +- [TableOptions\_Core](interfaces/tableoptions_core.md) +- [TableOptions\_GlobalFiltering](interfaces/tableoptions_globalfiltering.md) +- [TableOptions\_Headers](interfaces/tableoptions_headers.md) +- [TableOptions\_RowExpanding](interfaces/tableoptions_rowexpanding.md) +- [TableOptions\_RowPagination](interfaces/tableoptions_rowpagination.md) +- [TableOptions\_RowPinning](interfaces/tableoptions_rowpinning.md) +- [TableOptions\_Rows](interfaces/tableoptions_rows.md) +- [TableOptions\_RowSelection](interfaces/tableoptions_rowselection.md) +- [TableOptions\_RowSorting](interfaces/tableoptions_rowsorting.md) +- [TableOptions\_Table](interfaces/tableoptions_table.md) +- [TableState\_ColumnFiltering](interfaces/tablestate_columnfiltering.md) +- [TableState\_ColumnGrouping](interfaces/tablestate_columngrouping.md) +- [TableState\_ColumnOrdering](interfaces/tablestate_columnordering.md) +- [TableState\_ColumnPinning](interfaces/tablestate_columnpinning.md) +- [TableState\_ColumnResizing](interfaces/tablestate_columnresizing.md) +- [TableState\_ColumnSizing](interfaces/tablestate_columnsizing.md) +- [TableState\_ColumnVisibility](interfaces/tablestate_columnvisibility.md) +- [TableState\_GlobalFiltering](interfaces/tablestate_globalfiltering.md) +- [TableState\_RowExpanding](interfaces/tablestate_rowexpanding.md) +- [TableState\_RowPagination](interfaces/tablestate_rowpagination.md) +- [TableState\_RowPinning](interfaces/tablestate_rowpinning.md) +- [TableState\_RowSelection](interfaces/tablestate_rowselection.md) +- [TableState\_RowSorting](interfaces/tablestate_rowsorting.md) + +## Type Aliases + +- [\_TableState](type-aliases/tablestate.md) +- [AccessorColumnDef](type-aliases/accessorcolumndef.md) +- [AccessorFn](type-aliases/accessorfn.md) +- [AccessorFnColumnDef](type-aliases/accessorfncolumndef.md) +- [AccessorFnColumnDefBase](type-aliases/accessorfncolumndefbase.md) +- [AccessorKeyColumnDef](type-aliases/accessorkeycolumndef.md) +- [AccessorKeyColumnDefBase](type-aliases/accessorkeycolumndefbase.md) +- [AggregationFn](type-aliases/aggregationfn.md) +- [AggregationFnOption](type-aliases/aggregationfnoption.md) +- [BuiltInAggregationFn](type-aliases/builtinaggregationfn.md) +- [BuiltInFilterFn](type-aliases/builtinfilterfn.md) +- [BuiltInSortingFn](type-aliases/builtinsortingfn.md) +- [CachedRowModel\_All](type-aliases/cachedrowmodel_all.md) +- [CachedRowModels](type-aliases/cachedrowmodels.md) +- [Cell](type-aliases/cell.md) +- [CellData](type-aliases/celldata.md) +- [Column](type-aliases/column.md) +- [Column\_Internal](type-aliases/column_internal.md) +- [ColumnDef](type-aliases/columndef.md) +- [ColumnDefBase](type-aliases/columndefbase.md) +- [ColumnDefBase\_All](type-aliases/columndefbase_all.md) +- [ColumnDefResolved](type-aliases/columndefresolved.md) +- [ColumnDefTemplate](type-aliases/columndeftemplate.md) +- [ColumnFilterAutoRemoveTestFn](type-aliases/columnfilterautoremovetestfn.md) +- [ColumnFiltersState](type-aliases/columnfiltersstate.md) +- [ColumnHelper](type-aliases/columnhelper.md) +- [ColumnOrderState](type-aliases/columnorderstate.md) +- [ColumnPinningPosition](type-aliases/columnpinningposition.md) +- [ColumnResizeDirection](type-aliases/columnresizedirection.md) +- [ColumnResizeMode](type-aliases/columnresizemode.md) +- [ColumnResizingDefaultOptions](type-aliases/columnresizingdefaultoptions.md) +- [ColumnSizingDefaultOptions](type-aliases/columnsizingdefaultoptions.md) +- [ColumnSizingState](type-aliases/columnsizingstate.md) +- [ColumnVisibilityState](type-aliases/columnvisibilitystate.md) +- [CoreTableFeatures](type-aliases/coretablefeatures.md) +- [CreateRowModels](type-aliases/createrowmodels.md) +- [CreateRowModels\_All](type-aliases/createrowmodels_all.md) +- [CustomAggregationFns](type-aliases/customaggregationfns.md) +- [CustomFilterFns](type-aliases/customfilterfns.md) +- [CustomSortingFns](type-aliases/customsortingfns.md) +- [DeepKeys](type-aliases/deepkeys.md) +- [DeepValue](type-aliases/deepvalue.md) +- [DisplayColumnDef](type-aliases/displaycolumndef.md) +- [ExpandedState](type-aliases/expandedstate.md) +- [ExpandedStateList](type-aliases/expandedstatelist.md) +- [FilterFnOption](type-aliases/filterfnoption.md) +- [Getter](type-aliases/getter.md) +- [GroupColumnDef](type-aliases/groupcolumndef.md) +- [GroupingColumnMode](type-aliases/groupingcolumnmode.md) +- [GroupingState](type-aliases/groupingstate.md) +- [Header](type-aliases/header.md) +- [IdentifiedColumnDef](type-aliases/identifiedcolumndef.md) +- [NoInfer](type-aliases/noinfer.md) +- [OnChangeFn](type-aliases/onchangefn.md) +- [PartialKeys](type-aliases/partialkeys.md) +- [RequiredKeys](type-aliases/requiredkeys.md) +- [Row](type-aliases/row.md) +- [Row\_Internal](type-aliases/row_internal.md) +- [RowData](type-aliases/rowdata.md) +- [RowPinningPosition](type-aliases/rowpinningposition.md) +- [RowSelectionState](type-aliases/rowselectionstate.md) +- [SortDirection](type-aliases/sortdirection.md) +- [SortingFnOption](type-aliases/sortingfnoption.md) +- [SortingState](type-aliases/sortingstate.md) +- [StringOrTemplateHeader](type-aliases/stringortemplateheader.md) +- [Table](type-aliases/table.md) +- [Table\_Core](type-aliases/table_core.md) +- [Table\_Internal](type-aliases/table_internal.md) +- [Table\_RowModels](type-aliases/table_rowmodels.md) +- [TableFeatures](type-aliases/tablefeatures.md) +- [TableHelper\_Core](type-aliases/tablehelper_core.md) +- [TableHelperOptions](type-aliases/tablehelperoptions.md) +- [TableOptions](type-aliases/tableoptions.md) +- [TableOptions\_All](type-aliases/tableoptions_all.md) +- [TableState](type-aliases/tablestate.md) +- [TableState\_All](type-aliases/tablestate_all.md) +- [TransformFilterValueFn](type-aliases/transformfiltervaluefn.md) +- [UnionToIntersection](type-aliases/uniontointersection.md) +- [Updater](type-aliases/updater.md) +- [VisibilityDefaultOptions](type-aliases/visibilitydefaultoptions.md) + +## Variables + +- [aggregationFns](variables/aggregationfns.md) +- [Cells](variables/cells.md) +- [ColumnFaceting](variables/columnfaceting.md) +- [ColumnFiltering](variables/columnfiltering.md) +- [ColumnGrouping](variables/columngrouping.md) +- [ColumnOrdering](variables/columnordering.md) +- [ColumnPinning](variables/columnpinning.md) +- [ColumnResizing](variables/columnresizing.md) +- [Columns](variables/columns.md) +- [ColumnSizing](variables/columnsizing.md) +- [ColumnVisibility](variables/columnvisibility.md) +- [coreFeatures](variables/corefeatures.md) +- [filterFns](variables/filterfns.md) +- [GlobalFaceting](variables/globalfaceting.md) +- [GlobalFiltering](variables/globalfiltering.md) +- [Headers](variables/headers.md) +- [isDev](variables/isdev.md) +- [reSplitAlphaNumeric](variables/resplitalphanumeric.md) +- [RowExpanding](variables/rowexpanding.md) +- [RowModels](variables/rowmodels.md) +- [RowPagination](variables/rowpagination.md) +- [RowPinning](variables/rowpinning.md) +- [Rows](variables/rows.md) +- [RowSelection](variables/rowselection.md) +- [RowSorting](variables/rowsorting.md) +- [sortingFns](variables/sortingfns.md) +- [stockFeatures](variables/stockfeatures.md) +- [Tables](variables/tables.md) + +## Functions + +- [\_createExpandedRowModel](functions/createexpandedrowmodel.md) +- [aggregationFn\_count](functions/aggregationfn_count.md) +- [aggregationFn\_extent](functions/aggregationfn_extent.md) +- [aggregationFn\_max](functions/aggregationfn_max.md) +- [aggregationFn\_mean](functions/aggregationfn_mean.md) +- [aggregationFn\_median](functions/aggregationfn_median.md) +- [aggregationFn\_min](functions/aggregationfn_min.md) +- [aggregationFn\_sum](functions/aggregationfn_sum.md) +- [aggregationFn\_unique](functions/aggregationfn_unique.md) +- [aggregationFn\_uniqueCount](functions/aggregationfn_uniquecount.md) +- [assignAPIs](functions/assignapis.md) +- [buildHeaderGroups](functions/buildheadergroups.md) +- [callMemoOrStaticFn](functions/callmemoorstaticfn.md) +- [cell\_getContext](functions/cell_getcontext.md) +- [cell\_getIsAggregated](functions/cell_getisaggregated.md) +- [cell\_getIsGrouped](functions/cell_getisgrouped.md) +- [cell\_getIsPlaceholder](functions/cell_getisplaceholder.md) +- [cell\_getValue](functions/cell_getvalue.md) +- [cell\_renderValue](functions/cell_rendervalue.md) +- [column\_clearSorting](functions/column_clearsorting.md) +- [column\_getAfter](functions/column_getafter.md) +- [column\_getAggregationFn](functions/column_getaggregationfn.md) +- [column\_getAutoAggregationFn](functions/column_getautoaggregationfn.md) +- [column\_getAutoFilterFn](functions/column_getautofilterfn.md) +- [column\_getAutoSortDir](functions/column_getautosortdir.md) +- [column\_getAutoSortingFn](functions/column_getautosortingfn.md) +- [column\_getCanFilter](functions/column_getcanfilter.md) +- [column\_getCanGlobalFilter](functions/column_getcanglobalfilter.md) +- [column\_getCanGroup](functions/column_getcangroup.md) +- [column\_getCanHide](functions/column_getcanhide.md) +- [column\_getCanMultiSort](functions/column_getcanmultisort.md) +- [column\_getCanPin](functions/column_getcanpin.md) +- [column\_getCanResize](functions/column_getcanresize.md) +- [column\_getCanSort](functions/column_getcansort.md) +- [column\_getFacetedMinMaxValues](functions/column_getfacetedminmaxvalues.md) +- [column\_getFacetedRowModel](functions/column_getfacetedrowmodel.md) +- [column\_getFacetedUniqueValues](functions/column_getfaceteduniquevalues.md) +- [column\_getFilterFn](functions/column_getfilterfn.md) +- [column\_getFilterIndex](functions/column_getfilterindex.md) +- [column\_getFilterValue](functions/column_getfiltervalue.md) +- [column\_getFirstSortDir](functions/column_getfirstsortdir.md) +- [column\_getFlatColumns](functions/column_getflatcolumns.md) +- [column\_getGroupedIndex](functions/column_getgroupedindex.md) +- [column\_getIndex](functions/column_getindex.md) +- [column\_getIsFiltered](functions/column_getisfiltered.md) +- [column\_getIsFirstColumn](functions/column_getisfirstcolumn.md) +- [column\_getIsGrouped](functions/column_getisgrouped.md) +- [column\_getIsLastColumn](functions/column_getislastcolumn.md) +- [column\_getIsPinned](functions/column_getispinned.md) +- [column\_getIsResizing](functions/column_getisresizing.md) +- [column\_getIsSorted](functions/column_getissorted.md) +- [column\_getIsVisible](functions/column_getisvisible.md) +- [column\_getLeafColumns](functions/column_getleafcolumns.md) +- [column\_getNextSortingOrder](functions/column_getnextsortingorder.md) +- [column\_getPinnedIndex](functions/column_getpinnedindex.md) +- [column\_getSize](functions/column_getsize.md) +- [column\_getSortIndex](functions/column_getsortindex.md) +- [column\_getSortingFn](functions/column_getsortingfn.md) +- [column\_getStart](functions/column_getstart.md) +- [column\_getToggleGroupingHandler](functions/column_gettogglegroupinghandler.md) +- [column\_getToggleSortingHandler](functions/column_gettogglesortinghandler.md) +- [column\_getToggleVisibilityHandler](functions/column_gettogglevisibilityhandler.md) +- [column\_getVisibleLeafColumns](functions/column_getvisibleleafcolumns.md) +- [column\_pin](functions/column_pin.md) +- [column\_resetSize](functions/column_resetsize.md) +- [column\_setFilterValue](functions/column_setfiltervalue.md) +- [column\_toggleGrouping](functions/column_togglegrouping.md) +- [column\_toggleSorting](functions/column_togglesorting.md) +- [column\_toggleVisibility](functions/column_togglevisibility.md) +- [constructCell](functions/constructcell.md) +- [constructColumn](functions/constructcolumn.md) +- [constructHeader](functions/constructheader.md) +- [constructRow](functions/constructrow.md) +- [constructTable](functions/constructtable.md) +- [constructTableHelper](functions/constructtablehelper.md) +- [createColumnHelper](functions/createcolumnhelper.md) +- [createCoreRowModel](functions/createcorerowmodel.md) +- [createExpandedRowModel](functions/createexpandedrowmodel.md) +- [createFacetedMinMaxValues](functions/createfacetedminmaxvalues.md) +- [createFacetedRowModel](functions/createfacetedrowmodel.md) +- [createFacetedUniqueValues](functions/createfaceteduniquevalues.md) +- [createFilteredRowModel](functions/createfilteredrowmodel.md) +- [createGroupedRowModel](functions/creategroupedrowmodel.md) +- [createPaginatedRowModel](functions/createpaginatedrowmodel.md) +- [createSortedRowModel](functions/createsortedrowmodel.md) +- [expandRows](functions/expandrows.md) +- [filterFn\_arrIncludes](functions/filterfn_arrincludes.md) +- [filterFn\_arrIncludesAll](functions/filterfn_arrincludesall.md) +- [filterFn\_arrIncludesSome](functions/filterfn_arrincludessome.md) +- [filterFn\_equals](functions/filterfn_equals.md) +- [filterFn\_equalsString](functions/filterfn_equalsstring.md) +- [filterFn\_includesString](functions/filterfn_includesstring.md) +- [filterFn\_includesStringSensitive](functions/filterfn_includesstringsensitive.md) +- [filterFn\_inNumberRange](functions/filterfn_innumberrange.md) +- [filterFn\_weakEquals](functions/filterfn_weakequals.md) +- [flattenBy](functions/flattenby.md) +- [functionalUpdate](functions/functionalupdate.md) +- [getDefaultColumnFiltersState](functions/getdefaultcolumnfiltersstate.md) +- [getDefaultColumnOrderState](functions/getdefaultcolumnorderstate.md) +- [getDefaultColumnPinningState](functions/getdefaultcolumnpinningstate.md) +- [getDefaultColumnResizingState](functions/getdefaultcolumnresizingstate.md) +- [getDefaultColumnSizingColumnDef](functions/getdefaultcolumnsizingcolumndef.md) +- [getDefaultColumnSizingState](functions/getdefaultcolumnsizingstate.md) +- [getDefaultColumnVisibilityState](functions/getdefaultcolumnvisibilitystate.md) +- [getDefaultExpandedState](functions/getdefaultexpandedstate.md) +- [getDefaultGroupingState](functions/getdefaultgroupingstate.md) +- [getDefaultPaginationState](functions/getdefaultpaginationstate.md) +- [getDefaultRowPinningState](functions/getdefaultrowpinningstate.md) +- [getDefaultRowSelectionState](functions/getdefaultrowselectionstate.md) +- [getFunctionNameInfo](functions/getfunctionnameinfo.md) +- [getInitialTableState](functions/getinitialtablestate.md) +- [header\_getContext](functions/header_getcontext.md) +- [header\_getLeafHeaders](functions/header_getleafheaders.md) +- [header\_getResizeHandler](functions/header_getresizehandler.md) +- [header\_getSize](functions/header_getsize.md) +- [header\_getStart](functions/header_getstart.md) +- [isFunction](functions/isfunction.md) +- [isNumberArray](functions/isnumberarray.md) +- [isRowSelected](functions/isrowselected.md) +- [isSubRowSelected](functions/issubrowselected.md) +- [isTouchStartEvent](functions/istouchstartevent.md) +- [makeStateUpdater](functions/makestateupdater.md) +- [memo](functions/memo.md) +- [noop](functions/noop.md) +- [orderColumns](functions/ordercolumns.md) +- [passiveEventSupported](functions/passiveeventsupported.md) +- [row\_getAllCells](functions/row_getallcells.md) +- [row\_getAllCellsByColumnId](functions/row_getallcellsbycolumnid.md) +- [row\_getAllVisibleCells](functions/row_getallvisiblecells.md) +- [row\_getCanExpand](functions/row_getcanexpand.md) +- [row\_getCanMultiSelect](functions/row_getcanmultiselect.md) +- [row\_getCanPin](functions/row_getcanpin.md) +- [row\_getCanSelect](functions/row_getcanselect.md) +- [row\_getCanSelectSubRows](functions/row_getcanselectsubrows.md) +- [row\_getCenterVisibleCells](functions/row_getcentervisiblecells.md) +- [row\_getGroupingValue](functions/row_getgroupingvalue.md) +- [row\_getIsAllParentsExpanded](functions/row_getisallparentsexpanded.md) +- [row\_getIsAllSubRowsSelected](functions/row_getisallsubrowsselected.md) +- [row\_getIsExpanded](functions/row_getisexpanded.md) +- [row\_getIsGrouped](functions/row_getisgrouped.md) +- [row\_getIsPinned](functions/row_getispinned.md) +- [row\_getIsSelected](functions/row_getisselected.md) +- [row\_getIsSomeSelected](functions/row_getissomeselected.md) +- [row\_getLeafRows](functions/row_getleafrows.md) +- [row\_getLeftVisibleCells](functions/row_getleftvisiblecells.md) +- [row\_getParentRow](functions/row_getparentrow.md) +- [row\_getParentRows](functions/row_getparentrows.md) +- [row\_getPinnedIndex](functions/row_getpinnedindex.md) +- [row\_getRightVisibleCells](functions/row_getrightvisiblecells.md) +- [row\_getToggleExpandedHandler](functions/row_gettoggleexpandedhandler.md) +- [row\_getToggleSelectedHandler](functions/row_gettoggleselectedhandler.md) +- [row\_getUniqueValues](functions/row_getuniquevalues.md) +- [row\_getValue](functions/row_getvalue.md) +- [row\_getVisibleCells](functions/row_getvisiblecells.md) +- [row\_pin](functions/row_pin.md) +- [row\_renderValue](functions/row_rendervalue.md) +- [row\_toggleExpanded](functions/row_toggleexpanded.md) +- [row\_toggleSelected](functions/row_toggleselected.md) +- [selectRowsFn](functions/selectrowsfn.md) +- [shouldAutoRemoveFilter](functions/shouldautoremovefilter.md) +- [sortingFn\_alphanumeric](functions/sortingfn_alphanumeric.md) +- [sortingFn\_alphanumericCaseSensitive](functions/sortingfn_alphanumericcasesensitive.md) +- [sortingFn\_basic](functions/sortingfn_basic.md) +- [sortingFn\_datetime](functions/sortingfn_datetime.md) +- [sortingFn\_text](functions/sortingfn_text.md) +- [sortingFn\_textCaseSensitive](functions/sortingfn_textcasesensitive.md) +- [table\_autoResetExpanded](functions/table_autoresetexpanded.md) +- [table\_autoResetPageIndex](functions/table_autoresetpageindex.md) +- [table\_firstPage](functions/table_firstpage.md) +- [table\_getAllColumns](functions/table_getallcolumns.md) +- [table\_getAllFlatColumns](functions/table_getallflatcolumns.md) +- [table\_getAllFlatColumnsById](functions/table_getallflatcolumnsbyid.md) +- [table\_getAllLeafColumns](functions/table_getallleafcolumns.md) +- [table\_getBottomRows](functions/table_getbottomrows.md) +- [table\_getCanNextPage](functions/table_getcannextpage.md) +- [table\_getCanPreviousPage](functions/table_getcanpreviouspage.md) +- [table\_getCanSomeRowsExpand](functions/table_getcansomerowsexpand.md) +- [table\_getCenterFlatHeaders](functions/table_getcenterflatheaders.md) +- [table\_getCenterFooterGroups](functions/table_getcenterfootergroups.md) +- [table\_getCenterHeaderGroups](functions/table_getcenterheadergroups.md) +- [table\_getCenterLeafColumns](functions/table_getcenterleafcolumns.md) +- [table\_getCenterLeafHeaders](functions/table_getcenterleafheaders.md) +- [table\_getCenterRows](functions/table_getcenterrows.md) +- [table\_getCenterTotalSize](functions/table_getcentertotalsize.md) +- [table\_getCenterVisibleLeafColumns](functions/table_getcentervisibleleafcolumns.md) +- [table\_getColumn](functions/table_getcolumn.md) +- [table\_getCoreRowModel](functions/table_getcorerowmodel.md) +- [table\_getDefaultColumnDef](functions/table_getdefaultcolumndef.md) +- [table\_getExpandedDepth](functions/table_getexpandeddepth.md) +- [table\_getExpandedRowModel](functions/table_getexpandedrowmodel.md) +- [table\_getFilteredRowModel](functions/table_getfilteredrowmodel.md) +- [table\_getFilteredSelectedRowModel](functions/table_getfilteredselectedrowmodel.md) +- [table\_getFlatHeaders](functions/table_getflatheaders.md) +- [table\_getFooterGroups](functions/table_getfootergroups.md) +- [table\_getGlobalAutoFilterFn](functions/table_getglobalautofilterfn.md) +- [table\_getGlobalFacetedMinMaxValues](functions/table_getglobalfacetedminmaxvalues.md) +- [table\_getGlobalFacetedRowModel](functions/table_getglobalfacetedrowmodel.md) +- [table\_getGlobalFacetedUniqueValues](functions/table_getglobalfaceteduniquevalues.md) +- [table\_getGlobalFilterFn](functions/table_getglobalfilterfn.md) +- [table\_getGroupedRowModel](functions/table_getgroupedrowmodel.md) +- [table\_getGroupedSelectedRowModel](functions/table_getgroupedselectedrowmodel.md) +- [table\_getHeaderGroups](functions/table_getheadergroups.md) +- [table\_getInitialState](functions/table_getinitialstate.md) +- [table\_getIsAllColumnsVisible](functions/table_getisallcolumnsvisible.md) +- [table\_getIsAllPageRowsSelected](functions/table_getisallpagerowsselected.md) +- [table\_getIsAllRowsExpanded](functions/table_getisallrowsexpanded.md) +- [table\_getIsAllRowsSelected](functions/table_getisallrowsselected.md) +- [table\_getIsSomeColumnsPinned](functions/table_getissomecolumnspinned.md) +- [table\_getIsSomeColumnsVisible](functions/table_getissomecolumnsvisible.md) +- [table\_getIsSomePageRowsSelected](functions/table_getissomepagerowsselected.md) +- [table\_getIsSomeRowsExpanded](functions/table_getissomerowsexpanded.md) +- [table\_getIsSomeRowsPinned](functions/table_getissomerowspinned.md) +- [table\_getIsSomeRowsSelected](functions/table_getissomerowsselected.md) +- [table\_getLeafHeaders](functions/table_getleafheaders.md) +- [table\_getLeftFlatHeaders](functions/table_getleftflatheaders.md) +- [table\_getLeftFooterGroups](functions/table_getleftfootergroups.md) +- [table\_getLeftHeaderGroups](functions/table_getleftheadergroups.md) +- [table\_getLeftLeafColumns](functions/table_getleftleafcolumns.md) +- [table\_getLeftLeafHeaders](functions/table_getleftleafheaders.md) +- [table\_getLeftTotalSize](functions/table_getlefttotalsize.md) +- [table\_getLeftVisibleLeafColumns](functions/table_getleftvisibleleafcolumns.md) +- [table\_getOrderColumnsFn](functions/table_getordercolumnsfn.md) +- [table\_getPageCount](functions/table_getpagecount.md) +- [table\_getPageOptions](functions/table_getpageoptions.md) +- [table\_getPaginatedRowModel](functions/table_getpaginatedrowmodel.md) +- [table\_getPreExpandedRowModel](functions/table_getpreexpandedrowmodel.md) +- [table\_getPreFilteredRowModel](functions/table_getprefilteredrowmodel.md) +- [table\_getPreGroupedRowModel](functions/table_getpregroupedrowmodel.md) +- [table\_getPrePaginatedRowModel](functions/table_getprepaginatedrowmodel.md) +- [table\_getPreSelectedRowModel](functions/table_getpreselectedrowmodel.md) +- [table\_getPreSortedRowModel](functions/table_getpresortedrowmodel.md) +- [table\_getRightFlatHeaders](functions/table_getrightflatheaders.md) +- [table\_getRightFooterGroups](functions/table_getrightfootergroups.md) +- [table\_getRightHeaderGroups](functions/table_getrightheadergroups.md) +- [table\_getRightLeafColumns](functions/table_getrightleafcolumns.md) +- [table\_getRightLeafHeaders](functions/table_getrightleafheaders.md) +- [table\_getRightTotalSize](functions/table_getrighttotalsize.md) +- [table\_getRightVisibleLeafColumns](functions/table_getrightvisibleleafcolumns.md) +- [table\_getRow](functions/table_getrow.md) +- [table\_getRowCount](functions/table_getrowcount.md) +- [table\_getRowId](functions/table_getrowid.md) +- [table\_getRowModel](functions/table_getrowmodel.md) +- [table\_getSelectedRowModel](functions/table_getselectedrowmodel.md) +- [table\_getSortedRowModel](functions/table_getsortedrowmodel.md) +- [table\_getState](functions/table_getstate.md) +- [table\_getToggleAllColumnsVisibilityHandler](functions/table_gettoggleallcolumnsvisibilityhandler.md) +- [table\_getToggleAllPageRowsSelectedHandler](functions/table_gettoggleallpagerowsselectedhandler.md) +- [table\_getToggleAllRowsExpandedHandler](functions/table_gettoggleallrowsexpandedhandler.md) +- [table\_getToggleAllRowsSelectedHandler](functions/table_gettoggleallrowsselectedhandler.md) +- [table\_getTopRows](functions/table_gettoprows.md) +- [table\_getTotalSize](functions/table_gettotalsize.md) +- [table\_getVisibleFlatColumns](functions/table_getvisibleflatcolumns.md) +- [table\_getVisibleLeafColumns](functions/table_getvisibleleafcolumns.md) +- [table\_lastPage](functions/table_lastpage.md) +- [table\_mergeOptions](functions/table_mergeoptions.md) +- [table\_nextPage](functions/table_nextpage.md) +- [table\_previousPage](functions/table_previouspage.md) +- [table\_reset](functions/table_reset.md) +- [table\_resetColumnFilters](functions/table_resetcolumnfilters.md) +- [table\_resetColumnOrder](functions/table_resetcolumnorder.md) +- [table\_resetColumnPinning](functions/table_resetcolumnpinning.md) +- [table\_resetColumnSizing](functions/table_resetcolumnsizing.md) +- [table\_resetColumnVisibility](functions/table_resetcolumnvisibility.md) +- [table\_resetExpanded](functions/table_resetexpanded.md) +- [table\_resetGlobalFilter](functions/table_resetglobalfilter.md) +- [table\_resetGrouping](functions/table_resetgrouping.md) +- [table\_resetHeaderSizeInfo](functions/table_resetheadersizeinfo.md) +- [table\_resetPageIndex](functions/table_resetpageindex.md) +- [table\_resetPageSize](functions/table_resetpagesize.md) +- [table\_resetPagination](functions/table_resetpagination.md) +- [table\_resetRowPinning](functions/table_resetrowpinning.md) +- [table\_resetRowSelection](functions/table_resetrowselection.md) +- [table\_resetSorting](functions/table_resetsorting.md) +- [table\_setColumnFilters](functions/table_setcolumnfilters.md) +- [table\_setColumnOrder](functions/table_setcolumnorder.md) +- [table\_setColumnPinning](functions/table_setcolumnpinning.md) +- [table\_setColumnResizing](functions/table_setcolumnresizing.md) +- [table\_setColumnSizing](functions/table_setcolumnsizing.md) +- [table\_setColumnVisibility](functions/table_setcolumnvisibility.md) +- [table\_setExpanded](functions/table_setexpanded.md) +- [table\_setGlobalFilter](functions/table_setglobalfilter.md) +- [table\_setGrouping](functions/table_setgrouping.md) +- [table\_setOptions](functions/table_setoptions.md) +- [table\_setPageIndex](functions/table_setpageindex.md) +- [table\_setPageSize](functions/table_setpagesize.md) +- [table\_setPagination](functions/table_setpagination.md) +- [table\_setRowPinning](functions/table_setrowpinning.md) +- [table\_setRowSelection](functions/table_setrowselection.md) +- [table\_setSorting](functions/table_setsorting.md) +- [table\_setState](functions/table_setstate.md) +- [table\_toggleAllColumnsVisible](functions/table_toggleallcolumnsvisible.md) +- [table\_toggleAllPageRowsSelected](functions/table_toggleallpagerowsselected.md) +- [table\_toggleAllRowsExpanded](functions/table_toggleallrowsexpanded.md) +- [table\_toggleAllRowsSelected](functions/table_toggleallrowsselected.md) +- [tableFeatures](functions/tablefeatures.md) +- [tableMemo](functions/tablememo.md) +- [tableOptions](functions/tableoptions.md) diff --git a/docs/reference/interfaces/aggregationfns.md b/docs/reference/interfaces/aggregationfns.md new file mode 100644 index 0000000000..c716ba51ea --- /dev/null +++ b/docs/reference/interfaces/aggregationfns.md @@ -0,0 +1,6 @@ +--- +id: AggregationFns +title: AggregationFns +--- + +# Interface: AggregationFns diff --git a/docs/reference/interfaces/cachedrowmodel_core.md b/docs/reference/interfaces/cachedrowmodel_core.md new file mode 100644 index 0000000000..5209e5f7f8 --- /dev/null +++ b/docs/reference/interfaces/cachedrowmodel_core.md @@ -0,0 +1,28 @@ +--- +id: CachedRowModel_Core +title: CachedRowModel_Core +--- + +# Interface: CachedRowModel\_Core\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### coreRowModel()? + +```ts +optional coreRowModel: () => RowModel; +``` + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Defined in + +[core/row-models/RowModels.types.ts:39](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.types.ts#L39) diff --git a/docs/reference/interfaces/cachedrowmodel_expanded.md b/docs/reference/interfaces/cachedrowmodel_expanded.md new file mode 100644 index 0000000000..2df7a0485d --- /dev/null +++ b/docs/reference/interfaces/cachedrowmodel_expanded.md @@ -0,0 +1,28 @@ +--- +id: CachedRowModel_Expanded +title: CachedRowModel_Expanded +--- + +# Interface: CachedRowModel\_Expanded\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### expandedRowModel() + +```ts +expandedRowModel: () => RowModel; +``` + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:186](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L186) diff --git a/docs/reference/interfaces/cachedrowmodel_faceted.md b/docs/reference/interfaces/cachedrowmodel_faceted.md new file mode 100644 index 0000000000..62b00972e5 --- /dev/null +++ b/docs/reference/interfaces/cachedrowmodel_faceted.md @@ -0,0 +1,76 @@ +--- +id: CachedRowModel_Faceted +title: CachedRowModel_Faceted +--- + +# Interface: CachedRowModel\_Faceted\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### facetedMinMaxValues()? + +```ts +optional facetedMinMaxValues: (columnId) => [number, number]; +``` + +#### Parameters + +• **columnId**: `string` + +#### Returns + +[`number`, `number`] + +#### Defined in + +[features/column-faceting/ColumnFaceting.types.ts:76](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/ColumnFaceting.types.ts#L76) + +*** + +### facetedRowModel()? + +```ts +optional facetedRowModel: (columnId) => () => RowModel; +``` + +#### Parameters + +• **columnId**: `string` + +#### Returns + +`Function` + +##### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Defined in + +[features/column-faceting/ColumnFaceting.types.ts:75](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/ColumnFaceting.types.ts#L75) + +*** + +### facetedUniqueValues()? + +```ts +optional facetedUniqueValues: (columnId) => Map; +``` + +#### Parameters + +• **columnId**: `string` + +#### Returns + +`Map`\<`any`, `number`\> + +#### Defined in + +[features/column-faceting/ColumnFaceting.types.ts:77](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/ColumnFaceting.types.ts#L77) diff --git a/docs/reference/interfaces/cachedrowmodel_filtered.md b/docs/reference/interfaces/cachedrowmodel_filtered.md new file mode 100644 index 0000000000..5953ef99e3 --- /dev/null +++ b/docs/reference/interfaces/cachedrowmodel_filtered.md @@ -0,0 +1,28 @@ +--- +id: CachedRowModel_Filtered +title: CachedRowModel_Filtered +--- + +# Interface: CachedRowModel\_Filtered\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### filteredRowModel() + +```ts +filteredRowModel: () => RowModel; +``` + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:277](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L277) diff --git a/docs/reference/interfaces/cachedrowmodel_grouped.md b/docs/reference/interfaces/cachedrowmodel_grouped.md new file mode 100644 index 0000000000..6d33c4e212 --- /dev/null +++ b/docs/reference/interfaces/cachedrowmodel_grouped.md @@ -0,0 +1,28 @@ +--- +id: CachedRowModel_Grouped +title: CachedRowModel_Grouped +--- + +# Interface: CachedRowModel\_Grouped\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### groupedRowModel() + +```ts +groupedRowModel: () => RowModel; +``` + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:271](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L271) diff --git a/docs/reference/interfaces/cachedrowmodel_paginated.md b/docs/reference/interfaces/cachedrowmodel_paginated.md new file mode 100644 index 0000000000..f2dc230ae1 --- /dev/null +++ b/docs/reference/interfaces/cachedrowmodel_paginated.md @@ -0,0 +1,28 @@ +--- +id: CachedRowModel_Paginated +title: CachedRowModel_Paginated +--- + +# Interface: CachedRowModel\_Paginated\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### paginatedRowModel() + +```ts +paginatedRowModel: () => RowModel; +``` + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:187](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L187) diff --git a/docs/reference/interfaces/cachedrowmodel_sorted.md b/docs/reference/interfaces/cachedrowmodel_sorted.md new file mode 100644 index 0000000000..b2b4bf634f --- /dev/null +++ b/docs/reference/interfaces/cachedrowmodel_sorted.md @@ -0,0 +1,28 @@ +--- +id: CachedRowModel_Sorted +title: CachedRowModel_Sorted +--- + +# Interface: CachedRowModel\_Sorted\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### sortedRowModel() + +```ts +sortedRowModel: () => RowModel; +``` + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:292](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L292) diff --git a/docs/reference/interfaces/cell_cell.md b/docs/reference/interfaces/cell_cell.md new file mode 100644 index 0000000000..659a417653 --- /dev/null +++ b/docs/reference/interfaces/cell_cell.md @@ -0,0 +1,186 @@ +--- +id: Cell_Cell +title: Cell_Cell +--- + +# Interface: Cell\_Cell\ + +## Extends + +- [`Cell_CoreProperties`](cell_coreproperties.md)\<`TFeatures`, `TData`, `TValue`\> + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* [`CellData`](../type-aliases/celldata.md) = [`CellData`](../type-aliases/celldata.md) + +## Properties + +### column + +```ts +column: Column; +``` + +The associated Column object for the cell. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/cell#column) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/cells) + +#### Inherited from + +[`Cell_CoreProperties`](cell_coreproperties.md).[`column`](Cell_CoreProperties.md#column) + +#### Defined in + +[core/cells/Cells.types.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L31) + +*** + +### getContext() + +```ts +getContext: () => CellContext; +``` + +Returns the rendering context (or props) for cell-based components like cells and aggregated cells. Use these props with your framework's `flexRender` utility to render these using the template of your choice: + +#### Returns + +[`CellContext`](cellcontext.md)\<`TFeatures`, `TData`, `TValue`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/cell#getcontext) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/cells) + +#### Defined in + +[core/cells/Cells.types.ts:60](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L60) + +*** + +### getValue + +```ts +getValue: Getter; +``` + +Returns the value for the cell, accessed via the associated column's accessor key or accessor function. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/cell#getvalue) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/cells) + +#### Defined in + +[core/cells/Cells.types.ts:66](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L66) + +*** + +### id + +```ts +id: string; +``` + +The unique ID for the cell across the entire table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/cell#id) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/cells) + +#### Inherited from + +[`Cell_CoreProperties`](cell_coreproperties.md).[`id`](Cell_CoreProperties.md#id) + +#### Defined in + +[core/cells/Cells.types.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L37) + +*** + +### renderValue + +```ts +renderValue: Getter; +``` + +Renders the value for a cell the same as `getValue`, but will return the `renderFallbackValue` if no value is found. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/cell#rendervalue) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/cells) + +#### Defined in + +[core/cells/Cells.types.ts:72](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L72) + +*** + +### row + +```ts +row: Row; +``` + +The associated Row object for the cell. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/cell#row) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/cells) + +#### Inherited from + +[`Cell_CoreProperties`](cell_coreproperties.md).[`row`](Cell_CoreProperties.md#row) + +#### Defined in + +[core/cells/Cells.types.ts:43](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L43) + +*** + +### ~~table~~ + +```ts +table: Table_Internal; +``` + +#### Deprecated + +Reference to the table instance. + +#### Inherited from + +[`Cell_CoreProperties`](cell_coreproperties.md).[`table`](Cell_CoreProperties.md#table) + +#### Defined in + +[core/cells/Cells.types.ts:47](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L47) diff --git a/docs/reference/interfaces/cell_columngrouping.md b/docs/reference/interfaces/cell_columngrouping.md new file mode 100644 index 0000000000..af81e8b337 --- /dev/null +++ b/docs/reference/interfaces/cell_columngrouping.md @@ -0,0 +1,84 @@ +--- +id: Cell_ColumnGrouping +title: Cell_ColumnGrouping +--- + +# Interface: Cell\_ColumnGrouping + +## Properties + +### getIsAggregated() + +```ts +getIsAggregated: () => boolean; +``` + +Returns whether or not the cell is currently aggregated. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getisaggregated) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:168](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L168) + +*** + +### getIsGrouped() + +```ts +getIsGrouped: () => boolean; +``` + +Returns whether or not the cell is currently grouped. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getisgrouped) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:174](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L174) + +*** + +### getIsPlaceholder() + +```ts +getIsPlaceholder: () => boolean; +``` + +Returns whether or not the cell is currently a placeholder cell. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getisplaceholder) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:180](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L180) diff --git a/docs/reference/interfaces/cell_coreproperties.md b/docs/reference/interfaces/cell_coreproperties.md new file mode 100644 index 0000000000..42d4c595f3 --- /dev/null +++ b/docs/reference/interfaces/cell_coreproperties.md @@ -0,0 +1,100 @@ +--- +id: Cell_CoreProperties +title: Cell_CoreProperties +--- + +# Interface: Cell\_CoreProperties\ + +## Extended by + +- [`Cell_Cell`](cell_cell.md) + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* [`CellData`](../type-aliases/celldata.md) = [`CellData`](../type-aliases/celldata.md) + +## Properties + +### column + +```ts +column: Column; +``` + +The associated Column object for the cell. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/cell#column) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/cells) + +#### Defined in + +[core/cells/Cells.types.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L31) + +*** + +### id + +```ts +id: string; +``` + +The unique ID for the cell across the entire table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/cell#id) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/cells) + +#### Defined in + +[core/cells/Cells.types.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L37) + +*** + +### row + +```ts +row: Row; +``` + +The associated Row object for the cell. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/cell#row) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/cells) + +#### Defined in + +[core/cells/Cells.types.ts:43](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L43) + +*** + +### ~~table~~ + +```ts +table: Table_Internal; +``` + +#### Deprecated + +Reference to the table instance. + +#### Defined in + +[core/cells/Cells.types.ts:47](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L47) diff --git a/docs/reference/interfaces/cellcontext.md b/docs/reference/interfaces/cellcontext.md new file mode 100644 index 0000000000..d7a77ff4fe --- /dev/null +++ b/docs/reference/interfaces/cellcontext.md @@ -0,0 +1,86 @@ +--- +id: CellContext +title: CellContext +--- + +# Interface: CellContext\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* [`CellData`](../type-aliases/celldata.md) = [`CellData`](../type-aliases/celldata.md) + +## Properties + +### cell + +```ts +cell: Cell; +``` + +#### Defined in + +[core/cells/Cells.types.ts:13](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L13) + +*** + +### column + +```ts +column: Column; +``` + +#### Defined in + +[core/cells/Cells.types.ts:14](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L14) + +*** + +### getValue + +```ts +getValue: Getter; +``` + +#### Defined in + +[core/cells/Cells.types.ts:15](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L15) + +*** + +### renderValue + +```ts +renderValue: Getter; +``` + +#### Defined in + +[core/cells/Cells.types.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L16) + +*** + +### row + +```ts +row: Row; +``` + +#### Defined in + +[core/cells/Cells.types.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L17) + +*** + +### table + +```ts +table: Table; +``` + +#### Defined in + +[core/cells/Cells.types.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L18) diff --git a/docs/reference/interfaces/column_column.md b/docs/reference/interfaces/column_column.md new file mode 100644 index 0000000000..d1e7e51310 --- /dev/null +++ b/docs/reference/interfaces/column_column.md @@ -0,0 +1,249 @@ +--- +id: Column_Column +title: Column_Column +--- + +# Interface: Column\_Column\ + +## Extends + +- [`Column_CoreProperties`](column_coreproperties.md)\<`TFeatures`, `TData`, `TValue`\> + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* [`CellData`](../type-aliases/celldata.md) = [`CellData`](../type-aliases/celldata.md) + +## Properties + +### accessorFn? + +```ts +optional accessorFn: AccessorFn; +``` + +The resolved accessor function to use when extracting the value for the column from each row. Will only be defined if the column def has a valid accessor key or function defined. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/column#accessorfn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-defs) + +#### Inherited from + +[`Column_CoreProperties`](column_coreproperties.md).[`accessorFn`](Column_CoreProperties.md#accessorfn) + +#### Defined in + +[core/columns/Columns.types.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L17) + +*** + +### columnDef + +```ts +columnDef: ColumnDef; +``` + +The original column def used to create the column. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/column#columndef) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-defs) + +#### Inherited from + +[`Column_CoreProperties`](column_coreproperties.md).[`columnDef`](Column_CoreProperties.md#columndef) + +#### Defined in + +[core/columns/Columns.types.ts:23](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L23) + +*** + +### columns + +```ts +columns: Column[]; +``` + +The child column (if the column is a group column). Will be an empty array if the column is not a group column. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/column#columns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-defs) + +#### Inherited from + +[`Column_CoreProperties`](column_coreproperties.md).[`columns`](Column_CoreProperties.md#columns) + +#### Defined in + +[core/columns/Columns.types.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L29) + +*** + +### depth + +```ts +depth: number; +``` + +The depth of the column (if grouped) relative to the root column def array. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/column#depth) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-defs) + +#### Inherited from + +[`Column_CoreProperties`](column_coreproperties.md).[`depth`](Column_CoreProperties.md#depth) + +#### Defined in + +[core/columns/Columns.types.ts:35](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L35) + +*** + +### getFlatColumns() + +```ts +getFlatColumns: () => Column[]; +``` + +Returns the flattened array of this column and all child/grand-child columns for this column. + +#### Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/column#getflatcolumns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-defs) + +#### Defined in + +[core/columns/Columns.types.ts:67](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L67) + +*** + +### getLeafColumns() + +```ts +getLeafColumns: () => Column[]; +``` + +Returns an array of all leaf-node columns for this column. If a column has no children, it is considered the only leaf-node column. + +#### Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/column#getleafcolumns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-defs) + +#### Defined in + +[core/columns/Columns.types.ts:73](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L73) + +*** + +### id + +```ts +id: string; +``` + +The resolved unique identifier for the column resolved in this priority: + - A manual `id` property from the column def + - The accessor key from the column def + - The header string from the column def + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/column#id) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-defs) + +#### Inherited from + +[`Column_CoreProperties`](column_coreproperties.md).[`id`](Column_CoreProperties.md#id) + +#### Defined in + +[core/columns/Columns.types.ts:44](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L44) + +*** + +### parent? + +```ts +optional parent: Column; +``` + +The parent column for this column. Will be undefined if this is a root column. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/column#parent) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-defs) + +#### Inherited from + +[`Column_CoreProperties`](column_coreproperties.md).[`parent`](Column_CoreProperties.md#parent) + +#### Defined in + +[core/columns/Columns.types.ts:50](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L50) + +*** + +### ~~table~~ + +```ts +table: Table_Internal; +``` + +#### Deprecated + +Reference to the table instance. + +#### Inherited from + +[`Column_CoreProperties`](column_coreproperties.md).[`table`](Column_CoreProperties.md#table) + +#### Defined in + +[core/columns/Columns.types.ts:54](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L54) diff --git a/docs/reference/interfaces/column_columnfaceting.md b/docs/reference/interfaces/column_columnfaceting.md new file mode 100644 index 0000000000..27934aa882 --- /dev/null +++ b/docs/reference/interfaces/column_columnfaceting.md @@ -0,0 +1,12 @@ +--- +id: Column_ColumnFaceting +title: Column_ColumnFaceting +--- + +# Interface: Column\_ColumnFaceting\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) diff --git a/docs/reference/interfaces/column_columnfiltering.md b/docs/reference/interfaces/column_columnfiltering.md new file mode 100644 index 0000000000..1a2b963de2 --- /dev/null +++ b/docs/reference/interfaces/column_columnfiltering.md @@ -0,0 +1,198 @@ +--- +id: Column_ColumnFiltering +title: Column_ColumnFiltering +--- + +# Interface: Column\_ColumnFiltering\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getAutoFilterFn() + +```ts +getAutoFilterFn: () => undefined | FilterFn; +``` + +Returns an automatically calculated filter function for the column based off of the columns first known value. + +#### Returns + +`undefined` \| [`FilterFn`](filterfn.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#getautofilterfn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:108](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L108) + +*** + +### getCanFilter() + +```ts +getCanFilter: () => boolean; +``` + +Returns whether or not the column can be **column** filtered. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#getcanfilter) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:114](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L114) + +*** + +### getFilterFn() + +```ts +getFilterFn: () => undefined | FilterFn; +``` + +Returns the filter function (either user-defined or automatic, depending on configuration) for the columnId specified. + +#### Returns + +`undefined` \| [`FilterFn`](filterfn.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#getfilterfn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:120](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L120) + +*** + +### getFilterIndex() + +```ts +getFilterIndex: () => number; +``` + +Returns the index (including `-1`) of the column filter in the table's `state.columnFilters` array. + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#getfilterindex) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:126](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L126) + +*** + +### getFilterValue() + +```ts +getFilterValue: () => unknown; +``` + +Returns the current filter value for the column. + +#### Returns + +`unknown` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#getfiltervalue) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:132](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L132) + +*** + +### getIsFiltered() + +```ts +getIsFiltered: () => boolean; +``` + +Returns whether or not the column is currently filtered. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#getisfiltered) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:138](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L138) + +*** + +### setFilterValue() + +```ts +setFilterValue: (updater) => void; +``` + +A function that sets the current filter value for the column. You can pass it a value or an updater function for immutability-safe operations on existing values. + +#### Parameters + +• **updater**: `any` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#setfiltervalue) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:144](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L144) diff --git a/docs/reference/interfaces/column_columngrouping.md b/docs/reference/interfaces/column_columngrouping.md new file mode 100644 index 0000000000..43ec004d66 --- /dev/null +++ b/docs/reference/interfaces/column_columngrouping.md @@ -0,0 +1,198 @@ +--- +id: Column_ColumnGrouping +title: Column_ColumnGrouping +--- + +# Interface: Column\_ColumnGrouping\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getAggregationFn() + +```ts +getAggregationFn: () => undefined | AggregationFn; +``` + +Returns the aggregation function for the column. + +#### Returns + +`undefined` \| [`AggregationFn`](../type-aliases/aggregationfn.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getaggregationfn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:95](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L95) + +*** + +### getAutoAggregationFn() + +```ts +getAutoAggregationFn: () => undefined | AggregationFn; +``` + +Returns the automatically inferred aggregation function for the column. + +#### Returns + +`undefined` \| [`AggregationFn`](../type-aliases/aggregationfn.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getautoaggregationfn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:101](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L101) + +*** + +### getCanGroup() + +```ts +getCanGroup: () => boolean; +``` + +Returns whether or not the column can be grouped. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getcangroup) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:107](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L107) + +*** + +### getGroupedIndex() + +```ts +getGroupedIndex: () => number; +``` + +Returns the index of the column in the grouping state. + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupedindex) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:113](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L113) + +*** + +### getIsGrouped() + +```ts +getIsGrouped: () => boolean; +``` + +Returns whether or not the column is currently grouped. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getisgrouped) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:119](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L119) + +*** + +### getToggleGroupingHandler() + +```ts +getToggleGroupingHandler: () => () => void; +``` + +Returns a function that toggles the grouping state of the column. This is useful for passing to the `onClick` prop of a button. + +#### Returns + +`Function` + +##### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#gettogglegroupinghandler) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:125](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L125) + +*** + +### toggleGrouping() + +```ts +toggleGrouping: () => void; +``` + +Toggles the grouping state of the column. + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#togglegrouping) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:131](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L131) diff --git a/docs/reference/interfaces/column_columnordering.md b/docs/reference/interfaces/column_columnordering.md new file mode 100644 index 0000000000..a7a9a90e58 --- /dev/null +++ b/docs/reference/interfaces/column_columnordering.md @@ -0,0 +1,96 @@ +--- +id: Column_ColumnOrdering +title: Column_ColumnOrdering +--- + +# Interface: Column\_ColumnOrdering + +## Properties + +### getIndex() + +```ts +getIndex: (position?) => number; +``` + +Returns the index of the column in the order of the visible columns. Optionally pass a `position` parameter to get the index of the column in a sub-section of the table + +#### Parameters + +• **position?**: [`ColumnPinningPosition`](../type-aliases/columnpinningposition.md) \| `"center"` + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#getindex) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-ordering) + +#### Defined in + +[features/column-ordering/ColumnOrdering.types.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.types.ts#L26) + +*** + +### getIsFirstColumn() + +```ts +getIsFirstColumn: (position?) => boolean; +``` + +Returns `true` if the column is the first column in the order of the visible columns. Optionally pass a `position` parameter to check if the column is the first in a sub-section of the table. + +#### Parameters + +• **position?**: [`ColumnPinningPosition`](../type-aliases/columnpinningposition.md) \| `"center"` + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#getisfirstcolumn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-ordering) + +#### Defined in + +[features/column-ordering/ColumnOrdering.types.ts:32](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.types.ts#L32) + +*** + +### getIsLastColumn() + +```ts +getIsLastColumn: (position?) => boolean; +``` + +Returns `true` if the column is the last column in the order of the visible columns. Optionally pass a `position` parameter to check if the column is the last in a sub-section of the table. + +#### Parameters + +• **position?**: [`ColumnPinningPosition`](../type-aliases/columnpinningposition.md) \| `"center"` + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#getislastcolumn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-ordering) + +#### Defined in + +[features/column-ordering/ColumnOrdering.types.ts:38](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.types.ts#L38) diff --git a/docs/reference/interfaces/column_columnpinning.md b/docs/reference/interfaces/column_columnpinning.md new file mode 100644 index 0000000000..73096c105d --- /dev/null +++ b/docs/reference/interfaces/column_columnpinning.md @@ -0,0 +1,114 @@ +--- +id: Column_ColumnPinning +title: Column_ColumnPinning +--- + +# Interface: Column\_ColumnPinning + +## Properties + +### getCanPin() + +```ts +getCanPin: () => boolean; +``` + +Returns whether or not the column can be pinned. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getcanpin) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-pinning) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:53](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L53) + +*** + +### getIsPinned() + +```ts +getIsPinned: () => ColumnPinningPosition; +``` + +Returns the pinned position of the column. (`'left'`, `'right'` or `false`) + +#### Returns + +[`ColumnPinningPosition`](../type-aliases/columnpinningposition.md) + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getispinned) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-pinning) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:59](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L59) + +*** + +### getPinnedIndex() + +```ts +getPinnedIndex: () => number; +``` + +Returns the numeric pinned index of the column within a pinned column group. + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getpinnedindex) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-pinning) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:65](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L65) + +*** + +### pin() + +```ts +pin: (position) => void; +``` + +Pins a column to the `'left'` or `'right'`, or unpins the column to the center if `false` is passed. + +#### Parameters + +• **position**: [`ColumnPinningPosition`](../type-aliases/columnpinningposition.md) + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#pin) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-pinning) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:71](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L71) diff --git a/docs/reference/interfaces/column_columnresizing.md b/docs/reference/interfaces/column_columnresizing.md new file mode 100644 index 0000000000..87202ceda3 --- /dev/null +++ b/docs/reference/interfaces/column_columnresizing.md @@ -0,0 +1,58 @@ +--- +id: Column_ColumnResizing +title: Column_ColumnResizing +--- + +# Interface: Column\_ColumnResizing + +## Properties + +### getCanResize() + +```ts +getCanResize: () => boolean; +``` + +Returns `true` if the column can be resized. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getcanresize) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:82](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L82) + +*** + +### getIsResizing() + +```ts +getIsResizing: () => boolean; +``` + +Returns `true` if the column is currently being resized. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getisresizing) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:88](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L88) diff --git a/docs/reference/interfaces/column_columnsizing.md b/docs/reference/interfaces/column_columnsizing.md new file mode 100644 index 0000000000..9076c81521 --- /dev/null +++ b/docs/reference/interfaces/column_columnsizing.md @@ -0,0 +1,110 @@ +--- +id: Column_ColumnSizing +title: Column_ColumnSizing +--- + +# Interface: Column\_ColumnSizing + +## Properties + +### getAfter() + +```ts +getAfter: (position?) => number; +``` + +Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the header. This is effectively a sum of the offset measurements of all succeeding (right) headers in relation to the current column. + +#### Parameters + +• **position?**: [`ColumnPinningPosition`](../type-aliases/columnpinningposition.md) \| `"center"` + +#### Returns + +`number` + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:88](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L88) + +*** + +### getSize() + +```ts +getSize: () => number; +``` + +Returns the current size of the column. + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getsize) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:94](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L94) + +*** + +### getStart() + +```ts +getStart: (position?) => number; +``` + +Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the header. This is effectively a sum of the offset measurements of all preceding (left) headers in relation to the current column. + +#### Parameters + +• **position?**: [`ColumnPinningPosition`](../type-aliases/columnpinningposition.md) \| `"center"` + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getstart) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:100](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L100) + +*** + +### resetSize() + +```ts +resetSize: () => void; +``` + +Resets the column to its initial size. + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#resetsize) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:106](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L106) diff --git a/docs/reference/interfaces/column_columnvisibility.md b/docs/reference/interfaces/column_columnvisibility.md new file mode 100644 index 0000000000..9c0ad79da5 --- /dev/null +++ b/docs/reference/interfaces/column_columnvisibility.md @@ -0,0 +1,122 @@ +--- +id: Column_ColumnVisibility +title: Column_ColumnVisibility +--- + +# Interface: Column\_ColumnVisibility + +## Properties + +### getCanHide() + +```ts +getCanHide: () => boolean; +``` + +Returns whether the column can be hidden + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getcanhide) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:114](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L114) + +*** + +### getIsVisible() + +```ts +getIsVisible: () => boolean; +``` + +Returns whether the column is visible + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getisvisible) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:120](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L120) + +*** + +### getToggleVisibilityHandler() + +```ts +getToggleVisibilityHandler: () => (event) => void; +``` + +Returns a function that can be used to toggle the column visibility. This function can be used to bind to an event handler to a checkbox. + +#### Returns + +`Function` + +##### Parameters + +• **event**: `unknown` + +##### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#gettogglevisibilityhandler) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:126](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L126) + +*** + +### toggleVisibility() + +```ts +toggleVisibility: (value?) => void; +``` + +Toggles the visibility of the column. + +#### Parameters + +• **value?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#togglevisibility) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:132](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L132) diff --git a/docs/reference/interfaces/column_coreproperties.md b/docs/reference/interfaces/column_coreproperties.md new file mode 100644 index 0000000000..f545ce699c --- /dev/null +++ b/docs/reference/interfaces/column_coreproperties.md @@ -0,0 +1,169 @@ +--- +id: Column_CoreProperties +title: Column_CoreProperties +--- + +# Interface: Column\_CoreProperties\ + +## Extended by + +- [`Column_Column`](column_column.md) + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* [`CellData`](../type-aliases/celldata.md) = [`CellData`](../type-aliases/celldata.md) + +## Properties + +### accessorFn? + +```ts +optional accessorFn: AccessorFn; +``` + +The resolved accessor function to use when extracting the value for the column from each row. Will only be defined if the column def has a valid accessor key or function defined. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/column#accessorfn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-defs) + +#### Defined in + +[core/columns/Columns.types.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L17) + +*** + +### columnDef + +```ts +columnDef: ColumnDef; +``` + +The original column def used to create the column. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/column#columndef) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-defs) + +#### Defined in + +[core/columns/Columns.types.ts:23](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L23) + +*** + +### columns + +```ts +columns: Column[]; +``` + +The child column (if the column is a group column). Will be an empty array if the column is not a group column. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/column#columns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-defs) + +#### Defined in + +[core/columns/Columns.types.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L29) + +*** + +### depth + +```ts +depth: number; +``` + +The depth of the column (if grouped) relative to the root column def array. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/column#depth) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-defs) + +#### Defined in + +[core/columns/Columns.types.ts:35](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L35) + +*** + +### id + +```ts +id: string; +``` + +The resolved unique identifier for the column resolved in this priority: + - A manual `id` property from the column def + - The accessor key from the column def + - The header string from the column def + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/column#id) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-defs) + +#### Defined in + +[core/columns/Columns.types.ts:44](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L44) + +*** + +### parent? + +```ts +optional parent: Column; +``` + +The parent column for this column. Will be undefined if this is a root column. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/column#parent) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-defs) + +#### Defined in + +[core/columns/Columns.types.ts:50](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L50) + +*** + +### ~~table~~ + +```ts +table: Table_Internal; +``` + +#### Deprecated + +Reference to the table instance. + +#### Defined in + +[core/columns/Columns.types.ts:54](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L54) diff --git a/docs/reference/interfaces/column_globalfiltering.md b/docs/reference/interfaces/column_globalfiltering.md new file mode 100644 index 0000000000..d64908bb95 --- /dev/null +++ b/docs/reference/interfaces/column_globalfiltering.md @@ -0,0 +1,32 @@ +--- +id: Column_GlobalFiltering +title: Column_GlobalFiltering +--- + +# Interface: Column\_GlobalFiltering + +## Properties + +### getCanGlobalFilter() + +```ts +getCanGlobalFilter: () => boolean; +``` + +Returns whether or not the column can be **globally** filtered. Set to `false` to disable a column from being scanned during global filtering. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#getcanglobalfilter) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/global-filtering) + +#### Defined in + +[features/global-filtering/GlobalFiltering.types.ts:33](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.types.ts#L33) diff --git a/docs/reference/interfaces/column_rowsorting.md b/docs/reference/interfaces/column_rowsorting.md new file mode 100644 index 0000000000..3451536499 --- /dev/null +++ b/docs/reference/interfaces/column_rowsorting.md @@ -0,0 +1,330 @@ +--- +id: Column_RowSorting +title: Column_RowSorting +--- + +# Interface: Column\_RowSorting\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### clearSorting() + +```ts +clearSorting: () => void; +``` + +Removes this column from the table's sorting state + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#clearsorting) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:110](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L110) + +*** + +### getAutoSortDir() + +```ts +getAutoSortDir: () => SortDirection; +``` + +Returns a sort direction automatically inferred based on the columns values. + +#### Returns + +[`SortDirection`](../type-aliases/sortdirection.md) + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getautosortdir) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:116](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L116) + +*** + +### getAutoSortingFn() + +```ts +getAutoSortingFn: () => SortingFn; +``` + +Returns a sorting function automatically inferred based on the columns values. + +#### Returns + +[`SortingFn`](sortingfn.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getautosortingfn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:122](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L122) + +*** + +### getCanMultiSort() + +```ts +getCanMultiSort: () => boolean; +``` + +Returns whether this column can be multi-sorted. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getcanmultisort) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:128](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L128) + +*** + +### getCanSort() + +```ts +getCanSort: () => boolean; +``` + +Returns whether this column can be sorted. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getcansort) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:134](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L134) + +*** + +### getFirstSortDir() + +```ts +getFirstSortDir: () => SortDirection; +``` + +Returns the first direction that should be used when sorting this column. + +#### Returns + +[`SortDirection`](../type-aliases/sortdirection.md) + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getfirstsortdir) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:140](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L140) + +*** + +### getIsSorted() + +```ts +getIsSorted: () => false | SortDirection; +``` + +Returns the current sort direction of this column. + +#### Returns + +`false` \| [`SortDirection`](../type-aliases/sortdirection.md) + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getissorted) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:146](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L146) + +*** + +### getNextSortingOrder() + +```ts +getNextSortingOrder: () => false | SortDirection; +``` + +Returns the next sorting order. + +#### Returns + +`false` \| [`SortDirection`](../type-aliases/sortdirection.md) + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getnextsortingorder) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:152](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L152) + +*** + +### getSortIndex() + +```ts +getSortIndex: () => number; +``` + +Returns the index position of this column's sorting within the sorting state + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getsortindex) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:158](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L158) + +*** + +### getSortingFn() + +```ts +getSortingFn: () => SortingFn; +``` + +Returns the resolved sorting function to be used for this column + +#### Returns + +[`SortingFn`](sortingfn.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getsortingfn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:164](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L164) + +*** + +### getToggleSortingHandler() + +```ts +getToggleSortingHandler: () => undefined | (event) => void; +``` + +Returns a function that can be used to toggle this column's sorting state. This is useful for attaching a click handler to the column header. + +#### Returns + +`undefined` \| (`event`) => `void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#gettogglesortinghandler) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:170](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L170) + +*** + +### toggleSorting() + +```ts +toggleSorting: (desc?, isMulti?) => void; +``` + +Toggles this columns sorting state. If `desc` is provided, it will force the sort direction to that value. If `isMulti` is provided, it will additivity multi-sort the column (or toggle it if it is already sorted). + +#### Parameters + +• **desc?**: `boolean` + +• **isMulti?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#togglesorting) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:176](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L176) diff --git a/docs/reference/interfaces/columndef_columnfiltering.md b/docs/reference/interfaces/columndef_columnfiltering.md new file mode 100644 index 0000000000..942c56c097 --- /dev/null +++ b/docs/reference/interfaces/columndef_columnfiltering.md @@ -0,0 +1,56 @@ +--- +id: ColumnDef_ColumnFiltering +title: ColumnDef_ColumnFiltering +--- + +# Interface: ColumnDef\_ColumnFiltering\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### enableColumnFilter? + +```ts +optional enableColumnFilter: boolean; +``` + +Enables/disables the **column** filter for this column. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#enablecolumnfilter) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:90](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L90) + +*** + +### filterFn? + +```ts +optional filterFn: FilterFnOption; +``` + +The filter function to use with this column. Can be the name of a built-in filter function or a custom filter function. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#filterfn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:96](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L96) diff --git a/docs/reference/interfaces/columndef_columngrouping.md b/docs/reference/interfaces/columndef_columngrouping.md new file mode 100644 index 0000000000..2f80e7d0ba --- /dev/null +++ b/docs/reference/interfaces/columndef_columngrouping.md @@ -0,0 +1,110 @@ +--- +id: ColumnDef_ColumnGrouping +title: ColumnDef_ColumnGrouping +--- + +# Interface: ColumnDef\_ColumnGrouping\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* [`CellData`](../type-aliases/celldata.md) = [`CellData`](../type-aliases/celldata.md) + +## Properties + +### aggregatedCell? + +```ts +optional aggregatedCell: ColumnDefTemplate["getContext"]>>; +``` + +The cell to display each row for the column if the cell is an aggregate. If a function is passed, it will be passed a props object with the context of the cell and should return the property type for your adapter (the exact type depends on the adapter being used). + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#aggregatedcell) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:63](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L63) + +*** + +### aggregationFn? + +```ts +optional aggregationFn: AggregationFnOption; +``` + +The resolved aggregation function for the column. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#aggregationfn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:71](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L71) + +*** + +### enableGrouping? + +```ts +optional enableGrouping: boolean; +``` + +Enables/disables grouping for this column. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#enablegrouping) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:77](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L77) + +*** + +### getGroupingValue()? + +```ts +optional getGroupingValue: (row) => any; +``` + +Specify a value to be used for grouping rows on this column. If this option is not specified, the value derived from `accessorKey` / `accessorFn` will be used instead. + +#### Parameters + +• **row**: `TData` + +#### Returns + +`any` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupingvalue) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:83](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L83) diff --git a/docs/reference/interfaces/columndef_columnpinning.md b/docs/reference/interfaces/columndef_columnpinning.md new file mode 100644 index 0000000000..1b12c0f695 --- /dev/null +++ b/docs/reference/interfaces/columndef_columnpinning.md @@ -0,0 +1,28 @@ +--- +id: ColumnDef_ColumnPinning +title: ColumnDef_ColumnPinning +--- + +# Interface: ColumnDef\_ColumnPinning + +## Properties + +### enablePinning? + +```ts +optional enablePinning: boolean; +``` + +Enables/disables column pinning for this column. Defaults to `true`. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#enablepinning-1) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-pinning) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:44](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L44) diff --git a/docs/reference/interfaces/columndef_columnresizing.md b/docs/reference/interfaces/columndef_columnresizing.md new file mode 100644 index 0000000000..905f091425 --- /dev/null +++ b/docs/reference/interfaces/columndef_columnresizing.md @@ -0,0 +1,28 @@ +--- +id: ColumnDef_ColumnResizing +title: ColumnDef_ColumnResizing +--- + +# Interface: ColumnDef\_ColumnResizing + +## Properties + +### enableResizing? + +```ts +optional enableResizing: boolean; +``` + +Enables or disables column resizing for the column. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#enableresizing) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:73](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L73) diff --git a/docs/reference/interfaces/columndef_columnsizing.md b/docs/reference/interfaces/columndef_columnsizing.md new file mode 100644 index 0000000000..c7f99f0cbc --- /dev/null +++ b/docs/reference/interfaces/columndef_columnsizing.md @@ -0,0 +1,72 @@ +--- +id: ColumnDef_ColumnSizing +title: ColumnDef_ColumnSizing +--- + +# Interface: ColumnDef\_ColumnSizing + +## Properties + +### maxSize? + +```ts +optional maxSize: number; +``` + +The maximum allowed size for the column + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#maxsize) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:69](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L69) + +*** + +### minSize? + +```ts +optional minSize: number; +``` + +The minimum allowed size for the column + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#minsize) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:75](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L75) + +*** + +### size? + +```ts +optional size: number; +``` + +The desired size for the column + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#size) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:81](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L81) diff --git a/docs/reference/interfaces/columndef_columnvisibility.md b/docs/reference/interfaces/columndef_columnvisibility.md new file mode 100644 index 0000000000..321ba2a2ea --- /dev/null +++ b/docs/reference/interfaces/columndef_columnvisibility.md @@ -0,0 +1,28 @@ +--- +id: ColumnDef_ColumnVisibility +title: ColumnDef_ColumnVisibility +--- + +# Interface: ColumnDef\_ColumnVisibility + +## Properties + +### enableHiding? + +```ts +optional enableHiding: boolean; +``` + +Enables/disables column hiding for this column. Defaults to `true`. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#enablehiding) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:92](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L92) diff --git a/docs/reference/interfaces/columndef_globalfiltering.md b/docs/reference/interfaces/columndef_globalfiltering.md new file mode 100644 index 0000000000..cde6bb592d --- /dev/null +++ b/docs/reference/interfaces/columndef_globalfiltering.md @@ -0,0 +1,28 @@ +--- +id: ColumnDef_GlobalFiltering +title: ColumnDef_GlobalFiltering +--- + +# Interface: ColumnDef\_GlobalFiltering + +## Properties + +### enableGlobalFilter? + +```ts +optional enableGlobalFilter: boolean; +``` + +Enables/disables the **global** filter for this column. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#enableglobalfilter) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/global-filtering) + +#### Defined in + +[features/global-filtering/GlobalFiltering.types.ts:24](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.types.ts#L24) diff --git a/docs/reference/interfaces/columndef_rowsorting.md b/docs/reference/interfaces/columndef_rowsorting.md new file mode 100644 index 0000000000..d4ba6d90a5 --- /dev/null +++ b/docs/reference/interfaces/columndef_rowsorting.md @@ -0,0 +1,157 @@ +--- +id: ColumnDef_RowSorting +title: ColumnDef_RowSorting +--- + +# Interface: ColumnDef\_RowSorting\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### enableMultiSort? + +```ts +optional enableMultiSort: boolean; +``` + +Enables/Disables multi-sorting for this column. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablemultisort) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:60](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L60) + +*** + +### enableSorting? + +```ts +optional enableSorting: boolean; +``` + +Enables/Disables sorting for this column. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablesorting) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:66](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L66) + +*** + +### invertSorting? + +```ts +optional invertSorting: boolean; +``` + +Inverts the order of the sorting for this column. This is useful for values that have an inverted best/worst scale where lower numbers are better, eg. a ranking (1st, 2nd, 3rd) or golf-like scoring + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#invertsorting) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:72](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L72) + +*** + +### sortDescFirst? + +```ts +optional sortDescFirst: boolean; +``` + +Set to `true` for sorting toggles on this column to start in the descending direction. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortdescfirst) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:78](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L78) + +*** + +### sortingFn? + +```ts +optional sortingFn: SortingFnOption; +``` + +The sorting function to use with this column. +- A `string` referencing a built-in sorting function +- A custom sorting function + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortingfn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:86](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L86) + +*** + +### sortUndefined? + +```ts +optional sortUndefined: + | false + | 1 + | -1 + | "first" + | "last"; +``` + +The priority of undefined values when sorting this column. +- `false` + - Undefined values will be considered tied and need to be sorted by the next column filter or original index (whichever applies) +- `-1` + - Undefined values will be sorted with higher priority (ascending) (if ascending, undefined will appear on the beginning of the list) +- `1` + - Undefined values will be sorted with lower priority (descending) (if ascending, undefined will appear on the end of the list) + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortundefined) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:98](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L98) diff --git a/docs/reference/interfaces/columndefaultoptions.md b/docs/reference/interfaces/columndefaultoptions.md new file mode 100644 index 0000000000..07e1969069 --- /dev/null +++ b/docs/reference/interfaces/columndefaultoptions.md @@ -0,0 +1,30 @@ +--- +id: ColumnDefaultOptions +title: ColumnDefaultOptions +--- + +# Interface: ColumnDefaultOptions + +## Properties + +### enableGrouping + +```ts +enableGrouping: boolean; +``` + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:184](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L184) + +*** + +### onGroupingChange + +```ts +onGroupingChange: OnChangeFn; +``` + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:185](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L185) diff --git a/docs/reference/interfaces/columnfilter.md b/docs/reference/interfaces/columnfilter.md new file mode 100644 index 0000000000..ad170519ed --- /dev/null +++ b/docs/reference/interfaces/columnfilter.md @@ -0,0 +1,30 @@ +--- +id: ColumnFilter +title: ColumnFilter +--- + +# Interface: ColumnFilter + +## Properties + +### id + +```ts +id: string; +``` + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L25) + +*** + +### value + +```ts +value: unknown; +``` + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L26) diff --git a/docs/reference/interfaces/columnmeta.md b/docs/reference/interfaces/columnmeta.md new file mode 100644 index 0000000000..3857c170c2 --- /dev/null +++ b/docs/reference/interfaces/columnmeta.md @@ -0,0 +1,14 @@ +--- +id: ColumnMeta +title: ColumnMeta +--- + +# Interface: ColumnMeta\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* [`CellData`](../type-aliases/celldata.md) = [`CellData`](../type-aliases/celldata.md) diff --git a/docs/reference/interfaces/columnorderdefaultoptions.md b/docs/reference/interfaces/columnorderdefaultoptions.md new file mode 100644 index 0000000000..054869c5de --- /dev/null +++ b/docs/reference/interfaces/columnorderdefaultoptions.md @@ -0,0 +1,18 @@ +--- +id: ColumnOrderDefaultOptions +title: ColumnOrderDefaultOptions +--- + +# Interface: ColumnOrderDefaultOptions + +## Properties + +### onColumnOrderChange + +```ts +onColumnOrderChange: OnChangeFn; +``` + +#### Defined in + +[features/column-ordering/ColumnOrdering.types.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.types.ts#L42) diff --git a/docs/reference/interfaces/columnpinningdefaultoptions.md b/docs/reference/interfaces/columnpinningdefaultoptions.md new file mode 100644 index 0000000000..f2ecbfa05f --- /dev/null +++ b/docs/reference/interfaces/columnpinningdefaultoptions.md @@ -0,0 +1,18 @@ +--- +id: ColumnPinningDefaultOptions +title: ColumnPinningDefaultOptions +--- + +# Interface: ColumnPinningDefaultOptions + +## Properties + +### onColumnPinningChange + +```ts +onColumnPinningChange: OnChangeFn; +``` + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:35](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L35) diff --git a/docs/reference/interfaces/columnpinningstate.md b/docs/reference/interfaces/columnpinningstate.md new file mode 100644 index 0000000000..c77e01bfba --- /dev/null +++ b/docs/reference/interfaces/columnpinningstate.md @@ -0,0 +1,30 @@ +--- +id: ColumnPinningState +title: ColumnPinningState +--- + +# Interface: ColumnPinningState + +## Properties + +### left + +```ts +left: string[]; +``` + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L11) + +*** + +### right + +```ts +right: string[]; +``` + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L12) diff --git a/docs/reference/interfaces/columnresizingstate.md b/docs/reference/interfaces/columnresizingstate.md new file mode 100644 index 0000000000..e24eb56e50 --- /dev/null +++ b/docs/reference/interfaces/columnresizingstate.md @@ -0,0 +1,78 @@ +--- +id: columnResizingState +title: columnResizingState +--- + +# Interface: columnResizingState + +## Properties + +### columnSizingStart + +```ts +columnSizingStart: [string, number][]; +``` + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:8](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L8) + +*** + +### deltaOffset + +```ts +deltaOffset: null | number; +``` + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:9](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L9) + +*** + +### deltaPercentage + +```ts +deltaPercentage: null | number; +``` + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:10](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L10) + +*** + +### isResizingColumn + +```ts +isResizingColumn: string | false; +``` + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L11) + +*** + +### startOffset + +```ts +startOffset: null | number; +``` + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L12) + +*** + +### startSize + +```ts +startSize: null | number; +``` + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:13](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L13) diff --git a/docs/reference/interfaces/columnsort.md b/docs/reference/interfaces/columnsort.md new file mode 100644 index 0000000000..254873c301 --- /dev/null +++ b/docs/reference/interfaces/columnsort.md @@ -0,0 +1,30 @@ +--- +id: ColumnSort +title: ColumnSort +--- + +# Interface: ColumnSort + +## Properties + +### desc + +```ts +desc: boolean; +``` + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L11) + +*** + +### id + +```ts +id: string; +``` + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L12) diff --git a/docs/reference/interfaces/createrowmodel_core.md b/docs/reference/interfaces/createrowmodel_core.md new file mode 100644 index 0000000000..d7e5eaef4a --- /dev/null +++ b/docs/reference/interfaces/createrowmodel_core.md @@ -0,0 +1,46 @@ +--- +id: CreateRowModel_Core +title: CreateRowModel_Core +--- + +# Interface: CreateRowModel\_Core\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### coreRowModel()? + +```ts +optional coreRowModel: (table) => () => RowModel; +``` + +This required option is a factory for a function that computes and returns the core row model for the table. + +#### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +#### Returns + +`Function` + +##### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#getcorerowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/row-models/RowModels.types.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.types.ts#L30) diff --git a/docs/reference/interfaces/createrowmodel_expanded.md b/docs/reference/interfaces/createrowmodel_expanded.md new file mode 100644 index 0000000000..44edd0f769 --- /dev/null +++ b/docs/reference/interfaces/createrowmodel_expanded.md @@ -0,0 +1,46 @@ +--- +id: CreateRowModel_Expanded +title: CreateRowModel_Expanded +--- + +# Interface: CreateRowModel\_Expanded\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### expandedRowModel()? + +```ts +optional expandedRowModel: (table) => () => RowModel; +``` + +This function is responsible for returning the expanded row model. If this function is not provided, the table will not expand rows. You can use the default exported `getExpandedRowModel` function to get the expanded row model or implement your own. + +#### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +#### Returns + +`Function` + +##### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getexpandedrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:177](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L177) diff --git a/docs/reference/interfaces/createrowmodel_faceted.md b/docs/reference/interfaces/createrowmodel_faceted.md new file mode 100644 index 0000000000..44f7959db9 --- /dev/null +++ b/docs/reference/interfaces/createrowmodel_faceted.md @@ -0,0 +1,120 @@ +--- +id: CreateRowModel_Faceted +title: CreateRowModel_Faceted +--- + +# Interface: CreateRowModel\_Faceted\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### facetedMinMaxValues()? + +```ts +optional facetedMinMaxValues: (table, columnId) => () => undefined | [number, number]; +``` + +This function is used to retrieve the faceted min/max values. If using server-side faceting, this function is not required. To use client-side faceting, pass the exported `getFacetedMinMaxValues()` from your adapter to your table or implement your own. + +#### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +• **columnId**: `string` + +#### Returns + +`Function` + +##### Returns + +`undefined` \| [`number`, `number`] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-faceting#getfacetedminmaxvalues) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-faceting) + +#### Defined in + +[features/column-faceting/ColumnFaceting.types.ts:47](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/ColumnFaceting.types.ts#L47) + +*** + +### facetedRowModel()? + +```ts +optional facetedRowModel: (table, columnId) => () => RowModel; +``` + +This function is used to retrieve the faceted row model. If using server-side faceting, this function is not required. To use client-side faceting, pass the exported `getFacetedRowModel()` from your adapter to your table or implement your own. + +#### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +• **columnId**: `string` + +#### Returns + +`Function` + +##### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-faceting#getfacetedrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-faceting) + +#### Defined in + +[features/column-faceting/ColumnFaceting.types.ts:56](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/ColumnFaceting.types.ts#L56) + +*** + +### facetedUniqueValues()? + +```ts +optional facetedUniqueValues: (table, columnId) => () => Map; +``` + +This function is used to retrieve the faceted unique values. If using server-side faceting, this function is not required. To use client-side faceting, pass the exported `getFacetedUniqueValues()` from your adapter to your table or implement your own. + +#### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +• **columnId**: `string` + +#### Returns + +`Function` + +##### Returns + +`Map`\<`any`, `number`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-faceting#getfaceteduniquevalues) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-faceting) + +#### Defined in + +[features/column-faceting/ColumnFaceting.types.ts:65](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/ColumnFaceting.types.ts#L65) diff --git a/docs/reference/interfaces/createrowmodel_filtered.md b/docs/reference/interfaces/createrowmodel_filtered.md new file mode 100644 index 0000000000..a0a5fcf31d --- /dev/null +++ b/docs/reference/interfaces/createrowmodel_filtered.md @@ -0,0 +1,48 @@ +--- +id: CreateRowModel_Filtered +title: CreateRowModel_Filtered +--- + +# Interface: CreateRowModel\_Filtered\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### filteredRowModel()? + +```ts +optional filteredRowModel: (table) => () => RowModel; +``` + +If provided, this function is called **once** per table and should return a **new function** which will calculate and return the row model for the table when it's filtered. +- For server-side filtering, this function is unnecessary and can be ignored since the server should already return the filtered row model. +- For client-side filtering, this function is required. A default implementation is provided via any table adapter's `{ getFilteredRowModel }` export. + +#### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +#### Returns + +`Function` + +##### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#getfilteredrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:268](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L268) diff --git a/docs/reference/interfaces/createrowmodel_grouped.md b/docs/reference/interfaces/createrowmodel_grouped.md new file mode 100644 index 0000000000..c376861918 --- /dev/null +++ b/docs/reference/interfaces/createrowmodel_grouped.md @@ -0,0 +1,46 @@ +--- +id: CreateRowModel_Grouped +title: CreateRowModel_Grouped +--- + +# Interface: CreateRowModel\_Grouped\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### groupedRowModel()? + +```ts +optional groupedRowModel: (table) => () => RowModel; +``` + +Returns the row model after grouping has taken place, but no further. + +#### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +#### Returns + +`Function` + +##### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupedrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:262](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L262) diff --git a/docs/reference/interfaces/createrowmodel_paginated.md b/docs/reference/interfaces/createrowmodel_paginated.md new file mode 100644 index 0000000000..d2ca60b8c0 --- /dev/null +++ b/docs/reference/interfaces/createrowmodel_paginated.md @@ -0,0 +1,48 @@ +--- +id: CreateRowModel_Paginated +title: CreateRowModel_Paginated +--- + +# Interface: CreateRowModel\_Paginated\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### paginatedRowModel()? + +```ts +optional paginatedRowModel: (table) => () => RowModel; +``` + +Returns the row model after pagination has taken place, but no further. + +Pagination columns are automatically reordered by default to the start of the columns list. If you would rather remove them or leave them as-is, set the appropriate mode here. + +#### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +#### Returns + +`Function` + +##### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getPaginatedRowModel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:178](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L178) diff --git a/docs/reference/interfaces/createrowmodel_sorted.md b/docs/reference/interfaces/createrowmodel_sorted.md new file mode 100644 index 0000000000..f1b3841a45 --- /dev/null +++ b/docs/reference/interfaces/createrowmodel_sorted.md @@ -0,0 +1,46 @@ +--- +id: CreateRowModel_Sorted +title: CreateRowModel_Sorted +--- + +# Interface: CreateRowModel\_Sorted\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### sortedRowModel()? + +```ts +optional sortedRowModel: (table) => () => RowModel; +``` + +This function is used to retrieve the sorted row model. If using server-side sorting, this function is not required. To use client-side sorting, pass the exported `getSortedRowModel()` from your adapter to your table or implement your own. + +#### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +#### Returns + +`Function` + +##### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getsortedrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:283](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L283) diff --git a/docs/reference/interfaces/filterfn.md b/docs/reference/interfaces/filterfn.md new file mode 100644 index 0000000000..186716de67 --- /dev/null +++ b/docs/reference/interfaces/filterfn.md @@ -0,0 +1,62 @@ +--- +id: FilterFn +title: FilterFn +--- + +# Interface: FilterFn()\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +```ts +interface FilterFn( + row, + columnId, + filterValue, + addMeta): boolean +``` + +## Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +• **columnId**: `string` + +• **filterValue**: `any` + +• **addMeta** + +## Returns + +`boolean` + +## Defined in + +[features/column-filtering/ColumnFiltering.types.ts:49](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L49) + +## Properties + +### autoRemove? + +```ts +optional autoRemove: ColumnFilterAutoRemoveTestFn; +``` + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:55](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L55) + +*** + +### resolveFilterValue? + +```ts +optional resolveFilterValue: TransformFilterValueFn; +``` + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:56](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L56) diff --git a/docs/reference/interfaces/filterfns.md b/docs/reference/interfaces/filterfns.md new file mode 100644 index 0000000000..8be18ff8f0 --- /dev/null +++ b/docs/reference/interfaces/filterfns.md @@ -0,0 +1,6 @@ +--- +id: FilterFns +title: FilterFns +--- + +# Interface: FilterFns diff --git a/docs/reference/interfaces/filtermeta.md b/docs/reference/interfaces/filtermeta.md new file mode 100644 index 0000000000..86669ecef0 --- /dev/null +++ b/docs/reference/interfaces/filtermeta.md @@ -0,0 +1,6 @@ +--- +id: FilterMeta +title: FilterMeta +--- + +# Interface: FilterMeta diff --git a/docs/reference/interfaces/header_columnresizing.md b/docs/reference/interfaces/header_columnresizing.md new file mode 100644 index 0000000000..df5de42d6c --- /dev/null +++ b/docs/reference/interfaces/header_columnresizing.md @@ -0,0 +1,48 @@ +--- +id: Header_ColumnResizing +title: Header_ColumnResizing +--- + +# Interface: Header\_ColumnResizing + +## Properties + +### getResizeHandler() + +```ts +getResizeHandler: (context?) => (event) => void; +``` + +Returns an event handler function that can be used to resize the header. It can be used as an: +- `onMouseDown` handler +- `onTouchStart` handler + +The dragging and release events are automatically handled for you. + +#### Parameters + +• **context?**: `Document` + +#### Returns + +`Function` + +##### Parameters + +• **event**: `unknown` + +##### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getresizehandler) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:101](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L101) diff --git a/docs/reference/interfaces/header_columnsizing.md b/docs/reference/interfaces/header_columnsizing.md new file mode 100644 index 0000000000..729aef5806 --- /dev/null +++ b/docs/reference/interfaces/header_columnsizing.md @@ -0,0 +1,62 @@ +--- +id: Header_ColumnSizing +title: Header_ColumnSizing +--- + +# Interface: Header\_ColumnSizing + +## Properties + +### getSize() + +```ts +getSize: () => number; +``` + +Returns the current size of the header. + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getsize) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:115](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L115) + +*** + +### getStart() + +```ts +getStart: (position?) => number; +``` + +Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the header. This is effectively a sum of the offset measurements of all preceding headers. + +#### Parameters + +• **position?**: [`ColumnPinningPosition`](../type-aliases/columnpinningposition.md) + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getstart) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:121](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L121) diff --git a/docs/reference/interfaces/header_coreproperties.md b/docs/reference/interfaces/header_coreproperties.md new file mode 100644 index 0000000000..d2c3e8723e --- /dev/null +++ b/docs/reference/interfaces/header_coreproperties.md @@ -0,0 +1,254 @@ +--- +id: Header_CoreProperties +title: Header_CoreProperties +--- + +# Interface: Header\_CoreProperties\ + +## Extended by + +- [`Header_Header`](header_header.md) + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* [`CellData`](../type-aliases/celldata.md) = [`CellData`](../type-aliases/celldata.md) + +## Properties + +### colSpan + +```ts +colSpan: number; +``` + +The col-span for the header. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#colspan) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[core/headers/Headers.types.ts:76](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L76) + +*** + +### column + +```ts +column: Column; +``` + +The header's associated column object. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#column) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[core/headers/Headers.types.ts:82](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L82) + +*** + +### depth + +```ts +depth: number; +``` + +The depth of the header, zero-indexed based. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#depth) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[core/headers/Headers.types.ts:88](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L88) + +*** + +### headerGroup + +```ts +headerGroup: null | HeaderGroup; +``` + +The header's associated header group object. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#headergroup) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[core/headers/Headers.types.ts:94](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L94) + +*** + +### id + +```ts +id: string; +``` + +The unique identifier for the header. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#id) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[core/headers/Headers.types.ts:100](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L100) + +*** + +### index + +```ts +index: number; +``` + +The index for the header within the header group. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#index) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[core/headers/Headers.types.ts:106](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L106) + +*** + +### isPlaceholder + +```ts +isPlaceholder: boolean; +``` + +A boolean denoting if the header is a placeholder header. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#isplaceholder) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[core/headers/Headers.types.ts:112](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L112) + +*** + +### placeholderId? + +```ts +optional placeholderId: string; +``` + +If the header is a placeholder header, this will be a unique header ID that does not conflict with any other headers across the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#placeholderid) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[core/headers/Headers.types.ts:118](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L118) + +*** + +### rowSpan + +```ts +rowSpan: number; +``` + +The row-span for the header. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#rowspan) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[core/headers/Headers.types.ts:124](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L124) + +*** + +### subHeaders + +```ts +subHeaders: Header[]; +``` + +The header's hierarchical sub/child headers. Will be empty if the header's associated column is a leaf-column. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#subheaders) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[core/headers/Headers.types.ts:130](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L130) + +*** + +### ~~table~~ + +```ts +table: Table; +``` + +#### Deprecated + +Reference to the table instance. + +#### Defined in + +[core/headers/Headers.types.ts:134](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L134) diff --git a/docs/reference/interfaces/header_header.md b/docs/reference/interfaces/header_header.md new file mode 100644 index 0000000000..da9c0c74a2 --- /dev/null +++ b/docs/reference/interfaces/header_header.md @@ -0,0 +1,350 @@ +--- +id: Header_Header +title: Header_Header +--- + +# Interface: Header\_Header\ + +## Extends + +- [`Header_CoreProperties`](header_coreproperties.md)\<`TFeatures`, `TData`, `TValue`\> + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* [`CellData`](../type-aliases/celldata.md) = [`CellData`](../type-aliases/celldata.md) + +## Properties + +### colSpan + +```ts +colSpan: number; +``` + +The col-span for the header. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#colspan) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Inherited from + +[`Header_CoreProperties`](header_coreproperties.md).[`colSpan`](Header_CoreProperties.md#colspan) + +#### Defined in + +[core/headers/Headers.types.ts:76](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L76) + +*** + +### column + +```ts +column: Column; +``` + +The header's associated column object. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#column) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Inherited from + +[`Header_CoreProperties`](header_coreproperties.md).[`column`](Header_CoreProperties.md#column) + +#### Defined in + +[core/headers/Headers.types.ts:82](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L82) + +*** + +### depth + +```ts +depth: number; +``` + +The depth of the header, zero-indexed based. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#depth) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Inherited from + +[`Header_CoreProperties`](header_coreproperties.md).[`depth`](Header_CoreProperties.md#depth) + +#### Defined in + +[core/headers/Headers.types.ts:88](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L88) + +*** + +### getContext() + +```ts +getContext: () => HeaderContext; +``` + +Returns the rendering context (or props) for column-based components like headers, footers and filters. + +#### Returns + +[`HeaderContext`](headercontext.md)\<`TFeatures`, `TData`, `TValue`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#getcontext) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[core/headers/Headers.types.ts:147](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L147) + +*** + +### getLeafHeaders() + +```ts +getLeafHeaders: () => Header[]; +``` + +Returns the leaf headers hierarchically nested under this header. + +#### Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `TValue`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#getleafheaders) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[core/headers/Headers.types.ts:153](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L153) + +*** + +### headerGroup + +```ts +headerGroup: null | HeaderGroup; +``` + +The header's associated header group object. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#headergroup) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Inherited from + +[`Header_CoreProperties`](header_coreproperties.md).[`headerGroup`](Header_CoreProperties.md#headergroup) + +#### Defined in + +[core/headers/Headers.types.ts:94](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L94) + +*** + +### id + +```ts +id: string; +``` + +The unique identifier for the header. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#id) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Inherited from + +[`Header_CoreProperties`](header_coreproperties.md).[`id`](Header_CoreProperties.md#id) + +#### Defined in + +[core/headers/Headers.types.ts:100](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L100) + +*** + +### index + +```ts +index: number; +``` + +The index for the header within the header group. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#index) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Inherited from + +[`Header_CoreProperties`](header_coreproperties.md).[`index`](Header_CoreProperties.md#index) + +#### Defined in + +[core/headers/Headers.types.ts:106](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L106) + +*** + +### isPlaceholder + +```ts +isPlaceholder: boolean; +``` + +A boolean denoting if the header is a placeholder header. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#isplaceholder) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Inherited from + +[`Header_CoreProperties`](header_coreproperties.md).[`isPlaceholder`](Header_CoreProperties.md#isplaceholder) + +#### Defined in + +[core/headers/Headers.types.ts:112](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L112) + +*** + +### placeholderId? + +```ts +optional placeholderId: string; +``` + +If the header is a placeholder header, this will be a unique header ID that does not conflict with any other headers across the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#placeholderid) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Inherited from + +[`Header_CoreProperties`](header_coreproperties.md).[`placeholderId`](Header_CoreProperties.md#placeholderid) + +#### Defined in + +[core/headers/Headers.types.ts:118](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L118) + +*** + +### rowSpan + +```ts +rowSpan: number; +``` + +The row-span for the header. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#rowspan) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Inherited from + +[`Header_CoreProperties`](header_coreproperties.md).[`rowSpan`](Header_CoreProperties.md#rowspan) + +#### Defined in + +[core/headers/Headers.types.ts:124](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L124) + +*** + +### subHeaders + +```ts +subHeaders: Header[]; +``` + +The header's hierarchical sub/child headers. Will be empty if the header's associated column is a leaf-column. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/header#subheaders) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Inherited from + +[`Header_CoreProperties`](header_coreproperties.md).[`subHeaders`](Header_CoreProperties.md#subheaders) + +#### Defined in + +[core/headers/Headers.types.ts:130](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L130) + +*** + +### ~~table~~ + +```ts +table: Table; +``` + +#### Deprecated + +Reference to the table instance. + +#### Inherited from + +[`Header_CoreProperties`](header_coreproperties.md).[`table`](Header_CoreProperties.md#table) + +#### Defined in + +[core/headers/Headers.types.ts:134](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L134) diff --git a/docs/reference/interfaces/headercontext.md b/docs/reference/interfaces/headercontext.md new file mode 100644 index 0000000000..7925d4bf40 --- /dev/null +++ b/docs/reference/interfaces/headercontext.md @@ -0,0 +1,56 @@ +--- +id: HeaderContext +title: HeaderContext +--- + +# Interface: HeaderContext\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* [`CellData`](../type-aliases/celldata.md) = [`CellData`](../type-aliases/celldata.md) + +## Properties + +### column + +```ts +column: Column; +``` + +An instance of a column. + +#### Defined in + +[core/headers/Headers.types.ts:55](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L55) + +*** + +### header + +```ts +header: Header; +``` + +An instance of a header. + +#### Defined in + +[core/headers/Headers.types.ts:59](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L59) + +*** + +### table + +```ts +table: Table; +``` + +The table instance. + +#### Defined in + +[core/headers/Headers.types.ts:63](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L63) diff --git a/docs/reference/interfaces/headergroup.md b/docs/reference/interfaces/headergroup.md new file mode 100644 index 0000000000..0e16f0d75d --- /dev/null +++ b/docs/reference/interfaces/headergroup.md @@ -0,0 +1,64 @@ +--- +id: HeaderGroup +title: HeaderGroup +--- + +# Interface: HeaderGroup\ + +## Extends + +- [`HeaderGroup_Core`](headergroup_core.md)\<`TFeatures`, `TData`\> + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### depth + +```ts +depth: number; +``` + +#### Inherited from + +[`HeaderGroup_Core`](headergroup_core.md).[`depth`](HeaderGroup_Core.md#depth) + +#### Defined in + +[core/headers/Headers.types.ts:161](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L161) + +*** + +### headers + +```ts +headers: Header[]; +``` + +#### Inherited from + +[`HeaderGroup_Core`](headergroup_core.md).[`headers`](HeaderGroup_Core.md#headers) + +#### Defined in + +[core/headers/Headers.types.ts:162](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L162) + +*** + +### id + +```ts +id: string; +``` + +#### Inherited from + +[`HeaderGroup_Core`](headergroup_core.md).[`id`](HeaderGroup_Core.md#id) + +#### Defined in + +[core/headers/Headers.types.ts:163](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L163) diff --git a/docs/reference/interfaces/headergroup_core.md b/docs/reference/interfaces/headergroup_core.md new file mode 100644 index 0000000000..e098e85079 --- /dev/null +++ b/docs/reference/interfaces/headergroup_core.md @@ -0,0 +1,68 @@ +--- +id: HeaderGroup_Core +title: HeaderGroup_Core +--- + +# Interface: HeaderGroup\_Core\ + +## Extends + +- [`HeaderGroup_Header`](headergroup_header.md)\<`TFeatures`, `TData`\> + +## Extended by + +- [`HeaderGroup`](headergroup.md) + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### depth + +```ts +depth: number; +``` + +#### Inherited from + +[`HeaderGroup_Header`](headergroup_header.md).[`depth`](HeaderGroup_Header.md#depth) + +#### Defined in + +[core/headers/Headers.types.ts:161](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L161) + +*** + +### headers + +```ts +headers: Header[]; +``` + +#### Inherited from + +[`HeaderGroup_Header`](headergroup_header.md).[`headers`](HeaderGroup_Header.md#headers) + +#### Defined in + +[core/headers/Headers.types.ts:162](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L162) + +*** + +### id + +```ts +id: string; +``` + +#### Inherited from + +[`HeaderGroup_Header`](headergroup_header.md).[`id`](HeaderGroup_Header.md#id) + +#### Defined in + +[core/headers/Headers.types.ts:163](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L163) diff --git a/docs/reference/interfaces/headergroup_header.md b/docs/reference/interfaces/headergroup_header.md new file mode 100644 index 0000000000..12b2c04834 --- /dev/null +++ b/docs/reference/interfaces/headergroup_header.md @@ -0,0 +1,54 @@ +--- +id: HeaderGroup_Header +title: HeaderGroup_Header +--- + +# Interface: HeaderGroup\_Header\ + +## Extended by + +- [`HeaderGroup_Core`](headergroup_core.md) + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* [`CellData`](../type-aliases/celldata.md) = [`CellData`](../type-aliases/celldata.md) + +## Properties + +### depth + +```ts +depth: number; +``` + +#### Defined in + +[core/headers/Headers.types.ts:161](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L161) + +*** + +### headers + +```ts +headers: Header[]; +``` + +#### Defined in + +[core/headers/Headers.types.ts:162](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L162) + +*** + +### id + +```ts +id: string; +``` + +#### Defined in + +[core/headers/Headers.types.ts:163](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L163) diff --git a/docs/reference/interfaces/ididentifier.md b/docs/reference/interfaces/ididentifier.md new file mode 100644 index 0000000000..83ced4c914 --- /dev/null +++ b/docs/reference/interfaces/ididentifier.md @@ -0,0 +1,38 @@ +--- +id: IdIdentifier +title: IdIdentifier +--- + +# Interface: IdIdentifier\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* [`CellData`](../type-aliases/celldata.md) = [`CellData`](../type-aliases/celldata.md) + +## Properties + +### header? + +```ts +optional header: ColumnDefTemplate>; +``` + +#### Defined in + +[types/ColumnDef.ts:46](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L46) + +*** + +### id + +```ts +id: string; +``` + +#### Defined in + +[types/ColumnDef.ts:45](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L45) diff --git a/docs/reference/interfaces/paginationdefaultoptions.md b/docs/reference/interfaces/paginationdefaultoptions.md new file mode 100644 index 0000000000..581e4b9b83 --- /dev/null +++ b/docs/reference/interfaces/paginationdefaultoptions.md @@ -0,0 +1,18 @@ +--- +id: PaginationDefaultOptions +title: PaginationDefaultOptions +--- + +# Interface: PaginationDefaultOptions + +## Properties + +### onPaginationChange + +```ts +onPaginationChange: OnChangeFn; +``` + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:49](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L49) diff --git a/docs/reference/interfaces/paginationstate.md b/docs/reference/interfaces/paginationstate.md new file mode 100644 index 0000000000..d82173cf1b --- /dev/null +++ b/docs/reference/interfaces/paginationstate.md @@ -0,0 +1,30 @@ +--- +id: PaginationState +title: PaginationState +--- + +# Interface: PaginationState + +## Properties + +### pageIndex + +```ts +pageIndex: number; +``` + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:7](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L7) + +*** + +### pageSize + +```ts +pageSize: number; +``` + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:8](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L8) diff --git a/docs/reference/interfaces/resolvedcolumnfilter.md b/docs/reference/interfaces/resolvedcolumnfilter.md new file mode 100644 index 0000000000..0c8fecda01 --- /dev/null +++ b/docs/reference/interfaces/resolvedcolumnfilter.md @@ -0,0 +1,48 @@ +--- +id: ResolvedColumnFilter +title: ResolvedColumnFilter +--- + +# Interface: ResolvedColumnFilter\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### filterFn + +```ts +filterFn: FilterFn; +``` + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:33](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L33) + +*** + +### id + +```ts +id: string; +``` + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:34](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L34) + +*** + +### resolvedValue + +```ts +resolvedValue: unknown; +``` + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:35](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L35) diff --git a/docs/reference/interfaces/row_columnfiltering.md b/docs/reference/interfaces/row_columnfiltering.md new file mode 100644 index 0000000000..93e178c459 --- /dev/null +++ b/docs/reference/interfaces/row_columnfiltering.md @@ -0,0 +1,56 @@ +--- +id: Row_ColumnFiltering +title: Row_ColumnFiltering +--- + +# Interface: Row\_ColumnFiltering\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### columnFilters + +```ts +columnFilters: Record; +``` + +The column filters map for the row. This object tracks whether a row is passing/failing specific filters by their column ID. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#columnfilters) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:156](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L156) + +*** + +### columnFiltersMeta + +```ts +columnFiltersMeta: Record; +``` + +The column filters meta map for the row. This object tracks any filter meta for a row as optionally provided during the filtering process. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#columnfiltersmeta) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:162](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L162) diff --git a/docs/reference/interfaces/row_columngrouping.md b/docs/reference/interfaces/row_columngrouping.md new file mode 100644 index 0000000000..9c0ae43af7 --- /dev/null +++ b/docs/reference/interfaces/row_columngrouping.md @@ -0,0 +1,118 @@ +--- +id: Row_ColumnGrouping +title: Row_ColumnGrouping +--- + +# Interface: Row\_ColumnGrouping + +## Properties + +### \_groupingValuesCache + +```ts +_groupingValuesCache: Record; +``` + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:135](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L135) + +*** + +### getGroupingValue() + +```ts +getGroupingValue: (columnId) => unknown; +``` + +Returns the grouping value for any row and column (including leaf rows). + +#### Parameters + +• **columnId**: `string` + +#### Returns + +`unknown` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupingvalue) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:141](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L141) + +*** + +### getIsGrouped() + +```ts +getIsGrouped: () => boolean; +``` + +Returns whether or not the row is currently grouped. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getisgrouped) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:147](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L147) + +*** + +### groupingColumnId? + +```ts +optional groupingColumnId: string; +``` + +If this row is grouped, this is the id of the column that this row is grouped by. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#groupingcolumnid) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:153](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L153) + +*** + +### groupingValue? + +```ts +optional groupingValue: unknown; +``` + +If this row is grouped, this is the unique/shared value for the `groupingColumnId` for all of the rows in this group. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#groupingvalue) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:159](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L159) diff --git a/docs/reference/interfaces/row_columnpinning.md b/docs/reference/interfaces/row_columnpinning.md new file mode 100644 index 0000000000..ecf5747420 --- /dev/null +++ b/docs/reference/interfaces/row_columnpinning.md @@ -0,0 +1,90 @@ +--- +id: Row_ColumnPinning +title: Row_ColumnPinning +--- + +# Interface: Row\_ColumnPinning\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getCenterVisibleCells() + +```ts +getCenterVisibleCells: () => Cell[]; +``` + +Returns all center pinned (unpinned) leaf cells in the row. + +#### Returns + +[`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getcentervisiblecells) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-pinning) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:83](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L83) + +*** + +### getLeftVisibleCells() + +```ts +getLeftVisibleCells: () => Cell[]; +``` + +Returns all left pinned leaf cells in the row. + +#### Returns + +[`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getleftvisiblecells) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-pinning) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:89](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L89) + +*** + +### getRightVisibleCells() + +```ts +getRightVisibleCells: () => Cell[]; +``` + +Returns all right pinned leaf cells in the row. + +#### Returns + +[`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getrightvisiblecells) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-pinning) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:95](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L95) diff --git a/docs/reference/interfaces/row_columnvisibility.md b/docs/reference/interfaces/row_columnvisibility.md new file mode 100644 index 0000000000..765bf3ba56 --- /dev/null +++ b/docs/reference/interfaces/row_columnvisibility.md @@ -0,0 +1,54 @@ +--- +id: Row_ColumnVisibility +title: Row_ColumnVisibility +--- + +# Interface: Row\_ColumnVisibility\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getAllVisibleCells() + +```ts +getAllVisibleCells: () => Cell[]; +``` + +#### Returns + +[`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:99](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L99) + +*** + +### getVisibleCells() + +```ts +getVisibleCells: () => Cell[]; +``` + +Returns an array of cells that account for column visibility for the row. + +#### Returns + +[`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getvisiblecells) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:105](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L105) diff --git a/docs/reference/interfaces/row_coreproperties.md b/docs/reference/interfaces/row_coreproperties.md new file mode 100644 index 0000000000..7cc71e99e4 --- /dev/null +++ b/docs/reference/interfaces/row_coreproperties.md @@ -0,0 +1,210 @@ +--- +id: Row_CoreProperties +title: Row_CoreProperties +--- + +# Interface: Row\_CoreProperties\ + +## Extended by + +- [`Row_Row`](row_row.md) + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### \_uniqueValuesCache + +```ts +_uniqueValuesCache: Record; +``` + +#### Defined in + +[core/rows/Rows.types.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L11) + +*** + +### \_valuesCache + +```ts +_valuesCache: Record; +``` + +#### Defined in + +[core/rows/Rows.types.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L12) + +*** + +### depth + +```ts +depth: number; +``` + +The depth of the row (if nested or grouped) relative to the root row array. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#depth) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Defined in + +[core/rows/Rows.types.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L18) + +*** + +### id + +```ts +id: string; +``` + +The resolved unique identifier for the row resolved via the `options.getRowId` option. Defaults to the row's index (or relative index if it is a subRow). + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#id) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Defined in + +[core/rows/Rows.types.ts:24](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L24) + +*** + +### index + +```ts +index: number; +``` + +The index of the row within its parent array (or the root data array). + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#index) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Defined in + +[core/rows/Rows.types.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L30) + +*** + +### original + +```ts +original: TData; +``` + +The original row object provided to the table. If the row is a grouped row, the original row object will be the first original in the group. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#original) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Defined in + +[core/rows/Rows.types.ts:36](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L36) + +*** + +### originalSubRows? + +```ts +optional originalSubRows: TData[]; +``` + +An array of the original subRows as returned by the `options.getSubRows` option. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#originalsubrows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Defined in + +[core/rows/Rows.types.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L42) + +*** + +### parentId? + +```ts +optional parentId: string; +``` + +If nested, this row's parent row id. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#parentid) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Defined in + +[core/rows/Rows.types.ts:48](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L48) + +*** + +### subRows + +```ts +subRows: Row[]; +``` + +An array of subRows for the row as returned and created by the `options.getSubRows` option. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#subrows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Defined in + +[core/rows/Rows.types.ts:54](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L54) + +*** + +### ~~table~~ + +```ts +table: Table_Internal; +``` + +#### Deprecated + +Reference to the table instance. + +#### Defined in + +[core/rows/Rows.types.ts:58](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L58) diff --git a/docs/reference/interfaces/row_row.md b/docs/reference/interfaces/row_row.md new file mode 100644 index 0000000000..7b683ff145 --- /dev/null +++ b/docs/reference/interfaces/row_row.md @@ -0,0 +1,472 @@ +--- +id: Row_Row +title: Row_Row +--- + +# Interface: Row\_Row\ + +## Extends + +- [`Row_CoreProperties`](row_coreproperties.md)\<`TFeatures`, `TData`\> + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### \_uniqueValuesCache + +```ts +_uniqueValuesCache: Record; +``` + +#### Inherited from + +[`Row_CoreProperties`](row_coreproperties.md).[`_uniqueValuesCache`](Row_CoreProperties.md#_uniquevaluescache) + +#### Defined in + +[core/rows/Rows.types.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L11) + +*** + +### \_valuesCache + +```ts +_valuesCache: Record; +``` + +#### Inherited from + +[`Row_CoreProperties`](row_coreproperties.md).[`_valuesCache`](Row_CoreProperties.md#_valuescache) + +#### Defined in + +[core/rows/Rows.types.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L12) + +*** + +### depth + +```ts +depth: number; +``` + +The depth of the row (if nested or grouped) relative to the root row array. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#depth) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Inherited from + +[`Row_CoreProperties`](row_coreproperties.md).[`depth`](Row_CoreProperties.md#depth) + +#### Defined in + +[core/rows/Rows.types.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L18) + +*** + +### getAllCells() + +```ts +getAllCells: () => Cell[]; +``` + +Returns all of the cells for the row. + +#### Returns + +[`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#getallcells) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Defined in + +[core/rows/Rows.types.ts:69](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L69) + +*** + +### getAllCellsByColumnId() + +```ts +getAllCellsByColumnId: () => Record>; +``` + +#### Returns + +`Record`\<`string`, [`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `unknown`\>\> + +#### Defined in + +[core/rows/Rows.types.ts:63](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L63) + +*** + +### getLeafRows() + +```ts +getLeafRows: () => Row[]; +``` + +Returns the leaf rows for the row, not including any parent rows. + +#### Returns + +[`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#getleafrows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Defined in + +[core/rows/Rows.types.ts:75](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L75) + +*** + +### getParentRow() + +```ts +getParentRow: () => undefined | Row; +``` + +Returns the parent row for the row, if it exists. + +#### Returns + +`undefined` \| [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#getparentrow) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Defined in + +[core/rows/Rows.types.ts:81](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L81) + +*** + +### getParentRows() + +```ts +getParentRows: () => Row[]; +``` + +Returns the parent rows for the row, all the way up to a root row. + +#### Returns + +[`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#getparentrows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Defined in + +[core/rows/Rows.types.ts:87](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L87) + +*** + +### getUniqueValues() + +```ts +getUniqueValues: (columnId) => TValue[]; +``` + +Returns a unique array of values from the row for a given columnId. + +#### Type Parameters + +• **TValue** + +#### Parameters + +• **columnId**: `string` + +#### Returns + +`TValue`[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#getuniquevalues) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Defined in + +[core/rows/Rows.types.ts:93](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L93) + +*** + +### getValue() + +```ts +getValue: (columnId) => TValue; +``` + +Returns the value from the row for a given columnId. + +#### Type Parameters + +• **TValue** + +#### Parameters + +• **columnId**: `string` + +#### Returns + +`TValue` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#getvalue) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Defined in + +[core/rows/Rows.types.ts:99](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L99) + +*** + +### id + +```ts +id: string; +``` + +The resolved unique identifier for the row resolved via the `options.getRowId` option. Defaults to the row's index (or relative index if it is a subRow). + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#id) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Inherited from + +[`Row_CoreProperties`](row_coreproperties.md).[`id`](Row_CoreProperties.md#id) + +#### Defined in + +[core/rows/Rows.types.ts:24](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L24) + +*** + +### index + +```ts +index: number; +``` + +The index of the row within its parent array (or the root data array). + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#index) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Inherited from + +[`Row_CoreProperties`](row_coreproperties.md).[`index`](Row_CoreProperties.md#index) + +#### Defined in + +[core/rows/Rows.types.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L30) + +*** + +### original + +```ts +original: TData; +``` + +The original row object provided to the table. If the row is a grouped row, the original row object will be the first original in the group. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#original) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Inherited from + +[`Row_CoreProperties`](row_coreproperties.md).[`original`](Row_CoreProperties.md#original) + +#### Defined in + +[core/rows/Rows.types.ts:36](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L36) + +*** + +### originalSubRows? + +```ts +optional originalSubRows: TData[]; +``` + +An array of the original subRows as returned by the `options.getSubRows` option. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#originalsubrows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Inherited from + +[`Row_CoreProperties`](row_coreproperties.md).[`originalSubRows`](Row_CoreProperties.md#originalsubrows) + +#### Defined in + +[core/rows/Rows.types.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L42) + +*** + +### parentId? + +```ts +optional parentId: string; +``` + +If nested, this row's parent row id. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#parentid) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Inherited from + +[`Row_CoreProperties`](row_coreproperties.md).[`parentId`](Row_CoreProperties.md#parentid) + +#### Defined in + +[core/rows/Rows.types.ts:48](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L48) + +*** + +### renderValue() + +```ts +renderValue: (columnId) => TValue; +``` + +Renders the value for the row in a given columnId the same as `getValue`, but will return the `renderFallbackValue` if no value is found. + +#### Type Parameters + +• **TValue** + +#### Parameters + +• **columnId**: `string` + +#### Returns + +`TValue` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#rendervalue) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Defined in + +[core/rows/Rows.types.ts:105](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L105) + +*** + +### subRows + +```ts +subRows: Row[]; +``` + +An array of subRows for the row as returned and created by the `options.getSubRows` option. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/row#subrows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/rows) + +#### Inherited from + +[`Row_CoreProperties`](row_coreproperties.md).[`subRows`](Row_CoreProperties.md#subrows) + +#### Defined in + +[core/rows/Rows.types.ts:54](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L54) + +*** + +### ~~table~~ + +```ts +table: Table_Internal; +``` + +#### Deprecated + +Reference to the table instance. + +#### Inherited from + +[`Row_CoreProperties`](row_coreproperties.md).[`table`](Row_CoreProperties.md#table) + +#### Defined in + +[core/rows/Rows.types.ts:58](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L58) diff --git a/docs/reference/interfaces/row_rowexpanding.md b/docs/reference/interfaces/row_rowexpanding.md new file mode 100644 index 0000000000..79a8a663a0 --- /dev/null +++ b/docs/reference/interfaces/row_rowexpanding.md @@ -0,0 +1,144 @@ +--- +id: Row_RowExpanding +title: Row_RowExpanding +--- + +# Interface: Row\_RowExpanding + +## Properties + +### getCanExpand() + +```ts +getCanExpand: () => boolean; +``` + +Returns whether the row can be expanded. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getcanexpand) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L20) + +*** + +### getIsAllParentsExpanded() + +```ts +getIsAllParentsExpanded: () => boolean; +``` + +Returns whether all parent rows of the row are expanded. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getisallparentsexpanded) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L26) + +*** + +### getIsExpanded() + +```ts +getIsExpanded: () => boolean; +``` + +Returns whether the row is expanded. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getisexpanded) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:32](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L32) + +*** + +### getToggleExpandedHandler() + +```ts +getToggleExpandedHandler: () => () => void; +``` + +Returns a function that can be used to toggle the expanded state of the row. This function can be used to bind to an event handler to a button. + +#### Returns + +`Function` + +##### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#gettoggleexpandedhandler) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:38](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L38) + +*** + +### toggleExpanded() + +```ts +toggleExpanded: (expanded?) => void; +``` + +Toggles the expanded state (or sets it if `expanded` is provided) for the row. + +#### Parameters + +• **expanded?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#toggleexpanded) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:44](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L44) diff --git a/docs/reference/interfaces/row_rowpinning.md b/docs/reference/interfaces/row_rowpinning.md new file mode 100644 index 0000000000..2bf15a7095 --- /dev/null +++ b/docs/reference/interfaces/row_rowpinning.md @@ -0,0 +1,118 @@ +--- +id: Row_RowPinning +title: Row_RowPinning +--- + +# Interface: Row\_RowPinning + +## Properties + +### getCanPin() + +```ts +getCanPin: () => boolean; +``` + +Returns whether or not the row can be pinned. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#getcanpin-1) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-pinning) + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:50](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L50) + +*** + +### getIsPinned() + +```ts +getIsPinned: () => RowPinningPosition; +``` + +Returns the pinned position of the row. (`'top'`, `'bottom'` or `false`) + +#### Returns + +[`RowPinningPosition`](../type-aliases/rowpinningposition.md) + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#getispinned-1) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-pinning) + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:56](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L56) + +*** + +### getPinnedIndex() + +```ts +getPinnedIndex: () => number; +``` + +Returns the numeric pinned index of the row within a pinned row group. + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#getpinnedindex-1) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-pinning) + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:62](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L62) + +*** + +### pin() + +```ts +pin: (position, includeLeafRows?, includeParentRows?) => void; +``` + +Pins a row to the `'top'` or `'bottom'`, or unpins the row to the center if `false` is passed. + +#### Parameters + +• **position**: [`RowPinningPosition`](../type-aliases/rowpinningposition.md) + +• **includeLeafRows?**: `boolean` + +• **includeParentRows?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#pin-1) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-pinning) + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:68](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L68) diff --git a/docs/reference/interfaces/row_rowselection.md b/docs/reference/interfaces/row_rowselection.md new file mode 100644 index 0000000000..b4cad51764 --- /dev/null +++ b/docs/reference/interfaces/row_rowselection.md @@ -0,0 +1,230 @@ +--- +id: Row_RowSelection +title: Row_RowSelection +--- + +# Interface: Row\_RowSelection + +## Properties + +### getCanMultiSelect() + +```ts +getCanMultiSelect: () => boolean; +``` + +Returns whether or not the row can multi-select. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getcanmultiselect) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:62](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L62) + +*** + +### getCanSelect() + +```ts +getCanSelect: () => boolean; +``` + +Returns whether or not the row can be selected. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getcanselect) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:68](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L68) + +*** + +### getCanSelectSubRows() + +```ts +getCanSelectSubRows: () => boolean; +``` + +Returns whether or not the row can select sub rows automatically when the parent row is selected. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getcanselectsubrows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:74](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L74) + +*** + +### getIsAllSubRowsSelected() + +```ts +getIsAllSubRowsSelected: () => boolean; +``` + +Returns whether or not all of the row's sub rows are selected. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getisallsubrowsselected) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:80](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L80) + +*** + +### getIsSelected() + +```ts +getIsSelected: () => boolean; +``` + +Returns whether or not the row is selected. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getisselected) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:86](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L86) + +*** + +### getIsSomeSelected() + +```ts +getIsSomeSelected: () => boolean; +``` + +Returns whether or not some of the row's sub rows are selected. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getissomeselected) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:92](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L92) + +*** + +### getToggleSelectedHandler() + +```ts +getToggleSelectedHandler: () => (event) => void; +``` + +Returns a handler that can be used to toggle the row. + +#### Returns + +`Function` + +##### Parameters + +• **event**: `unknown` + +##### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#gettoggleselectedhandler) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:98](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L98) + +*** + +### toggleSelected() + +```ts +toggleSelected: (value?, opts?) => void; +``` + +Selects/deselects the row. + +#### Parameters + +• **value?**: `boolean` + +• **opts?** + +• **opts.selectChildren?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#toggleselected) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:104](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L104) diff --git a/docs/reference/interfaces/rowmodel.md b/docs/reference/interfaces/rowmodel.md new file mode 100644 index 0000000000..d29148b12d --- /dev/null +++ b/docs/reference/interfaces/rowmodel.md @@ -0,0 +1,48 @@ +--- +id: RowModel +title: RowModel +--- + +# Interface: RowModel\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### flatRows + +```ts +flatRows: Row[]; +``` + +#### Defined in + +[core/row-models/RowModels.types.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.types.ts#L17) + +*** + +### rows + +```ts +rows: Row[]; +``` + +#### Defined in + +[core/row-models/RowModels.types.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.types.ts#L16) + +*** + +### rowsById + +```ts +rowsById: Record>; +``` + +#### Defined in + +[core/row-models/RowModels.types.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.types.ts#L18) diff --git a/docs/reference/interfaces/rowpinningdefaultoptions.md b/docs/reference/interfaces/rowpinningdefaultoptions.md new file mode 100644 index 0000000000..8afa325b01 --- /dev/null +++ b/docs/reference/interfaces/rowpinningdefaultoptions.md @@ -0,0 +1,18 @@ +--- +id: RowPinningDefaultOptions +title: RowPinningDefaultOptions +--- + +# Interface: RowPinningDefaultOptions + +## Properties + +### onRowPinningChange + +```ts +onRowPinningChange: OnChangeFn; +``` + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:41](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L41) diff --git a/docs/reference/interfaces/rowpinningstate.md b/docs/reference/interfaces/rowpinningstate.md new file mode 100644 index 0000000000..c624c68281 --- /dev/null +++ b/docs/reference/interfaces/rowpinningstate.md @@ -0,0 +1,30 @@ +--- +id: RowPinningState +title: RowPinningState +--- + +# Interface: RowPinningState + +## Properties + +### bottom + +```ts +bottom: string[]; +``` + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:8](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L8) + +*** + +### top + +```ts +top: string[]; +``` + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:9](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L9) diff --git a/docs/reference/interfaces/sortingfn.md b/docs/reference/interfaces/sortingfn.md new file mode 100644 index 0000000000..3a27411b2b --- /dev/null +++ b/docs/reference/interfaces/sortingfn.md @@ -0,0 +1,35 @@ +--- +id: SortingFn +title: SortingFn +--- + +# Interface: SortingFn()\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +```ts +interface SortingFn( + rowA, + rowB, + columnId): number +``` + +## Parameters + +• **rowA**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +• **rowB**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +• **columnId**: `string` + +## Returns + +`number` + +## Defined in + +[features/row-sorting/RowSorting.types.ts:34](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L34) diff --git a/docs/reference/interfaces/sortingfns.md b/docs/reference/interfaces/sortingfns.md new file mode 100644 index 0000000000..6a564b3dc3 --- /dev/null +++ b/docs/reference/interfaces/sortingfns.md @@ -0,0 +1,6 @@ +--- +id: SortingFns +title: SortingFns +--- + +# Interface: SortingFns diff --git a/docs/reference/interfaces/stringheaderidentifier.md b/docs/reference/interfaces/stringheaderidentifier.md new file mode 100644 index 0000000000..66bafbee93 --- /dev/null +++ b/docs/reference/interfaces/stringheaderidentifier.md @@ -0,0 +1,30 @@ +--- +id: StringHeaderIdentifier +title: StringHeaderIdentifier +--- + +# Interface: StringHeaderIdentifier + +## Properties + +### header + +```ts +header: string; +``` + +#### Defined in + +[types/ColumnDef.ts:36](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L36) + +*** + +### id? + +```ts +optional id: string; +``` + +#### Defined in + +[types/ColumnDef.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L37) diff --git a/docs/reference/interfaces/table_columnfiltering.md b/docs/reference/interfaces/table_columnfiltering.md new file mode 100644 index 0000000000..58f7d3b1d5 --- /dev/null +++ b/docs/reference/interfaces/table_columnfiltering.md @@ -0,0 +1,132 @@ +--- +id: Table_ColumnFiltering +title: Table_ColumnFiltering +--- + +# Interface: Table\_ColumnFiltering\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### resetColumnFilters() + +```ts +resetColumnFilters: (defaultState?) => void; +``` + +Resets the **columnFilters** state to `initialState.columnFilters`, or `true` can be passed to force a default blank state reset to `[]`. + +#### Parameters + +• **defaultState?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#resetcolumnfilters) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:218](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L218) + +*** + +### resetGlobalFilter() + +```ts +resetGlobalFilter: (defaultState?) => void; +``` + +Resets the **globalFilter** state to `initialState.globalFilter`, or `true` can be passed to force a default blank state reset to `undefined`. + +#### Parameters + +• **defaultState?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#resetglobalfilter) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:224](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L224) + +*** + +### setColumnFilters() + +```ts +setColumnFilters: (updater) => void; +``` + +Sets or updates the `state.columnFilters` state. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`ColumnFiltersState`](../type-aliases/columnfiltersstate.md)\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#setcolumnfilters) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:230](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L230) + +*** + +### setGlobalFilter() + +```ts +setGlobalFilter: (updater) => void; +``` + +Sets or updates the `state.globalFilter` state. + +#### Parameters + +• **updater**: `any` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#setglobalfilter) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:236](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L236) diff --git a/docs/reference/interfaces/table_columngrouping.md b/docs/reference/interfaces/table_columngrouping.md new file mode 100644 index 0000000000..e9631e3ad4 --- /dev/null +++ b/docs/reference/interfaces/table_columngrouping.md @@ -0,0 +1,72 @@ +--- +id: Table_ColumnGrouping +title: Table_ColumnGrouping +--- + +# Interface: Table\_ColumnGrouping\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### resetGrouping() + +```ts +resetGrouping: (defaultState?) => void; +``` + +Resets the **grouping** state to `initialState.grouping`, or `true` can be passed to force a default blank state reset to `[]`. + +#### Parameters + +• **defaultState?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#resetgrouping) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:226](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L226) + +*** + +### setGrouping() + +```ts +setGrouping: (updater) => void; +``` + +Updates the grouping state of the table via an update function or value. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`GroupingState`](../type-aliases/groupingstate.md)\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#setgrouping) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:232](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L232) diff --git a/docs/reference/interfaces/table_columnordering.md b/docs/reference/interfaces/table_columnordering.md new file mode 100644 index 0000000000..4c72ef4017 --- /dev/null +++ b/docs/reference/interfaces/table_columnordering.md @@ -0,0 +1,72 @@ +--- +id: Table_ColumnOrdering +title: Table_ColumnOrdering +--- + +# Interface: Table\_ColumnOrdering\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### resetColumnOrder() + +```ts +resetColumnOrder: (defaultState?) => void; +``` + +Resets the **columnOrder** state to `initialState.columnOrder`, or `true` can be passed to force a default blank state reset to `[]`. + +#### Parameters + +• **defaultState?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#resetcolumnorder) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-ordering) + +#### Defined in + +[features/column-ordering/ColumnOrdering.types.ts:54](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.types.ts#L54) + +*** + +### setColumnOrder() + +```ts +setColumnOrder: (updater) => void; +``` + +Sets or updates the `state.columnOrder` state. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`ColumnOrderState`](../type-aliases/columnorderstate.md)\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#setcolumnorder) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-ordering) + +#### Defined in + +[features/column-ordering/ColumnOrdering.types.ts:60](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.types.ts#L60) diff --git a/docs/reference/interfaces/table_columnpinning.md b/docs/reference/interfaces/table_columnpinning.md new file mode 100644 index 0000000000..d9eae8a96f --- /dev/null +++ b/docs/reference/interfaces/table_columnpinning.md @@ -0,0 +1,570 @@ +--- +id: Table_ColumnPinning +title: Table_ColumnPinning +--- + +# Interface: Table\_ColumnPinning\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getCenterFlatHeaders() + +```ts +getCenterFlatHeaders: () => Header[]; +``` + +If pinning, returns headers for all columns that are not pinned, including parent headers. + +#### Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getcenterflatheaders) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:107](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L107) + +*** + +### getCenterFooterGroups() + +```ts +getCenterFooterGroups: () => HeaderGroup[]; +``` + +If pinning, returns the footer groups for columns that are not pinned. + +#### Returns + +[`HeaderGroup`](headergroup.md)\<`TFeatures`, `TData`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getcenterfootergroups) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:113](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L113) + +*** + +### getCenterHeaderGroups() + +```ts +getCenterHeaderGroups: () => HeaderGroup[]; +``` + +If pinning, returns the header groups for columns that are not pinned. + +#### Returns + +[`HeaderGroup`](headergroup.md)\<`TFeatures`, `TData`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getcenterheadergroups) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:119](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L119) + +*** + +### getCenterLeafColumns() + +```ts +getCenterLeafColumns: () => Column[]; +``` + +Returns all center pinned (unpinned) leaf columns. + +#### Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getcenterleafcolumns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-pinning) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:125](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L125) + +*** + +### getCenterLeafHeaders() + +```ts +getCenterLeafHeaders: () => Header[]; +``` + +If pinning, returns headers for all columns that are not pinned, (not including parent headers). + +#### Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getcenterleafheaders) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:131](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L131) + +*** + +### getCenterVisibleLeafColumns() + +```ts +getCenterVisibleLeafColumns: () => Column[]; +``` + +If column pinning, returns a flat array of leaf-node columns that are visible in the unpinned/center portion of the table. + +#### Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getcentervisibleleafcolumns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:137](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L137) + +*** + +### getIsSomeColumnsPinned() + +```ts +getIsSomeColumnsPinned: (position?) => boolean; +``` + +Returns whether or not any columns are pinned. Optionally specify to only check for pinned columns in either the `left` or `right` position. + +#### Parameters + +• **position?**: [`ColumnPinningPosition`](../type-aliases/columnpinningposition.md) + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getissomecolumnspinned) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-pinning) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:143](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L143) + +*** + +### getLeftFlatHeaders() + +```ts +getLeftFlatHeaders: () => Header[]; +``` + +If pinning, returns headers for all left pinned columns in the table, including parent headers. + +#### Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getleftflatheaders) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:149](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L149) + +*** + +### getLeftFooterGroups() + +```ts +getLeftFooterGroups: () => HeaderGroup[]; +``` + +If pinning, returns the footer groups for the left pinned columns. + +#### Returns + +[`HeaderGroup`](headergroup.md)\<`TFeatures`, `TData`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getleftfootergroups) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:155](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L155) + +*** + +### getLeftHeaderGroups() + +```ts +getLeftHeaderGroups: () => HeaderGroup[]; +``` + +If pinning, returns the header groups for the left pinned columns. + +#### Returns + +[`HeaderGroup`](headergroup.md)\<`TFeatures`, `TData`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getleftheadergroups) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:161](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L161) + +*** + +### getLeftLeafColumns() + +```ts +getLeftLeafColumns: () => Column[]; +``` + +Returns all left pinned leaf columns. + +#### Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getleftleafcolumns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-pinning) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:167](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L167) + +*** + +### getLeftLeafHeaders() + +```ts +getLeftLeafHeaders: () => Header[]; +``` + +If pinning, returns headers for all left pinned leaf columns in the table, (not including parent headers). + +#### Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getleftleafheaders) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:173](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L173) + +*** + +### getLeftVisibleLeafColumns() + +```ts +getLeftVisibleLeafColumns: () => Column[]; +``` + +If column pinning, returns a flat array of leaf-node columns that are visible in the left portion of the table. + +#### Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getleftvisibleleafcolumns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:179](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L179) + +*** + +### getRightFlatHeaders() + +```ts +getRightFlatHeaders: () => Header[]; +``` + +If pinning, returns headers for all right pinned columns in the table, including parent headers. + +#### Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getrightflatheaders) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:185](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L185) + +*** + +### getRightFooterGroups() + +```ts +getRightFooterGroups: () => HeaderGroup[]; +``` + +If pinning, returns the footer groups for the right pinned columns. + +#### Returns + +[`HeaderGroup`](headergroup.md)\<`TFeatures`, `TData`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getrightfootergroups) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:191](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L191) + +*** + +### getRightHeaderGroups() + +```ts +getRightHeaderGroups: () => HeaderGroup[]; +``` + +If pinning, returns the header groups for the right pinned columns. + +#### Returns + +[`HeaderGroup`](headergroup.md)\<`TFeatures`, `TData`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getrightheadergroups) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:197](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L197) + +*** + +### getRightLeafColumns() + +```ts +getRightLeafColumns: () => Column[]; +``` + +Returns all right pinned leaf columns. + +#### Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getrightleafcolumns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-pinning) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:203](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L203) + +*** + +### getRightLeafHeaders() + +```ts +getRightLeafHeaders: () => Header[]; +``` + +If pinning, returns headers for all right pinned leaf columns in the table, (not including parent headers). + +#### Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getrightleafheaders) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:209](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L209) + +*** + +### getRightVisibleLeafColumns() + +```ts +getRightVisibleLeafColumns: () => Column[]; +``` + +If column pinning, returns a flat array of leaf-node columns that are visible in the right portion of the table. + +#### Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getrightvisibleleafcolumns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:215](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L215) + +*** + +### resetColumnPinning() + +```ts +resetColumnPinning: (defaultState?) => void; +``` + +Resets the **columnPinning** state to `initialState.columnPinning`, or `true` can be passed to force a default blank state reset to `{ left: [], right: [], }`. + +#### Parameters + +• **defaultState?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#resetcolumnpinning) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-pinning) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:221](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L221) + +*** + +### setColumnPinning() + +```ts +setColumnPinning: (updater) => void; +``` + +Sets or updates the `state.columnPinning` state. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`ColumnPinningState`](columnpinningstate.md)\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#setcolumnpinning) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-pinning) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:227](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L227) diff --git a/docs/reference/interfaces/table_columnresizing.md b/docs/reference/interfaces/table_columnresizing.md new file mode 100644 index 0000000000..4a184d9624 --- /dev/null +++ b/docs/reference/interfaces/table_columnresizing.md @@ -0,0 +1,66 @@ +--- +id: Table_ColumnResizing +title: Table_ColumnResizing +--- + +# Interface: Table\_ColumnResizing + +## Properties + +### resetHeaderSizeInfo() + +```ts +resetHeaderSizeInfo: (defaultState?) => void; +``` + +Resets column sizing info to its initial state. If `defaultState` is `true`, the default state for the table will be used instead of the initialValue provided to the table. + +#### Parameters + +• **defaultState?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#resetheadersizeinfo) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:58](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L58) + +*** + +### setcolumnResizing() + +```ts +setcolumnResizing: (updater) => void; +``` + +Sets the column sizing info state using an updater function or a value. This will trigger the underlying `oncolumnResizingChange` function if one is passed to the table options, otherwise the state will be managed automatically by the table. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`columnResizingState`](columnresizingstate.md)\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#setcolumnResizing) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:64](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L64) diff --git a/docs/reference/interfaces/table_columns.md b/docs/reference/interfaces/table_columns.md new file mode 100644 index 0000000000..42cc77d655 --- /dev/null +++ b/docs/reference/interfaces/table_columns.md @@ -0,0 +1,172 @@ +--- +id: Table_Columns +title: Table_Columns +--- + +# Interface: Table\_Columns\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getAllColumns() + +```ts +getAllColumns: () => Column[]; +``` + +Returns all columns in the table in their normalized and nested hierarchy. + +#### Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#getallcolumns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/columns/Columns.types.ts:122](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L122) + +*** + +### getAllFlatColumns() + +```ts +getAllFlatColumns: () => Column[]; +``` + +Returns all columns in the table flattened to a single level. + +#### Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#getallflatcolumns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/columns/Columns.types.ts:128](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L128) + +*** + +### getAllFlatColumnsById() + +```ts +getAllFlatColumnsById: () => Record>; +``` + +Returns a map of all flat columns by their ID. + +#### Returns + +`Record`\<`string`, [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#getallflatcolumnsbyid) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/columns/Columns.types.ts:110](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L110) + +*** + +### getAllLeafColumns() + +```ts +getAllLeafColumns: () => Column[]; +``` + +Returns all leaf-node columns in the table flattened to a single level. This does not include parent columns. + +#### Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#getallleafcolumns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/columns/Columns.types.ts:134](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L134) + +*** + +### getColumn() + +```ts +getColumn: (columnId) => undefined | Column; +``` + +Returns a single column by its ID. + +#### Parameters + +• **columnId**: `string` + +#### Returns + +`undefined` \| [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#getcolumn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/columns/Columns.types.ts:140](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L140) + +*** + +### getDefaultColumnDef() + +```ts +getDefaultColumnDef: () => Partial>; +``` + +Returns the default column options to use for all column defs supplied to the table. + +#### Returns + +`Partial`\<[`ColumnDef`](../type-aliases/columndef.md)\<`TFeatures`, `TData`, `unknown`\>\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#getdefaultcolumndef) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/columns/Columns.types.ts:116](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L116) diff --git a/docs/reference/interfaces/table_columnsizing.md b/docs/reference/interfaces/table_columnsizing.md new file mode 100644 index 0000000000..446b144aec --- /dev/null +++ b/docs/reference/interfaces/table_columnsizing.md @@ -0,0 +1,170 @@ +--- +id: Table_ColumnSizing +title: Table_ColumnSizing +--- + +# Interface: Table\_ColumnSizing + +## Properties + +### getCenterTotalSize() + +```ts +getCenterTotalSize: () => number; +``` + +If pinning, returns the total size of the center portion of the table by calculating the sum of the sizes of all unpinned/center leaf-columns. + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getcentertotalsize) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L30) + +*** + +### getLeftTotalSize() + +```ts +getLeftTotalSize: () => number; +``` + +Returns the total size of the left portion of the table by calculating the sum of the sizes of all left leaf-columns. + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getlefttotalsize) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:36](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L36) + +*** + +### getRightTotalSize() + +```ts +getRightTotalSize: () => number; +``` + +Returns the total size of the right portion of the table by calculating the sum of the sizes of all right leaf-columns. + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getrighttotalsize) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L42) + +*** + +### getTotalSize() + +```ts +getTotalSize: () => number; +``` + +Returns the total size of the table by calculating the sum of the sizes of all leaf-columns. + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#gettotalsize) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:48](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L48) + +*** + +### resetColumnSizing() + +```ts +resetColumnSizing: (defaultState?) => void; +``` + +Resets column sizing to its initial state. If `defaultState` is `true`, the default state for the table will be used instead of the initialValue provided to the table. + +#### Parameters + +• **defaultState?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#resetcolumnsizing) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:54](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L54) + +*** + +### setColumnSizing() + +```ts +setColumnSizing: (updater) => void; +``` + +Sets the column sizing state using an updater function or a value. This will trigger the underlying `onColumnSizingChange` function if one is passed to the table options, otherwise the state will be managed automatically by the table. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`ColumnSizingState`](../type-aliases/columnsizingstate.md)\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#setcolumnsizing) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:60](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L60) diff --git a/docs/reference/interfaces/table_columnvisibility.md b/docs/reference/interfaces/table_columnvisibility.md new file mode 100644 index 0000000000..00315a2461 --- /dev/null +++ b/docs/reference/interfaces/table_columnvisibility.md @@ -0,0 +1,240 @@ +--- +id: Table_ColumnVisibility +title: Table_ColumnVisibility +--- + +# Interface: Table\_ColumnVisibility\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getIsAllColumnsVisible() + +```ts +getIsAllColumnsVisible: () => boolean; +``` + +Returns whether all columns are visible + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getisallcolumnsvisible) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:41](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L41) + +*** + +### getIsSomeColumnsVisible() + +```ts +getIsSomeColumnsVisible: () => boolean; +``` + +Returns whether any columns are visible + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getissomecolumnsvisible) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:47](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L47) + +*** + +### getToggleAllColumnsVisibilityHandler() + +```ts +getToggleAllColumnsVisibilityHandler: () => (event) => void; +``` + +Returns a handler for toggling the visibility of all columns, meant to be bound to a `input[type=checkbox]` element. + +#### Returns + +`Function` + +##### Parameters + +• **event**: `unknown` + +##### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#gettoggleallcolumnsvisibilityhandler) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:53](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L53) + +*** + +### getVisibleFlatColumns() + +```ts +getVisibleFlatColumns: () => Column[]; +``` + +Returns a flat array of columns that are visible, including parent columns. + +#### Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getvisibleflatcolumns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:59](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L59) + +*** + +### getVisibleLeafColumns() + +```ts +getVisibleLeafColumns: () => Column[]; +``` + +Returns a flat array of leaf-node columns that are visible. + +#### Returns + +[`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getvisibleleafcolumns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:65](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L65) + +*** + +### resetColumnVisibility() + +```ts +resetColumnVisibility: (defaultState?) => void; +``` + +Resets the column visibility state to the initial state. If `defaultState` is provided, the state will be reset to `{}` + +#### Parameters + +• **defaultState?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#resetcolumnvisibility) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:71](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L71) + +*** + +### setColumnVisibility() + +```ts +setColumnVisibility: (updater) => void; +``` + +Sets or updates the `state.columnVisibility` state. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`ColumnVisibilityState`](../type-aliases/columnvisibilitystate.md)\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#setcolumnvisibility) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:77](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L77) + +*** + +### toggleAllColumnsVisible() + +```ts +toggleAllColumnsVisible: (value?) => void; +``` + +Toggles the visibility of all columns. + +#### Parameters + +• **value?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#toggleallcolumnsvisible) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:83](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L83) diff --git a/docs/reference/interfaces/table_coreproperties.md b/docs/reference/interfaces/table_coreproperties.md new file mode 100644 index 0000000000..40dba591ed --- /dev/null +++ b/docs/reference/interfaces/table_coreproperties.md @@ -0,0 +1,126 @@ +--- +id: Table_CoreProperties +title: Table_CoreProperties +--- + +# Interface: Table\_CoreProperties\ + +## Extended by + +- [`Table_Table`](table_table.md) + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### \_features + +```ts +_features: Partial> & TFeatures; +``` + +The features that are enabled for the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#_features) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:110](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L110) + +*** + +### \_processingFns + +```ts +_processingFns: ProcessingFns; +``` + +The processing functions that are used to process the data by features. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#_processingFns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:116](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L116) + +*** + +### \_rowModels + +```ts +_rowModels: CachedRowModels; +``` + +The row models that are enabled for the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#_rowmodels) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:122](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L122) + +*** + +### initialState + +```ts +initialState: TableState; +``` + +This is the resolved initial state of the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#initialstate) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:128](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L128) + +*** + +### options + +```ts +options: TableOptions; +``` + +A read-only reference to the table's current options. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#options) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:134](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L134) diff --git a/docs/reference/interfaces/table_globalfaceting.md b/docs/reference/interfaces/table_globalfaceting.md new file mode 100644 index 0000000000..1f513603af --- /dev/null +++ b/docs/reference/interfaces/table_globalfaceting.md @@ -0,0 +1,90 @@ +--- +id: Table_GlobalFaceting +title: Table_GlobalFaceting +--- + +# Interface: Table\_GlobalFaceting\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getGlobalFacetedMinMaxValues() + +```ts +getGlobalFacetedMinMaxValues: () => undefined | [number, number]; +``` + +Returns the min and max values for the global filter. + +#### Returns + +`undefined` \| [`number`, `number`] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalfacetedminmaxvalues) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/global-faceting) + +#### Defined in + +[features/global-faceting/GlobalFaceting.types.ts:14](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-faceting/GlobalFaceting.types.ts#L14) + +*** + +### getGlobalFacetedRowModel() + +```ts +getGlobalFacetedRowModel: () => RowModel; +``` + +Returns the row model for the table after **global** filtering has been applied. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalfacetedrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/global-faceting) + +#### Defined in + +[features/global-faceting/GlobalFaceting.types.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-faceting/GlobalFaceting.types.ts#L20) + +*** + +### getGlobalFacetedUniqueValues() + +```ts +getGlobalFacetedUniqueValues: () => Map; +``` + +Returns the faceted unique values for the global filter. + +#### Returns + +`Map`\<`any`, `number`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalfaceteduniquevalues) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/global-faceting) + +#### Defined in + +[features/global-faceting/GlobalFaceting.types.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-faceting/GlobalFaceting.types.ts#L26) diff --git a/docs/reference/interfaces/table_globalfiltering.md b/docs/reference/interfaces/table_globalfiltering.md new file mode 100644 index 0000000000..e6b91184a0 --- /dev/null +++ b/docs/reference/interfaces/table_globalfiltering.md @@ -0,0 +1,124 @@ +--- +id: Table_GlobalFiltering +title: Table_GlobalFiltering +--- + +# Interface: Table\_GlobalFiltering\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getGlobalAutoFilterFn() + +```ts +getGlobalAutoFilterFn: () => undefined | FilterFn; +``` + +Currently, this function returns the built-in `includesString` filter function. In future releases, it may return more dynamic filter functions based on the nature of the data provided. + +#### Returns + +`undefined` \| [`FilterFn`](filterfn.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#getglobalautofilterfn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/global-filtering) + +#### Defined in + +[features/global-filtering/GlobalFiltering.types.ts:86](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.types.ts#L86) + +*** + +### getGlobalFilterFn() + +```ts +getGlobalFilterFn: () => undefined | FilterFn; +``` + +Returns the filter function (either user-defined or automatic, depending on configuration) for the global filter. + +#### Returns + +`undefined` \| [`FilterFn`](filterfn.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#getglobalfilterfn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/global-filtering) + +#### Defined in + +[features/global-filtering/GlobalFiltering.types.ts:92](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.types.ts#L92) + +*** + +### resetGlobalFilter() + +```ts +resetGlobalFilter: (defaultState?) => void; +``` + +Resets the **globalFilter** state to `initialState.globalFilter`, or `true` can be passed to force a default blank state reset to `undefined`. + +#### Parameters + +• **defaultState?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#resetglobalfilter) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/global-filtering) + +#### Defined in + +[features/global-filtering/GlobalFiltering.types.ts:98](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.types.ts#L98) + +*** + +### setGlobalFilter() + +```ts +setGlobalFilter: (updater) => void; +``` + +Sets or updates the `state.globalFilter` state. + +#### Parameters + +• **updater**: `any` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#setglobalfilter) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/global-filtering) + +#### Defined in + +[features/global-filtering/GlobalFiltering.types.ts:104](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.types.ts#L104) diff --git a/docs/reference/interfaces/table_headers.md b/docs/reference/interfaces/table_headers.md new file mode 100644 index 0000000000..504765665e --- /dev/null +++ b/docs/reference/interfaces/table_headers.md @@ -0,0 +1,116 @@ +--- +id: Table_Headers +title: Table_Headers +--- + +# Interface: Table\_Headers\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getFlatHeaders() + +```ts +getFlatHeaders: () => Header[]; +``` + +Returns headers for all columns in the table, including parent headers. + +#### Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getflatheaders) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[core/headers/Headers.types.ts:38](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L38) + +*** + +### getFooterGroups() + +```ts +getFooterGroups: () => HeaderGroup[]; +``` + +Returns the footer groups for the table. + +#### Returns + +[`HeaderGroup`](headergroup.md)\<`TFeatures`, `TData`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getfootergroups) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[core/headers/Headers.types.ts:32](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L32) + +*** + +### getHeaderGroups() + +```ts +getHeaderGroups: () => HeaderGroup[]; +``` + +Returns all header groups for the table. + +#### Returns + +[`HeaderGroup`](headergroup.md)\<`TFeatures`, `TData`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getheadergroups) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[core/headers/Headers.types.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L26) + +*** + +### getLeafHeaders() + +```ts +getLeafHeaders: () => Header[]; +``` + +Returns headers for all leaf columns in the table, (not including parent headers). + +#### Returns + +[`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `unknown`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/headers#getleafheaders) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/headers) + +#### Defined in + +[core/headers/Headers.types.ts:44](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L44) diff --git a/docs/reference/interfaces/table_rowexpanding.md b/docs/reference/interfaces/table_rowexpanding.md new file mode 100644 index 0000000000..ae3d604e8c --- /dev/null +++ b/docs/reference/interfaces/table_rowexpanding.md @@ -0,0 +1,256 @@ +--- +id: Table_RowExpanding +title: Table_RowExpanding +--- + +# Interface: Table\_RowExpanding\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### autoResetExpanded() + +```ts +autoResetExpanded: () => void; +``` + +#### Returns + +`void` + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:99](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L99) + +*** + +### getCanSomeRowsExpand() + +```ts +getCanSomeRowsExpand: () => boolean; +``` + +Returns whether there are any rows that can be expanded. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getcansomerowsexpand) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:105](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L105) + +*** + +### getExpandedDepth() + +```ts +getExpandedDepth: () => number; +``` + +Returns the maximum depth of the expanded rows. + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getexpandeddepth) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:111](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L111) + +*** + +### getIsAllRowsExpanded() + +```ts +getIsAllRowsExpanded: () => boolean; +``` + +Returns whether all rows are currently expanded. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getisallrowsexpanded) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:117](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L117) + +*** + +### getIsSomeRowsExpanded() + +```ts +getIsSomeRowsExpanded: () => boolean; +``` + +Returns whether there are any rows that are currently expanded. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getissomerowsexpanded) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:123](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L123) + +*** + +### getToggleAllRowsExpandedHandler() + +```ts +getToggleAllRowsExpandedHandler: () => (event) => void; +``` + +Returns a handler that can be used to toggle the expanded state of all rows. This handler is meant to be used with an `input[type=checkbox]` element. + +#### Returns + +`Function` + +##### Parameters + +• **event**: `unknown` + +##### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#gettoggleallrowsexpandedhandler) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:129](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L129) + +*** + +### resetExpanded() + +```ts +resetExpanded: (defaultState?) => void; +``` + +Resets the expanded state of the table to the initial state. + +#### Parameters + +• **defaultState?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#resetexpanded) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:135](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L135) + +*** + +### setExpanded() + +```ts +setExpanded: (updater) => void; +``` + +Updates the expanded state of the table via an update function or value. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`ExpandedState`](../type-aliases/expandedstate.md)\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#setexpanded) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:141](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L141) + +*** + +### toggleAllRowsExpanded() + +```ts +toggleAllRowsExpanded: (expanded?) => void; +``` + +Toggles the expanded state for all rows. + +#### Parameters + +• **expanded?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#toggleallrowsexpanded) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:147](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L147) diff --git a/docs/reference/interfaces/table_rowmodels_core.md b/docs/reference/interfaces/table_rowmodels_core.md new file mode 100644 index 0000000000..1065948765 --- /dev/null +++ b/docs/reference/interfaces/table_rowmodels_core.md @@ -0,0 +1,64 @@ +--- +id: Table_RowModels_Core +title: Table_RowModels_Core +--- + +# Interface: Table\_RowModels\_Core\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getCoreRowModel() + +```ts +getCoreRowModel: () => RowModel; +``` + +Returns the core row model before any processing has been applied. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#getcorerowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/row-models/RowModels.types.ts:51](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.types.ts#L51) + +*** + +### getRowModel() + +```ts +getRowModel: () => RowModel; +``` + +Returns the final model after all processing from other used features has been applied. This is the row model that is most commonly used for rendering. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#getrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/row-models/RowModels.types.ts:57](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.types.ts#L57) diff --git a/docs/reference/interfaces/table_rowmodels_expanded.md b/docs/reference/interfaces/table_rowmodels_expanded.md new file mode 100644 index 0000000000..76080f750d --- /dev/null +++ b/docs/reference/interfaces/table_rowmodels_expanded.md @@ -0,0 +1,64 @@ +--- +id: Table_RowModels_Expanded +title: Table_RowModels_Expanded +--- + +# Interface: Table\_RowModels\_Expanded\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getExpandedRowModel() + +```ts +getExpandedRowModel: () => RowModel; +``` + +Returns the row model after expansion has been applied. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getexpandedrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:159](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L159) + +*** + +### getPreExpandedRowModel() + +```ts +getPreExpandedRowModel: () => RowModel; +``` + +Returns the row model before expansion has been applied. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getpreexpandedrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:165](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L165) diff --git a/docs/reference/interfaces/table_rowmodels_faceted.md b/docs/reference/interfaces/table_rowmodels_faceted.md new file mode 100644 index 0000000000..f1ef99c450 --- /dev/null +++ b/docs/reference/interfaces/table_rowmodels_faceted.md @@ -0,0 +1,93 @@ +--- +id: Table_RowModels_Faceted +title: Table_RowModels_Faceted +--- + +# Interface: Table\_RowModels\_Faceted\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getFacetedMinMaxValues() + +```ts +getFacetedMinMaxValues: () => undefined | [number, number]; +``` + +A function that **computes and returns** a min/max tuple derived from `column.getFacetedRowModel`. Useful for displaying faceted result values. +> ⚠️ Requires that you pass a valid `getFacetedMinMaxValues` function to `options.getFacetedMinMaxValues`. A default implementation is provided via the exported `getFacetedMinMaxValues` function. + +#### Returns + +`undefined` \| [`number`, `number`] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-faceting#getfacetedminmaxvalues) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-faceting) + +#### Defined in + +[features/column-faceting/ColumnFaceting.types.ts:21](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/ColumnFaceting.types.ts#L21) + +*** + +### getFacetedRowModel() + +```ts +getFacetedRowModel: () => RowModel; +``` + +Returns the row model with all other column filters applied, excluding its own filter. Useful for displaying faceted result counts. +> ⚠️ Requires that you pass a valid `getFacetedRowModel` function to `options.facetedRowModel`. A default implementation is provided via the exported `getFacetedRowModel` function. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-faceting#getfacetedrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-faceting) + +#### Defined in + +[features/column-faceting/ColumnFaceting.types.ts:28](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/ColumnFaceting.types.ts#L28) + +*** + +### getFacetedUniqueValues() + +```ts +getFacetedUniqueValues: () => Map; +``` + +A function that **computes and returns** a `Map` of unique values and their occurrences derived from `column.getFacetedRowModel`. Useful for displaying faceted result values. +> ⚠️ Requires that you pass a valid `getFacetedUniqueValues` function to `options.getFacetedUniqueValues`. A default implementation is provided via the exported `getFacetedUniqueValues` function. + +#### Returns + +`Map`\<`any`, `number`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-faceting#getfaceteduniquevalues) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-faceting) + +#### Defined in + +[features/column-faceting/ColumnFaceting.types.ts:35](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/ColumnFaceting.types.ts#L35) diff --git a/docs/reference/interfaces/table_rowmodels_filtered.md b/docs/reference/interfaces/table_rowmodels_filtered.md new file mode 100644 index 0000000000..299b4ec29c --- /dev/null +++ b/docs/reference/interfaces/table_rowmodels_filtered.md @@ -0,0 +1,64 @@ +--- +id: Table_RowModels_Filtered +title: Table_RowModels_Filtered +--- + +# Interface: Table\_RowModels\_Filtered\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getFilteredRowModel() + +```ts +getFilteredRowModel: () => RowModel; +``` + +Returns the row model for the table after **column** filtering has been applied. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#getfilteredrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:248](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L248) + +*** + +### getPreFilteredRowModel() + +```ts +getPreFilteredRowModel: () => RowModel; +``` + +Returns the row model for the table before any **column** filtering has been applied. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#getprefilteredrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:254](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L254) diff --git a/docs/reference/interfaces/table_rowmodels_grouped.md b/docs/reference/interfaces/table_rowmodels_grouped.md new file mode 100644 index 0000000000..080a4ba802 --- /dev/null +++ b/docs/reference/interfaces/table_rowmodels_grouped.md @@ -0,0 +1,64 @@ +--- +id: Table_RowModels_Grouped +title: Table_RowModels_Grouped +--- + +# Interface: Table\_RowModels\_Grouped\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getGroupedRowModel() + +```ts +getGroupedRowModel: () => RowModel; +``` + +Returns the row model for the table after grouping has been applied. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupedrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:244](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L244) + +*** + +### getPreGroupedRowModel() + +```ts +getPreGroupedRowModel: () => RowModel; +``` + +Returns the row model for the table before any grouping has been applied. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getpregroupedrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:250](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L250) diff --git a/docs/reference/interfaces/table_rowmodels_paginated.md b/docs/reference/interfaces/table_rowmodels_paginated.md new file mode 100644 index 0000000000..66060d408d --- /dev/null +++ b/docs/reference/interfaces/table_rowmodels_paginated.md @@ -0,0 +1,64 @@ +--- +id: Table_RowModels_Paginated +title: Table_RowModels_Paginated +--- + +# Interface: Table\_RowModels\_Paginated\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getPaginatedRowModel() + +```ts +getPaginatedRowModel: () => RowModel; +``` + +Returns the row model for the table after pagination has been applied. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getPaginatedRowModel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:158](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L158) + +*** + +### getPrePaginatedRowModel() + +```ts +getPrePaginatedRowModel: () => RowModel; +``` + +Returns the row model for the table before any pagination has been applied. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getprepaginationrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:164](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L164) diff --git a/docs/reference/interfaces/table_rowmodels_sorted.md b/docs/reference/interfaces/table_rowmodels_sorted.md new file mode 100644 index 0000000000..e275edb136 --- /dev/null +++ b/docs/reference/interfaces/table_rowmodels_sorted.md @@ -0,0 +1,64 @@ +--- +id: Table_RowModels_Sorted +title: Table_RowModels_Sorted +--- + +# Interface: Table\_RowModels\_Sorted\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getPreSortedRowModel() + +```ts +getPreSortedRowModel: () => RowModel; +``` + +Returns the row model for the table before any sorting has been applied. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getpresortedrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:265](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L265) + +*** + +### getSortedRowModel() + +```ts +getSortedRowModel: () => RowModel; +``` + +Returns the row model for the table after sorting has been applied. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#getsortedrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:271](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L271) diff --git a/docs/reference/interfaces/table_rowpagination.md b/docs/reference/interfaces/table_rowpagination.md new file mode 100644 index 0000000000..eedf194c4c --- /dev/null +++ b/docs/reference/interfaces/table_rowpagination.md @@ -0,0 +1,442 @@ +--- +id: Table_RowPagination +title: Table_RowPagination +--- + +# Interface: Table\_RowPagination\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### \_autoResetPageIndex() + +```ts +_autoResetPageIndex: () => void; +``` + +#### Returns + +`void` + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:56](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L56) + +*** + +### firstPage() + +```ts +firstPage: () => void; +``` + +Sets the page index to `0`. + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#firstpage) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:104](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L104) + +*** + +### getCanNextPage() + +```ts +getCanNextPage: () => boolean; +``` + +Returns whether the table can go to the next page. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getcannextpage) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:62](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L62) + +*** + +### getCanPreviousPage() + +```ts +getCanPreviousPage: () => boolean; +``` + +Returns whether the table can go to the previous page. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getcanpreviouspage) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:68](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L68) + +*** + +### getPageCount() + +```ts +getPageCount: () => number; +``` + +Returns the page count. If manually paginating or controlling the pagination state, this will come directly from the `options.pageCount` table option, otherwise it will be calculated from the table data using the total row count and current page size. + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getpagecount) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:74](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L74) + +*** + +### getPageOptions() + +```ts +getPageOptions: () => number[]; +``` + +Returns an array of page options (zero-index-based) for the current page size. + +#### Returns + +`number`[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getpageoptions) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:86](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L86) + +*** + +### getRowCount() + +```ts +getRowCount: () => number; +``` + +Returns the row count. If manually paginating or controlling the pagination state, this will come directly from the `options.rowCount` table option, otherwise it will be calculated from the table data. + +#### Returns + +`number` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#getrowcount) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:80](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L80) + +*** + +### lastPage() + +```ts +lastPage: () => void; +``` + +Sets the page index to the last page. + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#lastpage) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:110](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L110) + +*** + +### nextPage() + +```ts +nextPage: () => void; +``` + +Increments the page index by one, if possible. + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#nextpage) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:92](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L92) + +*** + +### previousPage() + +```ts +previousPage: () => void; +``` + +Decrements the page index by one, if possible. + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#previouspage) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:98](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L98) + +*** + +### resetPageIndex() + +```ts +resetPageIndex: (defaultState?) => void; +``` + +Resets the page index to its initial state. If `defaultState` is `true`, the page index will be reset to `0` regardless of initial state. + +#### Parameters + +• **defaultState?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#resetpageindex) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:116](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L116) + +*** + +### resetPageSize() + +```ts +resetPageSize: (defaultState?) => void; +``` + +Resets the page size to its initial state. If `defaultState` is `true`, the page size will be reset to `10` regardless of initial state. + +#### Parameters + +• **defaultState?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#resetpagesize) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:122](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L122) + +*** + +### resetPagination() + +```ts +resetPagination: (defaultState?) => void; +``` + +Resets the **pagination** state to `initialState.pagination`, or `true` can be passed to force a default blank state reset to `[]`. + +#### Parameters + +• **defaultState?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#resetpagination) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:128](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L128) + +*** + +### setPageIndex() + +```ts +setPageIndex: (updater) => void; +``` + +Updates the page index using the provided function or value in the `state.pagination.pageIndex` state. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<`number`\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#setpageindex) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:134](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L134) + +*** + +### setPageSize() + +```ts +setPageSize: (updater) => void; +``` + +Updates the page size using the provided function or value in the `state.pagination.pageSize` state. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<`number`\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#setpagesize) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:140](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L140) + +*** + +### setPagination() + +```ts +setPagination: (updater) => void; +``` + +Sets or updates the `state.pagination` state. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`PaginationState`](paginationstate.md)\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#setpagination) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:146](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L146) diff --git a/docs/reference/interfaces/table_rowpinning.md b/docs/reference/interfaces/table_rowpinning.md new file mode 100644 index 0000000000..90406c57b4 --- /dev/null +++ b/docs/reference/interfaces/table_rowpinning.md @@ -0,0 +1,180 @@ +--- +id: Table_RowPinning +title: Table_RowPinning +--- + +# Interface: Table\_RowPinning\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getBottomRows() + +```ts +getBottomRows: () => Row[]; +``` + +Returns all bottom pinned rows. + +#### Returns + +[`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#getbottomrows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-pinning) + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:84](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L84) + +*** + +### getCenterRows() + +```ts +getCenterRows: () => Row[]; +``` + +Returns all rows that are not pinned to the top or bottom. + +#### Returns + +[`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#getcenterrows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-pinning) + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:90](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L90) + +*** + +### getIsSomeRowsPinned() + +```ts +getIsSomeRowsPinned: (position?) => boolean; +``` + +Returns whether or not any rows are pinned. Optionally specify to only check for pinned rows in either the `top` or `bottom` position. + +#### Parameters + +• **position?**: [`RowPinningPosition`](../type-aliases/rowpinningposition.md) + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#getissomerowspinned) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-pinning) + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:96](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L96) + +*** + +### getTopRows() + +```ts +getTopRows: () => Row[]; +``` + +Returns all top pinned rows. + +#### Returns + +[`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\>[] + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#gettoprows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-pinning) + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:102](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L102) + +*** + +### resetRowPinning() + +```ts +resetRowPinning: (defaultState?) => void; +``` + +Resets the **rowPinning** state to `initialState.rowPinning`, or `true` can be passed to force a default blank state reset to `{ top: [], bottom: [], }`. + +#### Parameters + +• **defaultState?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#resetrowpinning) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-pinning) + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:108](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L108) + +*** + +### setRowPinning() + +```ts +setRowPinning: (updater) => void; +``` + +Sets or updates the `state.rowPinning` state. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`RowPinningState`](rowpinningstate.md)\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#setrowpinning) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-pinning) + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:114](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L114) diff --git a/docs/reference/interfaces/table_rows.md b/docs/reference/interfaces/table_rows.md new file mode 100644 index 0000000000..e2ebbd2600 --- /dev/null +++ b/docs/reference/interfaces/table_rows.md @@ -0,0 +1,68 @@ +--- +id: Table_Rows +title: Table_Rows +--- + +# Interface: Table\_Rows\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getRow() + +```ts +getRow: (id, searchAll?) => Row; +``` + +Returns the row with the given ID. + +#### Parameters + +• **id**: `string` + +• **searchAll?**: `boolean` + +#### Returns + +[`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#getrow) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/rows/Rows.types.ts:148](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L148) + +*** + +### getRowId() + +```ts +getRowId: (_, index, parent?) => string; +``` + +#### Parameters + +• **\_**: `TData` + +• **index**: `number` + +• **parent?**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +#### Returns + +`string` + +#### Defined in + +[core/rows/Rows.types.ts:142](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L142) diff --git a/docs/reference/interfaces/table_rowselection.md b/docs/reference/interfaces/table_rowselection.md new file mode 100644 index 0000000000..7ac6daa7d2 --- /dev/null +++ b/docs/reference/interfaces/table_rowselection.md @@ -0,0 +1,408 @@ +--- +id: Table_RowSelection +title: Table_RowSelection +--- + +# Interface: Table\_RowSelection\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### getFilteredSelectedRowModel() + +```ts +getFilteredSelectedRowModel: () => RowModel; +``` + +Returns the row model of all rows that are selected after filtering has been applied. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getfilteredselectedrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:116](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L116) + +*** + +### getGroupedSelectedRowModel() + +```ts +getGroupedSelectedRowModel: () => RowModel; +``` + +Returns the row model of all rows that are selected after grouping has been applied. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getgroupedselectedrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:122](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L122) + +*** + +### getIsAllPageRowsSelected() + +```ts +getIsAllPageRowsSelected: () => boolean; +``` + +Returns whether or not all rows on the current page are selected. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getisallpagerowsselected) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:128](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L128) + +*** + +### getIsAllRowsSelected() + +```ts +getIsAllRowsSelected: () => boolean; +``` + +Returns whether or not all rows in the table are selected. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getisallrowsselected) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:134](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L134) + +*** + +### getIsSomePageRowsSelected() + +```ts +getIsSomePageRowsSelected: () => boolean; +``` + +Returns whether or not any rows on the current page are selected. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getissomepagerowsselected) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:140](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L140) + +*** + +### getIsSomeRowsSelected() + +```ts +getIsSomeRowsSelected: () => boolean; +``` + +Returns whether or not any rows in the table are selected. + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getissomerowsselected) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:146](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L146) + +*** + +### getPreSelectedRowModel() + +```ts +getPreSelectedRowModel: () => RowModel; +``` + +Returns the core row model of all rows before row selection has been applied. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getpreselectedrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:152](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L152) + +*** + +### getSelectedRowModel() + +```ts +getSelectedRowModel: () => RowModel; +``` + +Returns the row model of all rows that are selected. + +#### Returns + +[`RowModel`](rowmodel.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#getselectedrowmodel) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:158](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L158) + +*** + +### getToggleAllPageRowsSelectedHandler() + +```ts +getToggleAllPageRowsSelectedHandler: () => (event) => void; +``` + +Returns a handler that can be used to toggle all rows on the current page. + +#### Returns + +`Function` + +##### Parameters + +• **event**: `unknown` + +##### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#gettoggleallpagerowsselectedhandler) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:164](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L164) + +*** + +### getToggleAllRowsSelectedHandler() + +```ts +getToggleAllRowsSelectedHandler: () => (event) => void; +``` + +Returns a handler that can be used to toggle all rows in the table. + +#### Returns + +`Function` + +##### Parameters + +• **event**: `unknown` + +##### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#gettoggleallrowsselectedhandler) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:170](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L170) + +*** + +### resetRowSelection() + +```ts +resetRowSelection: (defaultState?) => void; +``` + +Resets the **rowSelection** state to the `initialState.rowSelection`, or `true` can be passed to force a default blank state reset to `{}`. + +#### Parameters + +• **defaultState?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#resetrowselection) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:176](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L176) + +*** + +### setRowSelection() + +```ts +setRowSelection: (updater) => void; +``` + +Sets or updates the `state.rowSelection` state. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`RowSelectionState`](../type-aliases/rowselectionstate.md)\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#setrowselection) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:182](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L182) + +*** + +### toggleAllPageRowsSelected() + +```ts +toggleAllPageRowsSelected: (value?) => void; +``` + +Selects/deselects all rows on the current page. + +#### Parameters + +• **value?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#toggleallpagerowsselected) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:188](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L188) + +*** + +### toggleAllRowsSelected() + +```ts +toggleAllRowsSelected: (value?) => void; +``` + +Selects/deselects all rows in the table. + +#### Parameters + +• **value?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#toggleallrowsselected) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:194](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L194) diff --git a/docs/reference/interfaces/table_rowsorting.md b/docs/reference/interfaces/table_rowsorting.md new file mode 100644 index 0000000000..36bcaaaaaf --- /dev/null +++ b/docs/reference/interfaces/table_rowsorting.md @@ -0,0 +1,72 @@ +--- +id: Table_RowSorting +title: Table_RowSorting +--- + +# Interface: Table\_RowSorting\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### resetSorting() + +```ts +resetSorting: (defaultState?) => void; +``` + +Resets the **sorting** state to `initialState.sorting`, or `true` can be passed to force a default blank state reset to `[]`. + +#### Parameters + +• **defaultState?**: `boolean` + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#resetsorting) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:247](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L247) + +*** + +### setSorting() + +```ts +setSorting: (updater) => void; +``` + +Sets or updates the `state.sorting` state. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`SortingState`](../type-aliases/sortingstate.md)\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#setsorting) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:253](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L253) diff --git a/docs/reference/interfaces/table_table.md b/docs/reference/interfaces/table_table.md new file mode 100644 index 0000000000..4038b2908c --- /dev/null +++ b/docs/reference/interfaces/table_table.md @@ -0,0 +1,258 @@ +--- +id: Table_Table +title: Table_Table +--- + +# Interface: Table\_Table\ + +## Extends + +- [`Table_CoreProperties`](table_coreproperties.md)\<`TFeatures`, `TData`\> + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### \_features + +```ts +_features: Partial> & TFeatures; +``` + +The features that are enabled for the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#_features) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`Table_CoreProperties`](table_coreproperties.md).[`_features`](Table_CoreProperties.md#_features) + +#### Defined in + +[core/table/Tables.types.ts:110](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L110) + +*** + +### \_processingFns + +```ts +_processingFns: ProcessingFns; +``` + +The processing functions that are used to process the data by features. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#_processingFns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`Table_CoreProperties`](table_coreproperties.md).[`_processingFns`](Table_CoreProperties.md#_processingfns) + +#### Defined in + +[core/table/Tables.types.ts:116](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L116) + +*** + +### \_rowModels + +```ts +_rowModels: CachedRowModels; +``` + +The row models that are enabled for the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#_rowmodels) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`Table_CoreProperties`](table_coreproperties.md).[`_rowModels`](Table_CoreProperties.md#_rowmodels) + +#### Defined in + +[core/table/Tables.types.ts:122](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L122) + +*** + +### getState() + +```ts +getState: () => TableState; +``` + +Call this function to get the table's current state. It's recommended to use this function and its state, especially when managing the table state manually. It is the exact same state used internally by the table for every feature and function it provides. + +#### Returns + +[`TableState`](../type-aliases/tablestate.md)\<`TFeatures`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#getstate) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:146](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L146) + +*** + +### initialState + +```ts +initialState: TableState; +``` + +This is the resolved initial state of the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#initialstate) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`Table_CoreProperties`](table_coreproperties.md).[`initialState`](Table_CoreProperties.md#initialstate) + +#### Defined in + +[core/table/Tables.types.ts:128](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L128) + +*** + +### options + +```ts +options: TableOptions; +``` + +A read-only reference to the table's current options. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#options) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`Table_CoreProperties`](table_coreproperties.md).[`options`](Table_CoreProperties.md#options) + +#### Defined in + +[core/table/Tables.types.ts:134](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L134) + +*** + +### reset() + +```ts +reset: () => void; +``` + +Call this function to reset the table state to the initial state. + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#reset) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:152](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L152) + +*** + +### setOptions() + +```ts +setOptions: (newOptions) => void; +``` + +This function can be used to update the table options. + +#### Parameters + +• **newOptions**: [`Updater`](../type-aliases/updater.md)\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#setoptions) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:158](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L158) + +*** + +### setState() + +```ts +setState: (updater) => void; +``` + +Call this function to update the table state. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`TableState`](../type-aliases/tablestate.md)\<`TFeatures`\>\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#setstate) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:164](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L164) diff --git a/docs/reference/interfaces/tablefeature.md b/docs/reference/interfaces/tablefeature.md new file mode 100644 index 0000000000..60c63d5d52 --- /dev/null +++ b/docs/reference/interfaces/tablefeature.md @@ -0,0 +1,216 @@ +--- +id: TableFeature +title: TableFeature +--- + +# Interface: TableFeature + +## Properties + +### constructCellAPIs()? + +```ts +optional constructCellAPIs: (cell) => void; +``` + +#### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +#### Parameters + +• **cell**: [`Cell`](../type-aliases/cell.md)\<`TFeatures`, `TData`, `TValue`\> + +#### Returns + +`void` + +#### Defined in + +[types/TableFeatures.ts:35](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L35) + +*** + +### constructColumnAPIs()? + +```ts +optional constructColumnAPIs: (column) => void; +``` + +#### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +#### Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +#### Returns + +`void` + +#### Defined in + +[types/TableFeatures.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L42) + +*** + +### constructHeaderAPIs()? + +```ts +optional constructHeaderAPIs: (header) => void; +``` + +#### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +#### Parameters + +• **header**: [`Header`](../type-aliases/header.md)\<`TFeatures`, `TData`, `TValue`\> + +#### Returns + +`void` + +#### Defined in + +[types/TableFeatures.ts:49](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L49) + +*** + +### constructRowAPIs()? + +```ts +optional constructRowAPIs: (row) => void; +``` + +#### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +#### Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +#### Returns + +`void` + +#### Defined in + +[types/TableFeatures.ts:56](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L56) + +*** + +### constructTableAPIs()? + +```ts +optional constructTableAPIs: (table) => void; +``` + +#### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +#### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +#### Returns + +`void` + +#### Defined in + +[types/TableFeatures.ts:59](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L59) + +*** + +### getDefaultColumnDef()? + +```ts +optional getDefaultColumnDef: () => ColumnDefBase_All; +``` + +#### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +#### Returns + +[`ColumnDefBase_All`](../type-aliases/columndefbase_all.md)\<`TFeatures`, `TData`, `TValue`\> + +#### Defined in + +[types/TableFeatures.ts:62](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L62) + +*** + +### getDefaultTableOptions()? + +```ts +optional getDefaultTableOptions: (table) => Partial>; +``` + +#### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +#### Parameters + +• **table**: [`Table`](../type-aliases/table.md)\<`TFeatures`, `TData`\> + +#### Returns + +`Partial`\<[`TableOptions_All`](../type-aliases/tableoptions_all.md)\<`TFeatures`, `TData`\>\> + +#### Defined in + +[types/TableFeatures.ts:67](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L67) + +*** + +### getInitialState()? + +```ts +optional getInitialState: (initialState) => Partial>; +``` + +#### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](tablefeature.md)\>\> + +#### Parameters + +• **initialState**: `Partial`\<[`TableState`](../type-aliases/tablestate.md)\<`TFeatures`\>\> + +#### Returns + +`Partial`\<[`TableState`](../type-aliases/tablestate.md)\<`TFeatures`\>\> + +#### Defined in + +[types/TableFeatures.ts:73](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L73) diff --git a/docs/reference/interfaces/tablefns_columnfiltering.md b/docs/reference/interfaces/tablefns_columnfiltering.md new file mode 100644 index 0000000000..b7c219002f --- /dev/null +++ b/docs/reference/interfaces/tablefns_columnfiltering.md @@ -0,0 +1,24 @@ +--- +id: TableFns_ColumnFiltering +title: TableFns_ColumnFiltering +--- + +# Interface: TableFns\_ColumnFiltering\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### filterFns + +```ts +filterFns: Record>; +``` + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L42) diff --git a/docs/reference/interfaces/tablefns_columngrouping.md b/docs/reference/interfaces/tablefns_columngrouping.md new file mode 100644 index 0000000000..4c1e86710c --- /dev/null +++ b/docs/reference/interfaces/tablefns_columngrouping.md @@ -0,0 +1,24 @@ +--- +id: TableFns_ColumnGrouping +title: TableFns_ColumnGrouping +--- + +# Interface: TableFns\_ColumnGrouping\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### aggregationFns + +```ts +aggregationFns: Record>; +``` + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L25) diff --git a/docs/reference/interfaces/tablefns_rowsorting.md b/docs/reference/interfaces/tablefns_rowsorting.md new file mode 100644 index 0000000000..7de3aa24e2 --- /dev/null +++ b/docs/reference/interfaces/tablefns_rowsorting.md @@ -0,0 +1,24 @@ +--- +id: TableFns_RowSorting +title: TableFns_RowSorting +--- + +# Interface: TableFns\_RowSorting\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### sortingFns + +```ts +sortingFns: Record>; +``` + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L25) diff --git a/docs/reference/interfaces/tablemeta.md b/docs/reference/interfaces/tablemeta.md new file mode 100644 index 0000000000..7ee416d883 --- /dev/null +++ b/docs/reference/interfaces/tablemeta.md @@ -0,0 +1,12 @@ +--- +id: TableMeta +title: TableMeta +--- + +# Interface: TableMeta\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) diff --git a/docs/reference/interfaces/tableoptions_cell.md b/docs/reference/interfaces/tableoptions_cell.md new file mode 100644 index 0000000000..a0c9bc4523 --- /dev/null +++ b/docs/reference/interfaces/tableoptions_cell.md @@ -0,0 +1,54 @@ +--- +id: TableOptions_Cell +title: TableOptions_Cell +--- + +# Interface: TableOptions\_Cell + +## Extended by + +- [`TableOptions_Core`](tableoptions_core.md) + +## Properties + +### debugCells? + +```ts +optional debugCells: boolean; +``` + +Set this option to `true` to output cell debugging information to the console. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugcells] + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/cells/Cells.types.ts:81](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L81) + +*** + +### renderFallbackValue? + +```ts +optional renderFallbackValue: any; +``` + +Value used when the desired value is not found in the data. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#renderfallbackvalue) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/cells/Cells.types.ts:87](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L87) diff --git a/docs/reference/interfaces/tableoptions_columnfiltering.md b/docs/reference/interfaces/tableoptions_columnfiltering.md new file mode 100644 index 0000000000..c9a08f4c8c --- /dev/null +++ b/docs/reference/interfaces/tableoptions_columnfiltering.md @@ -0,0 +1,148 @@ +--- +id: TableOptions_ColumnFiltering +title: TableOptions_ColumnFiltering +--- + +# Interface: TableOptions\_ColumnFiltering\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### enableColumnFilters? + +```ts +optional enableColumnFilters: boolean; +``` + +Enables/disables **column** filtering for all columns. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#enablecolumnfilters) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:174](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L174) + +*** + +### enableFilters? + +```ts +optional enableFilters: boolean; +``` + +Enables/disables all filtering for the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#enablefilters) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:180](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L180) + +*** + +### filterFromLeafRows? + +```ts +optional filterFromLeafRows: boolean; +``` + +By default, filtering is done from parent rows down (so if a parent row is filtered out, all of its children will be filtered out as well). Setting this option to `true` will cause filtering to be done from leaf rows up (which means parent rows will be included so long as one of their child or grand-child rows is also included). + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#filterfromleafrows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:186](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L186) + +*** + +### manualFiltering? + +```ts +optional manualFiltering: boolean; +``` + +Disables the `getFilteredRowModel` from being used to filter data. This may be useful if your table needs to dynamically support both client-side and server-side filtering. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#manualfiltering) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:192](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L192) + +*** + +### maxLeafRowFilterDepth? + +```ts +optional maxLeafRowFilterDepth: number; +``` + +By default, filtering is done for all rows (max depth of 100), no matter if they are root level parent rows or the child leaf rows of a parent row. Setting this option to `0` will cause filtering to only be applied to the root level parent rows, with all sub-rows remaining unfiltered. Similarly, setting this option to `1` will cause filtering to only be applied to child leaf rows 1 level deep, and so on. + +This is useful for situations where you want a row's entire child hierarchy to be visible regardless of the applied filter. + * + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#maxleafrowfilterdepth) + * + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:200](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L200) + +*** + +### onColumnFiltersChange? + +```ts +optional onColumnFiltersChange: OnChangeFn; +``` + +If provided, this function will be called with an `updaterFn` when `state.columnFilters` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering#oncolumnfilterschange) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:206](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L206) diff --git a/docs/reference/interfaces/tableoptions_columngrouping.md b/docs/reference/interfaces/tableoptions_columngrouping.md new file mode 100644 index 0000000000..632defc6fb --- /dev/null +++ b/docs/reference/interfaces/tableoptions_columngrouping.md @@ -0,0 +1,94 @@ +--- +id: TableOptions_ColumnGrouping +title: TableOptions_ColumnGrouping +--- + +# Interface: TableOptions\_ColumnGrouping + +## Properties + +### enableGrouping? + +```ts +optional enableGrouping: boolean; +``` + +Enables/disables grouping for the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#enablegrouping) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:194](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L194) + +*** + +### groupedColumnMode? + +```ts +optional groupedColumnMode: false | "reorder" | "remove"; +``` + +Grouping columns are automatically reordered by default to the start of the columns list. If you would rather remove them or leave them as-is, set the appropriate mode here. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#groupedcolumnmode) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:200](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L200) + +*** + +### manualGrouping? + +```ts +optional manualGrouping: boolean; +``` + +Enables manual grouping. If this option is set to `true`, the table will not automatically group rows using `getGroupedRowModel()` and instead will expect you to manually group the rows before passing them to the table. This is useful if you are doing server-side grouping and aggregation. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#manualgrouping) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:206](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L206) + +*** + +### onGroupingChange? + +```ts +optional onGroupingChange: OnChangeFn; +``` + +If this function is provided, it will be called when the grouping state changes and you will be expected to manage the state yourself. You can pass the managed state back to the table via the `tableOptions.state.grouping` option. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#ongroupingchange) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/grouping) + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:212](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L212) diff --git a/docs/reference/interfaces/tableoptions_columnordering.md b/docs/reference/interfaces/tableoptions_columnordering.md new file mode 100644 index 0000000000..1616d747cd --- /dev/null +++ b/docs/reference/interfaces/tableoptions_columnordering.md @@ -0,0 +1,28 @@ +--- +id: TableOptions_ColumnOrdering +title: TableOptions_ColumnOrdering +--- + +# Interface: TableOptions\_ColumnOrdering + +## Properties + +### onColumnOrderChange? + +```ts +optional onColumnOrderChange: OnChangeFn; +``` + +If provided, this function will be called with an `updaterFn` when `state.columnOrder` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#oncolumnorderchange) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-ordering) + +#### Defined in + +[features/column-ordering/ColumnOrdering.types.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.types.ts#L17) diff --git a/docs/reference/interfaces/tableoptions_columnpinning.md b/docs/reference/interfaces/tableoptions_columnpinning.md new file mode 100644 index 0000000000..be7bb6d5ec --- /dev/null +++ b/docs/reference/interfaces/tableoptions_columnpinning.md @@ -0,0 +1,50 @@ +--- +id: TableOptions_ColumnPinning +title: TableOptions_ColumnPinning +--- + +# Interface: TableOptions\_ColumnPinning + +## Properties + +### enableColumnPinning? + +```ts +optional enableColumnPinning: boolean; +``` + +Enables/disables column pinning for the table. Defaults to `true`. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#enablecolumnpinning) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-pinning) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L25) + +*** + +### onColumnPinningChange? + +```ts +optional onColumnPinningChange: OnChangeFn; +``` + +If provided, this function will be called with an `updaterFn` when `state.columnPinning` changes. This overrides the default internal state management, so you will also need to supply `state.columnPinning` from your own managed state. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#oncolumnpinningchange) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/oncolumnpinningchange) + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L31) diff --git a/docs/reference/interfaces/tableoptions_columnresizing.md b/docs/reference/interfaces/tableoptions_columnresizing.md new file mode 100644 index 0000000000..a88f271845 --- /dev/null +++ b/docs/reference/interfaces/tableoptions_columnresizing.md @@ -0,0 +1,94 @@ +--- +id: TableOptions_ColumnResizing +title: TableOptions_ColumnResizing +--- + +# Interface: TableOptions\_ColumnResizing + +## Properties + +### columnResizeDirection? + +```ts +optional columnResizeDirection: ColumnResizeDirection; +``` + +Enables or disables right-to-left support for resizing the column. defaults to 'ltr'. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#columnResizeDirection) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:38](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L38) + +*** + +### columnResizeMode? + +```ts +optional columnResizeMode: ColumnResizeMode; +``` + +Determines when the columnSizing state is updated. `onChange` updates the state when the user is dragging the resize handle. `onEnd` updates the state when the user releases the resize handle. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#columnresizemode) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:26](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L26) + +*** + +### enableColumnResizing? + +```ts +optional enableColumnResizing: boolean; +``` + +Enables or disables column resizing for the column. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#enablecolumnresizing) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:32](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L32) + +*** + +### onColumnResizingChange? + +```ts +optional onColumnResizingChange: OnChangeFn; +``` + +If provided, this function will be called with an `updaterFn` when `state.columnResizing` changes. This overrides the default internal state management, so you will also need to supply `state.columnResizing` from your own managed state. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#oncolumnResizingchange) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:44](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L44) diff --git a/docs/reference/interfaces/tableoptions_columns.md b/docs/reference/interfaces/tableoptions_columns.md new file mode 100644 index 0000000000..73da086453 --- /dev/null +++ b/docs/reference/interfaces/tableoptions_columns.md @@ -0,0 +1,84 @@ +--- +id: TableOptions_Columns +title: TableOptions_Columns +--- + +# Interface: TableOptions\_Columns\ + +## Extended by + +- [`TableOptions_Core`](tableoptions_core.md) + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* [`CellData`](../type-aliases/celldata.md) = [`CellData`](../type-aliases/celldata.md) + +## Properties + +### columns + +```ts +columns: ColumnDef[]; +``` + +The array of column defs to use for the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#columns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/columns/Columns.types.ts:86](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L86) + +*** + +### debugColumns? + +```ts +optional debugColumns: boolean; +``` + +Set this option to `true` to output column debugging information to the console. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugcolumns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/columns/Columns.types.ts:92](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L92) + +*** + +### defaultColumn? + +```ts +optional defaultColumn: Partial>; +``` + +Default column options to use for all column defs supplied to the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#defaultcolumn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/columns/Columns.types.ts:98](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L98) diff --git a/docs/reference/interfaces/tableoptions_columnsizing.md b/docs/reference/interfaces/tableoptions_columnsizing.md new file mode 100644 index 0000000000..749f469485 --- /dev/null +++ b/docs/reference/interfaces/tableoptions_columnsizing.md @@ -0,0 +1,28 @@ +--- +id: TableOptions_ColumnSizing +title: TableOptions_ColumnSizing +--- + +# Interface: TableOptions\_ColumnSizing + +## Properties + +### onColumnSizingChange? + +```ts +optional onColumnSizingChange: OnChangeFn; +``` + +If provided, this function will be called with an `updaterFn` when `state.columnSizing` changes. This overrides the default internal state management, so you will also need to supply `state.columnSizing` from your own managed state. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#oncolumnsizingchange) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L16) diff --git a/docs/reference/interfaces/tableoptions_columnvisibility.md b/docs/reference/interfaces/tableoptions_columnvisibility.md new file mode 100644 index 0000000000..63b7dfc40d --- /dev/null +++ b/docs/reference/interfaces/tableoptions_columnvisibility.md @@ -0,0 +1,50 @@ +--- +id: TableOptions_ColumnVisibility +title: TableOptions_ColumnVisibility +--- + +# Interface: TableOptions\_ColumnVisibility + +## Properties + +### enableHiding? + +```ts +optional enableHiding: boolean; +``` + +Whether to enable column hiding. Defaults to `true`. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#enablehiding) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L18) + +*** + +### onColumnVisibilityChange? + +```ts +optional onColumnVisibilityChange: OnChangeFn; +``` + +If provided, this function will be called with an `updaterFn` when `state.columnVisibility` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#oncolumnvisibilitychange) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-visibility) + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:24](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L24) diff --git a/docs/reference/interfaces/tableoptions_core.md b/docs/reference/interfaces/tableoptions_core.md new file mode 100644 index 0000000000..98787a09bc --- /dev/null +++ b/docs/reference/interfaces/tableoptions_core.md @@ -0,0 +1,617 @@ +--- +id: TableOptions_Core +title: TableOptions_Core +--- + +# Interface: TableOptions\_Core\ + +## Extends + +- [`TableOptions_Table`](tableoptions_table.md)\<`TFeatures`, `TData`\>.[`TableOptions_Cell`](tableoptions_cell.md).[`TableOptions_Columns`](tableoptions_columns.md)\<`TFeatures`, `TData`\>.[`TableOptions_Rows`](tableoptions_rows.md)\<`TFeatures`, `TData`\>.[`TableOptions_Headers`](tableoptions_headers.md) + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### \_features + +```ts +_features: TFeatures; +``` + +The features that you want to enable for the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#_features) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Table`](tableoptions_table.md).[`_features`](TableOptions_Table.md#_features) + +#### Defined in + +[core/table/Tables.types.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L25) + +*** + +### \_processingFns? + +```ts +optional _processingFns: ProcessingFns; +``` + +The processing functions that are used to process the data by features. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#_processingFns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Table`](tableoptions_table.md).[`_processingFns`](TableOptions_Table.md#_processingfns) + +#### Defined in + +[core/table/Tables.types.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L31) + +*** + +### \_rowModels? + +```ts +optional _rowModels: CreateRowModels; +``` + +The row model options that you want to enable for the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#_rowmodels) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Table`](tableoptions_table.md).[`_rowModels`](TableOptions_Table.md#_rowmodels) + +#### Defined in + +[core/table/Tables.types.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L37) + +*** + +### autoResetAll? + +```ts +optional autoResetAll: boolean; +``` + +Set this option to override any of the `autoReset...` feature options. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#autoresetall) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Table`](tableoptions_table.md).[`autoResetAll`](TableOptions_Table.md#autoresetall) + +#### Defined in + +[core/table/Tables.types.ts:43](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L43) + +*** + +### columns + +```ts +columns: ColumnDef[]; +``` + +The array of column defs to use for the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#columns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Columns`](tableoptions_columns.md).[`columns`](TableOptions_Columns.md#columns) + +#### Defined in + +[core/columns/Columns.types.ts:86](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L86) + +*** + +### data + +```ts +data: TData[]; +``` + +The data for the table to display. This array should match the type you provided to `table.setRowType<...>`. Columns can access this data via string/index or a functional accessor. When the `data` option changes reference, the table will reprocess the data. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#data) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Table`](tableoptions_table.md).[`data`](TableOptions_Table.md#data) + +#### Defined in + +[core/table/Tables.types.ts:49](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L49) + +*** + +### debugAll? + +```ts +optional debugAll: boolean; +``` + +Set this option to `true` to output all debugging information to the console. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugall) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Table`](tableoptions_table.md).[`debugAll`](TableOptions_Table.md#debugall) + +#### Defined in + +[core/table/Tables.types.ts:55](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L55) + +*** + +### debugCells? + +```ts +optional debugCells: boolean; +``` + +Set this option to `true` to output cell debugging information to the console. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugcells] + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Cell`](tableoptions_cell.md).[`debugCells`](TableOptions_Cell.md#debugcells) + +#### Defined in + +[core/cells/Cells.types.ts:81](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L81) + +*** + +### debugColumns? + +```ts +optional debugColumns: boolean; +``` + +Set this option to `true` to output column debugging information to the console. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugcolumns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Columns`](tableoptions_columns.md).[`debugColumns`](TableOptions_Columns.md#debugcolumns) + +#### Defined in + +[core/columns/Columns.types.ts:92](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L92) + +*** + +### debugHeaders? + +```ts +optional debugHeaders: boolean; +``` + +Set this option to `true` to output header debugging information to the console. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugheaders) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Headers`](tableoptions_headers.md).[`debugHeaders`](TableOptions_Headers.md#debugheaders) + +#### Defined in + +[core/headers/Headers.types.ts:14](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L14) + +*** + +### debugRows? + +```ts +optional debugRows: boolean; +``` + +Set this option to `true` to output row debugging information to the console. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugrows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Rows`](tableoptions_rows.md).[`debugRows`](TableOptions_Rows.md#debugrows) + +#### Defined in + +[core/rows/Rows.types.ts:117](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L117) + +*** + +### debugTable? + +```ts +optional debugTable: boolean; +``` + +Set this option to `true` to output table debugging information to the console. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugtable) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Table`](tableoptions_table.md).[`debugTable`](TableOptions_Table.md#debugtable) + +#### Defined in + +[core/table/Tables.types.ts:61](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L61) + +*** + +### defaultColumn? + +```ts +optional defaultColumn: Partial>; +``` + +Default column options to use for all column defs supplied to the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#defaultcolumn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Columns`](tableoptions_columns.md).[`defaultColumn`](TableOptions_Columns.md#defaultcolumn) + +#### Defined in + +[core/columns/Columns.types.ts:98](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.types.ts#L98) + +*** + +### getRowId()? + +```ts +optional getRowId: (originalRow, index, parent?) => string; +``` + +This optional function is used to derive a unique ID for any given row. If not provided the rows index is used (nested rows join together with `.` using their grandparents' index eg. `index.index.index`). If you need to identify individual rows that are originating from any server-side operations, it's suggested you use this function to return an ID that makes sense regardless of network IO/ambiguity eg. a userId, taskId, database ID field, etc. + +#### Parameters + +• **originalRow**: `TData` + +• **index**: `number` + +• **parent?**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +#### Returns + +`string` + +#### Example + +```ts +getRowId: row => row.userId +``` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#getrowid) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Rows`](tableoptions_rows.md).[`getRowId`](TableOptions_Rows.md#getrowid) + +#### Defined in + +[core/rows/Rows.types.ts:124](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L124) + +*** + +### getSubRows()? + +```ts +optional getSubRows: (originalRow, index) => undefined | TData[]; +``` + +This optional function is used to access the sub rows for any given row. If you are using nested rows, you will need to use this function to return the sub rows object (or undefined) from the row. + +#### Parameters + +• **originalRow**: `TData` + +• **index**: `number` + +#### Returns + +`undefined` \| `TData`[] + +#### Example + +```ts +getSubRows: row => row.subRows +``` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#getsubrows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Rows`](tableoptions_rows.md).[`getSubRows`](TableOptions_Rows.md#getsubrows) + +#### Defined in + +[core/rows/Rows.types.ts:135](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L135) + +*** + +### initialState? + +```ts +optional initialState: Partial>; +``` + +Use this option to optionally pass initial state to the table. This state will be used when resetting various table states either automatically by the table (eg. `options.autoResetPageIndex`) or via functions like `table.resetRowSelection()`. Most reset function allow you optionally pass a flag to reset to a blank/default state instead of the initial state. + +Table state will not be reset when this object changes, which also means that the initial state object does not need to be stable. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#initialstate) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Table`](tableoptions_table.md).[`initialState`](TableOptions_Table.md#initialstate) + +#### Defined in + +[core/table/Tables.types.ts:70](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L70) + +*** + +### mergeOptions()? + +```ts +optional mergeOptions: (defaultOptions, options) => TableOptions; +``` + +This option is used to optionally implement the merging of table options. + +#### Parameters + +• **defaultOptions**: [`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\> + +• **options**: `Partial`\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>\> + +#### Returns + +[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#mergeoptions) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Table`](tableoptions_table.md).[`mergeOptions`](TableOptions_Table.md#mergeoptions) + +#### Defined in + +[core/table/Tables.types.ts:76](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L76) + +*** + +### meta? + +```ts +optional meta: TableMeta; +``` + +You can pass any object to `options.meta` and access it anywhere the `table` is available via `table.options.meta`. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#meta) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Table`](tableoptions_table.md).[`meta`](TableOptions_Table.md#meta) + +#### Defined in + +[core/table/Tables.types.ts:85](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L85) + +*** + +### onStateChange()? + +```ts +optional onStateChange: (updater) => void; +``` + +The `onStateChange` option can be used to optionally listen to state changes within the table. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`TableState`](../type-aliases/tablestate.md)\<`TFeatures`\>\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#onstatechange) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Table`](tableoptions_table.md).[`onStateChange`](TableOptions_Table.md#onstatechange) + +#### Defined in + +[core/table/Tables.types.ts:91](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L91) + +*** + +### renderFallbackValue? + +```ts +optional renderFallbackValue: any; +``` + +Value used when the desired value is not found in the data. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#renderfallbackvalue) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Cell`](tableoptions_cell.md).[`renderFallbackValue`](TableOptions_Cell.md#renderfallbackvalue) + +#### Defined in + +[core/cells/Cells.types.ts:87](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.types.ts#L87) + +*** + +### state? + +```ts +optional state: Partial>; +``` + +The `state` option can be used to optionally _control_ part or all of the table state. The state you pass here will merge with and overwrite the internal automatically-managed state to produce the final state for the table. You can also listen to state changes via the `onStateChange` option. +> Note: Any state passed in here will override both the internal state and any other `initialState` you provide. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#state) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Inherited from + +[`TableOptions_Table`](tableoptions_table.md).[`state`](TableOptions_Table.md#state) + +#### Defined in + +[core/table/Tables.types.ts:98](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L98) diff --git a/docs/reference/interfaces/tableoptions_globalfiltering.md b/docs/reference/interfaces/tableoptions_globalfiltering.md new file mode 100644 index 0000000000..a233045f14 --- /dev/null +++ b/docs/reference/interfaces/tableoptions_globalfiltering.md @@ -0,0 +1,121 @@ +--- +id: TableOptions_GlobalFiltering +title: TableOptions_GlobalFiltering +--- + +# Interface: TableOptions\_GlobalFiltering\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### enableGlobalFilter? + +```ts +optional enableGlobalFilter: boolean; +``` + +Enables/disables **global** filtering for all columns. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#enableglobalfilter) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/global-filtering) + +#### Defined in + +[features/global-filtering/GlobalFiltering.types.ts:45](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.types.ts#L45) + +*** + +### getColumnCanGlobalFilter()? + +```ts +optional getColumnCanGlobalFilter: (column) => boolean; +``` + +If provided, this function will be called with the column and should return `true` or `false` to indicate whether this column should be used for global filtering. + +This is useful if the column can contain data that is not `string` or `number` (i.e. `undefined`). + +#### Type Parameters + +• **TFeatures** *extends* `Partial`\<`Record`\<`TableFeatureName`, [`TableFeature`](tablefeature.md)\>\> + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +• **TValue** *extends* `unknown` = `unknown` + +#### Parameters + +• **column**: [`Column`](../type-aliases/column.md)\<`TFeatures`, `TData`, `TValue`\> + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#getcolumncanglobalfilter) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/global-filtering) + +#### Defined in + +[features/global-filtering/GlobalFiltering.types.ts:53](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.types.ts#L53) + +*** + +### globalFilterFn? + +```ts +optional globalFilterFn: FilterFnOption; +``` + +The filter function to use for global filtering. +- A `string` referencing a built-in filter function +- A `string` that references a custom filter functions provided via the `tableOptions.filterFns` option +- A custom filter function + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#globalfilterfn) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/global-filtering) + +#### Defined in + +[features/global-filtering/GlobalFiltering.types.ts:68](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.types.ts#L68) + +*** + +### onGlobalFilterChange? + +```ts +optional onGlobalFilterChange: OnChangeFn; +``` + +If provided, this function will be called with an `updaterFn` when `state.globalFilter` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#onglobalfilterchange) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/global-filtering) + +#### Defined in + +[features/global-filtering/GlobalFiltering.types.ts:74](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.types.ts#L74) diff --git a/docs/reference/interfaces/tableoptions_headers.md b/docs/reference/interfaces/tableoptions_headers.md new file mode 100644 index 0000000000..b929771637 --- /dev/null +++ b/docs/reference/interfaces/tableoptions_headers.md @@ -0,0 +1,32 @@ +--- +id: TableOptions_Headers +title: TableOptions_Headers +--- + +# Interface: TableOptions\_Headers + +## Extended by + +- [`TableOptions_Core`](tableoptions_core.md) + +## Properties + +### debugHeaders? + +```ts +optional debugHeaders: boolean; +``` + +Set this option to `true` to output header debugging information to the console. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugheaders) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/headers/Headers.types.ts:14](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.types.ts#L14) diff --git a/docs/reference/interfaces/tableoptions_rowexpanding.md b/docs/reference/interfaces/tableoptions_rowexpanding.md new file mode 100644 index 0000000000..bdfdaf034c --- /dev/null +++ b/docs/reference/interfaces/tableoptions_rowexpanding.md @@ -0,0 +1,182 @@ +--- +id: TableOptions_RowExpanding +title: TableOptions_RowExpanding +--- + +# Interface: TableOptions\_RowExpanding\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### autoResetExpanded? + +```ts +optional autoResetExpanded: boolean; +``` + +Enable this setting to automatically reset the expanded state of the table when expanding state changes. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#autoresetexpanded) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:56](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L56) + +*** + +### enableExpanding? + +```ts +optional enableExpanding: boolean; +``` + +Enable/disable expanding for all rows. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#enableexpanding) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:62](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L62) + +*** + +### getIsRowExpanded()? + +```ts +optional getIsRowExpanded: (row) => boolean; +``` + +If provided, allows you to override the default behavior of determining whether a row is currently expanded. + +#### Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getisrowexpanded) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:68](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L68) + +*** + +### getRowCanExpand()? + +```ts +optional getRowCanExpand: (row) => boolean; +``` + +If provided, allows you to override the default behavior of determining whether a row can be expanded. + +#### Parameters + +• **row**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#getrowcanexpand) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:74](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L74) + +*** + +### manualExpanding? + +```ts +optional manualExpanding: boolean; +``` + +Enables manual row expansion. If this is set to `true`, `getExpandedRowModel` will not be used to expand rows and you would be expected to perform the expansion in your own data model. This is useful if you are doing server-side expansion. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#manualexpanding) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:80](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L80) + +*** + +### onExpandedChange? + +```ts +optional onExpandedChange: OnChangeFn; +``` + +This function is called when the `expanded` table state changes. If a function is provided, you will be responsible for managing this state on your own. To pass the managed state back to the table, use the `tableOptions.state.expanded` option. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#onexpandedchange) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:86](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L86) + +*** + +### paginateExpandedRows? + +```ts +optional paginateExpandedRows: boolean; +``` + +If `true` expanded rows will be paginated along with the rest of the table (which means expanded rows may span multiple pages). If `false` expanded rows will not be considered for pagination (which means expanded rows will always render on their parents page. This also means more rows will be rendered than the set page size) + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/expanding#paginateexpandedrows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/expanding) + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:92](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L92) diff --git a/docs/reference/interfaces/tableoptions_rowpagination.md b/docs/reference/interfaces/tableoptions_rowpagination.md new file mode 100644 index 0000000000..a2d7126643 --- /dev/null +++ b/docs/reference/interfaces/tableoptions_rowpagination.md @@ -0,0 +1,116 @@ +--- +id: TableOptions_RowPagination +title: TableOptions_RowPagination +--- + +# Interface: TableOptions\_RowPagination + +## Properties + +### autoResetPageIndex? + +```ts +optional autoResetPageIndex: boolean; +``` + +If set to `true`, pagination will be reset to the first page when page-altering state changes eg. `data` is updated, filters change, grouping changes, etc. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#autoresetpageindex) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:21](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L21) + +*** + +### manualPagination? + +```ts +optional manualPagination: boolean; +``` + +Enables manual pagination. If this option is set to `true`, the table will not automatically paginate rows using `getPaginatedRowModel()` and instead will expect you to manually paginate the rows before passing them to the table. This is useful if you are doing server-side pagination and aggregation. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#manualpagination) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L27) + +*** + +### onPaginationChange? + +```ts +optional onPaginationChange: OnChangeFn; +``` + +If this function is provided, it will be called when the pagination state changes and you will be expected to manage the state yourself. You can pass the managed state back to the table via the `tableOptions.state.pagination` option. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#onpaginationchange) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:33](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L33) + +*** + +### pageCount? + +```ts +optional pageCount: number; +``` + +When manually controlling pagination, you can supply a total `pageCount` value to the table if you know it (Or supply a `rowCount` and `pageCount` will be calculated). If you do not know how many pages there are, you can set this to `-1`. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#pagecount) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:39](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L39) + +*** + +### rowCount? + +```ts +optional rowCount: number; +``` + +When manually controlling pagination, you can supply a total `rowCount` value to the table if you know it. The `pageCount` can be calculated from this value and the `pageSize`. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination#rowcount) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:45](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L45) diff --git a/docs/reference/interfaces/tableoptions_rowpinning.md b/docs/reference/interfaces/tableoptions_rowpinning.md new file mode 100644 index 0000000000..3a02780db0 --- /dev/null +++ b/docs/reference/interfaces/tableoptions_rowpinning.md @@ -0,0 +1,78 @@ +--- +id: TableOptions_RowPinning +title: TableOptions_RowPinning +--- + +# Interface: TableOptions\_RowPinning\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### enableRowPinning? + +```ts +optional enableRowPinning: boolean | (row) => boolean; +``` + +Enables/disables row pinning for the table. Defaults to `true`. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#enablerowpinning) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-pinning) + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L25) + +*** + +### keepPinnedRows? + +```ts +optional keepPinnedRows: boolean; +``` + +When `false`, pinned rows will not be visible if they are filtered or paginated out of the table. When `true`, pinned rows will always be visible regardless of filtering or pagination. Defaults to `true`. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#keeppinnedrows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-pinning) + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L31) + +*** + +### onRowPinningChange? + +```ts +optional onRowPinningChange: OnChangeFn; +``` + +If provided, this function will be called with an `updaterFn` when `state.rowPinning` changes. This overrides the default internal state management, so you will also need to supply `state.rowPinning` from your own managed state. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning#onrowpinningchange) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/onrowpinningchange) + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L37) diff --git a/docs/reference/interfaces/tableoptions_rows.md b/docs/reference/interfaces/tableoptions_rows.md new file mode 100644 index 0000000000..a9c7d24e61 --- /dev/null +++ b/docs/reference/interfaces/tableoptions_rows.md @@ -0,0 +1,116 @@ +--- +id: TableOptions_Rows +title: TableOptions_Rows +--- + +# Interface: TableOptions\_Rows\ + +## Extended by + +- [`TableOptions_Core`](tableoptions_core.md) + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### debugRows? + +```ts +optional debugRows: boolean; +``` + +Set this option to `true` to output row debugging information to the console. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugrows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/rows/Rows.types.ts:117](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L117) + +*** + +### getRowId()? + +```ts +optional getRowId: (originalRow, index, parent?) => string; +``` + +This optional function is used to derive a unique ID for any given row. If not provided the rows index is used (nested rows join together with `.` using their grandparents' index eg. `index.index.index`). If you need to identify individual rows that are originating from any server-side operations, it's suggested you use this function to return an ID that makes sense regardless of network IO/ambiguity eg. a userId, taskId, database ID field, etc. + +#### Parameters + +• **originalRow**: `TData` + +• **index**: `number` + +• **parent?**: [`Row`](../type-aliases/row.md)\<`TFeatures`, `TData`\> + +#### Returns + +`string` + +#### Example + +```ts +getRowId: row => row.userId +``` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#getrowid) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/rows/Rows.types.ts:124](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L124) + +*** + +### getSubRows()? + +```ts +optional getSubRows: (originalRow, index) => undefined | TData[]; +``` + +This optional function is used to access the sub rows for any given row. If you are using nested rows, you will need to use this function to return the sub rows object (or undefined) from the row. + +#### Parameters + +• **originalRow**: `TData` + +• **index**: `number` + +#### Returns + +`undefined` \| `TData`[] + +#### Example + +```ts +getSubRows: row => row.subRows +``` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#getsubrows) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/rows/Rows.types.ts:135](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.types.ts#L135) diff --git a/docs/reference/interfaces/tableoptions_rowselection.md b/docs/reference/interfaces/tableoptions_rowselection.md new file mode 100644 index 0000000000..e3d1d0dc6b --- /dev/null +++ b/docs/reference/interfaces/tableoptions_rowselection.md @@ -0,0 +1,103 @@ +--- +id: TableOptions_RowSelection +title: TableOptions_RowSelection +--- + +# Interface: TableOptions\_RowSelection\ + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### enableMultiRowSelection? + +```ts +optional enableMultiRowSelection: boolean | (row) => boolean; +``` + +- Enables/disables multiple row selection for all rows in the table OR +- A function that given a row, returns whether to enable/disable multiple row selection for that row's children/grandchildren + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#enablemultirowselection) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:22](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L22) + +*** + +### enableRowSelection? + +```ts +optional enableRowSelection: boolean | (row) => boolean; +``` + +- Enables/disables row selection for all rows in the table OR +- A function that given a row, returns whether to enable/disable row selection for that row + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#enablerowselection) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L29) + +*** + +### enableSubRowSelection? + +```ts +optional enableSubRowSelection: boolean | (row) => boolean; +``` + +Enables/disables automatic sub-row selection when a parent row is selected, or a function that enables/disables automatic sub-row selection for each row. +(Use in combination with expanding or grouping features) + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#enablesubrowselection) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:36](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L36) + +*** + +### onRowSelectionChange? + +```ts +optional onRowSelectionChange: OnChangeFn; +``` + +If provided, this function will be called with an `updaterFn` when `state.rowSelection` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection#onrowselectionchange) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +#### Defined in + +[features/row-selection/RowSelection.types.ts:42](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L42) diff --git a/docs/reference/interfaces/tableoptions_rowsorting.md b/docs/reference/interfaces/tableoptions_rowsorting.md new file mode 100644 index 0000000000..4811e46f8f --- /dev/null +++ b/docs/reference/interfaces/tableoptions_rowsorting.md @@ -0,0 +1,214 @@ +--- +id: TableOptions_RowSorting +title: TableOptions_RowSorting +--- + +# Interface: TableOptions\_RowSorting + +## Properties + +### enableMultiRemove? + +```ts +optional enableMultiRemove: boolean; +``` + +Enables/disables the ability to remove multi-sorts + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablemultiremove) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:185](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L185) + +*** + +### enableMultiSort? + +```ts +optional enableMultiSort: boolean; +``` + +Enables/Disables multi-sorting for the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablemultisort) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:191](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L191) + +*** + +### enableSorting? + +```ts +optional enableSorting: boolean; +``` + +Enables/Disables sorting for the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablesorting) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:197](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L197) + +*** + +### enableSortingRemoval? + +```ts +optional enableSortingRemoval: boolean; +``` + +Enables/Disables the ability to remove sorting for the table. +- If `true` then changing sort order will circle like: 'none' -> 'desc' -> 'asc' -> 'none' -> ... +- If `false` then changing sort order will circle like: 'none' -> 'desc' -> 'asc' -> 'desc' -> 'asc' -> ... + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#enablesortingremoval) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:205](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L205) + +*** + +### isMultiSortEvent()? + +```ts +optional isMultiSortEvent: (e) => boolean; +``` + +Pass a custom function that will be used to determine if a multi-sort event should be triggered. It is passed the event from the sort toggle handler and should return `true` if the event should trigger a multi-sort. + +#### Parameters + +• **e**: `unknown` + +#### Returns + +`boolean` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#ismultisortevent) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:211](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L211) + +*** + +### manualSorting? + +```ts +optional manualSorting: boolean; +``` + +Enables manual sorting for the table. If this is `true`, you will be expected to sort your data before it is passed to the table. This is useful if you are doing server-side sorting. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#manualsorting) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:217](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L217) + +*** + +### maxMultiSortColCount? + +```ts +optional maxMultiSortColCount: number; +``` + +Set a maximum number of columns that can be multi-sorted. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#maxmultisortcolcount) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:223](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L223) + +*** + +### onSortingChange? + +```ts +optional onSortingChange: OnChangeFn; +``` + +If provided, this function will be called with an `updaterFn` when `state.sorting` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#onsortingchange) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:229](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L229) + +*** + +### sortDescFirst? + +```ts +optional sortDescFirst: boolean; +``` + +If `true`, all sorts will default to descending as their first toggle state. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting#sortdescfirst) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:235](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L235) diff --git a/docs/reference/interfaces/tableoptions_table.md b/docs/reference/interfaces/tableoptions_table.md new file mode 100644 index 0000000000..bc29876b2e --- /dev/null +++ b/docs/reference/interfaces/tableoptions_table.md @@ -0,0 +1,301 @@ +--- +id: TableOptions_Table +title: TableOptions_Table +--- + +# Interface: TableOptions\_Table\ + +## Extended by + +- [`TableOptions_Core`](tableoptions_core.md) + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](../type-aliases/tablefeatures.md) + +• **TData** *extends* [`RowData`](../type-aliases/rowdata.md) + +## Properties + +### \_features + +```ts +_features: TFeatures; +``` + +The features that you want to enable for the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#_features) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L25) + +*** + +### \_processingFns? + +```ts +optional _processingFns: ProcessingFns; +``` + +The processing functions that are used to process the data by features. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#_processingFns) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L31) + +*** + +### \_rowModels? + +```ts +optional _rowModels: CreateRowModels; +``` + +The row model options that you want to enable for the table. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#_rowmodels) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:37](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L37) + +*** + +### autoResetAll? + +```ts +optional autoResetAll: boolean; +``` + +Set this option to override any of the `autoReset...` feature options. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#autoresetall) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:43](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L43) + +*** + +### data + +```ts +data: TData[]; +``` + +The data for the table to display. This array should match the type you provided to `table.setRowType<...>`. Columns can access this data via string/index or a functional accessor. When the `data` option changes reference, the table will reprocess the data. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#data) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:49](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L49) + +*** + +### debugAll? + +```ts +optional debugAll: boolean; +``` + +Set this option to `true` to output all debugging information to the console. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugall) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:55](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L55) + +*** + +### debugTable? + +```ts +optional debugTable: boolean; +``` + +Set this option to `true` to output table debugging information to the console. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#debugtable) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:61](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L61) + +*** + +### initialState? + +```ts +optional initialState: Partial>; +``` + +Use this option to optionally pass initial state to the table. This state will be used when resetting various table states either automatically by the table (eg. `options.autoResetPageIndex`) or via functions like `table.resetRowSelection()`. Most reset function allow you optionally pass a flag to reset to a blank/default state instead of the initial state. + +Table state will not be reset when this object changes, which also means that the initial state object does not need to be stable. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#initialstate) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:70](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L70) + +*** + +### mergeOptions()? + +```ts +optional mergeOptions: (defaultOptions, options) => TableOptions; +``` + +This option is used to optionally implement the merging of table options. + +#### Parameters + +• **defaultOptions**: [`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\> + +• **options**: `Partial`\<[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\>\> + +#### Returns + +[`TableOptions`](../type-aliases/tableoptions.md)\<`TFeatures`, `TData`\> + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#mergeoptions) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:76](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L76) + +*** + +### meta? + +```ts +optional meta: TableMeta; +``` + +You can pass any object to `options.meta` and access it anywhere the `table` is available via `table.options.meta`. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#meta) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:85](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L85) + +*** + +### onStateChange()? + +```ts +optional onStateChange: (updater) => void; +``` + +The `onStateChange` option can be used to optionally listen to state changes within the table. + +#### Parameters + +• **updater**: [`Updater`](../type-aliases/updater.md)\<[`TableState`](../type-aliases/tablestate.md)\<`TFeatures`\>\> + +#### Returns + +`void` + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#onstatechange) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:91](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L91) + +*** + +### state? + +```ts +optional state: Partial>; +``` + +The `state` option can be used to optionally _control_ part or all of the table state. The state you pass here will merge with and overwrite the internal automatically-managed state to produce the final state for the table. You can also listen to state changes via the `onStateChange` option. +> Note: Any state passed in here will override both the internal state and any other `initialState` you provide. + +#### Link + +[API Docs](https://tanstack.com/table/v8/docs/api/core/table#state) + +#### Link + +[Guide](https://tanstack.com/table/v8/docs/guide/tables) + +#### Defined in + +[core/table/Tables.types.ts:98](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.types.ts#L98) diff --git a/docs/reference/interfaces/tablestate_columnfiltering.md b/docs/reference/interfaces/tablestate_columnfiltering.md new file mode 100644 index 0000000000..35de7edc49 --- /dev/null +++ b/docs/reference/interfaces/tablestate_columnfiltering.md @@ -0,0 +1,18 @@ +--- +id: TableState_ColumnFiltering +title: TableState_ColumnFiltering +--- + +# Interface: TableState\_ColumnFiltering + +## Properties + +### columnFilters + +```ts +columnFilters: ColumnFiltersState; +``` + +#### Defined in + +[features/column-filtering/ColumnFiltering.types.ts:19](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L19) diff --git a/docs/reference/interfaces/tablestate_columngrouping.md b/docs/reference/interfaces/tablestate_columngrouping.md new file mode 100644 index 0000000000..ca83c6d358 --- /dev/null +++ b/docs/reference/interfaces/tablestate_columngrouping.md @@ -0,0 +1,18 @@ +--- +id: TableState_ColumnGrouping +title: TableState_ColumnGrouping +--- + +# Interface: TableState\_ColumnGrouping + +## Properties + +### grouping + +```ts +grouping: GroupingState; +``` + +#### Defined in + +[features/column-grouping/ColumnGrouping.types.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L18) diff --git a/docs/reference/interfaces/tablestate_columnordering.md b/docs/reference/interfaces/tablestate_columnordering.md new file mode 100644 index 0000000000..a76f6a7dd6 --- /dev/null +++ b/docs/reference/interfaces/tablestate_columnordering.md @@ -0,0 +1,18 @@ +--- +id: TableState_ColumnOrdering +title: TableState_ColumnOrdering +--- + +# Interface: TableState\_ColumnOrdering + +## Properties + +### columnOrder + +```ts +columnOrder: ColumnOrderState; +``` + +#### Defined in + +[features/column-ordering/ColumnOrdering.types.ts:8](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.types.ts#L8) diff --git a/docs/reference/interfaces/tablestate_columnpinning.md b/docs/reference/interfaces/tablestate_columnpinning.md new file mode 100644 index 0000000000..99f6a54393 --- /dev/null +++ b/docs/reference/interfaces/tablestate_columnpinning.md @@ -0,0 +1,18 @@ +--- +id: TableState_ColumnPinning +title: TableState_ColumnPinning +--- + +# Interface: TableState\_ColumnPinning + +## Properties + +### columnPinning + +```ts +columnPinning: ColumnPinningState; +``` + +#### Defined in + +[features/column-pinning/ColumnPinning.types.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L16) diff --git a/docs/reference/interfaces/tablestate_columnresizing.md b/docs/reference/interfaces/tablestate_columnresizing.md new file mode 100644 index 0000000000..0a1098f748 --- /dev/null +++ b/docs/reference/interfaces/tablestate_columnresizing.md @@ -0,0 +1,18 @@ +--- +id: TableState_ColumnResizing +title: TableState_ColumnResizing +--- + +# Interface: TableState\_ColumnResizing + +## Properties + +### columnResizing + +```ts +columnResizing: columnResizingState; +``` + +#### Defined in + +[features/column-resizing/ColumnResizing.types.ts:4](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L4) diff --git a/docs/reference/interfaces/tablestate_columnsizing.md b/docs/reference/interfaces/tablestate_columnsizing.md new file mode 100644 index 0000000000..c422e8c70f --- /dev/null +++ b/docs/reference/interfaces/tablestate_columnsizing.md @@ -0,0 +1,18 @@ +--- +id: TableState_ColumnSizing +title: TableState_ColumnSizing +--- + +# Interface: TableState\_ColumnSizing + +## Properties + +### columnSizing + +```ts +columnSizing: ColumnSizingState; +``` + +#### Defined in + +[features/column-sizing/ColumnSizing.types.ts:5](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L5) diff --git a/docs/reference/interfaces/tablestate_columnvisibility.md b/docs/reference/interfaces/tablestate_columnvisibility.md new file mode 100644 index 0000000000..72042e4884 --- /dev/null +++ b/docs/reference/interfaces/tablestate_columnvisibility.md @@ -0,0 +1,18 @@ +--- +id: TableState_ColumnVisibility +title: TableState_ColumnVisibility +--- + +# Interface: TableState\_ColumnVisibility + +## Properties + +### columnVisibility + +```ts +columnVisibility: ColumnVisibilityState; +``` + +#### Defined in + +[features/column-visibility/ColumnVisibility.types.ts:9](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L9) diff --git a/docs/reference/interfaces/tablestate_globalfiltering.md b/docs/reference/interfaces/tablestate_globalfiltering.md new file mode 100644 index 0000000000..f333f6ec69 --- /dev/null +++ b/docs/reference/interfaces/tablestate_globalfiltering.md @@ -0,0 +1,18 @@ +--- +id: TableState_GlobalFiltering +title: TableState_GlobalFiltering +--- + +# Interface: TableState\_GlobalFiltering + +## Properties + +### globalFilter + +```ts +globalFilter: any; +``` + +#### Defined in + +[features/global-filtering/GlobalFiltering.types.ts:15](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.types.ts#L15) diff --git a/docs/reference/interfaces/tablestate_rowexpanding.md b/docs/reference/interfaces/tablestate_rowexpanding.md new file mode 100644 index 0000000000..fbf9250016 --- /dev/null +++ b/docs/reference/interfaces/tablestate_rowexpanding.md @@ -0,0 +1,18 @@ +--- +id: TableState_RowExpanding +title: TableState_RowExpanding +--- + +# Interface: TableState\_RowExpanding + +## Properties + +### expanded + +```ts +expanded: ExpandedState; +``` + +#### Defined in + +[features/row-expanding/RowExpanding.types.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L11) diff --git a/docs/reference/interfaces/tablestate_rowpagination.md b/docs/reference/interfaces/tablestate_rowpagination.md new file mode 100644 index 0000000000..7eeaa75505 --- /dev/null +++ b/docs/reference/interfaces/tablestate_rowpagination.md @@ -0,0 +1,18 @@ +--- +id: TableState_RowPagination +title: TableState_RowPagination +--- + +# Interface: TableState\_RowPagination + +## Properties + +### pagination + +```ts +pagination: PaginationState; +``` + +#### Defined in + +[features/row-pagination/RowPagination.types.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.types.ts#L12) diff --git a/docs/reference/interfaces/tablestate_rowpinning.md b/docs/reference/interfaces/tablestate_rowpinning.md new file mode 100644 index 0000000000..8c5fcc9c9a --- /dev/null +++ b/docs/reference/interfaces/tablestate_rowpinning.md @@ -0,0 +1,18 @@ +--- +id: TableState_RowPinning +title: TableState_RowPinning +--- + +# Interface: TableState\_RowPinning + +## Properties + +### rowPinning + +```ts +rowPinning: RowPinningState; +``` + +#### Defined in + +[features/row-pinning/RowPinning.types.ts:13](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L13) diff --git a/docs/reference/interfaces/tablestate_rowselection.md b/docs/reference/interfaces/tablestate_rowselection.md new file mode 100644 index 0000000000..bf2ebe4131 --- /dev/null +++ b/docs/reference/interfaces/tablestate_rowselection.md @@ -0,0 +1,18 @@ +--- +id: TableState_RowSelection +title: TableState_RowSelection +--- + +# Interface: TableState\_RowSelection + +## Properties + +### rowSelection + +```ts +rowSelection: RowSelectionState; +``` + +#### Defined in + +[features/row-selection/RowSelection.types.ts:9](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L9) diff --git a/docs/reference/interfaces/tablestate_rowsorting.md b/docs/reference/interfaces/tablestate_rowsorting.md new file mode 100644 index 0000000000..a5699359d7 --- /dev/null +++ b/docs/reference/interfaces/tablestate_rowsorting.md @@ -0,0 +1,18 @@ +--- +id: TableState_RowSorting +title: TableState_RowSorting +--- + +# Interface: TableState\_RowSorting + +## Properties + +### sorting + +```ts +sorting: SortingState; +``` + +#### Defined in + +[features/row-sorting/RowSorting.types.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L18) diff --git a/docs/reference/type-aliases/accessorcolumndef.md b/docs/reference/type-aliases/accessorcolumndef.md new file mode 100644 index 0000000000..f7fd95e180 --- /dev/null +++ b/docs/reference/type-aliases/accessorcolumndef.md @@ -0,0 +1,22 @@ +--- +id: AccessorColumnDef +title: AccessorColumnDef +--- + +# Type Alias: AccessorColumnDef\ + +```ts +type AccessorColumnDef: AccessorKeyColumnDef | AccessorFnColumnDef; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Defined in + +[types/ColumnDef.ts:172](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L172) diff --git a/docs/reference/type-aliases/accessorfn.md b/docs/reference/type-aliases/accessorfn.md new file mode 100644 index 0000000000..40f38d9a5f --- /dev/null +++ b/docs/reference/type-aliases/accessorfn.md @@ -0,0 +1,30 @@ +--- +id: AccessorFn +title: AccessorFn +--- + +# Type Alias: AccessorFn()\ + +```ts +type AccessorFn: (originalRow, index) => TValue; +``` + +## Type Parameters + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Parameters + +• **originalRow**: `TData` + +• **index**: `number` + +## Returns + +`TValue` + +## Defined in + +[types/ColumnDef.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L20) diff --git a/docs/reference/type-aliases/accessorfncolumndef.md b/docs/reference/type-aliases/accessorfncolumndef.md new file mode 100644 index 0000000000..70876ad4b2 --- /dev/null +++ b/docs/reference/type-aliases/accessorfncolumndef.md @@ -0,0 +1,22 @@ +--- +id: AccessorFnColumnDef +title: AccessorFnColumnDef +--- + +# Type Alias: AccessorFnColumnDef\ + +```ts +type AccessorFnColumnDef: AccessorFnColumnDefBase & ColumnIdentifiers; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Defined in + +[types/ColumnDef.ts:149](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L149) diff --git a/docs/reference/type-aliases/accessorfncolumndefbase.md b/docs/reference/type-aliases/accessorfncolumndefbase.md new file mode 100644 index 0000000000..b3034a8082 --- /dev/null +++ b/docs/reference/type-aliases/accessorfncolumndefbase.md @@ -0,0 +1,30 @@ +--- +id: AccessorFnColumnDefBase +title: AccessorFnColumnDefBase +--- + +# Type Alias: AccessorFnColumnDefBase\ + +```ts +type AccessorFnColumnDefBase: ColumnDefBase & object; +``` + +## Type declaration + +### accessorFn + +```ts +accessorFn: AccessorFn; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Defined in + +[types/ColumnDef.ts:141](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L141) diff --git a/docs/reference/type-aliases/accessorkeycolumndef.md b/docs/reference/type-aliases/accessorkeycolumndef.md new file mode 100644 index 0000000000..6770e0bf02 --- /dev/null +++ b/docs/reference/type-aliases/accessorkeycolumndef.md @@ -0,0 +1,22 @@ +--- +id: AccessorKeyColumnDef +title: AccessorKeyColumnDef +--- + +# Type Alias: AccessorKeyColumnDef\ + +```ts +type AccessorKeyColumnDef: AccessorKeyColumnDefBase & Partial>; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Defined in + +[types/ColumnDef.ts:165](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L165) diff --git a/docs/reference/type-aliases/accessorkeycolumndefbase.md b/docs/reference/type-aliases/accessorkeycolumndefbase.md new file mode 100644 index 0000000000..058763e683 --- /dev/null +++ b/docs/reference/type-aliases/accessorkeycolumndefbase.md @@ -0,0 +1,36 @@ +--- +id: AccessorKeyColumnDefBase +title: AccessorKeyColumnDefBase +--- + +# Type Alias: AccessorKeyColumnDefBase\ + +```ts +type AccessorKeyColumnDefBase: ColumnDefBase & object; +``` + +## Type declaration + +### accessorKey + +```ts +accessorKey: string & object | keyof TData; +``` + +### id? + +```ts +optional id: string; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Defined in + +[types/ColumnDef.ts:156](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L156) diff --git a/docs/reference/type-aliases/aggregationfn.md b/docs/reference/type-aliases/aggregationfn.md new file mode 100644 index 0000000000..e6f0ab749e --- /dev/null +++ b/docs/reference/type-aliases/aggregationfn.md @@ -0,0 +1,32 @@ +--- +id: AggregationFn +title: AggregationFn +--- + +# Type Alias: AggregationFn()\ + +```ts +type AggregationFn: (columnId, leafRows, childRows) => any; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Parameters + +• **columnId**: `string` + +• **leafRows**: [`Row`](row.md)\<`TFeatures`, `TData`\>[] + +• **childRows**: [`Row`](row.md)\<`TFeatures`, `TData`\>[] + +## Returns + +`any` + +## Defined in + +[features/column-grouping/ColumnGrouping.types.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L30) diff --git a/docs/reference/type-aliases/aggregationfnoption.md b/docs/reference/type-aliases/aggregationfnoption.md new file mode 100644 index 0000000000..21ff91b195 --- /dev/null +++ b/docs/reference/type-aliases/aggregationfnoption.md @@ -0,0 +1,20 @@ +--- +id: AggregationFnOption +title: AggregationFnOption +--- + +# Type Alias: AggregationFnOption\ + +```ts +type AggregationFnOption: "auto" | keyof AggregationFns | BuiltInAggregationFn | AggregationFn; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[features/column-grouping/ColumnGrouping.types.ts:44](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L44) diff --git a/docs/reference/type-aliases/builtinaggregationfn.md b/docs/reference/type-aliases/builtinaggregationfn.md new file mode 100644 index 0000000000..7fad03e27f --- /dev/null +++ b/docs/reference/type-aliases/builtinaggregationfn.md @@ -0,0 +1,14 @@ +--- +id: BuiltInAggregationFn +title: BuiltInAggregationFn +--- + +# Type Alias: BuiltInAggregationFn + +```ts +type BuiltInAggregationFn: keyof typeof aggregationFns; +``` + +## Defined in + +[fns/aggregationFns.ts:184](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L184) diff --git a/docs/reference/type-aliases/builtinfilterfn.md b/docs/reference/type-aliases/builtinfilterfn.md new file mode 100644 index 0000000000..d7446fb963 --- /dev/null +++ b/docs/reference/type-aliases/builtinfilterfn.md @@ -0,0 +1,14 @@ +--- +id: BuiltInFilterFn +title: BuiltInFilterFn +--- + +# Type Alias: BuiltInFilterFn + +```ts +type BuiltInFilterFn: keyof typeof filterFns; +``` + +## Defined in + +[fns/filterFns.ts:180](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L180) diff --git a/docs/reference/type-aliases/builtinsortingfn.md b/docs/reference/type-aliases/builtinsortingfn.md new file mode 100644 index 0000000000..0f154470c1 --- /dev/null +++ b/docs/reference/type-aliases/builtinsortingfn.md @@ -0,0 +1,14 @@ +--- +id: BuiltInSortingFn +title: BuiltInSortingFn +--- + +# Type Alias: BuiltInSortingFn + +```ts +type BuiltInSortingFn: keyof typeof sortingFns; +``` + +## Defined in + +[fns/sortingFns.ts:173](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortingFns.ts#L173) diff --git a/docs/reference/type-aliases/cachedrowmodel_all.md b/docs/reference/type-aliases/cachedrowmodel_all.md new file mode 100644 index 0000000000..f30a1b3896 --- /dev/null +++ b/docs/reference/type-aliases/cachedrowmodel_all.md @@ -0,0 +1,20 @@ +--- +id: CachedRowModel_All +title: CachedRowModel_All +--- + +# Type Alias: CachedRowModel\_All\ + +```ts +type CachedRowModel_All: Partial & CachedRowModel_Expanded & CachedRowModel_Faceted & CachedRowModel_Filtered & CachedRowModel_Grouped & CachedRowModel_Paginated & CachedRowModel_Sorted>; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[types/RowModel.ts:95](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L95) diff --git a/docs/reference/type-aliases/cachedrowmodels.md b/docs/reference/type-aliases/cachedrowmodels.md new file mode 100644 index 0000000000..28e889979b --- /dev/null +++ b/docs/reference/type-aliases/cachedrowmodels.md @@ -0,0 +1,38 @@ +--- +id: CachedRowModels +title: CachedRowModels +--- + +# Type Alias: CachedRowModels\ + +```ts +type CachedRowModels: object & UnionToIntersection< + | "ColumnFaceting" extends keyof TFeatures ? CachedRowModel_Faceted : never + | "ColumnFiltering" extends keyof TFeatures ? CachedRowModel_Filtered : never + | "RowExpanding" extends keyof TFeatures ? CachedRowModel_Expanded : never + | "ColumnGrouping" extends keyof TFeatures ? CachedRowModel_Grouped : never + | "RowPagination" extends keyof TFeatures ? CachedRowModel_Paginated : never +| "RowSorting" extends keyof TFeatures ? CachedRowModel_Sorted : never>; +``` + +## Type declaration + +### core()? + +```ts +optional core: () => RowModel; +``` + +#### Returns + +[`RowModel`](../interfaces/rowmodel.md)\<`TFeatures`, `TData`\> + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[types/RowModel.ts:69](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L69) diff --git a/docs/reference/type-aliases/cell.md b/docs/reference/type-aliases/cell.md new file mode 100644 index 0000000000..081dd96c77 --- /dev/null +++ b/docs/reference/type-aliases/cell.md @@ -0,0 +1,22 @@ +--- +id: Cell +title: Cell +--- + +# Type Alias: Cell\ + +```ts +type Cell: Cell_Cell & UnionToIntersection<"ColumnGrouping" extends keyof TFeatures ? Cell_ColumnGrouping : never>; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Defined in + +[types/Cell.ts:6](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Cell.ts#L6) diff --git a/docs/reference/type-aliases/celldata.md b/docs/reference/type-aliases/celldata.md new file mode 100644 index 0000000000..008eb0e027 --- /dev/null +++ b/docs/reference/type-aliases/celldata.md @@ -0,0 +1,14 @@ +--- +id: CellData +title: CellData +--- + +# Type Alias: CellData + +```ts +type CellData: unknown; +``` + +## Defined in + +[types/type-utils.ts:7](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/type-utils.ts#L7) diff --git a/docs/reference/type-aliases/column.md b/docs/reference/type-aliases/column.md new file mode 100644 index 0000000000..db09836581 --- /dev/null +++ b/docs/reference/type-aliases/column.md @@ -0,0 +1,32 @@ +--- +id: Column +title: Column +--- + +# Type Alias: Column\ + +```ts +type Column: Column_Column & UnionToIntersection< + | "ColumnFaceting" extends keyof TFeatures ? Column_ColumnFaceting : never + | "ColumnFiltering" extends keyof TFeatures ? Column_ColumnFiltering : never + | "ColumnGrouping" extends keyof TFeatures ? Column_ColumnGrouping : never + | "ColumnOrdering" extends keyof TFeatures ? Column_ColumnOrdering : never + | "ColumnPinning" extends keyof TFeatures ? Column_ColumnPinning : never + | "ColumnResizing" extends keyof TFeatures ? Column_ColumnResizing : never + | "ColumnSizing" extends keyof TFeatures ? Column_ColumnSizing : never + | "ColumnVisibility" extends keyof TFeatures ? Column_ColumnVisibility : never + | "GlobalFiltering" extends keyof TFeatures ? Column_GlobalFiltering : never +| "RowSorting" extends keyof TFeatures ? Column_RowSorting : never>; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** = `unknown` + +## Defined in + +[types/Column.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L16) diff --git a/docs/reference/type-aliases/column_internal.md b/docs/reference/type-aliases/column_internal.md new file mode 100644 index 0000000000..a1e5cc3f83 --- /dev/null +++ b/docs/reference/type-aliases/column_internal.md @@ -0,0 +1,30 @@ +--- +id: Column_Internal +title: Column_Internal +--- + +# Type Alias: Column\_Internal\ + +```ts +type Column_Internal: Column & object; +``` + +## Type declaration + +### columnDef + +```ts +columnDef: ColumnDefBase_All; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** = `unknown` + +## Defined in + +[types/Column.ts:46](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Column.ts#L46) diff --git a/docs/reference/type-aliases/columndef.md b/docs/reference/type-aliases/columndef.md new file mode 100644 index 0000000000..22f89e8842 --- /dev/null +++ b/docs/reference/type-aliases/columndef.md @@ -0,0 +1,22 @@ +--- +id: ColumnDef +title: ColumnDef +--- + +# Type Alias: ColumnDef\ + +```ts +type ColumnDef: DisplayColumnDef | GroupColumnDef | AccessorColumnDef; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Defined in + +[types/ColumnDef.ts:180](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L180) diff --git a/docs/reference/type-aliases/columndefbase.md b/docs/reference/type-aliases/columndefbase.md new file mode 100644 index 0000000000..b2dc8ef3a8 --- /dev/null +++ b/docs/reference/type-aliases/columndefbase.md @@ -0,0 +1,30 @@ +--- +id: ColumnDefBase +title: ColumnDefBase +--- + +# Type Alias: ColumnDefBase\ + +```ts +type ColumnDefBase: ColumnDefBase_Core & UnionToIntersection< + | "ColumnVisibility" extends keyof TFeatures ? ColumnDef_ColumnVisibility : never + | "ColumnPinning" extends keyof TFeatures ? ColumnDef_ColumnPinning : never + | "ColumnFiltering" extends keyof TFeatures ? ColumnDef_ColumnFiltering : never + | "GlobalFiltering" extends keyof TFeatures ? ColumnDef_GlobalFiltering : never + | "RowSorting" extends keyof TFeatures ? ColumnDef_RowSorting : never + | "ColumnGrouping" extends keyof TFeatures ? ColumnDef_ColumnGrouping : never + | "ColumnSizing" extends keyof TFeatures ? ColumnDef_ColumnSizing : never +| "ColumnResizing" extends keyof TFeatures ? ColumnDef_ColumnResizing : never>; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Defined in + +[types/ColumnDef.ts:65](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L65) diff --git a/docs/reference/type-aliases/columndefbase_all.md b/docs/reference/type-aliases/columndefbase_all.md new file mode 100644 index 0000000000..32277452e0 --- /dev/null +++ b/docs/reference/type-aliases/columndefbase_all.md @@ -0,0 +1,22 @@ +--- +id: ColumnDefBase_All +title: ColumnDefBase_All +--- + +# Type Alias: ColumnDefBase\_All\ + +```ts +type ColumnDefBase_All: ColumnDefBase_Core & Partial & ColumnDef_GlobalFiltering & ColumnDef_RowSorting & ColumnDef_ColumnGrouping & ColumnDef_ColumnSizing & ColumnDef_ColumnResizing>; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Defined in + +[types/ColumnDef.ts:95](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L95) diff --git a/docs/reference/type-aliases/columndefresolved.md b/docs/reference/type-aliases/columndefresolved.md new file mode 100644 index 0000000000..643d392c65 --- /dev/null +++ b/docs/reference/type-aliases/columndefresolved.md @@ -0,0 +1,30 @@ +--- +id: ColumnDefResolved +title: ColumnDefResolved +--- + +# Type Alias: ColumnDefResolved\ + +```ts +type ColumnDefResolved: Partial>> & object; +``` + +## Type declaration + +### accessorKey? + +```ts +optional accessorKey: string; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Defined in + +[types/ColumnDef.ts:189](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L189) diff --git a/docs/reference/type-aliases/columndeftemplate.md b/docs/reference/type-aliases/columndeftemplate.md new file mode 100644 index 0000000000..8c1b5d81a5 --- /dev/null +++ b/docs/reference/type-aliases/columndeftemplate.md @@ -0,0 +1,18 @@ +--- +id: ColumnDefTemplate +title: ColumnDefTemplate +--- + +# Type Alias: ColumnDefTemplate\ + +```ts +type ColumnDefTemplate: string | (props) => any; +``` + +## Type Parameters + +• **TProps** *extends* `object` + +## Defined in + +[types/ColumnDef.ts:25](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L25) diff --git a/docs/reference/type-aliases/columnfilterautoremovetestfn.md b/docs/reference/type-aliases/columnfilterautoremovetestfn.md new file mode 100644 index 0000000000..42bca7e592 --- /dev/null +++ b/docs/reference/type-aliases/columnfilterautoremovetestfn.md @@ -0,0 +1,32 @@ +--- +id: ColumnFilterAutoRemoveTestFn +title: ColumnFilterAutoRemoveTestFn +--- + +# Type Alias: ColumnFilterAutoRemoveTestFn()\ + +```ts +type ColumnFilterAutoRemoveTestFn: (value, column?) => boolean; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Parameters + +• **value**: `any` + +• **column?**: [`Column`](column.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`boolean` + +## Defined in + +[features/column-filtering/ColumnFiltering.types.ts:65](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L65) diff --git a/docs/reference/type-aliases/columnfiltersstate.md b/docs/reference/type-aliases/columnfiltersstate.md new file mode 100644 index 0000000000..ac8b442304 --- /dev/null +++ b/docs/reference/type-aliases/columnfiltersstate.md @@ -0,0 +1,14 @@ +--- +id: ColumnFiltersState +title: ColumnFiltersState +--- + +# Type Alias: ColumnFiltersState + +```ts +type ColumnFiltersState: ColumnFilter[]; +``` + +## Defined in + +[features/column-filtering/ColumnFiltering.types.ts:22](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L22) diff --git a/docs/reference/type-aliases/columnhelper.md b/docs/reference/type-aliases/columnhelper.md new file mode 100644 index 0000000000..71b72e1c82 --- /dev/null +++ b/docs/reference/type-aliases/columnhelper.md @@ -0,0 +1,72 @@ +--- +id: ColumnHelper +title: ColumnHelper +--- + +# Type Alias: ColumnHelper\ + +```ts +type ColumnHelper: object; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Type declaration + +### accessor() + +```ts +accessor: (accessor, column) => TAccessor extends AccessorFn ? AccessorFnColumnDef : AccessorKeyColumnDef; +``` + +#### Type Parameters + +• **TAccessor** *extends* [`AccessorFn`](accessorfn.md)\<`TData`\> \| [`DeepKeys`](deepkeys.md)\<`TData`\> + +• **TValue** *extends* `TAccessor` *extends* [`AccessorFn`](accessorfn.md)\<`TData`, infer TReturn\> ? `TReturn` : `TAccessor` *extends* [`DeepKeys`](deepkeys.md)\<`TData`\> ? [`DeepValue`](deepvalue.md)\<`TData`, `TAccessor`\> : `never` + +#### Parameters + +• **accessor**: `TAccessor` + +• **column**: `TAccessor` *extends* [`AccessorFn`](accessorfn.md)\<`TData`\> ? [`DisplayColumnDef`](displaycolumndef.md)\<`TFeatures`, `TData`, `TValue`\> : [`IdentifiedColumnDef`](identifiedcolumndef.md)\<`TFeatures`, `TData`, `TValue`\> + +#### Returns + +`TAccessor` *extends* [`AccessorFn`](accessorfn.md)\<`TData`\> ? [`AccessorFnColumnDef`](accessorfncolumndef.md)\<`TFeatures`, `TData`, `TValue`\> : [`AccessorKeyColumnDef`](accessorkeycolumndef.md)\<`TFeatures`, `TData`, `TValue`\> + +### display() + +```ts +display: (column) => DisplayColumnDef; +``` + +#### Parameters + +• **column**: [`DisplayColumnDef`](displaycolumndef.md)\<`TFeatures`, `TData`\> + +#### Returns + +[`DisplayColumnDef`](displaycolumndef.md)\<`TFeatures`, `TData`, `unknown`\> + +### group() + +```ts +group: (column) => GroupColumnDef; +``` + +#### Parameters + +• **column**: [`GroupColumnDef`](groupcolumndef.md)\<`TFeatures`, `TData`, `unknown`\> + +#### Returns + +[`GroupColumnDef`](groupcolumndef.md)\<`TFeatures`, `TData`, `unknown`\> + +## Defined in + +[helpers/columnHelper.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/columnHelper.ts#L12) diff --git a/docs/reference/type-aliases/columnorderstate.md b/docs/reference/type-aliases/columnorderstate.md new file mode 100644 index 0000000000..766475db36 --- /dev/null +++ b/docs/reference/type-aliases/columnorderstate.md @@ -0,0 +1,14 @@ +--- +id: ColumnOrderState +title: ColumnOrderState +--- + +# Type Alias: ColumnOrderState + +```ts +type ColumnOrderState: string[]; +``` + +## Defined in + +[features/column-ordering/ColumnOrdering.types.ts:5](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.types.ts#L5) diff --git a/docs/reference/type-aliases/columnpinningposition.md b/docs/reference/type-aliases/columnpinningposition.md new file mode 100644 index 0000000000..bedf045b7e --- /dev/null +++ b/docs/reference/type-aliases/columnpinningposition.md @@ -0,0 +1,14 @@ +--- +id: ColumnPinningPosition +title: ColumnPinningPosition +--- + +# Type Alias: ColumnPinningPosition + +```ts +type ColumnPinningPosition: false | "left" | "right"; +``` + +## Defined in + +[features/column-pinning/ColumnPinning.types.ts:8](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.types.ts#L8) diff --git a/docs/reference/type-aliases/columnresizedirection.md b/docs/reference/type-aliases/columnresizedirection.md new file mode 100644 index 0000000000..1908bc71ca --- /dev/null +++ b/docs/reference/type-aliases/columnresizedirection.md @@ -0,0 +1,14 @@ +--- +id: ColumnResizeDirection +title: ColumnResizeDirection +--- + +# Type Alias: ColumnResizeDirection + +```ts +type ColumnResizeDirection: "ltr" | "rtl"; +``` + +## Defined in + +[features/column-resizing/ColumnResizing.types.ts:18](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L18) diff --git a/docs/reference/type-aliases/columnresizemode.md b/docs/reference/type-aliases/columnresizemode.md new file mode 100644 index 0000000000..674dd296d6 --- /dev/null +++ b/docs/reference/type-aliases/columnresizemode.md @@ -0,0 +1,14 @@ +--- +id: ColumnResizeMode +title: ColumnResizeMode +--- + +# Type Alias: ColumnResizeMode + +```ts +type ColumnResizeMode: "onChange" | "onEnd"; +``` + +## Defined in + +[features/column-resizing/ColumnResizing.types.ts:16](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L16) diff --git a/docs/reference/type-aliases/columnresizingdefaultoptions.md b/docs/reference/type-aliases/columnresizingdefaultoptions.md new file mode 100644 index 0000000000..1ad028bbd5 --- /dev/null +++ b/docs/reference/type-aliases/columnresizingdefaultoptions.md @@ -0,0 +1,14 @@ +--- +id: ColumnResizingDefaultOptions +title: ColumnResizingDefaultOptions +--- + +# Type Alias: ColumnResizingDefaultOptions + +```ts +type ColumnResizingDefaultOptions: Pick; +``` + +## Defined in + +[features/column-resizing/ColumnResizing.types.ts:47](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.types.ts#L47) diff --git a/docs/reference/type-aliases/columnsizingdefaultoptions.md b/docs/reference/type-aliases/columnsizingdefaultoptions.md new file mode 100644 index 0000000000..1313ae84b4 --- /dev/null +++ b/docs/reference/type-aliases/columnsizingdefaultoptions.md @@ -0,0 +1,14 @@ +--- +id: ColumnSizingDefaultOptions +title: ColumnSizingDefaultOptions +--- + +# Type Alias: ColumnSizingDefaultOptions + +```ts +type ColumnSizingDefaultOptions: Pick; +``` + +## Defined in + +[features/column-sizing/ColumnSizing.types.ts:19](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L19) diff --git a/docs/reference/type-aliases/columnsizingstate.md b/docs/reference/type-aliases/columnsizingstate.md new file mode 100644 index 0000000000..4d5f65714d --- /dev/null +++ b/docs/reference/type-aliases/columnsizingstate.md @@ -0,0 +1,14 @@ +--- +id: ColumnSizingState +title: ColumnSizingState +--- + +# Type Alias: ColumnSizingState + +```ts +type ColumnSizingState: Record; +``` + +## Defined in + +[features/column-sizing/ColumnSizing.types.ts:8](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.types.ts#L8) diff --git a/docs/reference/type-aliases/columnvisibilitystate.md b/docs/reference/type-aliases/columnvisibilitystate.md new file mode 100644 index 0000000000..747318b3f2 --- /dev/null +++ b/docs/reference/type-aliases/columnvisibilitystate.md @@ -0,0 +1,14 @@ +--- +id: ColumnVisibilityState +title: ColumnVisibilityState +--- + +# Type Alias: ColumnVisibilityState + +```ts +type ColumnVisibilityState: Record; +``` + +## Defined in + +[features/column-visibility/ColumnVisibility.types.ts:6](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L6) diff --git a/docs/reference/type-aliases/coretablefeatures.md b/docs/reference/type-aliases/coretablefeatures.md new file mode 100644 index 0000000000..bc61821e25 --- /dev/null +++ b/docs/reference/type-aliases/coretablefeatures.md @@ -0,0 +1,14 @@ +--- +id: CoreTableFeatures +title: CoreTableFeatures +--- + +# Type Alias: CoreTableFeatures + +```ts +type CoreTableFeatures: Partial>; +``` + +## Defined in + +[types/TableFeatures.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L29) diff --git a/docs/reference/type-aliases/createrowmodels.md b/docs/reference/type-aliases/createrowmodels.md new file mode 100644 index 0000000000..1720415754 --- /dev/null +++ b/docs/reference/type-aliases/createrowmodels.md @@ -0,0 +1,26 @@ +--- +id: CreateRowModels +title: CreateRowModels +--- + +# Type Alias: CreateRowModels\ + +```ts +type CreateRowModels: CreateRowModel_Core & UnionToIntersection< + | "ColumnFaceting" extends keyof TFeatures ? CreateRowModel_Faceted : never + | "ColumnFiltering" extends keyof TFeatures ? CreateRowModel_Filtered : never + | "RowExpanding" extends keyof TFeatures ? CreateRowModel_Expanded : never + | "ColumnGrouping" extends keyof TFeatures ? CreateRowModel_Grouped : never + | "RowPagination" extends keyof TFeatures ? CreateRowModel_Paginated : never +| "RowSorting" extends keyof TFeatures ? CreateRowModel_Sorted : never>; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[types/RowModel.ts:33](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L33) diff --git a/docs/reference/type-aliases/createrowmodels_all.md b/docs/reference/type-aliases/createrowmodels_all.md new file mode 100644 index 0000000000..3520c60270 --- /dev/null +++ b/docs/reference/type-aliases/createrowmodels_all.md @@ -0,0 +1,20 @@ +--- +id: CreateRowModels_All +title: CreateRowModels_All +--- + +# Type Alias: CreateRowModels\_All\ + +```ts +type CreateRowModels_All: CreateRowModel_Core & CreateRowModel_Expanded & CreateRowModel_Faceted & CreateRowModel_Filtered & CreateRowModel_Grouped & CreateRowModel_Paginated & CreateRowModel_Sorted; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[types/RowModel.ts:58](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/RowModel.ts#L58) diff --git a/docs/reference/type-aliases/customaggregationfns.md b/docs/reference/type-aliases/customaggregationfns.md new file mode 100644 index 0000000000..4de04b2adb --- /dev/null +++ b/docs/reference/type-aliases/customaggregationfns.md @@ -0,0 +1,20 @@ +--- +id: CustomAggregationFns +title: CustomAggregationFns +--- + +# Type Alias: CustomAggregationFns\ + +```ts +type CustomAggregationFns: Record>; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[features/column-grouping/ColumnGrouping.types.ts:39](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L39) diff --git a/docs/reference/type-aliases/customfilterfns.md b/docs/reference/type-aliases/customfilterfns.md new file mode 100644 index 0000000000..56572a1382 --- /dev/null +++ b/docs/reference/type-aliases/customfilterfns.md @@ -0,0 +1,20 @@ +--- +id: CustomFilterFns +title: CustomFilterFns +--- + +# Type Alias: CustomFilterFns\ + +```ts +type CustomFilterFns: Record>; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[features/column-filtering/ColumnFiltering.types.ts:71](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L71) diff --git a/docs/reference/type-aliases/customsortingfns.md b/docs/reference/type-aliases/customsortingfns.md new file mode 100644 index 0000000000..25c392e931 --- /dev/null +++ b/docs/reference/type-aliases/customsortingfns.md @@ -0,0 +1,20 @@ +--- +id: CustomSortingFns +title: CustomSortingFns +--- + +# Type Alias: CustomSortingFns\ + +```ts +type CustomSortingFns: Record>; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[features/row-sorting/RowSorting.types.ts:41](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L41) diff --git a/docs/reference/type-aliases/deepkeys.md b/docs/reference/type-aliases/deepkeys.md new file mode 100644 index 0000000000..8dd8d7b7ff --- /dev/null +++ b/docs/reference/type-aliases/deepkeys.md @@ -0,0 +1,20 @@ +--- +id: DeepKeys +title: DeepKeys +--- + +# Type Alias: DeepKeys\ + +```ts +type DeepKeys: TDepth["length"] extends 5 ? never : unknown extends T ? string : T extends ReadonlyArray & IsTuple ? AllowedIndexes | DeepKeysPrefix, TDepth> : T extends any[] ? DeepKeys : T extends Date ? never : T extends object ? keyof T & string | DeepKeysPrefix : never; +``` + +## Type Parameters + +• **T** + +• **TDepth** *extends* `any`[] = [] + +## Defined in + +[types/type-utils.ts:46](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/type-utils.ts#L46) diff --git a/docs/reference/type-aliases/deepvalue.md b/docs/reference/type-aliases/deepvalue.md new file mode 100644 index 0000000000..08d1ff5b53 --- /dev/null +++ b/docs/reference/type-aliases/deepvalue.md @@ -0,0 +1,20 @@ +--- +id: DeepValue +title: DeepValue +--- + +# Type Alias: DeepValue\ + +```ts +type DeepValue: T extends Record ? TProp extends `${infer TBranch}.${infer TDeepProp}` ? DeepValue : T[TProp & string] : never; +``` + +## Type Parameters + +• **T** + +• **TProp** + +## Defined in + +[types/type-utils.ts:71](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/type-utils.ts#L71) diff --git a/docs/reference/type-aliases/displaycolumndef.md b/docs/reference/type-aliases/displaycolumndef.md new file mode 100644 index 0000000000..57ecfc0d19 --- /dev/null +++ b/docs/reference/type-aliases/displaycolumndef.md @@ -0,0 +1,22 @@ +--- +id: DisplayColumnDef +title: DisplayColumnDef +--- + +# Type Alias: DisplayColumnDef\ + +```ts +type DisplayColumnDef: ColumnDefBase & ColumnIdentifiers; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Defined in + +[types/ColumnDef.ts:120](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L120) diff --git a/docs/reference/type-aliases/expandedstate.md b/docs/reference/type-aliases/expandedstate.md new file mode 100644 index 0000000000..4fbceb96a1 --- /dev/null +++ b/docs/reference/type-aliases/expandedstate.md @@ -0,0 +1,14 @@ +--- +id: ExpandedState +title: ExpandedState +--- + +# Type Alias: ExpandedState + +```ts +type ExpandedState: true | Record; +``` + +## Defined in + +[features/row-expanding/RowExpanding.types.ts:8](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L8) diff --git a/docs/reference/type-aliases/expandedstatelist.md b/docs/reference/type-aliases/expandedstatelist.md new file mode 100644 index 0000000000..bd775399bc --- /dev/null +++ b/docs/reference/type-aliases/expandedstatelist.md @@ -0,0 +1,14 @@ +--- +id: ExpandedStateList +title: ExpandedStateList +--- + +# Type Alias: ExpandedStateList + +```ts +type ExpandedStateList: Record; +``` + +## Defined in + +[features/row-expanding/RowExpanding.types.ts:7](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.types.ts#L7) diff --git a/docs/reference/type-aliases/filterfnoption.md b/docs/reference/type-aliases/filterfnoption.md new file mode 100644 index 0000000000..01e291da62 --- /dev/null +++ b/docs/reference/type-aliases/filterfnoption.md @@ -0,0 +1,20 @@ +--- +id: FilterFnOption +title: FilterFnOption +--- + +# Type Alias: FilterFnOption\ + +```ts +type FilterFnOption: "auto" | BuiltInFilterFn | keyof FilterFns | FilterFn; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[features/column-filtering/ColumnFiltering.types.ts:76](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L76) diff --git a/docs/reference/type-aliases/getter.md b/docs/reference/type-aliases/getter.md new file mode 100644 index 0000000000..7934e7ce99 --- /dev/null +++ b/docs/reference/type-aliases/getter.md @@ -0,0 +1,26 @@ +--- +id: Getter +title: Getter +--- + +# Type Alias: Getter()\ + +```ts +type Getter: () => NoInfer; +``` + +## Type Parameters + +• **TValue** + +## Type Parameters + +• **TTValue** = `TValue` + +## Returns + +[`NoInfer`](noinfer.md)\<`TTValue`\> + +## Defined in + +[types/type-utils.ts:80](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/type-utils.ts#L80) diff --git a/docs/reference/type-aliases/groupcolumndef.md b/docs/reference/type-aliases/groupcolumndef.md new file mode 100644 index 0000000000..6a030f4bb7 --- /dev/null +++ b/docs/reference/type-aliases/groupcolumndef.md @@ -0,0 +1,22 @@ +--- +id: GroupColumnDef +title: GroupColumnDef +--- + +# Type Alias: GroupColumnDef\ + +```ts +type GroupColumnDef: GroupColumnDefBase & ColumnIdentifiers; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Defined in + +[types/ColumnDef.ts:134](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L134) diff --git a/docs/reference/type-aliases/groupingcolumnmode.md b/docs/reference/type-aliases/groupingcolumnmode.md new file mode 100644 index 0000000000..fa3b56aa3a --- /dev/null +++ b/docs/reference/type-aliases/groupingcolumnmode.md @@ -0,0 +1,14 @@ +--- +id: GroupingColumnMode +title: GroupingColumnMode +--- + +# Type Alias: GroupingColumnMode + +```ts +type GroupingColumnMode: false | "reorder" | "remove"; +``` + +## Defined in + +[features/column-grouping/ColumnGrouping.types.ts:215](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L215) diff --git a/docs/reference/type-aliases/groupingstate.md b/docs/reference/type-aliases/groupingstate.md new file mode 100644 index 0000000000..2ec39361d9 --- /dev/null +++ b/docs/reference/type-aliases/groupingstate.md @@ -0,0 +1,14 @@ +--- +id: GroupingState +title: GroupingState +--- + +# Type Alias: GroupingState + +```ts +type GroupingState: string[]; +``` + +## Defined in + +[features/column-grouping/ColumnGrouping.types.ts:15](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.types.ts#L15) diff --git a/docs/reference/type-aliases/header.md b/docs/reference/type-aliases/header.md new file mode 100644 index 0000000000..36bb7ace13 --- /dev/null +++ b/docs/reference/type-aliases/header.md @@ -0,0 +1,22 @@ +--- +id: Header +title: Header +--- + +# Type Alias: Header\ + +```ts +type Header: Header_Header & UnionToIntersection<"ColumnSizing" extends keyof TFeatures ? Header_ColumnSizing : never | "ColumnResizing" extends keyof TFeatures ? Header_ColumnResizing : never>; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Defined in + +[types/Header.ts:7](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Header.ts#L7) diff --git a/docs/reference/type-aliases/identifiedcolumndef.md b/docs/reference/type-aliases/identifiedcolumndef.md new file mode 100644 index 0000000000..afd6be8b63 --- /dev/null +++ b/docs/reference/type-aliases/identifiedcolumndef.md @@ -0,0 +1,36 @@ +--- +id: IdentifiedColumnDef +title: IdentifiedColumnDef +--- + +# Type Alias: IdentifiedColumnDef\ + +```ts +type IdentifiedColumnDef: ColumnDefBase & object; +``` + +## Type declaration + +### header? + +```ts +optional header: StringOrTemplateHeader; +``` + +### id? + +```ts +optional id: string; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Defined in + +[types/ColumnDef.ts:111](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L111) diff --git a/docs/reference/type-aliases/noinfer.md b/docs/reference/type-aliases/noinfer.md new file mode 100644 index 0000000000..6b13f7338f --- /dev/null +++ b/docs/reference/type-aliases/noinfer.md @@ -0,0 +1,18 @@ +--- +id: NoInfer +title: NoInfer +--- + +# Type Alias: NoInfer\ + +```ts +type NoInfer: [T][T extends any ? 0 : never]; +``` + +## Type Parameters + +• **T** + +## Defined in + +[types/type-utils.ts:78](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/type-utils.ts#L78) diff --git a/docs/reference/type-aliases/onchangefn.md b/docs/reference/type-aliases/onchangefn.md new file mode 100644 index 0000000000..192ff04314 --- /dev/null +++ b/docs/reference/type-aliases/onchangefn.md @@ -0,0 +1,26 @@ +--- +id: OnChangeFn +title: OnChangeFn +--- + +# Type Alias: OnChangeFn()\ + +```ts +type OnChangeFn: (updaterOrValue) => void; +``` + +## Type Parameters + +• **T** + +## Parameters + +• **updaterOrValue**: [`Updater`](updater.md)\<`T`\> + +## Returns + +`void` + +## Defined in + +[types/type-utils.ts:3](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/type-utils.ts#L3) diff --git a/docs/reference/type-aliases/partialkeys.md b/docs/reference/type-aliases/partialkeys.md new file mode 100644 index 0000000000..e4b694bea2 --- /dev/null +++ b/docs/reference/type-aliases/partialkeys.md @@ -0,0 +1,20 @@ +--- +id: PartialKeys +title: PartialKeys +--- + +# Type Alias: PartialKeys\ + +```ts +type PartialKeys: Omit & Partial>; +``` + +## Type Parameters + +• **T** + +• **K** *extends* keyof `T` + +## Defined in + +[types/type-utils.ts:9](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/type-utils.ts#L9) diff --git a/docs/reference/type-aliases/requiredkeys.md b/docs/reference/type-aliases/requiredkeys.md new file mode 100644 index 0000000000..d873c6bce0 --- /dev/null +++ b/docs/reference/type-aliases/requiredkeys.md @@ -0,0 +1,20 @@ +--- +id: RequiredKeys +title: RequiredKeys +--- + +# Type Alias: RequiredKeys\ + +```ts +type RequiredKeys: Omit & Required>; +``` + +## Type Parameters + +• **T** + +• **K** *extends* keyof `T` + +## Defined in + +[types/type-utils.ts:11](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/type-utils.ts#L11) diff --git a/docs/reference/type-aliases/row.md b/docs/reference/type-aliases/row.md new file mode 100644 index 0000000000..f942adc009 --- /dev/null +++ b/docs/reference/type-aliases/row.md @@ -0,0 +1,27 @@ +--- +id: Row +title: Row +--- + +# Type Alias: Row\ + +```ts +type Row: Row_Row & UnionToIntersection< + | "ColumnFiltering" extends keyof TFeatures ? Row_ColumnFiltering : never + | "ColumnGrouping" extends keyof TFeatures ? Row_ColumnGrouping : never + | "ColumnPinning" extends keyof TFeatures ? Row_ColumnPinning : never + | "ColumnVisibility" extends keyof TFeatures ? Row_ColumnVisibility : never + | "RowExpanding" extends keyof TFeatures ? Row_RowExpanding : never + | "RowPinning" extends keyof TFeatures ? Row_RowPinning : never +| "RowSelection" extends keyof TFeatures ? Row_RowSelection : never>; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[types/Row.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Row.ts#L12) diff --git a/docs/reference/type-aliases/row_internal.md b/docs/reference/type-aliases/row_internal.md new file mode 100644 index 0000000000..002031befb --- /dev/null +++ b/docs/reference/type-aliases/row_internal.md @@ -0,0 +1,20 @@ +--- +id: Row_Internal +title: Row_Internal +--- + +# Type Alias: Row\_Internal\ + +```ts +type Row_Internal: Row_Row & Partial>; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[types/Row.ts:32](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Row.ts#L32) diff --git a/docs/reference/type-aliases/rowdata.md b/docs/reference/type-aliases/rowdata.md new file mode 100644 index 0000000000..bd4f8758b2 --- /dev/null +++ b/docs/reference/type-aliases/rowdata.md @@ -0,0 +1,14 @@ +--- +id: RowData +title: RowData +--- + +# Type Alias: RowData + +```ts +type RowData: Record | any[]; +``` + +## Defined in + +[types/type-utils.ts:5](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/type-utils.ts#L5) diff --git a/docs/reference/type-aliases/rowpinningposition.md b/docs/reference/type-aliases/rowpinningposition.md new file mode 100644 index 0000000000..1165285fc5 --- /dev/null +++ b/docs/reference/type-aliases/rowpinningposition.md @@ -0,0 +1,14 @@ +--- +id: RowPinningPosition +title: RowPinningPosition +--- + +# Type Alias: RowPinningPosition + +```ts +type RowPinningPosition: false | "top" | "bottom"; +``` + +## Defined in + +[features/row-pinning/RowPinning.types.ts:5](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.types.ts#L5) diff --git a/docs/reference/type-aliases/rowselectionstate.md b/docs/reference/type-aliases/rowselectionstate.md new file mode 100644 index 0000000000..a178738603 --- /dev/null +++ b/docs/reference/type-aliases/rowselectionstate.md @@ -0,0 +1,14 @@ +--- +id: RowSelectionState +title: RowSelectionState +--- + +# Type Alias: RowSelectionState + +```ts +type RowSelectionState: Record; +``` + +## Defined in + +[features/row-selection/RowSelection.types.ts:6](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.types.ts#L6) diff --git a/docs/reference/type-aliases/sortdirection.md b/docs/reference/type-aliases/sortdirection.md new file mode 100644 index 0000000000..7f0796887c --- /dev/null +++ b/docs/reference/type-aliases/sortdirection.md @@ -0,0 +1,14 @@ +--- +id: SortDirection +title: SortDirection +--- + +# Type Alias: SortDirection + +```ts +type SortDirection: "asc" | "desc"; +``` + +## Defined in + +[features/row-sorting/RowSorting.types.ts:8](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L8) diff --git a/docs/reference/type-aliases/sortingfnoption.md b/docs/reference/type-aliases/sortingfnoption.md new file mode 100644 index 0000000000..7a47ceb953 --- /dev/null +++ b/docs/reference/type-aliases/sortingfnoption.md @@ -0,0 +1,20 @@ +--- +id: SortingFnOption +title: SortingFnOption +--- + +# Type Alias: SortingFnOption\ + +```ts +type SortingFnOption: "auto" | keyof SortingFns | BuiltInSortingFn | SortingFn; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[features/row-sorting/RowSorting.types.ts:46](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L46) diff --git a/docs/reference/type-aliases/sortingstate.md b/docs/reference/type-aliases/sortingstate.md new file mode 100644 index 0000000000..436f92d2d7 --- /dev/null +++ b/docs/reference/type-aliases/sortingstate.md @@ -0,0 +1,14 @@ +--- +id: SortingState +title: SortingState +--- + +# Type Alias: SortingState + +```ts +type SortingState: ColumnSort[]; +``` + +## Defined in + +[features/row-sorting/RowSorting.types.ts:15](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.types.ts#L15) diff --git a/docs/reference/type-aliases/stringortemplateheader.md b/docs/reference/type-aliases/stringortemplateheader.md new file mode 100644 index 0000000000..cad238d040 --- /dev/null +++ b/docs/reference/type-aliases/stringortemplateheader.md @@ -0,0 +1,22 @@ +--- +id: StringOrTemplateHeader +title: StringOrTemplateHeader +--- + +# Type Alias: StringOrTemplateHeader\ + +```ts +type StringOrTemplateHeader: string | ColumnDefTemplate>; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Defined in + +[types/ColumnDef.ts:29](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/ColumnDef.ts#L29) diff --git a/docs/reference/type-aliases/table.md b/docs/reference/type-aliases/table.md new file mode 100644 index 0000000000..f40482ec75 --- /dev/null +++ b/docs/reference/type-aliases/table.md @@ -0,0 +1,36 @@ +--- +id: Table +title: Table +--- + +# Type Alias: Table\ + +```ts +type Table: Table_Core & UnionToIntersection< + | "ColumnFiltering" extends keyof TFeatures ? Table_ColumnFiltering : never + | "ColumnGrouping" extends keyof TFeatures ? Table_ColumnGrouping : never + | "ColumnOrdering" extends keyof TFeatures ? Table_ColumnOrdering : never + | "ColumnPinning" extends keyof TFeatures ? Table_ColumnPinning : never + | "ColumnResizing" extends keyof TFeatures ? Table_ColumnResizing : never + | "ColumnSizing" extends keyof TFeatures ? Table_ColumnSizing : never + | "ColumnVisibility" extends keyof TFeatures ? Table_ColumnVisibility : never + | "GlobalFaceting" extends keyof TFeatures ? Table_GlobalFaceting : never + | "GlobalFiltering" extends keyof TFeatures ? Table_GlobalFiltering : never + | "RowExpanding" extends keyof TFeatures ? Table_RowExpanding : never + | "RowPagination" extends keyof TFeatures ? Table_RowPagination : never + | "RowPinning" extends keyof TFeatures ? Table_RowPinning : never + | "RowSelection" extends keyof TFeatures ? Table_RowSelection : never +| "RowSorting" extends keyof TFeatures ? Table_RowSorting : never>; +``` + +The table object that includes both the core table functionality and the features that are enabled via the `_features` table option. + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[types/Table.ts:43](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L43) diff --git a/docs/reference/type-aliases/table_core.md b/docs/reference/type-aliases/table_core.md new file mode 100644 index 0000000000..d393f359bd --- /dev/null +++ b/docs/reference/type-aliases/table_core.md @@ -0,0 +1,23 @@ +--- +id: Table_Core +title: Table_Core +--- + +# Type Alias: Table\_Core\ + +```ts +type Table_Core: Table_Table & Table_Columns & Table_Rows & Table_RowModels & Table_Headers; +``` + +The core table object that only includes the core table functionality such as column, header, row, and table APIS. +No features are included. + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[types/Table.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L31) diff --git a/docs/reference/type-aliases/table_internal.md b/docs/reference/type-aliases/table_internal.md new file mode 100644 index 0000000000..7059ef918d --- /dev/null +++ b/docs/reference/type-aliases/table_internal.md @@ -0,0 +1,60 @@ +--- +id: Table_Internal +title: Table_Internal +--- + +# Type Alias: Table\_Internal\ + +```ts +type Table_Internal: Table & object; +``` + +## Type declaration + +### \_processingFns + +```ts +_processingFns: ProcessingFns_All; +``` + +### \_rowModels + +```ts +_rowModels: CachedRowModel_All; +``` + +### options + +```ts +options: TableOptions_All & object; +``` + +#### Type declaration + +##### \_rowModels? + +```ts +optional _rowModels: CreateRowModels_All; +``` + +##### initialState? + +```ts +optional initialState: TableState_All; +``` + +##### state? + +```ts +optional state: TableState_All; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[types/Table.ts:88](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/Table.ts#L88) diff --git a/docs/reference/type-aliases/table_rowmodels.md b/docs/reference/type-aliases/table_rowmodels.md new file mode 100644 index 0000000000..7257463c9d --- /dev/null +++ b/docs/reference/type-aliases/table_rowmodels.md @@ -0,0 +1,20 @@ +--- +id: Table_RowModels +title: Table_RowModels +--- + +# Type Alias: Table\_RowModels\ + +```ts +type Table_RowModels: Table_RowModels_Core & Table_RowModels_Faceted & Table_RowModels_Filtered & Table_RowModels_Grouped & Table_RowModels_Expanded & Table_RowModels_Paginated & Table_RowModels_Sorted; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[core/row-models/RowModels.types.ts:60](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.types.ts#L60) diff --git a/docs/reference/type-aliases/tablefeatures.md b/docs/reference/type-aliases/tablefeatures.md new file mode 100644 index 0000000000..7b057ecdf2 --- /dev/null +++ b/docs/reference/type-aliases/tablefeatures.md @@ -0,0 +1,14 @@ +--- +id: TableFeatures +title: TableFeatures +--- + +# Type Alias: TableFeatures + +```ts +type TableFeatures: Partial>; +``` + +## Defined in + +[types/TableFeatures.ts:32](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableFeatures.ts#L32) diff --git a/docs/reference/type-aliases/tablehelper_core.md b/docs/reference/type-aliases/tablehelper_core.md new file mode 100644 index 0000000000..d76b6cbb57 --- /dev/null +++ b/docs/reference/type-aliases/tablehelper_core.md @@ -0,0 +1,56 @@ +--- +id: TableHelper_Core +title: TableHelper_Core +--- + +# Type Alias: TableHelper\_Core\ + +```ts +type TableHelper_Core: object; +``` + +Internal type that each adapter package will build off of to create a table helper + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Type declaration + +### columnHelper + +```ts +columnHelper: ColumnHelper; +``` + +### features + +```ts +features: TFeatures; +``` + +### options + +```ts +options: Omit, "columns" | "data" | "state">; +``` + +### tableCreator() + +```ts +tableCreator: (tableOptions) => Table; +``` + +#### Parameters + +• **tableOptions**: `Omit`\<[`TableOptions`](tableoptions.md)\<`TFeatures`, `TData`\>, `"_features"` \| `"_rowModels"`\> + +#### Returns + +[`Table`](table.md)\<`TFeatures`, `TData`\> + +## Defined in + +[helpers/tableHelper.ts:23](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableHelper.ts#L23) diff --git a/docs/reference/type-aliases/tablehelperoptions.md b/docs/reference/type-aliases/tablehelperoptions.md new file mode 100644 index 0000000000..91691ff5ef --- /dev/null +++ b/docs/reference/type-aliases/tablehelperoptions.md @@ -0,0 +1,37 @@ +--- +id: TableHelperOptions +title: TableHelperOptions +--- + +# Type Alias: TableHelperOptions\ + +```ts +type TableHelperOptions: Omit, "columns" | "data" | "state"> & object; +``` + +Options for creating a table helper to share common options across multiple tables +Columns, data, and state are excluded from this type and reserved for only the `useTable`/`createTable` functions + +## Type declaration + +### \_features + +```ts +_features: TFeatures; +``` + +### TData + +```ts +TData: TData; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[helpers/tableHelper.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/helpers/tableHelper.ts#L12) diff --git a/docs/reference/type-aliases/tableoptions.md b/docs/reference/type-aliases/tableoptions.md new file mode 100644 index 0000000000..a4be947864 --- /dev/null +++ b/docs/reference/type-aliases/tableoptions.md @@ -0,0 +1,33 @@ +--- +id: TableOptions +title: TableOptions +--- + +# Type Alias: TableOptions\ + +```ts +type TableOptions: TableOptions_Core & UnionToIntersection< + | "ColumnFiltering" extends keyof TFeatures ? TableOptions_ColumnFiltering : never + | "ColumnGrouping" extends keyof TFeatures ? TableOptions_ColumnGrouping : never + | "ColumnOrdering" extends keyof TFeatures ? TableOptions_ColumnOrdering : never + | "ColumnPinning" extends keyof TFeatures ? TableOptions_ColumnPinning : never + | "ColumnResizing" extends keyof TFeatures ? TableOptions_ColumnResizing : never + | "ColumnSizing" extends keyof TFeatures ? TableOptions_ColumnSizing : never + | "ColumnVisibility" extends keyof TFeatures ? TableOptions_ColumnVisibility : never + | "GlobalFiltering" extends keyof TFeatures ? TableOptions_GlobalFiltering : never + | "RowExpanding" extends keyof TFeatures ? TableOptions_RowExpanding : never + | "RowPagination" extends keyof TFeatures ? TableOptions_RowPagination : never + | "RowPinning" extends keyof TFeatures ? TableOptions_RowPinning : never + | "RowSelection" extends keyof TFeatures ? TableOptions_RowSelection : never +| "RowSorting" extends keyof TFeatures ? TableOptions_RowSorting : never>; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[types/TableOptions.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L31) diff --git a/docs/reference/type-aliases/tableoptions_all.md b/docs/reference/type-aliases/tableoptions_all.md new file mode 100644 index 0000000000..40f185846f --- /dev/null +++ b/docs/reference/type-aliases/tableoptions_all.md @@ -0,0 +1,20 @@ +--- +id: TableOptions_All +title: TableOptions_All +--- + +# Type Alias: TableOptions\_All\ + +```ts +type TableOptions_All: TableOptions_Core & Partial & TableOptions_ColumnGrouping & TableOptions_ColumnOrdering & TableOptions_ColumnPinning & TableOptions_ColumnResizing & TableOptions_ColumnSizing & TableOptions_ColumnVisibility & TableOptions_GlobalFiltering & TableOptions_RowExpanding & TableOptions_RowPagination & TableOptions_RowPinning & TableOptions_RowSelection & TableOptions_RowSorting>; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +## Defined in + +[types/TableOptions.ts:75](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableOptions.ts#L75) diff --git a/docs/reference/type-aliases/tablestate.md b/docs/reference/type-aliases/tablestate.md new file mode 100644 index 0000000000..28ca3f1ba1 --- /dev/null +++ b/docs/reference/type-aliases/tablestate.md @@ -0,0 +1,18 @@ +--- +id: TableState +title: TableState +--- + +# Type Alias: TableState\ + +```ts +type TableState: "ColumnFiltering" extends keyof TFeatures ? TableState_ColumnFiltering : never & "ColumnGrouping" extends keyof TFeatures ? TableState_ColumnGrouping : never & "ColumnOrdering" extends keyof TFeatures ? TableState_ColumnOrdering : never & "ColumnPinning" extends keyof TFeatures ? TableState_ColumnPinning : never & "ColumnResizing" extends keyof TFeatures ? TableState_ColumnResizing : never & "ColumnSizing" extends keyof TFeatures ? TableState_ColumnSizing : never & "ColumnVisibility" extends keyof TFeatures ? TableState_ColumnVisibility : never & "GlobalFiltering" extends keyof TFeatures ? TableState_GlobalFiltering : never & "RowExpanding" extends keyof TFeatures ? TableState_RowExpanding : never & "RowPagination" extends keyof TFeatures ? TableState_RowPagination : never & "RowPinning" extends keyof TFeatures ? TableState_RowPinning : never & "RowSelection" extends keyof TFeatures ? TableState_RowSelection : never & "RowSorting" extends keyof TFeatures ? TableState_RowSorting : never; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +## Defined in + +[types/TableState.ts:66](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L66) diff --git a/docs/reference/type-aliases/tablestate_all.md b/docs/reference/type-aliases/tablestate_all.md new file mode 100644 index 0000000000..fd4e6680fd --- /dev/null +++ b/docs/reference/type-aliases/tablestate_all.md @@ -0,0 +1,14 @@ +--- +id: TableState_All +title: TableState_All +--- + +# Type Alias: TableState\_All + +```ts +type TableState_All: Partial; +``` + +## Defined in + +[types/TableState.ts:50](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/TableState.ts#L50) diff --git a/docs/reference/type-aliases/transformfiltervaluefn.md b/docs/reference/type-aliases/transformfiltervaluefn.md new file mode 100644 index 0000000000..51c654d07b --- /dev/null +++ b/docs/reference/type-aliases/transformfiltervaluefn.md @@ -0,0 +1,32 @@ +--- +id: TransformFilterValueFn +title: TransformFilterValueFn +--- + +# Type Alias: TransformFilterValueFn()\ + +```ts +type TransformFilterValueFn: (value, column?) => TValue; +``` + +## Type Parameters + +• **TFeatures** *extends* [`TableFeatures`](tablefeatures.md) + +• **TData** *extends* [`RowData`](rowdata.md) + +• **TValue** *extends* [`CellData`](celldata.md) = [`CellData`](celldata.md) + +## Parameters + +• **value**: `any` + +• **column?**: [`Column`](column.md)\<`TFeatures`, `TData`, `TValue`\> + +## Returns + +`TValue` + +## Defined in + +[features/column-filtering/ColumnFiltering.types.ts:59](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.types.ts#L59) diff --git a/docs/reference/type-aliases/uniontointersection.md b/docs/reference/type-aliases/uniontointersection.md new file mode 100644 index 0000000000..23984254c9 --- /dev/null +++ b/docs/reference/type-aliases/uniontointersection.md @@ -0,0 +1,18 @@ +--- +id: UnionToIntersection +title: UnionToIntersection +--- + +# Type Alias: UnionToIntersection\ + +```ts +type UnionToIntersection: T extends any ? (x) => any : never extends (x) => any ? R : never; +``` + +## Type Parameters + +• **T** + +## Defined in + +[types/type-utils.ts:14](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/type-utils.ts#L14) diff --git a/docs/reference/type-aliases/updater.md b/docs/reference/type-aliases/updater.md new file mode 100644 index 0000000000..1cb6a9c65b --- /dev/null +++ b/docs/reference/type-aliases/updater.md @@ -0,0 +1,18 @@ +--- +id: Updater +title: Updater +--- + +# Type Alias: Updater\ + +```ts +type Updater: T | (old) => T; +``` + +## Type Parameters + +• **T** + +## Defined in + +[types/type-utils.ts:1](https://github.com/TanStack/table/blob/main/packages/table-core/src/types/type-utils.ts#L1) diff --git a/docs/reference/type-aliases/visibilitydefaultoptions.md b/docs/reference/type-aliases/visibilitydefaultoptions.md new file mode 100644 index 0000000000..f203d7445b --- /dev/null +++ b/docs/reference/type-aliases/visibilitydefaultoptions.md @@ -0,0 +1,14 @@ +--- +id: VisibilityDefaultOptions +title: VisibilityDefaultOptions +--- + +# Type Alias: VisibilityDefaultOptions + +```ts +type VisibilityDefaultOptions: Pick; +``` + +## Defined in + +[features/column-visibility/ColumnVisibility.types.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.types.ts#L27) diff --git a/docs/reference/variables/aggregationfns.md b/docs/reference/variables/aggregationfns.md new file mode 100644 index 0000000000..13b2de94e1 --- /dev/null +++ b/docs/reference/variables/aggregationfns.md @@ -0,0 +1,70 @@ +--- +id: aggregationFns +title: aggregationFns +--- + +# Variable: aggregationFns + +```ts +const aggregationFns: object; +``` + +## Type declaration + +### count + +```ts +count: AggregationFn = aggregationFn_count; +``` + +### extent + +```ts +extent: AggregationFn = aggregationFn_extent; +``` + +### max + +```ts +max: AggregationFn = aggregationFn_max; +``` + +### mean + +```ts +mean: AggregationFn = aggregationFn_mean; +``` + +### median + +```ts +median: AggregationFn = aggregationFn_median; +``` + +### min + +```ts +min: AggregationFn = aggregationFn_min; +``` + +### sum + +```ts +sum: AggregationFn = aggregationFn_sum; +``` + +### unique + +```ts +unique: AggregationFn = aggregationFn_unique; +``` + +### uniqueCount + +```ts +uniqueCount: AggregationFn = aggregationFn_uniqueCount; +``` + +## Defined in + +[fns/aggregationFns.ts:172](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/aggregationFns.ts#L172) diff --git a/docs/reference/variables/cells.md b/docs/reference/variables/cells.md new file mode 100644 index 0000000000..7719d58e94 --- /dev/null +++ b/docs/reference/variables/cells.md @@ -0,0 +1,14 @@ +--- +id: Cells +title: Cells +--- + +# Variable: Cells + +```ts +const Cells: TableFeature; +``` + +## Defined in + +[core/cells/Cells.ts:7](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/cells/Cells.ts#L7) diff --git a/docs/reference/variables/columnfaceting.md b/docs/reference/variables/columnfaceting.md new file mode 100644 index 0000000000..e63ad6f18b --- /dev/null +++ b/docs/reference/variables/columnfaceting.md @@ -0,0 +1,16 @@ +--- +id: ColumnFaceting +title: ColumnFaceting +--- + +# Variable: ColumnFaceting + +```ts +const ColumnFaceting: TableFeature; +``` + +The Column Faceting feature adds column faceting APIs to the column objects. + +## Defined in + +[features/column-faceting/ColumnFaceting.ts:15](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-faceting/ColumnFaceting.ts#L15) diff --git a/docs/reference/variables/columnfiltering.md b/docs/reference/variables/columnfiltering.md new file mode 100644 index 0000000000..b6cff0cf8b --- /dev/null +++ b/docs/reference/variables/columnfiltering.md @@ -0,0 +1,26 @@ +--- +id: ColumnFiltering +title: ColumnFiltering +--- + +# Variable: ColumnFiltering + +```ts +const ColumnFiltering: TableFeature; +``` + +The Column Filtering feature adds column filtering state and APIs to the table, row, and column objects. + +**Note:** This does not include Global Filtering. The GlobalFiltering feature has been split out into its own standalone feature. + +## Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-filtering) + +## Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-filtering) + +## Defined in + +[features/column-filtering/ColumnFiltering.ts:36](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-filtering/ColumnFiltering.ts#L36) diff --git a/docs/reference/variables/columngrouping.md b/docs/reference/variables/columngrouping.md new file mode 100644 index 0000000000..1f3a5beb34 --- /dev/null +++ b/docs/reference/variables/columngrouping.md @@ -0,0 +1,24 @@ +--- +id: ColumnGrouping +title: ColumnGrouping +--- + +# Variable: ColumnGrouping + +```ts +const ColumnGrouping: TableFeature; +``` + +The (Column) Grouping feature adds column grouping state and APIs to the table, row, column, and cell objects. + +## Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-grouping) + +## Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-grouping) + +## Defined in + +[features/column-grouping/ColumnGrouping.ts:40](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-grouping/ColumnGrouping.ts#L40) diff --git a/docs/reference/variables/columnordering.md b/docs/reference/variables/columnordering.md new file mode 100644 index 0000000000..418fb9e996 --- /dev/null +++ b/docs/reference/variables/columnordering.md @@ -0,0 +1,24 @@ +--- +id: ColumnOrdering +title: ColumnOrdering +--- + +# Variable: ColumnOrdering + +```ts +const ColumnOrdering: TableFeature; +``` + +The Column Ordering feature adds column ordering state and APIs to the table and column objects. + +## Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering) + +## Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-ordering) + +## Defined in + +[features/column-ordering/ColumnOrdering.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-ordering/ColumnOrdering.ts#L27) diff --git a/docs/reference/variables/columnpinning.md b/docs/reference/variables/columnpinning.md new file mode 100644 index 0000000000..d70302eec3 --- /dev/null +++ b/docs/reference/variables/columnpinning.md @@ -0,0 +1,24 @@ +--- +id: ColumnPinning +title: ColumnPinning +--- + +# Variable: ColumnPinning + +```ts +const ColumnPinning: TableFeature; +``` + +The Column Pinning feature adds column pinning state and APIs to the table, row, and column objects. + +## Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning) + +## Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-pinning) + +## Defined in + +[features/column-pinning/ColumnPinning.ts:52](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-pinning/ColumnPinning.ts#L52) diff --git a/docs/reference/variables/columnresizing.md b/docs/reference/variables/columnresizing.md new file mode 100644 index 0000000000..302b54d474 --- /dev/null +++ b/docs/reference/variables/columnresizing.md @@ -0,0 +1,26 @@ +--- +id: ColumnResizing +title: ColumnResizing +--- + +# Variable: ColumnResizing + +```ts +const ColumnResizing: TableFeature; +``` + +The Column Resizing feature adds column resizing state and APIs to the table and column objects. + +**Note:** This is dependent on the Column Sizing feature. + +## Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-resizing) + +## Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-resizing) + +## Defined in + +[features/column-resizing/ColumnResizing.ts:30](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-resizing/ColumnResizing.ts#L30) diff --git a/docs/reference/variables/columns.md b/docs/reference/variables/columns.md new file mode 100644 index 0000000000..f89a662b0f --- /dev/null +++ b/docs/reference/variables/columns.md @@ -0,0 +1,14 @@ +--- +id: Columns +title: Columns +--- + +# Variable: Columns + +```ts +const Columns: TableFeature; +``` + +## Defined in + +[core/columns/Columns.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/columns/Columns.ts#L17) diff --git a/docs/reference/variables/columnsizing.md b/docs/reference/variables/columnsizing.md new file mode 100644 index 0000000000..cbdf1f9b36 --- /dev/null +++ b/docs/reference/variables/columnsizing.md @@ -0,0 +1,26 @@ +--- +id: ColumnSizing +title: ColumnSizing +--- + +# Variable: ColumnSizing + +```ts +const ColumnSizing: TableFeature; +``` + +The Column Sizing feature adds column sizing state and APIs to the table, header, and column objects. + +**Note:** This does not include column resizing. The ColumnResizing feature has been split out into its own standalone feature. + +## Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing) + +## Link + +[Guide](https://tanstack.com/table/v8/docs/guide/column-sizing) + +## Defined in + +[features/column-sizing/ColumnSizing.ts:40](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-sizing/ColumnSizing.ts#L40) diff --git a/docs/reference/variables/columnvisibility.md b/docs/reference/variables/columnvisibility.md new file mode 100644 index 0000000000..3d8ea9c786 --- /dev/null +++ b/docs/reference/variables/columnvisibility.md @@ -0,0 +1,20 @@ +--- +id: ColumnVisibility +title: ColumnVisibility +--- + +# Variable: ColumnVisibility + +```ts +const ColumnVisibility: TableFeature; +``` + +The Column Visibility feature adds column visibility state and APIs to the table, row, and column objects. + +## Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility) + +## Defined in + +[features/column-visibility/ColumnVisibility.ts:41](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/column-visibility/ColumnVisibility.ts#L41) diff --git a/docs/reference/variables/corefeatures.md b/docs/reference/variables/corefeatures.md new file mode 100644 index 0000000000..70eefcd4a6 --- /dev/null +++ b/docs/reference/variables/corefeatures.md @@ -0,0 +1,52 @@ +--- +id: coreFeatures +title: coreFeatures +--- + +# Variable: coreFeatures + +```ts +const coreFeatures: object; +``` + +## Type declaration + +### Cells + +```ts +Cells: TableFeature; +``` + +### Columns + +```ts +Columns: TableFeature; +``` + +### Headers + +```ts +Headers: TableFeature; +``` + +### RowModels + +```ts +RowModels: TableFeature; +``` + +### Rows + +```ts +Rows: TableFeature; +``` + +### Tables + +```ts +Tables: TableFeature; +``` + +## Defined in + +[core/coreFeatures.ts:8](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/coreFeatures.ts#L8) diff --git a/docs/reference/variables/filterfns.md b/docs/reference/variables/filterfns.md new file mode 100644 index 0000000000..1418a42ba9 --- /dev/null +++ b/docs/reference/variables/filterfns.md @@ -0,0 +1,70 @@ +--- +id: filterFns +title: filterFns +--- + +# Variable: filterFns + +```ts +const filterFns: object; +``` + +## Type declaration + +### arrIncludes + +```ts +arrIncludes: FilterFn = filterFn_arrIncludes; +``` + +### arrIncludesAll + +```ts +arrIncludesAll: FilterFn = filterFn_arrIncludesAll; +``` + +### arrIncludesSome + +```ts +arrIncludesSome: FilterFn = filterFn_arrIncludesSome; +``` + +### equals + +```ts +equals: FilterFn = filterFn_equals; +``` + +### equalsString + +```ts +equalsString: FilterFn = filterFn_equalsString; +``` + +### includesString + +```ts +includesString: FilterFn = filterFn_includesString; +``` + +### includesStringSensitive + +```ts +includesStringSensitive: FilterFn = filterFn_includesStringSensitive; +``` + +### inNumberRange + +```ts +inNumberRange: FilterFn = filterFn_inNumberRange; +``` + +### weakEquals + +```ts +weakEquals: FilterFn = filterFn_weakEquals; +``` + +## Defined in + +[fns/filterFns.ts:168](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/filterFns.ts#L168) diff --git a/docs/reference/variables/globalfaceting.md b/docs/reference/variables/globalfaceting.md new file mode 100644 index 0000000000..1011c6888a --- /dev/null +++ b/docs/reference/variables/globalfaceting.md @@ -0,0 +1,24 @@ +--- +id: GlobalFaceting +title: GlobalFaceting +--- + +# Variable: GlobalFaceting + +```ts +const GlobalFaceting: TableFeature; +``` + +The Global Faceting feature adds global faceting APIs to the table object. + +## Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting) + +## Link + +[Guide](https://tanstack.com/table/v8/docs/guide/global-faceting) + +## Defined in + +[features/global-faceting/GlobalFaceting.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-faceting/GlobalFaceting.ts#L17) diff --git a/docs/reference/variables/globalfiltering.md b/docs/reference/variables/globalfiltering.md new file mode 100644 index 0000000000..607af363f7 --- /dev/null +++ b/docs/reference/variables/globalfiltering.md @@ -0,0 +1,26 @@ +--- +id: GlobalFiltering +title: GlobalFiltering +--- + +# Variable: GlobalFiltering + +```ts +const GlobalFiltering: TableFeature; +``` + +The Global Filtering feature adds global filtering state and APIs to the table and column objects. + +**Note:** This is dependent on the ColumnFiltering feature. + +## Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering) + +## Link + +[Guide](https://tanstack.com/table/v8/docs/guide/global-filtering) + +## Defined in + +[features/global-filtering/GlobalFiltering.ts:27](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/global-filtering/GlobalFiltering.ts#L27) diff --git a/docs/reference/variables/headers.md b/docs/reference/variables/headers.md new file mode 100644 index 0000000000..77f000cd14 --- /dev/null +++ b/docs/reference/variables/headers.md @@ -0,0 +1,14 @@ +--- +id: Headers +title: Headers +--- + +# Variable: Headers + +```ts +const Headers: TableFeature; +``` + +## Defined in + +[core/headers/Headers.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/headers/Headers.ts#L20) diff --git a/docs/reference/variables/isdev.md b/docs/reference/variables/isdev.md new file mode 100644 index 0000000000..b912731419 --- /dev/null +++ b/docs/reference/variables/isdev.md @@ -0,0 +1,14 @@ +--- +id: isDev +title: isDev +--- + +# Variable: isDev + +```ts +const isDev: boolean; +``` + +## Defined in + +[utils.ts:10](https://github.com/TanStack/table/blob/main/packages/table-core/src/utils.ts#L10) diff --git a/docs/reference/variables/resplitalphanumeric.md b/docs/reference/variables/resplitalphanumeric.md new file mode 100644 index 0000000000..fa81ee5ee1 --- /dev/null +++ b/docs/reference/variables/resplitalphanumeric.md @@ -0,0 +1,14 @@ +--- +id: reSplitAlphaNumeric +title: reSplitAlphaNumeric +--- + +# Variable: reSplitAlphaNumeric + +```ts +const reSplitAlphaNumeric: RegExp; +``` + +## Defined in + +[fns/sortingFns.ts:6](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortingFns.ts#L6) diff --git a/docs/reference/variables/rowexpanding.md b/docs/reference/variables/rowexpanding.md new file mode 100644 index 0000000000..26337720e9 --- /dev/null +++ b/docs/reference/variables/rowexpanding.md @@ -0,0 +1,24 @@ +--- +id: RowExpanding +title: RowExpanding +--- + +# Variable: RowExpanding + +```ts +const RowExpanding: TableFeature; +``` + +The Row Expanding feature adds row expanding state and APIs to the table and row objects. + +## Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-expanding) + +## Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-expanding) + +## Defined in + +[features/row-expanding/RowExpanding.ts:35](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-expanding/RowExpanding.ts#L35) diff --git a/docs/reference/variables/rowmodels.md b/docs/reference/variables/rowmodels.md new file mode 100644 index 0000000000..f243d01d76 --- /dev/null +++ b/docs/reference/variables/rowmodels.md @@ -0,0 +1,14 @@ +--- +id: RowModels +title: RowModels +--- + +# Variable: RowModels + +```ts +const RowModels: TableFeature; +``` + +## Defined in + +[core/row-models/RowModels.ts:20](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/row-models/RowModels.ts#L20) diff --git a/docs/reference/variables/rowpagination.md b/docs/reference/variables/rowpagination.md new file mode 100644 index 0000000000..09fd7e59c2 --- /dev/null +++ b/docs/reference/variables/rowpagination.md @@ -0,0 +1,24 @@ +--- +id: RowPagination +title: RowPagination +--- + +# Variable: RowPagination + +```ts +const RowPagination: TableFeature; +``` + +The (Row) Pagination feature adds pagination state and APIs to the table object. + +## Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/pagination) + +## Link + +[Guide](https://tanstack.com/table/v8/docs/guide/pagination) + +## Defined in + +[features/row-pagination/RowPagination.ts:35](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pagination/RowPagination.ts#L35) diff --git a/docs/reference/variables/rowpinning.md b/docs/reference/variables/rowpinning.md new file mode 100644 index 0000000000..b299b01938 --- /dev/null +++ b/docs/reference/variables/rowpinning.md @@ -0,0 +1,24 @@ +--- +id: RowPinning +title: RowPinning +--- + +# Variable: RowPinning + +```ts +const RowPinning: TableFeature; +``` + +The Row Pinning feature adds row pinning state and APIs to the table and row objects. + +## Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-pinning) + +## Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-pinning) + +## Defined in + +[features/row-pinning/RowPinning.ts:31](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-pinning/RowPinning.ts#L31) diff --git a/docs/reference/variables/rows.md b/docs/reference/variables/rows.md new file mode 100644 index 0000000000..d2b577e290 --- /dev/null +++ b/docs/reference/variables/rows.md @@ -0,0 +1,14 @@ +--- +id: Rows +title: Rows +--- + +# Variable: Rows + +```ts +const Rows: TableFeature; +``` + +## Defined in + +[core/rows/Rows.ts:19](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/rows/Rows.ts#L19) diff --git a/docs/reference/variables/rowselection.md b/docs/reference/variables/rowselection.md new file mode 100644 index 0000000000..4569ff1244 --- /dev/null +++ b/docs/reference/variables/rowselection.md @@ -0,0 +1,24 @@ +--- +id: RowSelection +title: RowSelection +--- + +# Variable: RowSelection + +```ts +const RowSelection: TableFeature; +``` + +The Row Selection feature adds row selection state and APIs to the table and row objects. + +## Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/row-selection) + +## Link + +[Guide](https://tanstack.com/table/v8/docs/guide/row-selection) + +## Defined in + +[features/row-selection/RowSelection.ts:44](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-selection/RowSelection.ts#L44) diff --git a/docs/reference/variables/rowsorting.md b/docs/reference/variables/rowsorting.md new file mode 100644 index 0000000000..4755e9064b --- /dev/null +++ b/docs/reference/variables/rowsorting.md @@ -0,0 +1,24 @@ +--- +id: RowSorting +title: RowSorting +--- + +# Variable: RowSorting + +```ts +const RowSorting: TableFeature; +``` + +The (Row) Sorting feature adds sorting state and APIs to the table and column objects. + +## Link + +[API Docs](https://tanstack.com/table/v8/docs/api/features/sorting) + +## Link + +[Guide](https://tanstack.com/table/v8/docs/guide/sorting) + +## Defined in + +[features/row-sorting/RowSorting.ts:33](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/row-sorting/RowSorting.ts#L33) diff --git a/docs/reference/variables/sortingfns.md b/docs/reference/variables/sortingfns.md new file mode 100644 index 0000000000..9c399bc470 --- /dev/null +++ b/docs/reference/variables/sortingfns.md @@ -0,0 +1,52 @@ +--- +id: sortingFns +title: sortingFns +--- + +# Variable: sortingFns + +```ts +const sortingFns: object; +``` + +## Type declaration + +### alphanumeric + +```ts +alphanumeric: SortingFn = sortingFn_alphanumeric; +``` + +### alphanumericCaseSensitive + +```ts +alphanumericCaseSensitive: SortingFn = sortingFn_alphanumericCaseSensitive; +``` + +### basic + +```ts +basic: SortingFn = sortingFn_basic; +``` + +### datetime + +```ts +datetime: SortingFn = sortingFn_datetime; +``` + +### text + +```ts +text: SortingFn = sortingFn_text; +``` + +### textCaseSensitive + +```ts +textCaseSensitive: SortingFn = sortingFn_textCaseSensitive; +``` + +## Defined in + +[fns/sortingFns.ts:164](https://github.com/TanStack/table/blob/main/packages/table-core/src/fns/sortingFns.ts#L164) diff --git a/docs/reference/variables/stockfeatures.md b/docs/reference/variables/stockfeatures.md new file mode 100644 index 0000000000..1145e41327 --- /dev/null +++ b/docs/reference/variables/stockfeatures.md @@ -0,0 +1,106 @@ +--- +id: stockFeatures +title: stockFeatures +--- + +# Variable: stockFeatures + +```ts +const stockFeatures: object; +``` + +## Type declaration + +### ColumnFaceting + +```ts +ColumnFaceting: TableFeature; +``` + +### ColumnFiltering + +```ts +ColumnFiltering: TableFeature; +``` + +### ColumnGrouping + +```ts +ColumnGrouping: TableFeature; +``` + +### ColumnOrdering + +```ts +ColumnOrdering: TableFeature; +``` + +### ColumnPinning + +```ts +ColumnPinning: TableFeature; +``` + +### ColumnResizing + +```ts +ColumnResizing: TableFeature; +``` + +### ColumnSizing + +```ts +ColumnSizing: TableFeature; +``` + +### ColumnVisibility + +```ts +ColumnVisibility: TableFeature; +``` + +### GlobalFaceting + +```ts +GlobalFaceting: TableFeature; +``` + +### GlobalFiltering + +```ts +GlobalFiltering: TableFeature; +``` + +### RowExpanding + +```ts +RowExpanding: TableFeature; +``` + +### RowPagination + +```ts +RowPagination: TableFeature; +``` + +### RowPinning + +```ts +RowPinning: TableFeature; +``` + +### RowSelection + +```ts +RowSelection: TableFeature; +``` + +### RowSorting + +```ts +RowSorting: TableFeature; +``` + +## Defined in + +[features/stockFeatures.ts:17](https://github.com/TanStack/table/blob/main/packages/table-core/src/features/stockFeatures.ts#L17) diff --git a/docs/reference/variables/tables.md b/docs/reference/variables/tables.md new file mode 100644 index 0000000000..8fa5eabe2d --- /dev/null +++ b/docs/reference/variables/tables.md @@ -0,0 +1,14 @@ +--- +id: Tables +title: Tables +--- + +# Variable: Tables + +```ts +const Tables: TableFeature; +``` + +## Defined in + +[core/table/Tables.ts:12](https://github.com/TanStack/table/blob/main/packages/table-core/src/core/table/Tables.ts#L12)