ViewType
Extends:
The base view type. Every registered view type must eventually inherit from this.
Static Member Summary
| Static Public Members | ||
| public static |
typeName: * |
|
Static Method Summary
| Static Public Methods | ||
| public static |
parseOptions(field: *, parseField: *): * |
|
Constructor Summary
| Public Constructor | ||
| public |
constructor(options: object) Creates a new instance of a view type. |
|
Method Summary
| Public Methods | ||
| public |
asType(Type: *): * |
|
| public |
filter(filterValue: *, rowValue: *): * |
|
| public |
getDefaultFlex(): * |
|
| public |
getFlexGrow(): * |
|
| public |
getFlexShrink(): * |
|
| public |
getLabel(renderData: RenderData, secondLabel: ViewType | string): string Returns a label using 1 of 3 options. |
|
| public |
getMinWidth(): * |
|
| public |
getTableProps(label: *): object Returns display information for table based displays. |
|
| public |
getWidth(): * |
|
| public |
initialize(renderData: RenderData, children: ViewType | List<ViewType>): * Base class implementation that children can call such as:
|
|
Inherited Summary
| From class Type | ||
| public static |
typeName: * The type name. |
|
| public static |
Parses a JS or Immutable.js object into a type. |
|
| public static |
parseOneOrMany(parseField: func): oneOrManyParser Creates a one or many parser with the passed in field parser. |
|
| public static |
parseOptions(field: Immutable.Map, parseField: function): Immutable.Map Override this function if you want the type to reference other types. |
|
Static Public Members
public static typeName: * source
The type name. This must be overridden so that the type can be registered.
Override:
Type#typeNameStatic Public Methods
public static parseOptions(field: *, parseField: *): * source
Override this function if you want the type to reference other types.
Override:
Type#parseOptionsParams:
| Name | Type | Attribute | Description |
| field | * | ||
| parseField | * |
Return:
| * |
Public Constructors
Public Methods
public filter(filterValue: *, rowValue: *): * source
Params:
| Name | Type | Attribute | Description |
| filterValue | * | ||
| rowValue | * |
Return:
| * |
public getLabel(renderData: RenderData, secondLabel: ViewType | string): string source
Returns a label using 1 of 3 options. If the internal label is a basic value, return it. If it is a view type, get its associated display value. If it is a function, call the function with the render data.
Params:
| Name | Type | Attribute | Description |
| renderData | RenderData | The data to maybe generate the label from. |
|
| secondLabel | ViewType | string | A second label to use in place of the built in label. |
public getTableProps(label: *): object source
Returns display information for table based displays. Currently, the only display used is react-virtualized, so the options are entirely based on that library.
For a view type to be used as a table column, it must have a string label.
TODO: Consider allowing any labels, but pass in "dummy" render data that
always returns empty (or default) values. In the current setup, this would
work by just passing the data type and using undefined for the data
value.
If a width is supplied to the view type, the default shrink / grow factor is 0. Otherwise, the default factor is 1 and the default width is 100.
Params:
| Name | Type | Attribute | Description |
| label | * |
public initialize(renderData: RenderData, children: ViewType | List<ViewType>): * source
Base class implementation that children can call such as:
super.initialize(this.getChildren())
If a child does not override this, it means that this function will be
called with no arguments, which is a no-op.
Params:
| Name | Type | Attribute | Description |
| renderData | RenderData | the render data to initialize the type to. |
|
| children | ViewType | List<ViewType> | a single view type or a list of view types to call initialize on |
Return:
| * |