Delphi DLL

Google Sheets Conditional Formatting - Color Gradient

See more Google Sheets Examples

Add a conditional color gradient across a row Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, HttpResponse, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
http: HCkHttp;
sheetId: PWideChar;
json: HCkJsonObject;
resp: HCkHttpResponse;

begin
success := False;

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := CkHttp_Create();

// Implements the following CURL command:

// curl -H "Content-Type: application/json" \
//    -H "Authorization: Bearer ACCESS_TOKEN" \
//    -X POST \
//    -d '{
//   "requests": [
//     {
//       "addConditionalFormatRule": {
//         "rule": {
//           "ranges": [
//             {
//               "sheetId": sheetId,
//               "startRowIndex": 9,
//               "endRowIndex": 10,
//             }
//           ],
//           "gradientRule": {
//             "minpoint": {
//               "color": {
//                 "green": 0.2,
//                 "red": 0.8
//               },
//               "type": "MIN"
//             },
//             "maxpoint": {
//               "color": {
//                 "green": 0.9
//               },
//               "type": "MAX"
//             },
//           }
//         },
//         "index": 0
//       }
//     },
//     {
//       "addConditionalFormatRule": {
//         "rule": {
//           "ranges": [
//             {
//               "sheetId": sheetId,
//               "startRowIndex": 10,
//               "endRowIndex": 11,
//             }
//           ],
//           "gradientRule": {
//             "minpoint": {
//               "color": {
//                 "green": 0.8,
//                 "red": 0.8
//               },
//               "type": "NUMBER",
//               "value": "0"
//             },
//             "maxpoint": {
//               "color": {
//                 "blue": 0.9,
//                 "green": 0.5,
//                 "red": 0.5
//               },
//               "type": "NUMBER",
//               "value": "256"
//             },
//           }
//         },
//         "index": 1
//       }
//     },
//   ]
// }' https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:batchUpdate

// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code

// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "requests": [
//     {
//       "addConditionalFormatRule": {
//         "rule": {
//           "ranges": [
//             {
//               "sheetId": sheetId,
//               "startRowIndex": 9,
//               "endRowIndex": 10
//             }
//           ],
//           "gradientRule": {
//             "minpoint": {
//               "color": {
//                 "green": 0.2,
//                 "red": 0.8
//               },
//               "type": "MIN"
//             },
//             "maxpoint": {
//               "color": {
//                 "green": 0.9
//               },
//               "type": "MAX"
//             }
//           }
//         },
//         "index": 0
//       }
//     },
//     {
//       "addConditionalFormatRule": {
//         "rule": {
//           "ranges": [
//             {
//               "sheetId": sheetId,
//               "startRowIndex": 10,
//               "endRowIndex": 11
//             }
//           ],
//           "gradientRule": {
//             "minpoint": {
//               "color": {
//                 "green": 0.8,
//                 "red": 0.8
//               },
//               "type": "NUMBER",
//               "value": "0"
//             },
//             "maxpoint": {
//               "color": {
//                 "blue": 0.9,
//                 "green": 0.5,
//                 "red": 0.5
//               },
//               "type": "NUMBER",
//               "value": "256"
//             }
//           }
//         },
//         "index": 1
//       }
//     }
//   ]
// }

sheetId := 'YOUR_SHEET_ID';

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'requests[0].addConditionalFormatRule.rule.ranges[0].sheetId',sheetId);
CkJsonObject_UpdateInt(json,'requests[0].addConditionalFormatRule.rule.ranges[0].startRowIndex',9);
CkJsonObject_UpdateInt(json,'requests[0].addConditionalFormatRule.rule.ranges[0].endRowIndex',10);
CkJsonObject_UpdateNumber(json,'requests[0].addConditionalFormatRule.rule.gradientRule.minpoint.color.green','0.2');
CkJsonObject_UpdateNumber(json,'requests[0].addConditionalFormatRule.rule.gradientRule.minpoint.color.red','0.8');
CkJsonObject_UpdateString(json,'requests[0].addConditionalFormatRule.rule.gradientRule.minpoint.type','MIN');
CkJsonObject_UpdateNumber(json,'requests[0].addConditionalFormatRule.rule.gradientRule.maxpoint.color.green','0.9');
CkJsonObject_UpdateString(json,'requests[0].addConditionalFormatRule.rule.gradientRule.maxpoint.type','MAX');
CkJsonObject_UpdateInt(json,'requests[0].addConditionalFormatRule.index',0);
CkJsonObject_UpdateString(json,'requests[1].addConditionalFormatRule.rule.ranges[0].sheetId',sheetId);
CkJsonObject_UpdateInt(json,'requests[1].addConditionalFormatRule.rule.ranges[0].startRowIndex',10);
CkJsonObject_UpdateInt(json,'requests[1].addConditionalFormatRule.rule.ranges[0].endRowIndex',11);
CkJsonObject_UpdateNumber(json,'requests[1].addConditionalFormatRule.rule.gradientRule.minpoint.color.green','0.8');
CkJsonObject_UpdateNumber(json,'requests[1].addConditionalFormatRule.rule.gradientRule.minpoint.color.red','0.8');
CkJsonObject_UpdateString(json,'requests[1].addConditionalFormatRule.rule.gradientRule.minpoint.type','NUMBER');
CkJsonObject_UpdateString(json,'requests[1].addConditionalFormatRule.rule.gradientRule.minpoint.value','0');
CkJsonObject_UpdateNumber(json,'requests[1].addConditionalFormatRule.rule.gradientRule.maxpoint.color.blue','0.9');
CkJsonObject_UpdateNumber(json,'requests[1].addConditionalFormatRule.rule.gradientRule.maxpoint.color.green','0.5');
CkJsonObject_UpdateNumber(json,'requests[1].addConditionalFormatRule.rule.gradientRule.maxpoint.color.red','0.5');
CkJsonObject_UpdateString(json,'requests[1].addConditionalFormatRule.rule.gradientRule.maxpoint.type','NUMBER');
CkJsonObject_UpdateString(json,'requests[1].addConditionalFormatRule.rule.gradientRule.maxpoint.value','256');
CkJsonObject_UpdateInt(json,'requests[1].addConditionalFormatRule.index',1);

// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
CkHttp_putAuthToken(http,'ACCESS_TOKEN');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');

resp := CkHttpResponse_Create();
success := CkHttp_HttpJson(http,'POST','https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:batchUpdate',json,'application/json',resp);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add('Status code: ' + IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add('Response body:');
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkHttpResponse_Dispose(resp);

end;