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

AngleParameterJSON Overview

Inherits Classes: ParameterJSON

Indicates an angle. A degree symbol will be displayed next to the input. The value returned to the processing function will be in degrees. The ParameterJSON.type must be set to "angle" for these additional properties to be configured.

1 Example:

var params = [
  {
    "id": "sweep",
    "displayName": "Sweep Angle",
    "type": "angle",
    "rangeMin": 0,
    "rangeMax": 360,
    "default": 270
  }
];

JSON Field Summary

  • property
      default | Required
  • property
      displayValue | Optional , Default: true
  • property
      rangeMax | Optional , Default: 1
  • property
      rangeMin | Optional , Default: 0
  • property
      steps | Optional , Default: 1
  • property
      ticks | Optional
  • 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

Number default | Required

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

Boolean displayValue | Optional , Default: true

Indicates whether the underlying parameter value should be displayed to the user.

Number rangeMax | Optional , Default: 1

The maximum value for the parameter slider expressed in degrees (inclusive). Be aware however that currently users can still manually enter larger values, so the processing code needs to safeguard against that scenario.

Number rangeMin | Optional , Default: 0

The minimum value for the parameter slider expressed in degrees (inclusive). Be aware however that currently users can still manually enter smaller values, so the processing code needs to safeguard against that scenario.

Number or Array [ Number ] steps | Optional , Default: 1

When an array is supplied, it explicitly defines the allowable values for the input. When a number is supplied, it identifies allowable values based on integer multiples of the number supplied, starting with rangeMin.

Array [ Number ] ticks | Optional

This property allows the developer to specify where visual indicators appear for numberline tick marks. This does not prevent a user from manually entering a value that does not coorespond with one of the predefined tick marks.