About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Interface Popout

Represents an object that can be used to create and show a Spotfire popout dialog.

interface Popout {
    components: PopoutComponentFactory;
    section(options: PopoutSectionOptions): PopoutSection;
    show(options: PopoutOptions, components: (() => PopoutSection[])): PopoutDialog;
}

Index

Properties

Methods

Properties

components

components: PopoutComponentFactory

Gets an object with methods that create PopoutComponents.

Methods

section

section(options): PopoutSection
Creates a section that contains a heading and components.
Parameters
- options: PopoutSectionOptions
  Specifies the heading and the components.
Returns PopoutSection

show

show(options, components): PopoutDialog
Shows a pop out dialog as specified by the options and controls.
Parameters
- options: PopoutOptions
  Specifies where and how to show the pop out dialog.
- components: (() => PopoutSection[])
  A callback that shall produce the array of components that the pop out will show. If the pop out is shown with PopoutOptions.autoClose set to false this callback will be invoked every time the user has interacted with one of the PopoutComponents so that the pop out can be re-rendered to show the result of the interaction.
  - - (): PopoutSection[]
    - Returns PopoutSection[]
Returns PopoutDialog