Version: 4.2.5

Panel

class Panel

Constructor

new Panel(options, options.index, options.align, options.flicking)

PARAMETER	TYPE	OPTIONAL	DESCRIPTION
options	object		An options object
options.index	number	✔️	An initial index of the panel
options.align	Constants.ALIGN \| string \| number	✔️	An initial align value of the panel
options.flicking	Flicking	✔️	A Flicking instance panel's referencing

Properties

index

readonly

Index of the panel

Type: number

position

readonly

Position of the panel, including alignPosition

Type: number

size

readonly

Cached size of the panel element
This is equal to element's offsetWidth if horizontal is true, and offsetHeight else

Type: number

sizeIncludingMargin

readonly

Panel's size including CSS margin
This value includes element's margin left/right if horizontal is true, and margin top/bottom else

Type: number

height

readonly

Height of the panel element

Type: number

margin

readonly

Cached CSS margin value of the panel element

Type: object

PROPERTY	TYPE	DESCRIPTION
prev	number	CSS `margin-left` when the horizontal is `true`, and `margin-top` else
next	number	CSS `margin-right` when the horizontal is `true`, and `margin-bottom` else

alignPosition

readonly

Align position inside the panel where Camera's alignPosition inside viewport should be located at

Type: number

removed

readonly

A value indicating whether the panel's removed

Type: boolean

range

readonly

Panel element's range of the bounding box

Type: object

PROPERTY	TYPE	DESCRIPTION
min	number	Bounding box's left(horizontal: true) / top(horizontal: false)
max	number	Bounding box's right(horizontal: true) / bottom(horizontal: false)

toggled

readonly

A value indicating whether the panel's position is toggled by circular behavior

Type: boolean

toggleDirection

readonly

A direction where the panel's position is toggled

Type: DIRECTION

offset

readonly

Actual position offset determined by Panel#order

Type: number

progress

readonly

Progress of movement between previous or next panel relative to current panel

Type: number

outsetProgress

readonly

Progress of movement between points that panel is completely invisible outside of viewport(prev direction: -1, selected point: 0, next direction: 1)

Type: number

visibleRatio

readonly

Percentage of area where panel is visible in the viewport

Type: number

align

A value indicating where the alignPosition should be located at inside the panel element

Type: Constants.ALIGN | string | number

Methods

resize

Update size of the panel

Returns: this

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
cached	object	✔️		Predefined cached size of the panel

setSize

Change panel's size. This will change the actual size of the panel element by changing its CSS width/height property

Returns: this

PARAMETER	TYPE	OPTIONAL	DESCRIPTION
size	object	✔️	New panel size
size.width	number \| string	✔️	CSS string or number(in px)
size.height	number \| string	✔️	CSS string or number(in px)

contains

Check whether the given element is inside of this panel's element

Returns: boolean

A Boolean value indicating the element is inside of this panel element

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
element	HTMLElement			The HTMLElement to check

destroy

Reset internal state and set removed to true

Returns: void

includePosition

Check whether the given position is inside of this panel's range

Returns: boolean

A Boolean value indicating whether the given position is included in the panel range

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
pos	number			A position to check
includeMargin	boolean	✔️	false	Include margin to the range

includeRange

Check whether the given range is fully included in this panel's area

Returns: boolean

A Boolean value indicating whether the given range is fully included in the panel range

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
min	number			Minimum value of the range to check
max	number			Maximum value of the range to check
includeMargin	boolean	✔️	false	Include margin to the range

focus

Move Camera to this panel

Returns: Promise<void>

A Promise which will be resolved after reaching the panel

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
duration	number	✔️		Duration of the animation (unit: ms)

Get previous(index - 1) panel. When the previous panel does not exist, this will return null instead
If the circular is enabled, this will return the last panel if called from the first panel

Returns: Panel | null

The previous panel

Get next(index + 1) panel. When the next panel does not exist, this will return null instead
If the circular is enabled, this will return the first panel if called from the last panel

Returns: Panel | null

The previous panel