(Lianja) Google Sheets Conditional Formatting - Color Gradient

Add a conditional color gradient across a row

For more information, see https://developers.google.com/sheets/api/samples/conditional-formatting#add_a_conditional_color_gradient_across_a_row

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loHttp = createobject("CkHttp")

// 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
//       }
//     }
//   ]
// }

lcSheetId = "YOUR_SHEET_ID"

loJson = createobject("CkJsonObject")
loJson.UpdateString("requests[0].addConditionalFormatRule.rule.ranges[0].sheetId",lcSheetId)
loJson.UpdateInt("requests[0].addConditionalFormatRule.rule.ranges[0].startRowIndex",9)
loJson.UpdateInt("requests[0].addConditionalFormatRule.rule.ranges[0].endRowIndex",10)
loJson.UpdateNumber("requests[0].addConditionalFormatRule.rule.gradientRule.minpoint.color.green","0.2")
loJson.UpdateNumber("requests[0].addConditionalFormatRule.rule.gradientRule.minpoint.color.red","0.8")
loJson.UpdateString("requests[0].addConditionalFormatRule.rule.gradientRule.minpoint.type","MIN")
loJson.UpdateNumber("requests[0].addConditionalFormatRule.rule.gradientRule.maxpoint.color.green","0.9")
loJson.UpdateString("requests[0].addConditionalFormatRule.rule.gradientRule.maxpoint.type","MAX")
loJson.UpdateInt("requests[0].addConditionalFormatRule.index",0)
loJson.UpdateString("requests[1].addConditionalFormatRule.rule.ranges[0].sheetId",lcSheetId)
loJson.UpdateInt("requests[1].addConditionalFormatRule.rule.ranges[0].startRowIndex",10)
loJson.UpdateInt("requests[1].addConditionalFormatRule.rule.ranges[0].endRowIndex",11)
loJson.UpdateNumber("requests[1].addConditionalFormatRule.rule.gradientRule.minpoint.color.green","0.8")
loJson.UpdateNumber("requests[1].addConditionalFormatRule.rule.gradientRule.minpoint.color.red","0.8")
loJson.UpdateString("requests[1].addConditionalFormatRule.rule.gradientRule.minpoint.type","NUMBER")
loJson.UpdateString("requests[1].addConditionalFormatRule.rule.gradientRule.minpoint.value","0")
loJson.UpdateNumber("requests[1].addConditionalFormatRule.rule.gradientRule.maxpoint.color.blue","0.9")
loJson.UpdateNumber("requests[1].addConditionalFormatRule.rule.gradientRule.maxpoint.color.green","0.5")
loJson.UpdateNumber("requests[1].addConditionalFormatRule.rule.gradientRule.maxpoint.color.red","0.5")
loJson.UpdateString("requests[1].addConditionalFormatRule.rule.gradientRule.maxpoint.type","NUMBER")
loJson.UpdateString("requests[1].addConditionalFormatRule.rule.gradientRule.maxpoint.value","256")
loJson.UpdateInt("requests[1].addConditionalFormatRule.index",1)

// Adds the "Authorization: Bearer ACCESS_TOKEN" header.
loHttp.AuthToken = "ACCESS_TOKEN"
loHttp.SetRequestHeader("Content-Type","application/json")

loResp = loHttp.PostJson3("https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:batchUpdate","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

? "Status code: " + str(loResp.StatusCode)
? "Response body:"
? loResp.BodyStr

release loResp


release loHttp
release loJson