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

    Defines the interface for OutSystemsUI SectionIndex Pattern

    ISectionIndex

    interface ISectionIndex {
        build(): void;
        dispose(): void;
        beNotifiedByChild(childItem: IChild, notifiedTo: string): void;
        isBuilt: boolean;
        selfElement: HTMLElement;
        uniqueId: string;
        widgetId: string;
        changeProperty(propertyName: string, propertyValue: unknown): void;
        registerCallback(eventName: string, callback: OSGeneric): void;
        equalsToID(id: string): boolean;
    }

    Implemented by

    Index
    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 used to be notified by a given dropdownOptionId about a given action and act accordingly

      Parameters

      • childItem: IChild

        Child Item to be stored

      • notifiedTo: string

        triggered notification type name

      Returns void

      OSFramework.Interface.IParent

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

      Parameters

      • propertyName: string
      • propertyValue: unknown

      Returns void

      OSFramework.Interface.IPattern

    • Validates if object matched with the given id

      Parameters

      • id: string

      Returns boolean

      {boolean}

      OSFramework.Interface.ISearchById