The field definition for a custom field. Used for registration in RegisterCustomField.

Hierarchy

  • CustomFieldDefinition

Properties

Properties

Events: {
    Create: CustomFieldCallback;
    OpenUi: CustomFieldCallback;
    Redraw: CustomFieldCallback;
    Resize: CustomFieldCallback;
}

The events available for this custom field. The individual events can be null in which case no custom code will be executed.

Type declaration

  • Create: CustomFieldCallback

    Event handler triggered when a new field of this type has been created. The field object is passed as parameter.

  • OpenUi: CustomFieldCallback

    Event handler triggered when a field of this type should open its UI. The field object is passed as parameter.

  • Redraw: CustomFieldCallback

    Event handler triggered when a field of this type should redraw itself.

  • Resize: CustomFieldCallback

    Event handler triggered when a field of this type is being resized. The field object is passed as parameter.

Name: string

The sub type of the custom field. Used to identify the field type and ensure the correct actions are applied. Use a unique name to avoid conflicts with other custom fields ideally via a naming convention.

Settings: {
    AllowCopy: boolean;
    CustomFieldVariableName: string;
    DialogTitle: string;
    HasBorder: boolean;
    HasOptionDialog: boolean;
    HasReset: boolean;
    HasSecondTab: boolean;
    HasShadow: boolean;
    Selectable: boolean;
    TabTitle: string;
    TabToolTip: string;
}

The settings available for this custom field.

Type declaration

  • AllowCopy: boolean

    Flag to indicate if the field can be duplicated.

  • CustomFieldVariableName: string

    The variable name of the field. This should be a global variable within the custom field script and used to access functions specific to that field in other scripts via that class available under this variable.

  • DialogTitle: string

    The dialog title for the settings dialog.

  • HasBorder: boolean

    Flag to indicate if the field should have a border.

  • HasOptionDialog: boolean

    Flag indicating if the field should have an options dialog.

  • HasReset: boolean

    Flag to indicate if the field can be reset.

  • HasSecondTab: boolean

    Flag indicating if the field should have a second tab.

  • HasShadow: boolean

    Flag to indicate if the field should have a shadow.

  • Selectable: boolean

    Flag indicating if the field can be selected by the user.

  • TabTitle: string

    The title of the UI tab.

  • TabToolTip: string

    The tooltip for the UI tab.

Generated using TypeDoc