Class AbstractVirtualSelectConfig`Abstract`

Class that represents the custom configurations received by the Dropdown.

Export

AbstractVirtualSelectConfig

Hierarchy (View Summary)

AbstractDropdownConfig
- AbstractVirtualSelectConfig
  - VirtualSelectSearchConfig
  - VirtualSelectTagsConfig

Constructors

constructor

new AbstractVirtualSelectConfig(config: JSON): AbstractVirtualSelectConfig
Parameters
- config: JSON
Returns AbstractVirtualSelectConfig
Inherited from AbstractDropdownConfig.constructor
- Defined in OSFramework/OSUI/Pattern/Dropdown/AbstractDropdownConfig.ts:7

Properties

ExtendedClass

ExtendedClass: string

IsDisabled

IsDisabled: boolean

`Protected`providerExtendedOptions

providerExtendedOptions: VirtualSelectOpts

ElementId

ElementId: string

NoOptionsText

NoOptionsText: string

NoResultsText

NoResultsText: string

OptionsList

OptionsList: DropDownOption[]

PopupDropboxBreakpoint

PopupDropboxBreakpoint: string

Prompt

Prompt: string

SanitizeDropdownValues

SanitizeDropdownValues: boolean = false

SearchPrompt

SearchPrompt: string

ShowDropboxAsPopup

ShowDropboxAsPopup: boolean = true

StartingSelection

StartingSelection: DropDownOption[]

Methods

`Protected`validateBoolean

validateBoolean(value: boolean, defaultValue: boolean): boolean
Protected
Method that helps to validate if a boolean is not undefined
Parameters
- value: boolean
- defaultValue: boolean
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractDropdownConfig.validateBoolean
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:30

`Protected`validateDate

validateDate(value: string | Date, defaultValue: string): string | Date
Protected
Method that helps to validate if a given value is a valid date
Parameters
- value: string | Date
- defaultValue: string
Returns string | Date
{(string | Date)}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractDropdownConfig.validateDate
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:43

`Protected`validateInRange

validateInRange(
    value: unknown,
    defaultValue: unknown,
    ...args: unknown[],
): unknown
Protected
Method that helps to validate if a given value is within a range of values.
Parameters
- value: unknown
- defaultValue: unknown
- ...args: unknown[]
Returns unknown
{unknown}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractDropdownConfig.validateInRange
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:57

`Protected`validateNumber

validateNumber(value: number, defaultValue: number): number
Protected
Method that helps to validate if a number is not empty or undefined.
Parameters
- value: number
- defaultValue: number
Returns number
{number}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractDropdownConfig.validateNumber
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:79

`Protected`validateString

validateString(value: string, defaultValue: string): string
Protected
Method that helps to validate if a string is not empty or undefined.
Parameters
- value: string
- defaultValue: string
Returns string
{string}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractDropdownConfig.validateString
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:92

`Protected`validateTime

validateTime(value: string, defaultValue: string): string
Protected
Method that helps to validate if a given value is a valid time
Parameters
- value: string
- defaultValue: string
Returns string
{(string)}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractDropdownConfig.validateTime
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:105

validateCanChange

validateCanChange(_isBuilt: boolean, _key: string): boolean
Method that validates if a given property can be changed.
Parameters
- _isBuilt: boolean
- _key: string
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractConfiguration
Inherited from AbstractDropdownConfig.validateCanChange
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:118

`Protected`mergeConfigs

mergeConfigs(
    commonConfigs: any,
    specificConfigs: any,
    extendedConfigs?: any,
): any
Protected
Method to merge Common, Specific and External configs
Parameters
- commonConfigs: any
- specificConfigs: any
- OptionalextendedConfigs: any
Returns any
{ProviderConfigs}

Memberof
OSFramework.Patterns.AbstractProviderConfiguration
Inherited from AbstractDropdownConfig.mergeConfigs
- Defined in OSFramework/OSUI/Pattern/AbstractProviderConfiguration.ts:23

getProviderConfig

getProviderConfig(): VirtualSelectOpts
Method used to set all the common VirtualSelect properties across the different types of instances

Returns VirtualSelectOpts
[VirtualSelectOpts]

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelectConfig
Overrides AbstractDropdownConfig.getProviderConfig
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelectConfig.ts:171

setExtensibilityConfigs

setExtensibilityConfigs(newConfigs: VirtualSelectOpts): void
Method to validate and save the external provider configs
Parameters
- newConfigs: VirtualSelectOpts
Returns void

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelectConfig
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelectConfig.ts:238

validateDefault

validateDefault(key: string, value: unknown): unknown
Override, Validate configs key values
Parameters
- key: string
- value: unknown
Returns unknown

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelectConfig
Overrides AbstractDropdownConfig.validateDefault
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelectConfig.ts:254

`Protected` `Abstract`getSelectedValues

getSelectedValues(): string[]
Returns string[]
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelectConfig.ts:273

Class AbstractVirtualSelectConfigAbstract

Export

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AbstractVirtualSelectConfig

Properties

ExtendedClass

IsDisabled

ProtectedproviderExtendedOptions

ElementId

NoOptionsText

NoResultsText

OptionsList

PopupDropboxBreakpoint

Prompt

SanitizeDropdownValues

SearchPrompt

ShowDropboxAsPopup

StartingSelection

Methods

ProtectedvalidateBoolean

Parameters

Returns boolean

Memberof

ProtectedvalidateDate

Parameters

Returns string | Date

Memberof

ProtectedvalidateInRange

Parameters

Returns unknown

Memberof

ProtectedvalidateNumber

Parameters

Returns number

Memberof

ProtectedvalidateString

Parameters

Returns string

Memberof

ProtectedvalidateTime

Parameters

Returns string

Memberof

validateCanChange

Parameters

Returns boolean

Memberof

ProtectedmergeConfigs

Parameters

Returns any

Memberof

getProviderConfig

Returns VirtualSelectOpts

Memberof

setExtensibilityConfigs

Parameters

Returns void

Memberof

validateDefault

Parameters

Returns unknown

Memberof

Protected AbstractgetSelectedValues

Returns string[]

Settings

On This Page

Class AbstractVirtualSelectConfig`Abstract`

`Protected`providerExtendedOptions

`Protected`validateBoolean

`Protected`validateDate

`Protected`validateInRange

`Protected`validateNumber

`Protected`validateString

`Protected`validateTime

`Protected`mergeConfigs

`Protected` `Abstract`getSelectedValues