Home Reference Source 
import DropDownType from 'formatron/src/types/view/data/dropDown.js'
public class | source

DropDownType

Extends:

* → DropDownType

Static Member Summary

Static Public Members
public static

Method Summary

Public Methods
public

getFilterOptions(dataType: *): *

Allows subtypes to define filter options for faster searches.
public

getOptions(renderData: RenderData, input: string): Immutable.List

Returns a list of avaliable options in the drop down, either specified in this view type's options, or in the passed in data type.
public

getValueOption(dataType: *, value: *, renderData: *): undefined[]

public

isAsync(dataType: *): boolean

Supports async loading of options.
public

isMulti(dataType: DataType): boolean

Returns if this display should allow picking multiple items or not.

Static Public Members

public static typeName: * source

Public Methods

public getFilterOptions(dataType: *): * source

Allows subtypes to define filter options for faster searches. Returns undefined so that the default filter options are used.

Params:

NameTypeAttributeDescription
dataType *

Return:

*

The filter options.

public getOptions(renderData: RenderData, input: string): Immutable.List source

Returns a list of avaliable options in the drop down, either specified in this view type's options, or in the passed in data type.

Params:

NameTypeAttributeDescription
renderData RenderData

The render data to get options from.
input string

If async, the input entered to return options for.

Return:

Immutable.List

a list of options.

public getValueOption(dataType: *, value: *, renderData: *): undefined[] source

Params:

NameTypeAttributeDescription
dataType *
value *
renderData *

Return:

undefined[]

public isAsync(dataType: *): boolean source

Supports async loading of options. The getOptions method will then be passed a second argument of the current drop down text input. The return value is expected to be a promise.

Params:

NameTypeAttributeDescription
dataType *

Return:

boolean

true if the options are loaded asynchronously.

public isMulti(dataType: DataType): boolean source

Returns if this display should allow picking multiple items or not.

Params:

NameTypeAttributeDescription
dataType DataType

An optional data type to provide.

Return:

boolean

true if this should allow picking multiple options.