Class OSUISplide

Defines the interface for OutSystemsUI Patterns

Hierarchy-Diagram

Legend

class

abstract class

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractCarousel<Splide, SplideConfig>
- OSUISplide

Implements

ICarousel

Index

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Protected` providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

`Private` _blockOnRender

_blockOnRender: boolean = false

`Private` _carouselListWidgetElem

_carouselListWidgetElem: HTMLElement

`Private` _carouselPlaceholderElem

_carouselPlaceholderElem: HTMLElement

`Private` _carouselProviderElem

_carouselProviderElem: HTMLElement

`Private` _carouselTrackElem

_carouselTrackElem: HTMLElement

`Private` _currentIndex

_currentIndex: number

`Private` _eventOnResize

_eventOnResize: Generic

`Private` _hasList

_hasList: boolean

`Private` _platformEventOnSlideMoved

_platformEventOnSlideMoved: OSOnSlideMovedEvent

`Private` _splideOptions

_splideOptions: Options

Methods

`Protected` finishBuild

finishBuild(): void
Protected
Marks the built as being finished.

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractCarousel.finishBuild
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:61

`Protected` triggerPlatformEventCallback

triggerPlatformEventCallback(platFormCallback: OSGeneric, ...args: unknown[]): void
Protected
Triggers a generic platform event.

Memberof
AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
- Rest ...args: unknown[]
Returns void
Inherited from AbstractCarousel.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected` triggerPlatformInitializedEventCallback

triggerPlatformInitializedEventCallback(): void
Protected
Trigger the Initialized callback platform event.

Memberof
AbstractPattern

Returns void
Inherited from AbstractCarousel.triggerPlatformInitializedEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:93

`Protected` unsetGlobalCallbacks

unsetGlobalCallbacks(): void
Protected
Unsets the global callbacks. This naming is used to prevent overriding the unsetCallback method on all patterns

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractCarousel.unsetGlobalCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

equalsToID

equalsToID(patternId: string): boolean
Enables to uniquely identify the pattern in all ways.

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- patternId: string
Returns boolean
Implementation of ICarousel.equalsToID

Inherited from AbstractCarousel.equalsToID
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:172

`Protected` redraw

redraw(): void
Protected
Method that will be responsible to redraw pattern when needed

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractCarousel.redraw
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:107

checkAddedProviderEvents

checkAddedProviderEvents(): void
Method to check for pending events to be added

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractCarousel.checkAddedProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:156

checkPendingProviderEvents

checkPendingProviderEvents(): void
Method to check for saved events to be added after a destroy/init cycle

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractCarousel.checkPendingProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:170

setProviderEvent

setProviderEvent(eventName: string, callback: Generic, uniqueId: string, saveEvent??: boolean): void
Method to add a provider event using extensibility

Returns
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- eventName: string
- callback: Generic
- uniqueId: string
- Optional saveEvent: boolean = true
Returns void
Implementation of ICarousel.setProviderEvent

Inherited from AbstractCarousel.setProviderEvent
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:235

unsetProviderEvent

unsetProviderEvent(eventId: string): void
Method to remove a provider event using extensibility

Returns
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- eventId: string
Returns void
Implementation of ICarousel.unsetProviderEvent

Inherited from AbstractCarousel.unsetProviderEvent
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:268

updateProviderEvents

updateProviderEvents(providerInfo: ProviderInfo): void
Method to update the provider events API instance and save/pending events

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- providerInfo: ProviderInfo
Returns void
Inherited from AbstractCarousel.updateProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:295

`Private` _checkListWidget

_checkListWidget(): void
Returns void
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:37

`Private` _initProvider

_initProvider(): void
Returns void
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:52

`Private` _prepareCarouselItems

_prepareCarouselItems(): void
Returns void
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:80

`Private` _redefineCarouselWidth

_redefineCarouselWidth(): void
Returns void
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:96

`Private` _setCarouselWidth

_setCarouselWidth(): void
Returns void
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:118

