API Reference
Cmdlet
Add-OfficeMarkdownTable
Adds a Markdown table from objects.
Remarks
Adds a Markdown table from objects.
Examples
Add a table from input objects.
PS>
MarkdownTable -InputObject $rows
Appends a Markdown table using the supplied objects.
Append multiple tables to the same document.
PS>
$doc = New-OfficeMarkdown -Path .\Report.md -NoSave -PassThru
$doc | MarkdownTable -InputObject $summary -PassThru | MarkdownTable -InputObject $details
Creates two tables in sequence within the same Markdown document.
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.
Syntax
Add-OfficeMarkdownTable [-CollectionSeparator <String>] [-DictionaryEntrySeparator <String>] [-DictionaryKeyValueSeparator <String>] [-DisableAutoAlign] -InputObject <Object> [-MaxCollectionItems <Int32>] [-MaxNestingDepth <Int32>] [-PassThru] [-View <Normal|Transpose>] [<CommonParameters>]Parameter set:
ContextParameters
- CollectionSeparator String
- Text used between items when a cell contains a collection.
- DictionaryEntrySeparator String
- Text used between entries when a cell contains a dictionary.
- DictionaryKeyValueSeparator String
- Text used between a dictionary key and value.
- DisableAutoAlign SwitchParameter
- Disable automatic alignment heuristics for tables.
- InputObject Object
- Objects to convert into a Markdown table.
- MaxCollectionItems Int32
- Maximum number of items allowed in one nested collection or dictionary cell. Defaults to 1,048,575; increase explicitly for trusted larger values.
- MaxNestingDepth Int32
- Maximum nesting depth allowed while normalizing one cell value. Defaults to 64; increase explicitly for trusted deeper values.
- PassThru SwitchParameter
- Emit the Markdown document after appending the table.
- View OfficeTableView
- Projection to apply before writing the table.
- Possible values:
Normal,Transpose
Outputs
OfficeIMO.Markdown.MarkdownDoc
Add-OfficeMarkdownTable [-CollectionSeparator <String>] [-DictionaryEntrySeparator <String>] [-DictionaryKeyValueSeparator <String>] [-DisableAutoAlign] -Document <MarkdownDoc> -InputObject <Object> [-MaxCollectionItems <Int32>] [-MaxNestingDepth <Int32>] [-PassThru] [-View <Normal|Transpose>] [<CommonParameters>]Parameter set:
DocumentParameters
- CollectionSeparator String
- Text used between items when a cell contains a collection.
- DictionaryEntrySeparator String
- Text used between entries when a cell contains a dictionary.
- DictionaryKeyValueSeparator String
- Text used between a dictionary key and value.
- DisableAutoAlign SwitchParameter
- Disable automatic alignment heuristics for tables.
- Document MarkdownDoc
- Markdown document to update outside the DSL context.
- InputObject Object
- Objects to convert into a Markdown table.
- MaxCollectionItems Int32
- Maximum number of items allowed in one nested collection or dictionary cell. Defaults to 1,048,575; increase explicitly for trusted larger values.
- MaxNestingDepth Int32
- Maximum nesting depth allowed while normalizing one cell value. Defaults to 64; increase explicitly for trusted deeper values.
- PassThru SwitchParameter
- Emit the Markdown document after appending the table.
- View OfficeTableView
- Projection to apply before writing the table.
- Possible values:
Normal,Transpose
Outputs
OfficeIMO.Markdown.MarkdownDoc
Add-OfficeMarkdownTable [-CollectionSeparator <String>] [-DictionaryEntrySeparator <String>] [-DictionaryKeyValueSeparator <String>] [-DisableAutoAlign] -Document <MarkdownDoc> -InputObject <Object> [-MaxCollectionItems <Int32>] [-MaxNestingDepth <Int32>] [-PassThru] [-View <Normal|Transpose>] [<CommonParameters>]Parameter set:
PipelineDocumentParameters
- CollectionSeparator String
- Text used between items when a cell contains a collection.
- DictionaryEntrySeparator String
- Text used between entries when a cell contains a dictionary.
- DictionaryKeyValueSeparator String
- Text used between a dictionary key and value.
- DisableAutoAlign SwitchParameter
- Disable automatic alignment heuristics for tables.
- Document MarkdownDoc
- Markdown document to update outside the DSL context.
- InputObject Object
- Objects to convert into a Markdown table.
- MaxCollectionItems Int32
- Maximum number of items allowed in one nested collection or dictionary cell. Defaults to 1,048,575; increase explicitly for trusted larger values.
- MaxNestingDepth Int32
- Maximum nesting depth allowed while normalizing one cell value. Defaults to 64; increase explicitly for trusted deeper values.
- PassThru SwitchParameter
- Emit the Markdown document after appending the table.
- View OfficeTableView
- Projection to apply before writing the table.
- Possible values:
Normal,Transpose
Outputs
OfficeIMO.Markdown.MarkdownDoc