syidaxgrid
Home Pricing Settings

SYIDAX GRID

Grid API reference

Grid APIs cover Grid-wide properties, individual column settings, callable methods, result events, and shared types. Each entry links the current public contract by name.

Markdown source Features

How it works and when to use it

Start with the feature manuals when configuring a feature. Open API entries for exact arguments, return values, and defaults. Search by purpose or API name.

In the code, grid is the Grid element prepared in the installation chapter. Check each example's data and settings, and implement the app functions and server endpoints for your project.

Example 1. Grid properties versus column settings

Set pagination on Grid; set editable on individual columns or defaultColDef.

javascript
grid.pagination = true;
grid.defaultColDef = { editable: true };
grid.columnDefs = [{ field: 'id', editable: false }, { field: 'quantity', editor: 'number' }];

Verify the result: Quantity is editable, while an individual column setting prevents ID editing. Options do not all belong in the same place.

Example 2. Read method result types

Check applyTransaction's argument and return types for supported changes and report fields. With Promise<T>, awaiting the result yields T.

Verify the result: Open the return-type link to understand status, reason, and issue lists, then handle success and rejection separately in your app.

Example 3. Connect results through events

Open cellValueChanged in the event list and inspect its detail type. Do not reference fields absent from the type; also read related feature examples.

Verify the result: Find copyable subscription examples and lifecycle cleanup instructions. Use the exact case of API names.

Combining features and troubleshooting

The type reference is not a list of JavaScript import paths. Distinguish type definitions from runtime package exports.

Pro labels indicate usage requirements. Matching names or readable types do not enable Pro features in Community.

Related reading