DocsReferenceGlossary
Chapter 16

Glossary

Plain-English definitions of every term used in this manual

A plain-English dictionary of every term used in this manual. Skim it once, then come back whenever a word in another chapter is unfamiliar. Terms are grouped: EliteGrid concepts first, then general web/JavaScript terms, then React-specific terms.


EliteGrid concepts

Adapter The framework-specific package you install (@elitegrid/react). It wraps the shared core engine so the grid feels native to React. There is a matching Vue adapter with the same features.

Core engine / kernel The framework-agnostic "brain" that actually holds your data and runs sorting, filtering, pagination, selection, and editing. createGrid() builds one. The adapter draws it on screen. Also called the engine or kernel.

createGrid(options) The function that builds the engine from your columns, data, and feature options. Call it once, at module scope (outside the component), so it isn't rebuilt on every render. (See Chapter 01.)

<Grid> The single React component you render. It takes the engine via grid={grid} and draws the header, rows, scrollbars, and pagination bar. It fills its parent, so the parent needs a height.

Grid API The "remote control" object full of methods (api.setPage(), api.exportCSV(), …) for driving the grid from your own code. You receive it from the onReady event. (See Chapter 12.)

Column definition (ColumnDef) One object in the columns array describing a single column. Uses grouped config: related settings live under size, display, sort, filter, edit, and value. (See Chapter 02.)

Grouped config EliteGrid's style of nesting a column's many settings into named groups so autocomplete stays tidy. size: { width: 80 } rather than a flat width: 80.

field The property name a column reads from each row (row.salary). It doubles as the column's unique ID in API calls. Every column needs a distinct field.

rowId Tells the grid which field uniquely identifies a row (defaults to id). Used to track selection, edits, and re-renders. Can be a field name or a function. (See Chapter 01.)

Pinning (freezing) Sticking a column to the left or right edge so it stays put while the rest scroll sideways — like "freeze panes" in a spreadsheet.

flex A column width that grows/shrinks to share leftover space, weighted against other flex columns (flex: 2 gets twice the share of flex: 1). The counterpart to a fixed pixel width.

Comparator A function (a, b) => number that decides the order of two values when sorting: negative if a comes first, positive if b does, 0 if equal. Used for custom sort orders. (See Chapter 03.)

Sort model An array of { columnId, direction } describing the current sort. The array order is the priority (primary sort first, then tie-breakers).

Operator The kind of comparison a filter performs: contains, equals, greater than, between, etc. Different data types offer different operators.

Filter model An object keyed by column field describing the active filters, each { type, operator, value }. (See Chapter 04.)

Popover The small floating panel anchored to the funnel icon that holds a column's filter controls.

Debounce Waiting until the user stops typing before reacting, so the grid filters once instead of on every keystroke. Controlled by filtering.debounceMs.

Page / page size A page is one screenful of rows; page size is how many rows per page. Pagination splits the data into pages with navigation controls. (See Chapter 05.)

Selection The grid's private list of which row IDs are currently ticked. Reading it lets you act on chosen rows (delete, export, etc.). Modes: none, single, multiple. (See Chapter 06.)

Inline editing Changing a cell's value in place — the cell becomes an input — rather than in a separate form. Has a start → commit → cancel lifecycle. (See Chapter 07.)

Parser An editor function that converts the raw string from an <input> into your data's real type (e.g. "42"42). Without it, number fields can end up as strings.

Validator An editor function that checks a typed value before saving. Return an error string to reject, or null to accept. May be async (return a Promise).

Formatter A display function that turns the underlying value into the display text (49.99"$49.99"). Affects only what's shown — sorting/filtering still use the real value.

exportFormatter A separate formatter used only for CSV export, for when the on-screen format is bad for spreadsheets ($50,00050000).

Getter / setter (value group) A getter reads a value out of a row (for nested or computed columns); a setter writes one back (for editing nested data). (See Chapter 08.)

Pipeline The internal sequence your rows pass through: raw → filter → sort → paginate → displayed. getData() reads the start; getDisplayedRows() reads the end.

Virtualization Rendering only the rows visible in the viewport (plus a buffer) and recycling them as you scroll, so even a million rows stay fast. Always on. (See Chapter 14.)

Viewport The visible, scrollable window onto the data — usually a few dozen rows.

Buffer (scroll.bufferSize) Extra rows rendered just outside the viewport so scrolling doesn't flash blank.

