Class StringProperty

Represents a string property with optional constraints.

Hierarchy (View Summary)

Property
- StringProperty

Index

Constructors

Properties

default description editor enum required title type

Methods

allowedValues setDefault setDescription setRequired setTitle textEditor

Constructors

constructor

new StringProperty(): StringProperty
Returns StringProperty
Overrides Property.constructor
- Defined in settings.ts:95

Properties

default

default: string

description

description: string

editor

editor: boolean = false

enum

enum: string[]

required

required: boolean = false

title

title: string

type

type: "string" | "number" | "boolean" | "array"

Methods

allowedValues

allowedValues(_enum: string[]): StringProperty
Defines allowed values for the string property.
Parameters
- _enum: string[]
Returns StringProperty
- Defined in settings.ts:110

setDefault

setDefault(_default: string): StringProperty
Sets the default value of the string property.
Parameters
- _default: string
Returns StringProperty
- Defined in settings.ts:102

setDescription

setDescription(description: string): Property
Sets the description of the property.
Parameters
- description: string
Returns Property
Inherited from Property.setDescription
- Defined in settings.ts:24

setRequired

setRequired(required: boolean): StringProperty
Marks the string property as required.
Parameters
- required: boolean
Returns StringProperty
- Defined in settings.ts:126

setTitle

setTitle(title: string): Property
Sets the title of the property.
Parameters
- title: string
Returns Property
Inherited from Property.setTitle
- Defined in settings.ts:16

textEditor

textEditor(enable: boolean): StringProperty
Enables or disables the text editor for this property.
Parameters
- enable: boolean
Returns StringProperty
- Defined in settings.ts:118