Module Values_0.SheetDefinitionSource

A sheet is an object that contains a set of visuals that are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.

Sourcetype nonrec t = {
  1. sheetId : ShortRestrictiveResourceId.t;
    (*

    The unique identifier of a sheet.

    *)
  2. title : SheetTitle.t option;
    (*

    The title of the sheet.

    *)
  3. description : SheetDescription.t option;
    (*

    A description of the sheet.

    *)
  4. name : SheetName.t option;
    (*

    The name of the sheet. This name is displayed on the sheet's tab in the Quick console.

    *)
  5. parameterControls : ParameterControlList.t option;
    (*

    The list of parameter controls that are on a sheet. For more information, see Using a Control with a Parameter in Amazon Quick Sight in the Amazon Quick Suite User Guide.

    *)
  6. filterControls : FilterControlList.t option;
    (*

    The list of filter controls that are on a sheet. For more information, see Adding filter controls to analysis sheets in the Amazon Quick Suite User Guide.

    *)
  7. visuals : VisualList.t option;
    (*

    A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

    *)
  8. textBoxes : SheetTextBoxList.t option;
    (*

    The text boxes that are on a sheet.

    *)
  9. images : SheetImageList.t option;
    (*

    A list of images on a sheet.

    *)
  10. layouts : LayoutList.t option;
    (*

    Layouts define how the components of a sheet are arranged. For more information, see Types of layout in the Amazon Quick Suite User Guide.

    *)
  11. sheetControlLayouts : SheetControlLayoutList.t option;
    (*

    The control layouts of the sheet.

    *)
  12. contentType : SheetContentType.t option;
    (*

    The layout content type of the sheet. Choose one of the following options: PAGINATED: Creates a sheet for a paginated report. INTERACTIVE: Creates a sheet for an interactive dashboard.

    *)
  13. customActionDefaults : VisualCustomActionDefaults.t option;
    (*

    A list of visual custom actions for the sheet.

    *)
}
Sourceval context_ : string
Sourceval make : ?title:??? -> ?description:??? -> ?name:??? -> ?parameterControls:??? -> ?filterControls:??? -> ?visuals:??? -> ?textBoxes:??? -> ?images:??? -> ?layouts:??? -> ?sheetControlLayouts:??? -> ?contentType:??? -> ?customActionDefaults:??? -> sheetId:ShortRestrictiveResourceId.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of ParameterName.t | `Structure of (string * [> `Enum of string | `String of String_.t | `Structure of (string * [> `Boolean of BooleanObject.t | `String of DataSetIdentifier.t | `Structure of (string * [> `List of [> `Double of SensitiveDoubleObject.t | `Long of SensitiveLongObject.t | `String of SensitiveStringObject.t | `Timestamp of SensitiveTimestamp.t ] list ]) list ]) list ]) list ]) list ] list | `String of URLOperationTemplate.t | `Structure of (string * [> `String of ShortRestrictiveResourceId.t ]) list ]) list ]) list ] list | `String of ShortRestrictiveResourceId.t ]) list ] list | `String of ShortRestrictiveResourceId.t | `Structure of (string * [> `Double of Double.t | `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of ParameterName.t | `Structure of (string * [> `Enum of string | `String of String_.t | `Structure of (string * [> `Boolean of BooleanObject.t | `String of DataSetIdentifier.t | `Structure of (string * [> `List of [> `Double of SensitiveDoubleObject.t | `Long of SensitiveLongObject.t | `String of SensitiveStringObject.t | `Timestamp of SensitiveTimestamp.t ] list ]) list ]) list ]) list ]) list ] list | `String of URLOperationTemplate.t | `Structure of (string * [> `Enum of string | `List of [> `String of FieldId.t | `Structure of (string * [> `String of DataSetIdentifier.t ]) list ] list | `String of ShortRestrictiveResourceId.t | `Structure of (string * [> `Enum of string | `List of [> `String of ShortRestrictiveResourceId.t ] list ]) list ]) list ]) list ]) list ] list | `String of ShortRestrictiveResourceId.t | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of DataSetIdentifier.t | `Structure of (string * [> `Double of Double.t | `Enum of string | `List of [> `String of CategoryValue.t ] list | `Structure of (string * [> `String of DataSetIdentifier.t ]) list | `Timestamp of Timestamp.t ]) list ]) list ] list | `String of HierarchyId.t | `Structure of (string * [> `Double of CoordinateLatitudeDouble.t | `Enum of string | `String of DataSetIdentifier.t | `Structure of (string * [> `Enum of string | `String of String_.t | `Structure of (string * [> `Double of PercentileValue.t ]) list ]) list ]) list ]) list ]) list ] list | `String of ShortRestrictiveResourceId.t | `Structure of (string * [> `Double of RadarChartStartAngle.t | `Enum of string | `List of [> `String of String_.t | `Structure of (string * [> `Enum of string | `Integer of GridLayoutElementColumnIndex.t | `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of ParameterName.t | `Structure of (string * [> `Enum of string | `String of String_.t | `Structure of (string * [> `Boolean of BooleanObject.t | `String of DataSetIdentifier.t | `Structure of (string * [> `List of [> `Double of SensitiveDoubleObject.t | `Long of SensitiveLongObject.t | `String of SensitiveStringObject.t | `Timestamp of SensitiveTimestamp.t ] list ]) list ]) list ]) list ]) list ] list | `String of URLOperationTemplate.t | `Structure of (string * [> `Enum of string | `List of [> `String of FieldId.t | `Structure of (string * [> `String of DataSetIdentifier.t ]) list ] list | `String of ShortRestrictiveResourceId.t | `Structure of (string * [> `Enum of string | `List of [> `String of ShortRestrictiveResourceId.t ] list ]) list ]) list ]) list ]) list ] list | `String of DataSetIdentifier.t | `Structure of (string * [> `Enum of string | `String of FieldId.t | `Structure of (string * [> `Enum of string | `String of DataSetIdentifier.t | `Structure of (string * [> `Double of PercentileValue.t | `String of NullString.t | `Structure of (string * [> `Enum of string | `String of Prefix.t | `Structure of (string * [> `Enum of string | `Long of DecimalPlaces.t | `String of NullString.t | `Structure of (string * [> `Enum of string ]) list ]) list ]) list ]) list ]) list ]) list ]) list ] list | `String of String_.t | `Structure of (string * [> `Double of Double.t | `Enum of string | `Integer of PeriodsForward.t | `List of [> `String of ShortRestrictiveResourceId.t | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Integer of BodySectionDynamicDimensionLimit.t | `List of [> `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `String of DataSetIdentifier.t | `Structure of (string * [> `Enum of string | `String of String_.t | `Structure of (string * [> `Double of PercentileValue.t ]) list ]) list ]) list ]) list ] list | `Structure of (string * [> `String of DataSetIdentifier.t ]) list ]) list ]) list ] list | `String of DataSetIdentifier.t | `Structure of (string * [> `Double of SensitiveDouble.t | `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of Expression.t | `Structure of (string * [> `Enum of string ]) list ]) list ] list | `String of ShortRestrictiveResourceId.t | `Structure of (string * [> `Enum of string | `String of FieldId.t | `Structure of (string * [> `Enum of string | `String of DataSetIdentifier.t | `Structure of (string * [> `Double of PercentileValue.t | `Enum of string | `String of String_.t | `Structure of (string * [> `Double of PercentileValue.t | `Enum of string | `String of Prefix.t | `Structure of (string * [> `Enum of string | `Long of DecimalPlaces.t | `String of NullString.t | `Structure of (string * [> `Enum of string ]) list ]) list ]) list ]) list ]) list ]) list ]) list ] list | `String of PixelLength.t | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of Expression.t | `Structure of (string * [> `Enum of string ]) list ]) list ] list | `String of ShortRestrictiveResourceId.t | `Structure of (string * [> `Enum of string | `String of HexColorWithTransparency.t ]) list ]) list ] list | `String of FieldId.t | `Structure of (string * [> `Double of PercentileValue.t | `Enum of string | `List of [> `Structure of (string * [> `Double of Double.t | `String of HexColor.t ]) list ] list | `String of DataSetIdentifier.t | `Structure of (string * [> `Double of PercentileValue.t | `Enum of string | `List of [> `Structure of (string * [> `Double of Double.t | `String of HexColor.t ]) list ] list | `Long of DecimalPlaces.t | `String of NullString.t | `Structure of (string * [> `Double of Opacity.t | `Enum of string | `List of [> `Structure of (string * [> `Double of Double.t | `String of HexColorWithTransparency.t ]) list ] list | `String of Prefix.t | `Structure of (string * [> `Enum of string | `Long of DecimalPlaces.t | `String of NullString.t | `Structure of (string * [> `Double of GeospatialWidth.t | `Enum of string | `String of HexColorWithTransparency.t ]) list ]) list ]) list ]) list ]) list ]) list | `Timestamp of Timestamp.t ]) list ]) list ]) list ] list | `String of DateTimeFormat.t | `Structure of (string * [> `Double of Double.t | `Enum of string | `Integer of WordCloudMaximumStringLength.t | `List of [> `String of FieldId.t | `Structure of (string * [> `Double of Double.t | `Enum of string | `Integer of TransposedColumnIndex.t | `List of [> `Structure of (string * [> `String of FieldId.t | `Structure of (string * [> `Enum of string ]) list ]) list ] list | `String of FieldId.t | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of FieldId.t | `Structure of (string * [> `Enum of string ]) list ]) list ] list | `String of FieldId.t | `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `String of FieldId.t | `Structure of (string * [> `Enum of string ]) list ]) list ] list | `String of DataSetIdentifier.t | `Structure of (string * [> `Double of PercentileValue.t | `Enum of string | `String of String_.t | `Structure of (string * [> `Double of PercentileValue.t | `Enum of string | `String of String_.t | `Structure of (string * [> `Double of PercentileValue.t | `Enum of string | `Long of DecimalPlaces.t | `String of HexColor.t | `Structure of (string * [> `Enum of string | `String of PixelLength.t ]) list ]) list ]) list ]) list ]) list ]) list ]) list ] list | `Long of VisiblePanelRows.t | `String of String_.t | `Structure of (string * [> `Double of Double.t | `Enum of string | `Integer of TableFieldHeight.t | `List of [> `String of HexColor.t | `Structure of (string * [> `Enum of string | `String of FieldId.t | `Structure of (string * [> `Enum of string | `String of FieldId.t | `Structure of (string * [> `Enum of string | `String of DataSetIdentifier.t | `Structure of (string * [> `Double of PercentileValue.t | `Enum of string | `String of NullString.t | `Structure of (string * [> `Double of PercentileValue.t | `Enum of string | `String of Prefix.t | `Structure of (string * [> `Enum of string | `Long of DecimalPlaces.t | `String of NullString.t | `Structure of (string * [> `Enum of string ]) list ]) list ]) list ]) list ]) list ]) list ]) list ] list | `Long of Long.t | `String of HexColor.t | `Structure of (string * [> `Double of Double.t | `Enum of string | `Integer of TableFieldHeight.t | `List of [> `Structure of (string * [> `String of HexColor.t ]) list ] list | `Long of Long.t | `String of PixelLength.t | `Structure of (string * [> `Double of PercentNumber.t | `Enum of string | `Integer of TableBorderThickness.t | `String of PixelLength.t | `Structure of (string * [> `Double of Double.t | `Enum of string | `Integer of TableBorderThickness.t | `Long of DecimalPlaces.t | `String of HexColor.t | `Structure of (string * [> `Double of Double.t | `Enum of string | `Integer of TableBorderThickness.t | `String of HexColor.t ]) list ]) list ]) list ]) list ]) list ]) list ]) list ]) list ]) list ] list | `String of ShortRestrictiveResourceId.t | `Structure of (string * [> `Structure of (string * [> `Enum of string ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t