Renderer
class Renderer
A component that manages Panel and its elements
Properties
Methods
Constructor
new Renderer(options, options.align)
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| options | object | yes | {} | An options object |
| options.align | Constants.ALIGN | string | number | yes | An align value that will be applied to all panels |
Properties
panels
Array of panels
Type: Array<Panel>
See:
panelCount
Count of panels
Type: number
align
A Panel's align value that applied to all panels
Type: Constants.ALIGN | string | number
Methods
render
Render panel elements inside the camera element
Returns: this
init
Initialize Renderer
Returns: this
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| flicking | Flicking | no | An instance of Flicking |
destroy
Destroy Renderer and return to initial state
Returns: void
getPanel
Return the Panel at the given index. null if it doesn't exists.
Returns: Panel | null
- Panel at the given index
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| index | number | no |
See:
updatePanelSize
Update all panel sizes
Returns: this
batchInsert
Insert new panels at given index
This will increase index of panels after by the number of panels added
Returns: Array<Panel>
- An array of prepended panels
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| index | number | no | Index to insert new panels at | |
| elements | Array<any> | no | An array of element or framework component with element in it |
batchRemove
Remove the panel at the given index
This will decrease index of panels after by the number of panels removed
Returns: Panel[]
- An array of removed panels
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| index | number | no | Index of panel to remove | |
| deleteCount | number | yes | 1 | Number of panels to remove from index |