Class OSUISplide

Defines the interface for OutSystemsUI Patterns

Hierarchy (View Summary)

AbstractCarousel<Splide, SplideConfig>
- OSUISplide

Implements

ICarousel

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

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

`Protected`providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

Accessors

`Protected`_enableAccessibility

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns HTMLElement

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns C

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
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

Returns ProviderInfo

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from OSFramework.OSUI.Patterns.Carousel.AbstractCarousel.providerInfo
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:345

provider

get provider(): P
Provider getter

Returns P

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from OSFramework.OSUI.Patterns.Carousel.AbstractCarousel.provider
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:374

Methods

`Protected`finishBuild

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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
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.
Parameters
- platFormCallback: OSGeneric
- ...args: unknown[]
Returns void

Memberof
AbstractProviderPattern
Inherited from AbstractCarousel.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected`triggerPlatformInitializedEventCallback

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

Returns void

Memberof
AbstractPattern
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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
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.
Parameters
- patternId: string
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
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

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractCarousel.redraw
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:132

checkAddedProviderEvents

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

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractCarousel.checkAddedProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:181

checkPendingProviderEvents

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

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractCarousel.checkPendingProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:195

setProviderEvent

setProviderEvent(
    eventName: string,
    callback: Generic,
    uniqueId: string,
    saveEvent?: boolean,
): void
Method to add a provider event using extensibility
Parameters
- eventName: string
- callback: Generic
- uniqueId: string
- OptionalsaveEvent: boolean = true
Returns void
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Implementation of ICarousel.setProviderEvent

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

unsetProviderEvent

unsetProviderEvent(eventId: string): void
Method to remove a provider event using extensibility
Parameters
- eventId: string
Returns void
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Implementation of ICarousel.unsetProviderEvent

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

updateProviderEvents

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

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractCarousel.updateProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:322

`Protected`prepareConfigs

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

Returns void

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Overrides AbstractCarousel.prepareConfigs
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:435

`Protected`setA11YProperties

setA11YProperties(): void
Protected
Apply all Carousel ARIA attributes (status live region, list roles, aria-current). Invoked after Splide mount/refresh and whenever slide state changes.

Returns void

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Overrides AbstractCarousel.setA11YProperties
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:450

`Protected`setCallbacks

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

Returns void

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Overrides AbstractCarousel.setCallbacks
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:466

`Protected`setHtmlElements

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

Returns void

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Overrides AbstractCarousel.setHtmlElements
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:482

`Protected`setInitialCssClasses

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

Returns void

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:499

`Protected`unsetCallbacks

unsetCallbacks(): void
Protected
Unsets the callbacks.

Returns void

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Overrides AbstractCarousel.unsetCallbacks
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:521

`Protected`unsetHtmlElements

unsetHtmlElements(): void
Protected
Unsets the HTML elements.

Returns void

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Overrides AbstractCarousel.unsetHtmlElements
- Defined in Providers/OSUI/Carousel/Splide/Splide.ts:539

build

build(): void
Build the pattern.

Returns void

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Implementation of ICarousel.build

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

changeProperty

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

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Implementation of ICarousel.changeProperty

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

dispose

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

Returns void

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Implementation of ICarousel.dispose

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

goTo

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

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Implementation of ICarousel.goTo

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

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

Returns void

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Implementation of ICarousel.next

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

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

Returns void

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Implementation of ICarousel.previous

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

registerCallback

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

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Implementation of ICarousel.registerCallback

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

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

setProviderConfigs

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

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Implementation of ICarousel.setProviderConfigs

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

toggleDrag

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

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Implementation of ICarousel.toggleDrag

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

toggleOnRender

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

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Implementation of ICarousel.toggleOnRender

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

updateOnRender

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

Returns void

Memberof
Providers.OSUI.Carousel.Splide.OSUISplide
Implementation of ICarousel.updateOnRender

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

Class OSUISplide

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSUISplide

Properties

ProtectedisProviderBased

ProtectedproviderEventsManagerInstance

Accessors

Protected_enableAccessibility

Returns boolean

Memberof

selfElement

Returns HTMLElement

Memberof

isBuilt

Returns boolean

Memberof

configs

Returns C

Memberof

uniqueId

Returns string

Memberof

widgetId

Returns string

Memberof

providerInfo

Returns ProviderInfo

Memberof

provider

Returns P

Memberof

Methods

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

equalsToID

Parameters

Returns boolean

Memberof

Protectedredraw

Returns void

Memberof

checkAddedProviderEvents

Returns void

Memberof

checkPendingProviderEvents

Returns void

Memberof

setProviderEvent

Parameters

Returns void

Memberof

unsetProviderEvent

Parameters

Returns void

Memberof

updateProviderEvents

Parameters

Returns void

Memberof

ProtectedprepareConfigs

`Protected`isProviderBased

`Protected`providerEventsManagerInstance

`Protected`_enableAccessibility

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected`redraw

`Protected`prepareConfigs

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setHtmlElements

`Protected`setInitialCssClasses

`Protected`unsetCallbacks

`Protected`unsetHtmlElements