API Properties

The API type exposes the following members.

Properties

	Name	Description
	areaColor	Change color for areas
	autoMassInX	Set the auto-mass in X direction.
	autoMassInY	Set the auto-mass in Y direction.
	autoMassInZ	Set the auto-mass in Z direction.
	backgroundColor	Get or set the background color
	baselineGrade	Get or set the degree of the baseline correction function for dynamic analyses. Set to -1 to disable baseline correction, or use 0, 1, 2 or 3.
	binFolder	Get or set binary folder for NextFEM API - this will affect only design data (materials, translations, etc.)
	bordersColor	Change color for borders in extruded view
	constraintsColor	Change color for constraints
	defSolverType	Get the system of equation type in standard solver. The property is read-only, use changeDefSolverType to modify it
	designMaterialsID	Get the list of design material IDs
	DocXfontSize	Change font size for DocX reporting tool. Default is 8
	DocXtableAlignment	Change table aligment: 0=left, 1=center, 2=right, 3=justified. Default is 1
	DocXtableBorders	Change table borders: True=border present, False=no border. Default is True for all sides.
	DocXtableFitting	Change table fitting: True=Page, False=Content. Default is False.
	DocXtableFontSize	Change table font size for DocX reporting tool. Default is 6
	dontDeleteChecks	Set if checking results can be deleted or not.
	dontDeleteResults	Set if results can be deleted or not.
	DXFoptions	Get or set a JSON string containing options for DXF export of RC beams and members
	elemsList	Get the list of element numbers
	elemsNumber	Get the number of elements in the model
	elemTextColor	Change color for element text
	envName	Return the name of checking envelope
	hingesColor	Change color for hinges
	IFC_format	Set 0 for IFC4, 1 for IFC2x3
	IFC_includeAnalyticalModel	Set whether or not to include analytical model in IFC export
	IFC_WallMeshSize	Set or get mesh size for meshing walls in IFC import, in millimeters
	isRemote	True if this API instance is redirected to a remote server
	lineColor	Change color for lines
	loading	Readonly property for API loading
	massColor	Change color for mass
	materialsID	Get the list of material IDs
	modeldata	Model in JSON format
	modelName	Name of the model. To be set prior to launch to have properly-named temporary files.
	modelPath	Return the full path of the currently opened file
	modelresults	Results in JSON format
	nodeColor	Change color for nodes
	nodesList	Get the list of node numbers
	nodesNumber	Get the number of nodes in the model
	nodeTextColor	Change color for node text
	numberFormat	Get or set the format for printing numbers in output of some functions (e.g. getNodeInfo, getElementInfo)
	OS_beamWithHingesOption	Get or set flag for using beamWithHinges instead of forceBeamColumn in OpenSees fiber models
	OS_concreteTensileStrength	Get or set flag for using or not the tensile strength in concrete for fiber sections
	OS_IntegrationPointsOption	Get or set number of integration points in OpenSees fiber models
	OS_NDfiberSectionsOption	Get or set flag for using NDFiber sections in OpenSees fiber models
	OS_saveStateVariables	Get or set flag for saving state variables in OpenSees analysis
	releasesColor	Change color for releases
	resCalc_accuracy	Get or set section calculation accuracy in Section Analyzer (from 10 to 1000)
	resCalc_cacheEnabled	Enable or disable section calculation cache. Enabled by default.
	resCalc_cacheSize	Get or set the cache size for storing section calculations
	resCalc_concreteBehaviour	Set concrete law for strength calculation: 0 parabola-rectangle, 1 bilinear, 2 confined
	resCalc_domainCorrectionType	Set the type of resisting domain correction (0,1,2,3) - contact NextFEM Support to change this
	resCalc_elasticTolerance	Tolerance for elastic strength calculation of a section
	resCalc_getAllJSONresults	Get or set a flag to get all results in JSON from getSectionResMoments method
	resCalc_homogBarsFactor	Set custom homogenization factor for bars in concrete sections
	resCalc_kMod	Set kmod factor for strength calculation of timber sections
	resCalc_rebarHardeningRatio	Hardening ratio for rebar bilinear behaviour
	resCalc_refinement	Get or set the refinement in resistance calculation domain (e.g. more domain points in the zone of interest)
	resCalc_resDomainSlices	Set number of domain slices in sectional strength calculation
	resCalc_responseInTension	Set response in tension for concrete sections in strength calculation
	resCalc_steelClass	Set the class for steel section in strength calculation (1, 2, 3, 4)
	resCalc_strandHardeningRatio	Hardening ratio for strand bilinear behaviour
	resCalc_useFibers	Get or set if fibers are used in section calculation (True or False)
	restraintsColor	Change color for restraints
	saveStateVariables	Get or set flag for saving state variables in NXF file
	sectionsID	Get the list of section IDs
	selAreaColor	Change color for selected areas
	selectedElements	Get or set selected elements in viewport. REST version only against local instance of NextFEM Designer
	selectedNodes	Get or set selected nodes in viewport. REST version only against local instance of NextFEM Designer
	selLineColor	Change color for selected lines
	selNodeColor	Change color for selected nodes
	selSolidColor	Change color for selected solids
	selSpringColor	Change color for selected springs
	solidColor	Change color for solids
	solverType	Get current solver type. The property is read-only, use changeSolver to modify it
	springColor	Change color for springs
	tempFolder	Get or set the temporary folder.
	textColor	Change color for text
	useFastEigensolver	Get or set flag for using fast eigensolver
	WallMeshSize	Set or get mesh size for meshing areas in the model, in millimeters

Top

See Also