# New-ImageConsoleStoryTab

Creates a persistent tab in an ImagePlayground console story.

Project

ImagePlayground

Automate image processing, codes, metadata, charts, topology, and visual stories from PowerShell.

[View on GitHub](https://github.com/EvotecIT/ImagePlayground) [Visit Website](#) [Releases](https://github.com/EvotecIT/ImagePlayground/releases) [Changelog](#) [Get package](https://www.powershellgallery.com/packages/ImagePlayground)

Stars **102**

Forks **7**

Open issues 

Total downloads **708,853**

Release **ImagePlayground-PowerShellModule.v3.2.7**

Language: C# Updated: 2026-11-18

Command 

**Module**

`ImagePlayground`

**Inputs**

`None`

**Outputs**

`ImagePlayground.PowerShell.ImageConsoleStoryStep`

Creates a persistent tab in an ImagePlayground console story.

## Syntax

```
New-ImageConsoleStoryTab
[-Id] <String>
[-Palette <TerminalTheme>]
[-Profile <PowerShell|WindowsPowerShell|Ubuntu|Bash|CommandPrompt>]
[[-Title] <String>]
[-TransitionSeconds <Double>]
[-WorkingDirectory <String>]
[<CommonParameters>]
```

[#](#method-new-imageconsolestorytab-string-terminaltheme-string-string-double-string)

Parameter set: `Open`

```
New-ImageConsoleStoryTab
-Active
[-Id] <String>
[-Palette <TerminalTheme>]
[-Profile <PowerShell|WindowsPowerShell|Ubuntu|Bash|CommandPrompt>]
[[-Title] <String>]
[-TransitionSeconds <Double>]
[-WorkingDirectory <String>]
[<CommonParameters>]
```

[#](#method-new-imageconsolestorytab-switchparameter-string-terminaltheme-string-string-double-string)

Parameter set: `Initial`

```
New-ImageConsoleStoryTab
-Background
[-Id] <String>
[-Palette <TerminalTheme>]
[-Profile <PowerShell|WindowsPowerShell|Ubuntu|Bash|CommandPrompt>]
[[-Title] <String>]
[-TransitionSeconds <Double>]
[-WorkingDirectory <String>]
[<CommonParameters>]
```

[#](#method-new-imageconsolestorytab-switchparameter-string-terminaltheme-string-string-double-string-2)

Parameter set: `Background`

## Description

By default, the new tab opens and becomes active after the current tab's configured reading dwell. Use Active for the initial tab, Background to pre-stage a visible inactive tab, and Select-ImageConsoleStoryTab to revisit any existing tab without clearing its buffer.

## Examples

### Define the initial active PowerShell tab

```powershell
New-ImageConsoleStoryTab -Id PowerShell -Title 'PowerShell' -Profile PowerShell -Active
```

Names and styles the initial persistent tab without creating an extra transition.

### Open an Ubuntu tab

```powershell
New-ImageConsoleStoryTab -Id ubuntu -Profile Ubuntu -Title Ubuntu -WorkingDirectory '~/src'
```

Opens and activates an Ubuntu-styled Bash session only after the previous tab has finished its configured reading dwell.

### Prepare a background tab for a later jump

```powershell
New-ImageConsoleStoryTab -Id logs -Title Logs -Profile PowerShell -Background
Select-ImageConsoleStoryTab -Id logs
```

The declaration makes the tab available in the strip without interrupting the active session. Selection later activates its retained buffer.

## Parameters

**-Id String requiredposition: 0**

Stable identifier used by later tab-selection steps.

**-Palette TerminalTheme optional**

Optional custom palette, normally created by New-ImageConsoleStoryPalette.

**-Profile String optional**

Built-in profile that supplies prompt behavior, default working directory, palette, and icon.

Possible values: `PowerShell`, `WindowsPowerShell`, `Ubuntu`, `Bash`, `CommandPrompt`

**-Title String optionalposition: 1**

Visible tab title. Defaults to the selected profile name.

**-TransitionSeconds Double optional**

Duration of the visual switch from the previously active tab.

**-WorkingDirectory String optional**

Working directory shown by this tab. Defaults to C:\ for Windows profiles and ~ for POSIX profiles.

**-Active SwitchParameter requiredsets: Initial**

Configure this declaration as the initial active tab. It must be the first content step.

**-Background SwitchParameter requiredsets: Background**

Declare the tab without activating it. Use Select-ImageConsoleStoryTab for the later intentional switch.

## Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see [about_CommonParameters](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_commonparameters).

## Outputs

ImagePlayground.PowerShell.ImageConsoleStoryStep: Use the console story command, output, table, blank-line, pause, tab, and tab-selection cmdlets to create steps.

Evotec API Reference Copyright 2026 Evotec Services

<!-- PowerForge markdown artifact sha256:96858AEBD8D151C27055B5D71571BE74397445C0A1FF1BDDC2D3C95AF34088A1 -->
