arlas-wui-toolkit / Exports / ArlasWalkthroughService

Class: ArlasWalkthroughService

Table of contents

Constructors

• constructor

Properties

• hopscotch
• isActivable
• tourData

Methods

• configure
• endTour
• getCurrStepNum
• getCurrTour
• listen
• load
• nextStep
• prevStep
• removeCallbacks
• resetTour
• setTour
• showStep
• startTour
• unlisten

Constructors

constructor

• new ArlasWalkthroughService(walkthrougLoader, translateService)

Parameters

Name	Type
walkthrougLoader	WalkthroughLoader
translateService	TranslateService

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:37

Properties

hopscotch

• hopscotch: any

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:33

---

isActivable

• isActivable: boolean = true

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:35

---

tourData

• tourData: any

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:34

Methods

configure

▸ configure(options): void

Sets options for running the tour

Parameters

Name	Type	Description
options	any	: see https://linkedin.github.io/hopscotch/#setting-tour-options

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:161

---

endTour

▸ endTour(clearCookie?): void

Ends the current tour. If clearCookie is set to false, the tour state is preserved. Otherwise, if clearCookie is set to true or is not provided, the tour state is cleared

Parameters

Name	Type
clearCookie?	boolean

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:153

---

getCurrStepNum

▸ getCurrStepNum(): any

Returns the current zero-based step number

Returns

any

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:175

---

getCurrTour

▸ getCurrTour(): any

Returns the currently running tour

Returns

any

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:168

---

listen

▸ listen(eventName, callback): void

Adds a callback for one of the event types.

Parameters

Name	Type	Description
eventName	string	Valid event types are: start, end, next, prev, show, close, error
callback	() => void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:184

---

load

▸ load(): void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:45

---

nextStep

▸ nextStep(): void

Goes forward one step in the tour

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:143

---

prevStep

▸ prevStep(): void

Goes back one step in the tour

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:136

---

removeCallbacks

▸ removeCallbacks(): void

Remove all callbacks for hopscotch events

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:198

---

resetTour

▸ resetTour(): void

Clear localStorage for the given tour

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:206

---

setTour

▸ setTour(tour): void

Parameters

Name	Type
tour	Object
tour.id	string
tour.steps	any[]

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:93

---

showStep

▸ showStep(index): void

Skips to a given step in the tour

Parameters

Name	Type
index	any

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:129

---

startTour

▸ startTour(stepNum?): void

Actually starts the tour.

Parameters

Name	Type	Description
stepNum?	number	Optional : specifies what step to start at

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:101

---

unlisten

▸ unlisten(eventName, callback): void

Removes a callback for one of the event types

Parameters

Name	Type
eventName	string
callback	() => void

Returns

void

Defined in

projects/arlas-toolkit/src/lib/services/walkthrough/walkthrough.service.ts:191