dataSource An object with a getRows method used instead of data when rows are too large to load at once. The grid asks for one page at a time; your server does the filtering/sorting. (See Chapter 14.)

Announcement A short spoken message pushed to a screen reader when something changes ("Sorted by name, ascending"). Configurable and translatable. (See Chapter 13.)

Empty state / loading state / error state Full-grid overlays shown when there are no rows, while data is loading, or when a data source fails. (See Chapter 09.)


General web & JavaScript terms

TypeScript interface / type A description of an object's shape (its properties and their types). Exists only to help the compiler catch mistakes; produces no runtime code.

Generic type argument (<Product>) Extra type information you pass to a function, e.g. createGrid<Product>(...), so it knows the shape of your data and can autocomplete and type-check.

Autocomplete / IntelliSense The dropdown of suggestions your editor shows as you type, powered by TypeScript types.

Callback / event handler A function you give to something else so it can call you back at the right moment (e.g. onRowClick). You define what happens; the grid decides when.

Signature The shape of a function's inputs and output, written as an arrow type, e.g. (row, event) => void. void means "returns nothing useful".

Async / Promise / await "Async" means a result arrives later, not immediately (e.g. a network request). A Promise is the placeholder for that future value; await pauses until it arrives.

Closure The bundle of surrounding variables a function "remembers" from when it was created. A stale closure is one still holding old values after those variables changed.

Immutability ("copy, don't mutate") Producing a new object with changes applied (often via the ... spread) instead of modifying the existing one. Helps the grid detect changes reliably.

DOM (Document Object Model) The browser's live tree of the HTML elements on the page. Each element costs memory and layout time, which is why virtualization keeps the count tiny.

CSS class A name attached to an element so a matching stylesheet rule styles it. cellClass attaches one to cells.

CSS custom property ("CSS variable") A reusable named value in CSS, starting with -- (e.g. --eg-accent). EliteGrid themes itself with these, all prefixed --eg-. Override them to re-skin the grid.

localStorage A small browser store for strings that survives page reloads. Used to remember things like saved column layouts (JSON.stringify to save, JSON.parse to read).

Serializable Able to be turned into a string (via JSON.stringify) and back, so it can be stored or sent over the network. The column-state object is serializable.

CSV (Comma-Separated Values) A plain-text table format — one line per row, cells separated by commas — that every spreadsheet program opens. (See Chapter 10.)

Delimiter The character placed between cells in a CSV (a comma by default; sometimes ; or a tab \t).

Set A JavaScript collection of unique values. getSelectedIds() returns one; spread it into an array ([...set]) to use array methods like .map.

ascending / descending Sort directions. Ascending (asc) goes small→large (A→Z, 0→9); descending (desc) is the reverse.

Locale The user's language/region setting. toLocaleString() formats numbers and dates to match it.


Accessibility terms

a11y Shorthand for accessibility ("a" + 11 letters + "y").

i18n Shorthand for internationalization ("i" + 18 letters + "n") — supporting multiple languages and regions.

Screen reader Software (VoiceOver, NVDA, JAWS) that reads the interface aloud for blind and low-vision users.

ARIA HTML attributes (like role="grid", aria-label) that tell assistive technology what an element is and how it behaves.

Assistive technology (AT) Umbrella term for screen readers and similar tools.

prefers-reduced-motion A browser setting indicating the user wants less animation. EliteGrid honours it automatically.


React-specific terms

Component A function that returns JSX describing UI. React re-runs it on every render — which is why createGrid() must live outside it.

Render One execution of a component to produce its UI. Can happen many times per second; state changes trigger re-renders.

JSX The HTML-like syntax inside React components (<Grid grid={grid} />).

Hook A function whose name starts with use… that taps into React features. EliteGrid's state hooks (usePaginationState, …) let you read live grid state.

useState / useEffect Core React hooks. useState stores component state; useEffect runs code after render (used here to capture the API and to call updateEvents).

useMemo A hook that remembers a computed value across renders — one way to create a grid inside a component without rebuilding it every render.

updateEvents A grid method that re-registers event handlers, used to fix stale closures so handlers always see current React state. (See Chapter 11.)

updateAppearance A grid method that changes appearance options (theme, density, row height, …) after the grid has already been created — handy for syncing the grid to an app-wide theme toggle. (See Chapter 09.)

Reactive A value that automatically re-renders your component when it changes (as opposed to a one-off snapshot from an API get… method).


Back to the manual index.

Was this page helpful?