IDF Automatic Layout Settings
Layout settings are optional query-string parameters for POST /api/v1/create-diagram/<docId>. They apply to JSON and CSV imports and are case-insensitive.
https://arcentry.com/api/v1/create-diagram/ce223f94-2471-437f-8f1b-4f1ded0974ad?LABEL_HEIGHT=1&LABEL_PADDING=0.75&GROUP_MARGIN_X=2Values must be non-negative numbers written with a decimal point. Invalid values return HTTP 400. MAX_COMPONENTS_PER_TIER must be a positive integer. Unrecognized query parameters are ignored so that parameters such as the API-key parameter can be used alongside layout settings.
| Setting | Default | Description |
|---|---|---|
| MAX_COMPONENTS_PER_TIER | 20 | Maximum number of automatically positioned components in one horizontal tier before the tier wraps. |
| TIER_GAP | 2 | Vertical space between tiers. |
| COMP_GAP | 2 | Horizontal space between components in the same group and tier. |
| GROUP_MARGIN_X | 1.5 | Horizontal space between sibling groups and frames. |
| GROUP_MARGIN_Y | 1.5 | Vertical space between sibling groups and frames. |
| GROUP_MARGIN | not set | Convenience alias that sets both axis-specific group margins. An explicitly supplied GROUP_MARGIN_X or GROUP_MARGIN_Y takes precedence for that axis. |
| GROUP_PADDING | 0.75 | Space between a group border and its contents. This also applies when groups are adjusted around frames. |
| LABEL_HEIGHT | 0.75 | Height reserved for block-style group labels. |
| LABEL_PADDING | 0.25 | Horizontal padding around group labels. |
| LABEL_FOLD_WIDTH | 0.5 | Width of the folded corners on block-style group labels. |
| COMPONENT_LABEL_GAP | 0.25 | Vertical gap between a component and its generated label. |
Visual examples
MAX_COMPONENTS_PER_TIER
TIER_GAP
COMP_GAP
GROUP_MARGIN_X and GROUP_MARGIN_Y
GROUP_PADDING
LABEL_HEIGHT
LABEL_PADDING
