Class DrawingControl

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

Constructors

constructor

Properties

defaultValue disposed element enabled height image label labelEl onChanged options required responsive tooltip visiting width

Methods

deleteFields disable dispose enable get getAllValues getDefault getPostfixFieldId getWithId hide isRepeatingUnit set setLabel setWithId show val

Constructors

constructor

Properties

defaultValue

defaultValue: any

Protected disposed

disposed: boolean

element

element: HTMLElement

enabled

enabled: any

height

height: number

Sets the height of the canvas.

image

image: string

Sets the background image of the control.

label

label: string

labelEl

labelEl: JQuery<HTMLElement>

onChanged

onChanged: Function

Protected options

options: any

required

required: boolean

responsive

responsive: boolean

Sets the image responsive. Overrites width and height parameter.

tooltip

tooltip: string

visiting

visiting: boolean = false

width

width: number

Sets the width of the canvas.

Methods

deleteFields

  • Deletes the all fields related to the form control.

    Parameters

    • name: string

      The field id.

    Returns Promise<any>

disable

  • Disables the form control.

    Returns void

dispose

  • Disposes the form control.

    Returns void

enable

  • Enables the form control.

    Returns void

get

getAllValues

  • Returns

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

    Returns any

getDefault

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

    Returns any

getPostfixFieldId

  • 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

getWithId

hide

  • 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

isRepeatingUnit

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

    Returns boolean

set

  • 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

setLabel

  • Sets a new label value.

    Parameters

    • value: string

      The value to set.

    Returns void

setWithId

  • 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

  • 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

val

  • Does nothing on the DrawingControl.

    Parameters

    • value: any

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc