Home Manual Reference Source Repository

Typedef

Static Public Summary
public	AddChildArgs: BaseModificationArgs
public	BaseModificationArgs: Object
public	BusEventOptions: Object
public	DragOptions: Object
public	DropArea: Object
public	HighlightCoordinateArgs: Object
public	LayoutConfig: Object
public	Provider: ValueProvider \| ClassProvider \| ExistingProvider \| FactoryProvider
public	ProviderArg: Provider \| Type<*>
public	RemoveChildArgs: BaseModificationArgs
public	Serialized: Object
public	SerializedLayout: Serialized
public	SerializerContainerConfig: Object
public	StackConfig: Object
public	StackConfigArgs: Object
public	StackItemContainerConfig: Object
public	StackTabConfig: Object
public	StackTabConfigArgs: Object

Static Public

public AddChildArgs: BaseModificationArgs source

Properties:

Name	Type	Attribute	Description
index	number	optional	What index to add the child renderable to. If not provided then it will be pushed.
resize	boolean	optional	Whether to invoke a resize of this renderable.

public BaseModificationArgs: Object source

Properties:

Name	Type	Attribute	Description
render	boolean	optional	Whether to invoke the render cycle. This is useful for delaying the render cycle to a later time.

public BusEventOptions: Object source

public DragOptions: Object source

Properties:

Name	Type	Attribute	Description
host	T		The host object for the event.
startX	number		The start pageX coordinates.
startY	number		The start pageX coordinates.
threshold	number	optional	The threshold before the dragging should start.

public DropArea: Object source

Properties:

Name	Type	Attribute	Description
item	RenderableDropTarget		The renderable being dropped.
area	RenderableArea		The area being dropped.
dragArea	RenderableArea		The area of the item being dragged.

public HighlightCoordinateArgs: Object source

Properties:

Name	Type	Attribute	Description
pageX	number		The current page x.
pageY	number		The current page y.
dropArea	DropArea		The current drop area.
dragArea	RenderableArea		The current dragging items area.

public LayoutConfig: Object source

Properties:

Name	Type	Attribute	Description
child	RenderableArg<Renderable>		The child Renderable to be used in this layout.

public Provider: ValueProvider | ClassProvider | ExistingProvider | FactoryProvider source

public ProviderArg: Provider | Type<*> source

public RemoveChildArgs: BaseModificationArgs source

Properties:

Name	Type	Attribute	Description
destroy	boolean	optional	Whether to destroy the child being removed.

public Serialized: Object source

Properties:

Name	Type	Attribute	Description
name	string		The name to identify the serialized node.

public SerializedLayout: Serialized source

Properties:

Name	Type	Attribute	Description
child	Serialized		The serialized child node.

public SerializerContainerConfig: Object source

Properties:

Name	Type	Attribute	Description
injector	Injector	optional	An injector to use as the parent injector.

public StackConfig: Object source

Properties:

Name	Type	Attribute	Description
children	StackItemContainerConfig[]		Stack item configurations.
startIndex	number		The starting index item.
direction	XYDirection		The direction of the Stack.
reverse	boolean		Display header on opposite side of the Stack.
header	StackHeaderConfigArgs \| null		Stack header configuration.
controls	RenderableArg<StackControl>[]		List of Stack controls to use.

public StackConfigArgs: Object source

Properties:

Name	Type	Attribute	Description
children	StackItemContainerConfig[]		Stack item configurations.
startIndex	number	optional default: 0	The starting index item.
direction	XYDirection	optional default: XYDirection.X	The direction of the Stack.
reverse	boolean	optional default: false	Display header on opposite side of the Stack.
header	StackHeaderConfigArgs \| null	optional default: null	Stack header configuration.
controls	RenderableArg<StackControl>[]	optional default: []	List of Stack controls to use.

public StackItemContainerConfig: Object source

Properties:

Name	Type	Attribute	Description
use	RenderableArg<Renderable>		The Renderable to use for this item.
title	string	optional	The title of this item.
droppable	boolean	optional default: true	Whether the item can be dropped on.
draggable	boolean	optional default: true	Whether the item can be dragged.
closeable	boolean	optional default: true	Whether the item can be closed.
tabControls	RenderableArg<TabControl>[]	optional default: []	List of TabControls to use.

public StackTabConfig: Object source

Properties:

Name	Type	Attribute	Description
maxSize	number		The max size of the tab in pixels.
title	string		The title of the tab.

public StackTabConfigArgs: Object source

Properties:

Name	Type	Attribute	Description
maxSize	number	optional	The max size of the tab in pixels.
title	string	optional	The title of the tab.