API List

The list of methods provided by aideye after initialization.

Method	Parameter	Returns	Description
start	`number \| undefined`	`void`	Starts the tour at step `number`.
moveNext	-	`void`	Moves to the next step.
movePrevious	-	`void`	Moves to the previous step.
moveTo	`number`	`void`	Moves to step `number`.
hasNextStep	-	`AidEyeStep \| false`	Returns whether there is a next step.
hasPreviousStep	-	`AidEyeStep \| false`	Returns whether there is a previous step.
isFirstStep	-	`boolean`	Returns whether the current step is the first step.
getActiveIndex	-	`number \| undefined`	Returns the active step index.
getActiveStep	-	`AidEyeStep \| undefined`	Returns the active step configuration.
getPreviousStep	-	`AidEyeStep \| undefined`	Returns the previous step configuration.
getActiveElement	-	`Element \| undefined`	Returns the active HTML element.
getPreviousElement	-	`Element \| undefined`	Returns the previous HTML element.
isActive	-	`boolean`	Returns whether the tour or highlight is currently active.
refresh	-	`void`	Recalculates and redraws the highlight.
getConfig	-	`Config`	Returns the configuration object.
setConfig	`Config \| undefined`	`void`	Sets the configuration object.
setSteps	`AidEyeStep[]`	`void`	Sets the steps.
getState	-	`State`	Returns the state object.
highlight	`AidEyeStep`	`void`	Highlights an element.
destroy	-	`void`	Destroys the instance.