<!-- GENERATED by docs/sphinx/bin/20-reference (p5) from reference/bundled/Test2/EventFacet/Info/Table.md. Do not edit. -->

```{index} single: Test2::EventFacet::Info::Table
```

# Test2::EventFacet::Info::Table

Intermediary representation of a table.

## DESCRIPTION

Intermediary representation of a table for use in specialized
[Test2::API::Context](../../API/Context.md) methods which generate [Test2::EventFacet::Info](../Info.md) facets.

## SYNOPSIS

```perl
use Test2::EventFacet::Info::Table;
use Test2::API qw/context/;

sub my_tool {
    my $ctx = context();

    ...

    $ctx->fail(
        $name,
        "failure diag message",
        Test2::EventFacet::Info::Table->new(
            # Required
            rows => [['a', 'b'], ['c', 'd'], ...],

            # Strongly Recommended
            as_string => "... string to print when table cannot be rendered ...",

            # Optional
            header => ['col1', 'col2'],
            collapse => $bool,
            no_collapse => ['col1', ...],
        ),
    );

    ...

    $ctx->release;
}

my_tool();
```

## ATTRIBUTES

- $header\_aref = $t->header()
- $rows\_aref = $t->rows()
- $bool = $t->collapse()
- $aref = $t->no\_collapse()

    The above are all directly tied to the table hashref structure described in
    [Test2::EventFacet::Info](../Info.md).

- $str = $t->as\_string()

    This returns the string form of the table if it was set, otherwise it returns
    the string `"<TABLE NOT DISPLAYED>"`.

- $href = $t->as\_hash()

    This returns the data structure used for tables by [Test2::EventFacet::Info](../Info.md).

- %args = $t->info\_args()

    This returns the arguments that should be used to construct the proper
    [Test2::EventFacet::Info](../Info.md) structure.

    ```perl
    return (table => $t->as_hash(), details => $t->as_string());
    ```

## SOURCE

The source code repository for Test2 can be found at
[https://github.com/Test-More/test-more/](https://github.com/Test-More/test-more/).

## MAINTAINERS

- Chad Granum <exodist@cpan.org>

## AUTHORS

- Chad Granum <exodist@cpan.org>

## COPYRIGHT

Copyright Chad Granum <exodist@cpan.org>.

This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.

See [https://dev.perl.org/licenses/](https://dev.perl.org/licenses/)