ISectionSlidesTransformerFunction

ISectionSlidesTransformerFunction.breakUpSlidepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

This transformer ís used to extract break up slide from current section. Break up slide is created from section title and description. This transformer only create slide when section has title or description.

breakUpSlide: (section: IDashboardLayoutSection<TWidget>) => IDashboardLayoutSection<TWidget>[] | undefined;

ISectionSlidesTransformerFunction.containerSlidepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

This is more complex transformer that is used to transform container item in the layout to a slide. Container item is transformed as a structured slide, but if it contains a visualization switcher, it is transformed to a flat list of visualizations that are part of container item.

containerSlide: (item: IDashboardLayoutItem<TWidget>, transform: (section: IDashboardLayoutSection<TWidget>) => IDashboardLayoutSection<TWidget>[] | undefined) => IDashboardLayoutSection<TWidget>[] | undefined;

ISectionSlidesTransformerFunction.containerSwitcherSlidepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

This is more complex transformer that is used to transform container item in the layout to a slide. Container item is transformed as a structured slide, but if it contains a visualization switcher, switcher is spread into multiple slides where each slide contains one visualization from each switcher.

containerSwitcherSlide: (item: IDashboardLayoutItem<TWidget>, transform: (section: IDashboardLayoutSection<TWidget>) => IDashboardLayoutSection<TWidget>[] | undefined) => IDashboardLayoutSection<TWidget>[] | undefined;

Remarks

If there are 2 switchers in the container, one with 3 visualizations and the other with 2 visualizations, then this transformer will create 3 slides. First slide will contain first visualizations from both switchers, second slide will contain second visualizations from both switchers and last slide will contain third visualization from the first switcher and empty item from the second switcher.

ISectionSlidesTransformerFunction.containsVisualisationSwitcherpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

This function is used to determine if the section contains visualization switcher.

containsVisualisationSwitcher: (section: IDashboardLayoutSection<TWidget>) => boolean;

ISectionSlidesTransformerFunction.defaultItemspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Default transformer for the items. This is used as default transformation method for the items in section in case that no plugin override it. Can be used to provide default transformation for the items in custom plugin.

defaultItems: (section: IDashboardLayoutSection<TWidget>) => IDashboardLayoutSection<TWidget>[] | undefined;

ISectionSlidesTransformerFunction.defaultSectionpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Default transformer for the section. This is used as default transformation method for the section in case that no plugin override it. Can be used to provide default transformation for the section in custom plugin.

defaultSection: (section: IDashboardLayoutSection<TWidget>) => IDashboardLayoutSection<TWidget>[] | undefined;

ISectionSlidesTransformerFunction.itemsSlidepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

This is helper function that is used to iterate all items in the section. On every item it calls provided transform function. This function is used to transform all items in the section.

itemsSlide: (section: IDashboardLayoutSection<TWidget>, transform: (item: IDashboardLayoutItem<TWidget>) => IDashboardLayoutSection<TWidget>[]) => IDashboardLayoutSection<TWidget>[] | undefined;

ISectionSlidesTransformerFunction.switcherSlidepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

This transformer is used to create multiple slides from switcher widget. Each slide contains one visualization that is part of the switcher.

switcherSlide: (item: IDashboardLayoutItem<TWidget>) => IDashboardLayoutSection<TWidget>[] | undefined;

ISectionSlidesTransformerFunction.widgetSlidepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

This transformer is used to extract widget slide from current section and provided item. Widget slide is created from provided item. Widget slide always contains only one item that mean there will be one item on created slide.

widgetSlide: (item: IDashboardLayoutItem<TWidget>) => IDashboardLayoutSection<TWidget>[] | undefined;