Skip to main content
Version: 4.5.1

ExternalRenderer

⚠️ This class is for internal use only.
class ExternalRenderer extends Renderer

Properties

panels

readonlyinherited

Array of panels

Type: Array<Panel>

See:

panelCount

readonlyinherited

Count of panels

Type: number

strategy

inherited
⚠️ This member is for internal use only.

align

inherited

A Panel's align value that applied to all panels

Type: Constants.ALIGN | string | number

Methods

render

inherited

Render panel elements inside the camera element

Returns: this

init

inherited

Initialize Renderer

Returns: this

PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
flickingFlickingAn instance of Flicking

destroy

inherited

Destroy Renderer and return to initial state

Returns: void

getPanel

inherited

Return the Panel at the given index. null if it doesn't exists.

Returns: Panel | null

  • Panel at the given index
PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
indexnumber

See:

updatePanelSize

inherited

Update all panel sizes

Returns: this

batchInsert

inherited

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
PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
itemsArray<object>An array of items to insert
items.indexnumber✔️Index to insert new panels at
items.elementsArray<any>✔️An array of element or framework component with element in it
items.hasDOMInElementsboolean✔️Whether it contains actual DOM elements. If set to true, renderer will add them to the camera element

batchRemove

inherited

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
PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
itemsArray<object>An array of items to remove
items.indexnumber✔️Index of panel to remove
items.deleteCountnumber✔️1Number of panels to remove from index
items.hasDOMInElementsboolean✔️1Whether it contains actual DOM elements. If set to true, renderer will remove them from the camera element

checkPanelContentsReady

inherited
PARAMETERTYPEOPTIONALDEFAULTDESCRIPTION
checkingPanelsPanel[]
⚠️ This function is for internal use only.