Skip to content
This repository has been archived by the owner on Dec 2, 2021. It is now read-only.

Latest commit

 

History

History
202 lines (156 loc) · 9.15 KB

LayoutController.md

File metadata and controls

202 lines (156 loc) · 9.15 KB
Raw

#LayoutController LayoutController lays out renderables according to a layout- function and a data-source.

##class: LayoutController ⏏ Members

###new LayoutController(options) Params

  • options Object - Options.
    • [layout] function | Object - Layout function or layout-literal.
    • [layoutOptions] Object - Options to pass in to the layout-function.
    • [dataSource] Array | ViewSequence | Object - Array, ViewSequence or Object with key/value pairs.
    • [direction] Utility.Direction - Direction to layout into (e.g. Utility.Direction.Y) (when ommited the default direction of the layout is used)
    • [flow] Bool - Enables flow animations when the layout changes (default: false).
    • [insertSpec] Spec - Size, transform, opacity... to use when inserting new renderables into the scene (default: {}).
    • [removeSpec] Spec - Size, transform, opacity... to use when removing renderables from the scene (default: {}).
    • [alwaysLayout] Bool - When set to true, always calls the layout function on every render-cycle (default: false).
    • [autoPipeEvents] Bool - When set to true, automatically calls .pipe on all renderables when inserted (default: false).

###layoutController.setOptions(options) Patches the LayoutController instance's options with the passed-in ones.

Params

  • options Options - An object of configurable options for the LayoutController instance.
    • [layout] function | Object - Layout function or layout-literal.
    • [layoutOptions] Object - Options to pass in to the layout-function.
    • [dataSource] Array | ViewSequence | Object - Array, ViewSequence or Object with key/value pairs.
    • [direction] Utility.Direction - Direction to layout into (e.g. Utility.Direction.Y) (when ommited the default direction of the layout is used)
    • [insertSpec] Spec - Size, transform, opacity... to use when inserting new renderables into the scene (default: {}).
    • [removeSpec] Spec - Size, transform, opacity... to use when removing renderables from the scene (default: {}).
    • [alwaysLayout] Bool - When set to true, always calls the layout function on every render-cycle (default: false).
    • [autoPipeEvents] Bool - When set to true, automatically calls .pipe on all renderables when inserted (default: false).

Returns: LayoutController - this
###layoutController.setDataSource(dataSource) Sets the collection of renderables which are layed out according to the layout-function.

The data-source can be either an Array, ViewSequence or Object with key/value pairs.

Params

  • dataSource Array | Object | ViewSequence - Array, ViewSequence or Object.

Returns: LayoutController - this
###layoutController.getDataSource() Get the data-source.

Returns: Array | ViewSequence | Object - data-source
###layoutController.setLayout(layout, [options]) Set the new layout.

Params

  • layout function | Object - Layout function or layout-literal
  • [options] Object - Options to pass in to the layout-function

Returns: LayoutController - this
###layoutController.getLayout() Get the current layout.

Returns: function | Object - Layout function or layout literal
###layoutController.setLayoutOptions([options]) Set the options for the current layout. Use this function after setLayout to update one or more options for the layout-function.

Params

  • [options] Object - Options to pass in to the layout-function

Returns: LayoutController - this
###layoutController.getLayoutOptions() Get the current layout options.

Returns: Object - Layout options
###layoutController.setDirection(direction) Set the direction of the layout. When no direction is set, the default direction of the layout function is used.

Params

  • direction Utility.Direction - Direction (e.g. Utility.Direction.X)

Returns: LayoutController - this
###layoutController.getDirection([actual]) Get the direction (e.g. Utility.Direction.Y). By default, this function returns the direction that was configured by setting setDirection. When the direction has not been set, undefined is returned.

When no direction has been set, the first direction is used that is specified in the capabilities of the layout-function. To obtain the actual in-use direction, use getDirection(true). This method returns the actual in-use direction and never returns undefined.

Params

  • [actual] Boolean - Set to true to obtain the actual in-use direction

Returns: Utility.Direction - Direction or undefined
###layoutController.getSpec(node) Get the spec (size, transform, etc..) for the given renderable or Id.

Params

  • node Renderable | String - Renderabe or Id to look for

Returns: Spec - spec or undefined
###layoutController.reflowLayout() Forces a reflow of the layout the next render cycle.

Returns: LayoutController - this
###layoutController.insert(indexOrId, renderable, [insertSpec]) Inserts a renderable into the data-source.

The optional argument insertSpec is only used flow mode is enabled. When specified, the renderable is inserted using an animation starting with size, origin, opacity, transform, etc... as specified in `insertSpec'.

Params

  • indexOrId Number | String - Index (0 = before first, -1 at end), within dataSource array or id (String)
  • renderable Object - Renderable to add to the data-source
  • [insertSpec] Spec - Size, transform, etc.. to start with when inserting

Returns: LayoutController - this
###layoutController.push(renderable, [insertSpec]) Adds a renderable to the end of a sequential data-source.

The optional argument insertSpec is only used flow mode is enabled. When specified, the renderable is inserted using an animation starting with size, origin, opacity, transform, etc... as specified in `insertSpec'.

Params

  • renderable Object - Renderable to add to the data-source
  • [insertSpec] Spec - Size, transform, etc.. to start with when inserting

Returns: LayoutController - this
###layoutController.remove(indexOrId, [removeSpec]) Removes a renderable from the data-source.

The optional argument removeSpec is only used flow mode is enabled. When specified, the renderable is removed using an animation ending at the size, origin, opacity, transform, etc... as specified in `removeSpec'.

Params

  • indexOrId Number | String - Index within dataSource array or id (String)
  • [removeSpec] Spec - Size, transform, etc.. to end with when removing

Returns: LayoutController - this
###layoutController.removeAll() Removes all renderables from the data-source.

Returns: LayoutController - this
###layoutController.getSize() Return size of contained element or undefined when size is not defined.

Returns: Array.Number - [width, height]