Skip to content

Widgets reference

There are a number of input widgets you can use when defining your inputs. For more details about the configurable options of each of these individual widgets, use hover-over context help in your IDE when writing your package.

APITokenSelector

APITokenSelector
39
40
41
42
43
44
45
46
inputs {
  ["var_name_a"] = new APITokenSelector {
    title = "API Token Selector (title)"
    required = false
    helpText = "Example for API token selector widget (helpText)."
    showAll = true 
  }
}

BooleanInput

BooleanInput
39
40
41
42
43
44
45
46
inputs {
  ["var_name_b"] = new BooleanInput {
    title = "Boolean Input (title)"
    required = false
    helpText = "Example for boolean input widget (helpText)."
    defaultSelection = true
  }
}

ConnectionCreator

ConnectionCreator
39
40
41
42
43
44
45
46
inputs {
  ["var_name_c"] = new ConnectionCreator {
    title = "Connection Creator (title)"
    required = false
    helpText = "Example for connection creator widget (helpText)."
    width = 8
  }
}

ConnectionSelector

ConnectionSelector
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
inputs {
  ["var_name_d"] = new ConnectionSelector {
    title = "Connection Selector single (title)"
    required = false
    helpText = "Example for connection selector widget (helpText)."
    multiSelect = false
    limitToConnectors = "snowflake" 
  }
  ["var_name_e"] = new ConnectionSelector {
    title = "Connection Selector multi (title)"
    required = false
    helpText = "Example for connection selector widget (helpText)."
    multiSelect = true
    limitToConnectors = { "snowflake" "bigquery" }
  }
}

ConnectorTypeSelector

ConnectorTypeSelector
39
40
41
42
43
44
45
46
inputs {
  ["var_name_f"] = new ConnectorTypeSelector {
    title = "Connector Type Selector (title)"
    required = false
    helpText = "Example for connector type selector widget (helpText)."
    width = 8
  }
}

CredentialInput

CredentialInput
39
40
41
42
43
44
45
46
inputs {
  ["var_name_g"] = new CredentialInput {
    title = "Credential (title)"
    credType = "atlan-connectors-snowflake" // 
    helpText = "Example for connector type selector widget (helpText)."
    allowTestAuthentication = true // 
  }
}

DateInput

DateInput
39
40
41
42
43
44
45
46
47
48
49
inputs {
  ["var_name_h"] = new DateInput {
    title = "Date Input (title)"
    required = false
    helpText = "Example for date input widget (helpText)."
    past = -14 // 
    future = 14 // 
    defaultDay = -1 // 
    width = 8
  }
}
DropDown
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
inputs {
  ["var_name_i"] = new DropDown {
    title = "Drop Down single (title)"
    required = false
    helpText = "Example for drop down widget (restricted to a single) (helpText)."
    possibleValues {
      ["ONE"] = "One"
      ["TWO"] = "Two"
      ["THREE"] = "Three"
    }
    multiSelect = false
    width = 4
  }
  ["var_name_j"] = new DropDown {
    title = "Drop Down multi (title)"
    required = false
    helpText = "Example for drop down widget (allowing multiple) (helpText)."
    possibleValues {
      ["ONE"] = "One"
      ["TWO"] = "Two"
      ["THREE"] = "Three"
    }
    multiSelect = true
    width = 4
  }
}

FileCopier

FileCopier
39
40
41
42
43
44
45
46
47
inputs {
  ["var_name_k"] = new FileCopier {
    title = "File Copier (title)"
    required = false
    helpText = "Example for file copier widget (helpText)."
    placeholderText = "path/file.csv (placeholderText)"
    width = 8
  }
}

FileUploader

FileUploader
39
40
41
42
43
44
45
46
47
48
49
50
inputs {
  ["var_name_l"] = new FileUploader {
    title = "File Uploader (title)"
    required = false
    helpText = "Example for file uploader widget (helpText)."
    placeholderText = "Sample CSV file (placeholderText)"
    fileTypes { 
      "text/csv"
    }
    width = 8
  }
}

KeygenInput

KeygenInput
39
40
41
42
43
44
45
46
inputs {
  ["var_name_m"] = new KeygenInput {
    title = "Keygen Input (title)"
    required = false
    helpText = "Example for keygen input widget (helpText)."
    width = 8
  }
}

MultipleGroups / SingleGroup

SingleGroup | MultipleGroups
39
40
41
42
43
44
45
46
47
48
49
50
51
52
inputs {
  ["var_name_n"] = new SingleGroup {
    title = "Single Group (title)"
    required = false
    helpText = "Example for single group widget (helpText)."
    width = 4
  }
  ["var_name_o"] = new MultipleGroups {
    title = "Multiple Groups (title)"
    required = false
    helpText = "Example for multiple groups widget (helpText)."
    width = 4
  }
}

MultipleUsers / SingleUser

SingleUser | MultipleUsers
39
40
41
42
43
44
45
46
47
48
49
50
51
52
inputs {
  ["var_name_p"] = new SingleUser {
    title = "Single User (title)"
    required = false
    helpText = "Example for single user widget (helpText)."
    width = 4
  }
  ["var_name_q"] = new MultipleUsers {
    title = "Multiple Users (title)"
    required = false
    helpText = "Example for multiple users widget (helpText)."
    width = 4
  }
}

NumericInput

NumericInput
39
40
41
42
43
44
45
46
47
inputs {
  ["var_name_r"] = new NumericInput {
    title = "Numeric Input (title)"
    required = false
    helpText = "Example for numeric input widget (helpText)."
    placeholderValue = 50
    width = 8
  }
}

PasswordInput

PasswordInput
39
40
41
42
43
44
45
46
inputs {
  ["var_name_s"] = new PasswordInput {
    title = "Password Input (title)"
    required = false
    helpText = "Example for password input widget (helpText)."
    width = 8
  }
}

Radio

Radio
39
40
41
42
43
44
45
46
47
48
49
50
51
inputs {
  ["var_name_t"] = new Radio {
    title = "Radio (title)"
    required = false
    helpText = "Example for radio widget (helpText)."
    possibleValues {
      ["ONE"] = "One (value)"
      ["TWO"] = "Two (value)"
      ["THREE"] = "Three (value)"
    }
    default = "TWO"
  }
}

TextInput

TextInput
39
40
41
42
43
44
45
46
inputs {
  ["var_name_u"] = new TextInput {
    title = "Text Input (title)"
    required = false
    helpText = "Example for text input widget (helpText)."
    width = 8
  }
}