Autodesk Creative Platform Core Version 1.19.0
A broad and deep collection of 2D and 3D capabilities.

StringParameterJSON Overview

Inherits Classes: ParameterJSON

This is the definition of a parameter

1 Example:

var params = [
  {
    "id": "equation",
    "displayName": "Z = f(x,y)",
    "type": "string",
    "default": "Math.cos(Math.sqrt(x * x + y * y))"
  }
];

JSON Field Summary

  • property
      default | Required
  • property
      maxLength | Optional
  • property
      singleLine | Optional , Default: false
  • property
      displayIcon | Optional
  • property
      displayName | Required
  • property
      id | Required
  • property
      invalid | Optional , Default: "" , Coming Soon!
  • property
      type | Required
  • property
      validate | Optional , Default: false , Coming Soon!
  • property
      visible | Optional , Default: true , Coming Soon!

JSON Field Details

String default | Required

The default value for the parameter. The value of this parameter when accessed through IShapeGenerator.preview, IShapeGenerator.evaluate or IShapeGenerator.validate will be the same type.

Number maxLength | Optional

The upper limit number of characters that the text entry can accept.

Boolean singleLine | Optional , Default: false

A single-line text entry input is provided, rather than the default multi-line text area input.