package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module GapiSheetsV4Model.CellDataSource

Sourcetype t = {
  1. userEnteredValue : ExtendedValue.t;
    (*

    The value the user entered in the cell. e.g., `1234`, `'Hello'`, or `=NOW()` Note: Dates, Times and DateTimes are represented as doubles in serial number format.

    *)
  2. effectiveValue : ExtendedValue.t;
    (*

    The effective value of the cell. For cells with formulas, this is the calculated value. For cells with literals, this is the same as the user_entered_value. This field is read-only.

    *)
  3. formattedValue : string;
    (*

    The formatted value of the cell. This is the value as it's shown to the user. This field is read-only.

    *)
  4. userEnteredFormat : CellFormat.t;
    (*

    The format the user entered for the cell. When writing, the new format will be merged with the existing format.

    *)
  5. effectiveFormat : CellFormat.t;
    (*

    The effective format being used by the cell. This includes the results of applying any conditional formatting and, if the cell contains a formula, the computed number format. If the effective format is the default format, effective format will not be written. This field is read-only.

    *)
  6. note : string;
    (*

    Any note on the cell.

    *)
  7. textFormatRuns : TextFormatRun.t list;
    (*

    Runs of rich text applied to subsections of the cell. Runs are only valid on user entered strings, not formulas, bools, or numbers. Properties of a run start at a specific index in the text and continue until the next run. Runs will inherit the properties of the cell unless explicitly changed. When writing, the new runs will overwrite any prior runs. When writing a new user_entered_value, previous runs are erased.

    *)
  8. dataValidation : DataValidationRule.t;
    (*

    A data validation rule on the cell, if any. When writing, the new data validation rule will overwrite any prior rule.

    *)
  9. pivotTable : PivotTable.t;
    (*

    A pivot table anchored at this cell. The size of pivot table itself is computed dynamically based on its data, grouping, filters, values, etc. Only the top-left cell of the pivot table contains the pivot table definition. The other cells will contain the calculated values of the results of the pivot in their effective_value fields.

    *)
  10. dataSourceTable : DataSourceTable.t;
    (*

    A data source table anchored at this cell. The size of data source table itself is computed dynamically based on its configuration. Only the first cell of the data source table contains the data source table definition. The other cells will contain the display values of the data source table result in their effective_value fields.

    *)
  11. dataSourceFormula : DataSourceFormula.t;
    (*

    Output only. Information about a data source formula on the cell. The field is set if user_entered_value is a formula referencing some DATA_SOURCE sheet, e.g. `=SUM(DataSheet!Column)`.

    *)
}
Sourceval userEnteredValue : (t, ExtendedValue.t) GapiLens.t
Sourceval effectiveValue : (t, ExtendedValue.t) GapiLens.t
Sourceval formattedValue : (t, string) GapiLens.t
Sourceval userEnteredFormat : (t, CellFormat.t) GapiLens.t
Sourceval effectiveFormat : (t, CellFormat.t) GapiLens.t
Sourceval note : (t, string) GapiLens.t
Sourceval textFormatRuns : (t, TextFormatRun.t list) GapiLens.t
Sourceval dataValidation : (t, DataValidationRule.t) GapiLens.t
Sourceval pivotTable : (t, PivotTable.t) GapiLens.t
Sourceval dataSourceTable : (t, DataSourceTable.t) GapiLens.t
Sourceval dataSourceFormula : (t, DataSourceFormula.t) GapiLens.t
Sourceval empty : t
Sourceval render : t -> GapiJson.json_data_model list
Sourceval to_data_model : t -> GapiJson.json_data_model
Sourceval of_data_model : GapiJson.json_data_model -> t