gridstack_get_float
Retrieve the current floating state of widgets in a GridStack dashboard to determine which elements are set to float above the grid layout.
Instructions
Get current float state
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/index.ts:1151-1155 (handler)The handler function that executes the tool logic: generates code to call `grid.float()` and retrieve the current float mode state from the GridStack instance.private async getFloat(): Promise<string> { return this.utils.generateGridStackCode("getFloat", { code: `const floatMode = grid.float();`, }); }
- src/tools/index.ts:852-853 (registration)Switch case in the callTool method that registers and dispatches execution of the gridstack_get_float tool to its handler.case "gridstack_get_float": return this.getFloat();
- src/tools/index.ts:724-731 (registration)Tool registration in the getTools() array, including name, description, and empty input schema (no parameters required).{ name: "gridstack_get_float", description: "Get current float state", inputSchema: { type: "object", properties: {}, }, },
- src/tools/index.ts:727-730 (schema)Input schema definition: empty object properties, indicating the tool takes no input parameters.inputSchema: { type: "object", properties: {}, },