SimulationViewOptionsΒΆ

Generated from the central API contract. Availability and permissions are checked by the connected service.

Field

Type / accepted values

Required

Default

Constraints / meaning

mode

"surface" / "section" / "streamlines"

No

"surface"

field_names

array of string or null

No

Omitted

minItems: 1; maxItems: 12; Published scalar fields or vector components/magnitude; omit to discover available fields.

axis

"x" / "y" / "z" or null

No

Omitted

position_m

number or null

No

Omitted

include_edges

boolean or null

No

Omitted

Surface/section views: false omits optional wire edges, retaining every triangle and field value. Omit preserves edges.

seed_points_m

array of array [number, number, number] or null

No

Omitted

minItems: 1; maxItems: 128; Streamlines only: explicit starting XYZ points in the saved volume coordinate frame, in metres.

vector_field

string or null

No

Omitted

pattern: "^[A-Za-z0-9_][A-Za-z0-9_.:-]{0,127}$"; Streamlines only: saved velocity vector array, defaults to U. Scalar magnitude is not a vector.

integration_direction

"forward" / "backward" / "both" or null

No

Omitted

Streamlines only: integration direction; defaults to forward.

max_length_m

number or null

No

Omitted

maximum: 1000000.0; exclusiveMinimum: 0.0; Streamlines only: required maximum traced length in metres, at most 1,000,000 m.

max_steps

integer or null

No

Omitted

minimum: 1.0; maximum: 4000.0; Streamlines only: maximum integration steps per trace; defaults to 2000, at most 4000.

Omission and explicit null are different. Defaults shown are schema defaults; validators may resolve conditional defaults or reject incompatible combinations. See the workflow guide and validate the complete request before submission.