IEditablePropertyOption | Babylon.js API documentation

Interface IEditablePropertyOption

Interface that defines the options available for an editable property

interface IEditablePropertyOption {
    embedded?: boolean;
    max?: number;
    min?: number;
    notifiers?: {
        activatePreviewCommand?: boolean;
        callback?: (
            scene: Nullable<Scene>,
            block: any,
        ) => undefined | boolean | void;
        onValidation?: (block: any, propertyName: string) => boolean;
        rebuild?: boolean;
        update?: boolean;
    };
    options?: IEditablePropertyListOption[];
}

Index

Properties

embedded? max? min? notifiers? options?

Properties

`Optional`embedded

embedded?: boolean

Define if the property is displayed inside the source block or in a separate property tab

`Optional`max

max?: number

max value

`Optional`min

min?: number

min value

`Optional`notifiers

notifiers?: {
    activatePreviewCommand?: boolean;
    callback?: (
        scene: Nullable<Scene>,
        block: any,
    ) => undefined | boolean | void;
    onValidation?: (block: any, propertyName: string) => boolean;
    rebuild?: boolean;
    update?: boolean;
}

notifiers: indicates which actions to take when the property is changed

Type declaration

OptionalactivatePreviewCommand?: boolean
the onPreviewCommandActivated observer of the preview manager should be triggered
Optionalcallback?: (scene: Nullable<Scene>, block: any) => undefined | boolean | void
a callback to trigger
OptionalonValidation?: (block: any, propertyName: string) => boolean
a callback to validate the property. Returns true if the property is ok, else false. If false, the rebuild/update/callback events won't be called
Optionalrebuild?: boolean
the entity should be rebuilt
Optionalupdate?: boolean
the preview should be updated

`Optional`options

options?: IEditablePropertyListOption[]

list of the options for a variable of type list

Interface IEditablePropertyOption

Index

Properties

Properties

`Optional`embedded

`Optional`max

`Optional`min

`Optional`notifiers

Type declaration

`Optional`activatePreviewCommand?: boolean

`Optional`callback?: (scene: Nullable<Scene>, block: any) => undefined | boolean | void

`Optional`onValidation?: (block: any, propertyName: string) => boolean

`Optional`rebuild?: boolean

`Optional`update?: boolean

`Optional`options

Settings

On This Page

Interface IEditablePropertyOption

Index

Properties

Properties

Optionalembedded

Optionalmax

Optionalmin

Optionalnotifiers

Type declaration

OptionalactivatePreviewCommand?: boolean

Optionalcallback?: (scene: Nullable<Scene>, block: any) => undefined | boolean | void

OptionalonValidation?: (block: any, propertyName: string) => boolean

Optionalrebuild?: boolean

Optionalupdate?: boolean

Optionaloptions

Settings

On This Page

`Optional`embedded

`Optional`max

`Optional`min

`Optional`notifiers

`Optional`activatePreviewCommand?: boolean

`Optional`callback?: (scene: Nullable<Scene>, block: any) => undefined | boolean | void

`Optional`onValidation?: (block: any, propertyName: string) => boolean

`Optional`rebuild?: boolean

`Optional`update?: boolean

`Optional`options