`Private` _setOnInitializedEvent

_setOnInitializedEvent(): void
Returns void
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:128

`Private` _setOnSlideMovedEvent

_setOnSlideMovedEvent(): void
Returns void
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:135

`Private` _togglePaginationClass

_togglePaginationClass(): void
Returns void
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:145

`Protected` prepareConfigs

prepareConfigs(): void
Protected
Method that encapsulates all methods needed to create a new Carousel

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide

Returns void
Overrides AbstractCarousel.prepareConfigs
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:169

`Protected` setA11YProperties

setA11YProperties(): void
Protected
This method has no implementation on this pattern context!

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide

Returns void
Overrides AbstractCarousel.setA11YProperties
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:183

`Protected` setCallbacks

setCallbacks(): void
Protected
Sets the callbacks to be used.

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide

Returns void
Overrides AbstractCarousel.setCallbacks
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:193

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Method to set the html elements used

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide

Returns void
Overrides AbstractCarousel.setHtmlElements
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:209

`Protected` setInitialCssClasses

setInitialCssClasses(): void
Protected
Method to set the initial CSS Classes

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide

Returns void
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:226

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Unsets the callbacks.

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide

Returns void
Overrides AbstractCarousel.unsetCallbacks
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:248

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Unsets the HTML elements.

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide

Returns void
Overrides AbstractCarousel.unsetHtmlElements
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:266

build

build(): void
Build the pattern.

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide

Returns void
Implementation of ICarousel.build

Overrides AbstractCarousel.build
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:276

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method to change the value of configs/current state.

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
Implementation of ICarousel.changeProperty

Overrides AbstractCarousel.changeProperty
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:299

dispose

dispose(): void
Method to remove and destroy Carousel Splide instance

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide

Returns void
Implementation of ICarousel.dispose

Overrides AbstractCarousel.dispose
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:341

goTo

goTo(index: number): void
Method to call the go API from the provider

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Parameters
- index: number
Returns void
Implementation of ICarousel.goTo

Overrides AbstractCarousel.goTo
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:359

next(): void
Method to call the go API from the provider. With '>' it will go to the next page

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide

Returns void
Implementation of ICarousel.next

Overrides AbstractCarousel.next
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:368

previous(): void
Method to call the go API from the provider. With '<' it will go to the previous page

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide

Returns void
Implementation of ICarousel.previous

Overrides AbstractCarousel.previous
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:377

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Set callbacks for the onChange event

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of ICarousel.registerCallback

Overrides AbstractCarousel.registerCallback
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:388

setCarouselDirection

setCarouselDirection(direction: string): void
Parameters
- direction: string
Returns void
Implementation of ICarousel.setCarouselDirection

Overrides AbstractCarousel.setCarouselDirection
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:399

setProviderConfigs

setProviderConfigs(newConfigs: Options): void
Method used to set all the extended Splide properties across the different types of instances

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Parameters
- newConfigs: Options
Returns void
Implementation of ICarousel.setProviderConfigs

Overrides AbstractCarousel.setProviderConfigs
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:423

toggleDrag

toggleDrag(hasDrag: boolean): void
Method to call the option API from the provider to toggle drag events

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Parameters
- hasDrag: boolean
Returns void
Implementation of ICarousel.toggleDrag

Overrides AbstractCarousel.toggleDrag
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:435

toggleOnRender

toggleOnRender(blockOnRender: boolean): void
Method to toggle the _blockOnRender that enables/disables the OnRender update

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Parameters
- blockOnRender: boolean
Returns void
Implementation of ICarousel.toggleOnRender

Overrides AbstractCarousel.toggleOnRender
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:445

updateOnRender

updateOnRender(): void
Method to run when there's a platform onRender

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide

Returns void
Implementation of ICarousel.updateOnRender

Overrides AbstractCarousel.updateOnRender
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:454

Accessors

`Protected` _enableAccessibility

