format.paragraph.setFlowOptions

Summary

Set paragraph flow flags: contextual spacing, page-break-before, suppress-auto-hyphens, and the advanced layout toggles auto-space-DE, auto-space-DN, adjust-right-indent, and snap-to-grid.

Operation ID: format.paragraph.setFlowOptions
API member path: editor.doc.format.paragraph.setFlowOptions(...)
Mutates document: yes
Idempotency: conditional
Supports tracked mode: yes
Supports dry run: yes
Deterministic target resolution: yes

Expected result

Returns a ParagraphMutationResult; reports NO_OP if all flags already match.

Input fields

Variant 1 (required: contextualSpacing)

Field	Type	Required	Description
`contextualSpacing`	boolean	yes
`target`	ParagraphAddress \| HeadingAddress \| ListItemAddress	yes	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Variant 2 (required: pageBreakBefore)

Field	Type	Required	Description
`pageBreakBefore`	boolean	yes
`target`	ParagraphAddress \| HeadingAddress \| ListItemAddress	yes	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Variant 3 (required: suppressAutoHyphens)

Field	Type	Required	Description
`suppressAutoHyphens`	boolean	yes
`target`	ParagraphAddress \| HeadingAddress \| ListItemAddress	yes	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Variant 4 (required: autoSpaceDE)

Field	Type	Required	Description
`autoSpaceDE`	boolean	yes
`target`	ParagraphAddress \| HeadingAddress \| ListItemAddress	yes	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Variant 5 (required: autoSpaceDN)

Field	Type	Required	Description
`autoSpaceDN`	boolean	yes
`target`	ParagraphAddress \| HeadingAddress \| ListItemAddress	yes	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Variant 6 (required: adjustRightInd)

Field	Type	Required	Description
`adjustRightInd`	boolean	yes
`target`	ParagraphAddress \| HeadingAddress \| ListItemAddress	yes	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Variant 7 (required: snapToGrid)

Field	Type	Required	Description
`snapToGrid`	boolean	yes
`target`	ParagraphAddress \| HeadingAddress \| ListItemAddress	yes	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Example request

{
  "contextualSpacing": true,
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph",
    "story": {
      "kind": "story",
      "storyType": "body"
    }
  }
}

Output fields

Variant 1 (success=true)

Field	Type	Required	Description
`resolution`	object	yes
`resolution.target`	ParagraphAddress \| HeadingAddress \| ListItemAddress	yes	One of: ParagraphAddress, HeadingAddress, ListItemAddress
`success`	`true`	yes	Constant: `true`
`target`	ParagraphAddress \| HeadingAddress \| ListItemAddress	yes	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Variant 2 (success=false)

Field	Type	Required	Description
`failure`	object	yes
`failure.code`	enum	yes	`"NO_OP"`
`failure.details`	any	no
`failure.message`	string	yes
`resolution`	object	no
`resolution.target`	ParagraphAddress \| HeadingAddress \| ListItemAddress	no	One of: ParagraphAddress, HeadingAddress, ListItemAddress
`success`	`false`	yes	Constant: `false`

Example response

{
  "resolution": {
    "target": {
      "kind": "block",
      "nodeId": "node-def456",
      "nodeType": "paragraph",
      "story": {
        "kind": "story",
        "storyType": "body"
      }
    }
  },
  "success": true,
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph",
    "story": {
      "kind": "story",
      "storyType": "body"
    }
  }
}

Pre-apply throws

TARGET_NOT_FOUND
INVALID_TARGET
CAPABILITY_UNAVAILABLE

Non-applied failure codes

NO_OP

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "anyOf": [
    {
      "required": [
        "target",
        "contextualSpacing"
      ]
    },
    {
      "required": [
        "target",
        "pageBreakBefore"
      ]
    },
    {
      "required": [
        "target",
        "suppressAutoHyphens"
      ]
    },
    {
      "required": [
        "target",
        "autoSpaceDE"
      ]
    },
    {
      "required": [
        "target",
        "autoSpaceDN"
      ]
    },
    {
      "required": [
        "target",
        "adjustRightInd"
      ]
    },
    {
      "required": [
        "target",
        "snapToGrid"
      ]
    }
  ],
  "properties": {
    "adjustRightInd": {
      "type": "boolean"
    },
    "autoSpaceDE": {
      "type": "boolean"
    },
    "autoSpaceDN": {
      "type": "boolean"
    },
    "contextualSpacing": {
      "type": "boolean"
    },
    "pageBreakBefore": {
      "type": "boolean"
    },
    "snapToGrid": {
      "type": "boolean"
    },
    "suppressAutoHyphens": {
      "type": "boolean"
    },
    "target": {
      "oneOf": [
        {
          "$ref": "#/$defs/ParagraphAddress"
        },
        {
          "$ref": "#/$defs/HeadingAddress"
        },
        {
          "$ref": "#/$defs/ListItemAddress"
        }
      ]
    }
  },
  "required": [
    "target"
  ],
  "type": "object"
}

