API Reference

The API Reference provides technical details and type descriptions for the LyteNyte Grid's public interface.

Grid Public Interface

LyteNyte Grid’s public API has six sections:

1. Grid Props: Properties passed to the grid component to configure and customize grid behavior.
2. Grid API: Methods exposed by the grid to allow imperative interaction.
3. Column: Define column specifications and what the grid displays.
4. Row: Define row types that dictate how the grid retrieves and renders data for cells.
5. Layout: Objects used to assemble the grid when running in headless mode.
6. Grid Types: Auxiliary types used by the grid’s functions, methods, and properties.

Grid Row Source

The row source is a separate interface that the grid uses to query and interact with row data. LyteNyte Grid provides several built-in row sources:

• Row Source: An overview of the row data source interface.
• Client Row Source: A row source for data that exists on the client.
• Server Row Source: A row source for loading data in slices from the server.
• Tree Row Source: A row source for rendering and editing hierarchical, object-based data.

Grid Utility Functions

LyteNyte Grid provides a set of utility functions that enhance the grid’s functionality:

• Piece utility: Creates stable references from unstable state sources that can be shared with the grid and other components.
• Utility Functions: Includes other small utility functions, such as equal, to simplify building advanced use cases within the grid.

Reference vs. Guides

Each reference page provides descriptions and type information required to use the public API. Use this API reference section as a quick lookup for method and function details, and consult the Guides to learn how to implement LyteNyte Grid in practice.