« blib/lib/Paws/Honeycode/BatchUpsertTableRowsResult.pm
↑ Summary
blib/lib/Paws/Honeycode/CellInput.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Honeycode::Cell; | ||
| 3 | use Moose; | ||
| 4 | has Format => (is => 'ro', isa => 'Str', request_name => 'format', traits => ['NameInRequest']); | ||
| 5 | has FormattedValue => (is => 'ro', isa => 'Str', request_name => 'formattedValue', traits => ['NameInRequest']); | ||
| 6 | has Formula => (is => 'ro', isa => 'Str', request_name => 'formula', traits => ['NameInRequest']); | ||
| 7 | has RawValue => (is => 'ro', isa => 'Str', request_name => 'rawValue', traits => ['NameInRequest']); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::Honeycode::Cell | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::Honeycode::Cell object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Format => $value, ..., RawValue => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::Honeycode::Cell object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Format | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | An object that represents a single cell in a table. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 Format => Str | ||
| 45 | |||
| 46 | The format of the cell. If this field is empty, then the format is | ||
| 47 | either not specified in the workbook or the format is set to AUTO. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 FormattedValue => Str | ||
| 51 | |||
| 52 | The formatted value of the cell. This is the value that you see | ||
| 53 | displayed in the cell in the UI. | ||
| 54 | |||
| 55 | Note that the formatted value of a cell is always represented as a | ||
| 56 | string irrespective of the data that is stored in the cell. For | ||
| 57 | example, if a cell contains a date, the formatted value of the cell is | ||
| 58 | the string representation of the formatted date being shown in the cell | ||
| 59 | in the UI. See details in the rawValue field below for how cells of | ||
| 60 | different formats will have different raw and formatted values. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 Formula => Str | ||
| 64 | |||
| 65 | The formula contained in the cell. This field is empty if a cell does | ||
| 66 | not have a formula. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 RawValue => Str | ||
| 70 | |||
| 71 | The raw value of the data contained in the cell. The raw value depends | ||
| 72 | on the format of the data in the cell. However the attribute in the API | ||
| 73 | return value is always a string containing the raw value. | ||
| 74 | |||
| 75 | Cells with format DATE, DATE_TIME or TIME have the raw value as a | ||
| 76 | floating point number where the whole number represents the number of | ||
| 77 | days since 1/1/1900 and the fractional part represents the fraction of | ||
| 78 | the day since midnight. For example, a cell with date 11/3/2020 has the | ||
| 79 | raw value "44138". A cell with the time 9:00 AM has the raw value | ||
| 80 | "0.375" and a cell with date/time value of 11/3/2020 9:00 AM has the | ||
| 81 | raw value "44138.375". Notice that even though the raw value is a | ||
| 82 | number in all three cases, it is still represented as a string. | ||
| 83 | |||
| 84 | Cells with format NUMBER, CURRENCY, PERCENTAGE and ACCOUNTING have the | ||
| 85 | raw value of the data as the number representing the data being | ||
| 86 | displayed. For example, the number 1.325 with two decimal places in the | ||
| 87 | format will have it's raw value as "1.325" and formatted value as | ||
| 88 | "1.33". A currency value for $10 will have the raw value as "10" and | ||
| 89 | formatted value as "$10.00". A value representing 20% with two decimal | ||
| 90 | places in the format will have its raw value as "0.2" and the formatted | ||
| 91 | value as "20.00%". An accounting value of -$25 will have "-25" as the | ||
| 92 | raw value and "$ (25.00)" as the formatted value. | ||
| 93 | |||
| 94 | Cells with format TEXT will have the raw text as the raw value. For | ||
| 95 | example, a cell with text "John Smith" will have "John Smith" as both | ||
| 96 | the raw value and the formatted value. | ||
| 97 | |||
| 98 | Cells with format CONTACT will have the name of the contact as a | ||
| 99 | formatted value and the email address of the contact as the raw value. | ||
| 100 | For example, a contact for John Smith will have "John Smith" as the | ||
| 101 | formatted value and "john.smith@example.com" as the raw value. | ||
| 102 | |||
| 103 | Cells with format ROWLINK (aka picklist) will have the first column of | ||
| 104 | the linked row as the formatted value and the row id of the linked row | ||
| 105 | as the raw value. For example, a cell containing a picklist to a table | ||
| 106 | that displays task status might have "Completed" as the formatted value | ||
| 107 | and | ||
| 108 | "row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" | ||
| 109 | as the raw value. | ||
| 110 | |||
| 111 | Cells with format AUTO or cells without any format that are | ||
| 112 | auto-detected as one of the formats above will contain the raw and | ||
| 113 | formatted values as mentioned above, based on the auto-detected | ||
| 114 | formats. If there is no auto-detected format, the raw and formatted | ||
| 115 | values will be the same as the data in the cell. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head1 SEE ALSO | ||
| 120 | |||
| 121 | This class forms part of L<Paws>, describing an object used in L<Paws::Honeycode> | ||
| 122 | |||
| 123 | =head1 BUGS and CONTRIBUTIONS | ||
| 124 | |||
| 125 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 126 | |||
| 127 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 128 | |||
| 129 | =cut | ||
| 130 |