arlas-wui-toolkit / Exports / ArlasWalkthroughService

Class: ArlasWalkthroughService

Table of contents

Constructors

Properties

Methods

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:162

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:154

getCurrStepNum

▸ getCurrStepNum(): any

Returns the current zero-based step number

Returns

any

Defined in

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

getCurrTour

▸ getCurrTour(): any

Returns the currently running tour

Returns

any

Defined in

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

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:185

load

▸ load(): void

Returns

void

Defined in

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

nextStep

▸ nextStep(): void

Goes forward one step in the tour

Returns

void

Defined in

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

prevStep

▸ prevStep(): void

Goes back one step in the tour

Returns

void

Defined in

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

removeCallbacks

▸ removeCallbacks(): void

Remove all callbacks for hopscotch events

Returns

void

Defined in

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

resetTour

▸ resetTour(): void

Clear localStorage for the given tour

Returns

void

Defined in

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

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:94

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:130

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:102

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:192