Raw output schema

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "resolution": {
          "additionalProperties": false,
          "properties": {
            "target": {
              "oneOf": [
                {
                  "$ref": "#/$defs/ParagraphAddress"
                },
                {
                  "$ref": "#/$defs/HeadingAddress"
                },
                {
                  "$ref": "#/$defs/ListItemAddress"
                }
              ]
            }
          },
          "required": [
            "target"
          ],
          "type": "object"
        },
        "success": {
          "const": true
        },
        "target": {
          "oneOf": [
            {
              "$ref": "#/$defs/ParagraphAddress"
            },
            {
              "$ref": "#/$defs/HeadingAddress"
            },
            {
              "$ref": "#/$defs/ListItemAddress"
            }
          ]
        }
      },
      "required": [
        "success",
        "target",
        "resolution"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "enum": [
                "NO_OP"
              ]
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "resolution": {
          "additionalProperties": false,
          "properties": {
            "target": {
              "oneOf": [
                {
                  "$ref": "#/$defs/ParagraphAddress"
                },
                {
                  "$ref": "#/$defs/HeadingAddress"
                },
                {
                  "$ref": "#/$defs/ListItemAddress"
                }
              ]
            }
          },
          "required": [
            "target"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

Raw success schema

{
  "additionalProperties": false,
  "properties": {
    "resolution": {
      "additionalProperties": false,
      "properties": {
        "target": {
          "oneOf": [
            {
              "$ref": "#/$defs/ParagraphAddress"
            },
            {
              "$ref": "#/$defs/HeadingAddress"
            },
            {
              "$ref": "#/$defs/ListItemAddress"
            }
          ]
        }
      },
      "required": [
        "target"
      ],
      "type": "object"
    },
    "success": {
      "const": true
    },
    "target": {
      "oneOf": [
        {
          "$ref": "#/$defs/ParagraphAddress"
        },
        {
          "$ref": "#/$defs/HeadingAddress"
        },
        {
          "$ref": "#/$defs/ListItemAddress"
        }
      ]
    }
  },
  "required": [
    "success",
    "target",
    "resolution"
  ],
  "type": "object"
}

Raw failure schema

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "enum": [
            "NO_OP"
          ]
        },
        "details": {},
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "resolution": {
      "additionalProperties": false,
      "properties": {
        "target": {
          "oneOf": [
            {
              "$ref": "#/$defs/ParagraphAddress"
            },
            {
              "$ref": "#/$defs/HeadingAddress"
            },
            {
              "$ref": "#/$defs/ListItemAddress"
            }
          ]
        }
      },
      "required": [
        "target"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}

Getting Started

Editor

Document Engine

AI

Solutions

Resources

format.paragraph.setFlowOptions

Summary

Expected result

Input fields

Variant 1 (required: contextualSpacing)

Variant 2 (required: pageBreakBefore)

Variant 3 (required: suppressAutoHyphens)

Variant 4 (required: autoSpaceDE)

Variant 5 (required: autoSpaceDN)

Variant 6 (required: adjustRightInd)

Variant 7 (required: snapToGrid)

Example request

Output fields

Variant 1 (success=true)

Variant 2 (success=false)

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas

​Summary

​Expected result

​Input fields

​Variant 1 (required: contextualSpacing)

​Variant 2 (required: pageBreakBefore)

​Variant 3 (required: suppressAutoHyphens)

​Variant 4 (required: autoSpaceDE)

​Variant 5 (required: autoSpaceDN)

​Variant 6 (required: adjustRightInd)

​Variant 7 (required: snapToGrid)

​Example request

​Output fields

​Variant 1 (success=true)

​Variant 2 (success=false)

​Example response

​Pre-apply throws

​Non-applied failure codes

​Raw schemas

Summary

Expected result

Input fields

Variant 1 (required: contextualSpacing)

Variant 2 (required: pageBreakBefore)

Variant 3 (required: suppressAutoHyphens)

Variant 4 (required: autoSpaceDE)

Variant 5 (required: autoSpaceDN)

Variant 6 (required: adjustRightInd)

Variant 7 (required: snapToGrid)

Example request

Output fields

Variant 1 (success=true)

Variant 2 (success=false)

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas