analysis-results

Analysis Results Skill

How to fetch, read, and interpret S3D structural analysis results — the object returned once a model has been solved — whether you're calling the SkyCiv API or building a client-side S3D App that reads results from an already-open session.

Prerequisite: A model must be solved before results exist. Over the API, that's S3D.model.solve (see s3d-api). Inside an S3D App, the user solves via the S3D UI itself — see s3d-apps for the app runtime this skill's client-side functions run in.

Two ways to get results — same object, different calls

Do not skip the conversion step in an App. S3D.results.get() / getAll() alone return a different, older internal shape — if your app was built to read the documented results schema (the one below, matching the API), reading S3D.results.getAll()'s raw output directly will look similar but have different/missing keys and silently produce wrong values. Always wrap it:

S3D.API.output.S3D2API(S3D.results.getAll(true))

Checking solve status first

if (!S3D.solver.isSolved()) {
  // Nothing to fetch yet — prompt the user to solve, or solve programmatically first.
} else {
  // S3D.results.get() is the current load combination only, and always instantly available.
  const currentComboResults = S3D.API.output.S3D2API(S3D.results.get());

  // S3D.results.getAll(true, cb) returns every load combination, but may take a moment to
  // download — do the real work inside the callback, not immediately after the call.
  S3D.results.getAll(true, function () {
    const allResults = S3D.API.output.S3D2API(S3D.results.getAll(true));
  });
}