Interface ComponentApi

Functionality related to dynamically creating SAS Visual Investigator user interface components.

Accessed from the window at window.sas.vi.component.

window.sas.vi.component.create(SviComponent.Page, targetElement, bindings);
interface ComponentApi {
    create(component: ControlCollection, target: HTMLElement, bindings?: ControlCollectionBindings): Promise<ComponentCreationResult<ControlCollectionBindings>>;
    create(component: Page, target: HTMLElement, bindings?: PageViewerBindings): Promise<ComponentCreationResult<PageViewerBindings>>;
    create(component: PagePreview, target: HTMLElement, bindings?: PagePreviewBindings): Promise<ComponentCreationResult<PagePreviewBindings>>;
    create(component: RelationshipDetails, target: HTMLElement, bindings?: RelationshipDetailsBindings): Promise<ComponentCreationResult<RelationshipDetailsBindings>>;
    create(component: SearchInput, target: HTMLElement, bindings?: SearchInputBindings): Promise<ComponentCreationResult<SearchInputBindings>>;
    create(component: SearchAndSelectWithPreview, target: HTMLElement, bindings?: SearchAndSelectWithPreviewBindings): Promise<ComponentCreationResult<SearchAndSelectWithPreviewBindings>>;
    create(component: TimeSlider, target: HTMLElement, bindings?: TimeSliderBindings): Promise<ComponentCreationResult<TimeSliderBindings>>;
    create(component: SviComponent, target: HTMLElement, bindings?: SviComponentBindings): Promise<ComponentCreationResult<SviComponentBindings>>;
    detectChanges(callback?: (() => void)): void;
}

Methods

  • Parameters

    • Optionalcallback: (() => void)

      {ComponentApi~afterDetectChanges} Function to be called after a change is detected.

        • (): void
        • Returns void

    Returns void

    Notifies the application to identify and react to any changes that have been applied.