outsystems-ui - v2.30.0
    Preparing search index...

    Interface ICarousel

    Defines the interface for OutSystemsUI Carousel Pattern

    interface ICarousel {
        build(): void;
        dispose(): void;
        isBuilt: boolean;
        selfElement: HTMLElement;
        uniqueId: string;
        widgetId: string;
        changeProperty(propertyName: string, propertyValue: unknown): void;
        equalsToID(id: string): boolean;
        goTo(index: number): void;
        next(): void;
        previous(): void;
        registerCallback(eventName: string, callback: OSGeneric): void;
        setCarouselDirection(direction: string): void;
        setProviderConfigs(providerConfigs: any): void;
        setProviderEvent(
            eventName: string,
            callback: Generic,
            uniqueId: string,
        ): void;
        toggleDrag(hasDrag: boolean): void;
        toggleOnRender(blockOnRender: boolean): void;
        unsetProviderEvent(eventId: string): void;
        updateOnRender(): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index
    isBuilt selfElement uniqueId widgetId
    build dispose changeProperty equalsToID goTo next previous registerCallback setCarouselDirection setProviderConfigs setProviderEvent toggleDrag toggleOnRender unsetProviderEvent updateOnRender
    isBuilt: boolean

    Indicates if the instance of the pattern is built.

    OSFramework.Interface.IPattern

    selfElement: HTMLElement

    Pattern HTML element

    OSFramework.Interface.IPattern

    uniqueId: string

    Internal Id of the instance of the pattern.

    OSFramework.Interface.IPattern

    widgetId: string

    External Id of the instance of the pattern

    OSFramework.Interface.IPattern

    • Method signature to change the properties/configs of the pattern.

      Parameters

      • propertyName: string
      • propertyValue: unknown

      Returns void

      OSFramework.Interface.IPattern

    Settings
    Member Visibility

    On This Page
    Properties
    Methods