Class Property

Operator type for representing a property of operator OperatorObject|Object type.

Hierarchy

Property

Index

Constructors

Properties

defaultValue? description? errorMessage? invalid? onChange? required? resolver type view?

Methods

toProps fromJSON

Constructors

constructor

new Property(type: ANY_TYPE, options?: PropertyOptions): Property
Parameters
- type: ANY_TYPE
  
  operator type for the property
- Optional options: PropertyOptions
  metadata for the property as described below:
  - defaultValue: default value of the property when operator is executed
  - required: indicates if property is require when executing operator. If true and value is not provided, validation error will be raised preventing execution
  - invalid: indicate if value provided for the property is considered invalid.
  - errorMessage: custom error message for the property if invalid is set to true. view: view options for the property. Refer to View
Returns Property
- Defined in packages/operators/src/types.ts:223

Properties

`Optional` defaultValue

defaultValue?: unknown

`Optional` description

description?: string

`Optional` errorMessage

errorMessage?: string

`Optional` invalid

invalid?: boolean

`Optional` onChange

onChange?: string

`Optional` required

required?: boolean

resolver

resolver: ((property: Property, ctx: ExecutionContext) => Property)

Type declaration

- (property: Property, ctx: ExecutionContext): Property
- Parameters
  - property: Property
  - ctx: ExecutionContext
  Returns Property

type

`Optional` view

view?: View

Methods

toProps

toProps(): {
    choices: any;
    default: unknown;
    errorMessage: string;
    invalid: boolean;
    onChange: string;
    required: boolean;
    type: ANY_TYPE;
    view: View;
}
Returns {
    choices: any;
    default: unknown;
    errorMessage: string;
    invalid: boolean;
    onChange: string;
    required: boolean;
    type: ANY_TYPE;
    view: View;
}
- choices: any
- default: unknown
- errorMessage: string
- invalid: boolean
- onChange: string
- required: boolean
- type: ANY_TYPE
- view: View
- Defined in packages/operators/src/types.ts:246

`Static` fromJSON

fromJSON(json: any): Property
Parameters
- json: any
Returns Property
- Defined in packages/operators/src/types.ts:242

Generated using TypeDoc