HybridForms API
    Preparing search index...

    The HybridForms DrawingControl. Users can draw on an image inside edit overlay with all drawing funtionality. Optional a background image can be included. The drawn sketch is stored.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    defaultValue: any
    disposed: boolean
    element: HTMLElement
    enabled: any
    height: number

    Sets the height of the canvas.

    image: string

    Sets the background image of the control.

    label: string
    labelEl: JQuery<HTMLElement>
    onChanged: (value: any) => void
    options: any
    required: boolean
    responsive: boolean

    Sets the image responsive. Overrites width and height parameter.

    tooltip: string
    visiting: boolean = false
    width: number

    Sets the width of the canvas.

    Methods

    • Deletes the all fields related to the form control.

      Parameters

      • name: string

        The field id.

      Returns Promise<any>

    • Enables the form control.

      Returns void

    • Returns any

      all fields and values that are connected with the the form control.

    • Gets the default value auf the form control, if it is set.

      Returns any

    • Gets the PostfixFieldId. Relevant for operations in repeating units. Check first, if the form control is contained in a repeating unit, see: isRepeatingUnit.

      Returns string

    • Hide FormControl

      Parameters

      • animate: boolean = false

        En/Disable animation

      • lock: boolean = true

        Enable lock of hidden FormControl to not process control with condition

      Returns void

    • Checks if the form control is included in a repeating unit.

      Returns boolean

    • Sets the field value of the form control. Be careful: This does not update the UI. In most cases it is better to use the val() method, see: val

      Parameters

      • value: any

        The value of the field

      Returns number

    • Sets a new label value.

      Parameters

      • value: string

        The value to set.

      Returns void

    • Sets any field value by providing its id.

      Parameters

      • id: string

        The id of the field.

      • val: any

        The value of the field. Data type is an object. Its structure depends on the specific field type.

      Returns number

    • Show hidden FormControl

      Parameters

      • animate: boolean = false

        En/Disable animation

      • unlock: boolean = true

        Disable lock of hidden state to process control with condition

      Returns void

    • Does nothing on the DrawingControl.

      Parameters

      • value: any

      Returns void