S3D.results namespace provides post-processing functions to read and interpret analysis results produced by
Used to get the analysis results.
|Only return specific data in the response. You can also provide names you have applied to load combination. E.g. ||All cases|
|Only return specific data in the response.||All results|
The analysis results will return an object of all load combination results in the following format.
Sets the results data for further processing.
Analysis results from any source can be used. Simply provide the data in the same format that is returned from S3D.results.get.md.
|Results of a structural analysis (from |
The response will confirm whether or not the model was successfully set.
Fetches results data for a particular member.
|An integer||Fetch the results of the member with this ID. A value of |
|An array of integers||Load combinations to include. An empty array will return all load combinations.|
|The type of results to be returned.|
|Format of results. |
"type": "image" is provided, then an image will be returned in base64 format.
Generates a structural analysis report and returns a download link to retrieve the report.
|Any string.||The name of your project. This will be used as the analysis report name.|
|The report format to be returned.|
|An array of integers or strings||An array of load combination IDs or load combination names to report on. Users can also use shortcuts like load_combination = "all" or load_combination = "envelope" to only filter these|
|Key-value pairs||The different type of analysis results to include in your report (see below)|
The function will return links to download and preview your analysis report in the format specified by the
Returns dynamic frequency analysis results, including modes, frequencies, periods, modal masses, and mass particpation percentages.
Note: A dynamic frequency analysis needs to be run using S3D.model.solve, before calling this function.