get _enableAccessibility(): boolean
Protected
Getter that allows to obtain the accessibility is enabled.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from OSFramework.OSUI.Patterns.Carousel.AbstractCarousel._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

get selfElement(): HTMLElement
Getter that allows to obtain the self element.

Memberof
OSFramework.Patterns.AbstractPattern

Returns HTMLElement
Implementation of ICarousel.selfElement

Inherited from OSFramework.OSUI.Patterns.Carousel.AbstractCarousel.selfElement
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:218

isBuilt

get isBuilt(): boolean
Getter that tells if the pattern is already built.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Implementation of ICarousel.isBuilt

Inherited from OSFramework.OSUI.Patterns.Carousel.AbstractCarousel.isBuilt
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:229

configs

get configs(): C
Current configurations/state of the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
Inherited from OSFramework.OSUI.Patterns.Carousel.AbstractCarousel.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

get uniqueId(): string
Unique id of the pattern. Internal use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of ICarousel.uniqueId

Inherited from OSFramework.OSUI.Patterns.Carousel.AbstractCarousel.uniqueId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:251

widgetId

get widgetId(): string
Id of the pattern known by the developer. External use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of ICarousel.widgetId

Inherited from OSFramework.OSUI.Patterns.Carousel.AbstractCarousel.widgetId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:262

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns ProviderInfo
Inherited from OSFramework.OSUI.Patterns.Carousel.AbstractCarousel.providerInfo
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:318

provider

get provider(): P
Provider getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns P
Inherited from OSFramework.OSUI.Patterns.Carousel.AbstractCarousel.provider
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:347

Constructors

constructor

new OSUISplide(uniqueId: string, configs: JSON): OSUISplide
Parameters
- uniqueId: string
- configs: JSON
Returns OSUISplide
Overrides AbstractCarousel.constructor
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:32

Class OSUISplide

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Protected providerEventsManagerInstance

Private _blockOnRender

Private _carouselListWidgetElem

Private _carouselPlaceholderElem

Private _carouselProviderElem

Private _carouselTrackElem

Private _currentIndex

Private _eventOnResize

Private _hasList

Private _platformEventOnSlideMoved

Private _splideOptions

Methods

Protected finishBuild

Memberof

Returns void

Protected triggerPlatformEventCallback

Memberof

Parameters

platFormCallback: OSGeneric

Rest ...args: unknown[]

Returns void

Protected triggerPlatformInitializedEventCallback

Memberof

Returns void

Protected unsetGlobalCallbacks

Memberof

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Protected redraw

Memberof

Returns void

checkAddedProviderEvents

Memberof

Returns void

checkPendingProviderEvents

Memberof

Returns void

setProviderEvent

Returns

Memberof

Parameters

eventName: string

callback: Generic

uniqueId: string

Optional saveEvent: boolean = true

Returns void

unsetProviderEvent

Returns

Memberof

Parameters

eventId: string

Returns void

updateProviderEvents

Memberof

Parameters

providerInfo: ProviderInfo

Returns void

Private _checkListWidget

Returns void

Private _initProvider

Returns void

Private _prepareCarouselItems

Returns void

`Protected` isProviderBased

`Protected` providerEventsManagerInstance

`Private` _blockOnRender

`Private` _carouselListWidgetElem

`Private` _carouselPlaceholderElem

`Private` _carouselProviderElem

`Private` _carouselTrackElem

`Private` _currentIndex

`Private` _eventOnResize

`Private` _hasList

`Private` _platformEventOnSlideMoved

`Private` _splideOptions

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Protected` redraw

`Optional` saveEvent: boolean = true

`Private` _checkListWidget

`Private` _initProvider

`Private` _prepareCarouselItems

`Private` _redefineCarouselWidth

`Private` _setCarouselWidth

`Private` _setOnInitializedEvent

`Private` _setOnSlideMovedEvent

`Private` _togglePaginationClass

`Protected` prepareConfigs

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` setInitialCssClasses

`Protected` unsetCallbacks

`Protected` unsetHtmlElements