Class GradientCondition
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
وضعیت گرادیان دسترسی به شرایط گرادیان (رنگی) در Conditional Format Rule Apis
. هر قانون قالب شرطی ممکن است شامل یک شرط گرادیان واحد باشد. یک شرط گرادیان با سه نقطه در امتداد یک مقیاس عددی (min، mid و max) تعریف میشود که هر کدام دارای یک رنگ، یک مقدار و یک Interpolation Type
هستند. محتوای یک سلول با مقادیر در مقیاس اعداد مقایسه می شود و رنگ اعمال شده به سلول بر اساس نزدیکی محتوای سلول به شرایط گرادیان min، mid و max نقاط درونیابی می شود.
// Logs all the information inside gradient conditional format rules on a sheet.
// The below snippet assumes all colors have ColorType.RGB.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
for (let i = 0; i < rules.length; i++) {
const gradient = rules[i].getGradientCondition();
const minColor = gradient.getMinColorObject().asRgbColor().asHexString();
const minType = gradient.getMinType();
const minValue = gradient.getMinValue();
const midColor = gradient.getMidColorObject().asRgbColor().asHexString();
const midType = gradient.getMidType();
const midValue = gradient.getMidValue();
const maxColor = gradient.getMaxColorObject().asRgbColor().asHexString();
const maxType = gradient.getMaxType();
const maxValue = gradient.getMaxValue();
Logger.log(`The conditional format gradient information for rule ${i}:
MinColor ${minColor}, MinType ${minType}, MinValue ${minValue},
MidColor ${midColor}, MidType ${midType}, MidValue ${midValue},
MaxColor ${maxColor}, MaxType ${maxType}, MaxValue ${maxValue}`);
}
روش های منسوخ شده
روش | نوع برگشت | شرح مختصر |
---|
get Max Color()
| String | مجموعه رنگ را برای حداکثر مقدار این شرایط گرادیان دریافت می کند. |
get Mid Color()
| String | مجموعه رنگ را برای مقدار نقطه میانی این شرایط گرادیان دریافت می کند. |
get Min Color()
| String | مجموعه رنگ را برای حداقل مقدار این شرایط گرادیان دریافت می کند. |
مستندات دقیق
get Max Color Object()
مجموعه رنگ را برای حداکثر مقدار این شرایط گرادیان دریافت می کند. اگر رنگ تنظیم نشده باشد، null
برمیگرداند.
بازگشت
Color
- مجموعه رنگ برای حداکثر مقدار این شرایط گرادیان یا null
.
get Max Type()
نوع درونیابی را برای حداکثر مقدار این شرایط گرادیان دریافت می کند. اگر نوع گرادیان max تنظیم نشده باشد، null
برمیگرداند.
بازگشت
Interpolation Type
- نوع درونیابی برای حداکثر مقدار این شرایط گرادیان یا null
.
get Max Value()
حداکثر مقدار این شرایط گرادیان را دریافت می کند. اگر Interpolation Type
MAX
باشد یا اگر مقدار حداکثر تنظیم نشده باشد، یک رشته خالی برمی گرداند.
بازگشت
String
- حداکثر مقدار در صورت مشخص شدن یا یک رشته خالی.
get Mid Color Object()
مجموعه رنگ را برای مقدار نقطه میانی این شرایط گرادیان دریافت می کند. اگر رنگ تنظیم نشده باشد، null
برمیگرداند.
بازگشت
Color
- رنگ تنظیم شده برای مقدار نقطه میانی این شرایط گرادیان یا null
.
get Mid Type()
نوع درونیابی را برای مقدار نقطه میانی این شرایط گرادیان دریافت می کند. اگر نوع گرادیان وسط تنظیم نشده باشد، null
برمیگرداند.
بازگشت
Interpolation Type
- نوع درونیابی برای مقدار نقطه میانی این شرایط گرادیان یا null
.
get Mid Value()
مقدار نقطه میانی این شرط گرادیان را دریافت می کند. اگر مقدار متوسط گرادیان تنظیم نشده باشد، یک رشته خالی را برمیگرداند.
بازگشت
String
- مقدار نقطه میانی یا یک رشته خالی.
get Min Color Object()
مجموعه رنگ را برای حداقل مقدار این شرایط گرادیان دریافت می کند. اگر رنگ تنظیم نشده باشد، null
برمیگرداند.
بازگشت
Color
- مجموعه رنگ برای حداقل مقدار این شرایط گرادیان یا null
.
get Min Type()
نوع درونیابی را برای حداقل مقدار این شرایط گرادیان دریافت می کند. اگر نوع گرادیان min تنظیم نشده باشد، null
برمیگرداند.
بازگشت
Interpolation Type
- نوع درونیابی برای حداقل مقدار این شرایط گرادیان یا null
.
get Min Value()
حداقل مقدار این شرایط گرادیان را دریافت می کند. اگر Interpolation Type
MIN
باشد یا اگر مقدار min تنظیم نشده باشد، یک رشته خالی برمی گرداند.
بازگشت
String
- حداقل مقدار در صورت مشخص شدن یا یک رشته خالی.
روش های منسوخ شده
get Max Color()
منسوخ شده است. با get Max Color Object()
جایگزین شد
مجموعه رنگ را برای حداکثر مقدار این شرایط گرادیان دریافت می کند. اگر رنگ تنظیم نشده باشد یک رشته خالی را برمی گرداند.
بازگشت
String
- رنگ تنظیم شده برای حداکثر مقدار این شرایط گرادیان یا یک رشته خالی.
get Mid Color()
منسوخ شده است. با get Mid Color Object()
جایگزین شد
مجموعه رنگ را برای مقدار نقطه میانی این شرایط گرادیان دریافت می کند. اگر رنگ تنظیم نشده باشد یک رشته خالی را برمی گرداند.
بازگشت
String
- رنگ تنظیم شده برای مقدار نقطه میانی این شرایط گرادیان یا یک رشته خالی.
get Min Color()
منسوخ شده است. با get Min Color Object()
جایگزین شد
مجموعه رنگ را برای حداقل مقدار این شرایط گرادیان دریافت می کند. اگر رنگ تنظیم نشده باشد یک رشته خالی را برمی گرداند.
بازگشت
String
- رنگ تنظیم شده برای حداقل مقدار این شرایط گرادیان یا یک رشته خالی.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-08-05 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-08-05 بهوقت ساعت هماهنگ جهانی."],[[["\u003cp\u003eGradient conditions in Google Sheets allow you to apply color scales to cells based on their values, interpolating colors between minimum, midpoint, and maximum points.\u003c/p\u003e\n"],["\u003cp\u003eEach gradient condition is defined by three points (min, mid, max), each having a color, value, and interpolation type.\u003c/p\u003e\n"],["\u003cp\u003eYou can access and manipulate gradient conditions programmatically using Apps Script methods like \u003ccode\u003egetMinColorObject()\u003c/code\u003e, \u003ccode\u003egetMidValue()\u003c/code\u003e, and \u003ccode\u003egetMaxType()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eDeprecated methods like \u003ccode\u003egetMinColor()\u003c/code\u003e, \u003ccode\u003egetMidColor()\u003c/code\u003e, and \u003ccode\u003egetMaxColor()\u003c/code\u003e have been replaced by object-based alternatives for color retrieval.\u003c/p\u003e\n"]]],["Gradient conditions, within conditional format rules, define cell colors based on a number scale with minimum, midpoint, and maximum values. Each point has a color, value, and interpolation type. Methods like `getMinColorObject()`, `getMidType()`, and `getMaxValue()` retrieve these attributes. Cell content is compared to these values to interpolate and apply a corresponding color. Deprecated methods (`getMinColor()`, `getMidColor()`, `getMaxColor()`) are replaced with `get[Point]ColorObject()`.\n"],null,["# Class GradientCondition\n\nGradientCondition\n\nAccess gradient (color) conditions in [ConditionalFormatRuleApis](/apps-script/reference/spreadsheet/conditional-format-rule).\nEach conditional format rule may contain a single gradient condition. A gradient condition is\ndefined by three points along a number scale (min, mid, and max), each of which has a color, a\nvalue, and a [InterpolationType](/apps-script/reference/spreadsheet/interpolation-type). The content of a cell is\ncompared to the values in the number scale and the color applied to the cell is interpolated\nbased on the cell content's proximity to the gradient condition min, mid, and max points.\n\n```javascript\n// Logs all the information inside gradient conditional format rules on a sheet.\n// The below snippet assumes all colors have ColorType.RGB.\nconst sheet = SpreadsheetApp.getActiveSheet();\nconst rules = sheet.getConditionalFormatRules();\nfor (let i = 0; i \u003c rules.length; i++) {\n const gradient = rules[i].getGradientCondition();\n\n const minColor = gradient.getMinColorObject().asRgbColor().asHexString();\n const minType = gradient.getMinType();\n const minValue = gradient.getMinValue();\n const midColor = gradient.getMidColorObject().asRgbColor().asHexString();\n const midType = gradient.getMidType();\n const midValue = gradient.getMidValue();\n const maxColor = gradient.getMaxColorObject().asRgbColor().asHexString();\n const maxType = gradient.getMaxType();\n const maxValue = gradient.getMaxValue();\n\n Logger.log(`The conditional format gradient information for rule ${i}:\n MinColor ${minColor}, MinType ${minType}, MinValue ${minValue},\n MidColor ${midColor}, MidType ${midType}, MidValue ${midValue},\n MaxColor ${maxColor}, MaxType ${maxType}, MaxValue ${maxValue}`);\n}\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------|----------------------------------------------------------------------------|--------------------------------------------------------------------------------|\n| [getMaxColorObject()](#getMaxColorObject()) | [Color](/apps-script/reference/spreadsheet/color) | Gets the color set for the maximum value of this gradient condition. |\n| [getMaxType()](#getMaxType()) | [InterpolationType](/apps-script/reference/spreadsheet/interpolation-type) | Gets the interpolation type for the maximum value of this gradient condition. |\n| [getMaxValue()](#getMaxValue()) | `String` | Gets the max value of this gradient condition. |\n| [getMidColorObject()](#getMidColorObject()) | [Color](/apps-script/reference/spreadsheet/color) | Gets the color set for the midpoint value of this gradient condition. |\n| [getMidType()](#getMidType()) | [InterpolationType](/apps-script/reference/spreadsheet/interpolation-type) | Gets the interpolation type for the midpoint value of this gradient condition. |\n| [getMidValue()](#getMidValue()) | `String` | Gets the midpoint value of this gradient condition. |\n| [getMinColorObject()](#getMinColorObject()) | [Color](/apps-script/reference/spreadsheet/color) | Gets the color set for the minimum value of this gradient condition. |\n| [getMinType()](#getMinType()) | [InterpolationType](/apps-script/reference/spreadsheet/interpolation-type) | Gets the interpolation type for the minimum value of this gradient condition. |\n| [getMinValue()](#getMinValue()) | `String` | Gets the minimum value of this gradient condition. |\n\n### Deprecated methods\n\n| Method | Return type | Brief description |\n|---------------------------------|-------------|-----------------------------------------------------------------------|\n| [getMaxColor()](#getMaxColor()) | `String` | Gets the color set for the maximum value of this gradient condition. |\n| [getMidColor()](#getMidColor()) | `String` | Gets the color set for the midpoint value of this gradient condition. |\n| [getMinColor()](#getMinColor()) | `String` | Gets the color set for the minimum value of this gradient condition. |\n\nDetailed documentation\n----------------------\n\n### `get``Max``Color``Object()`\n\nGets the color set for the maximum value of this gradient condition. Returns `null` if\nthe color hasn't been set.\n\n#### Return\n\n\n[Color](/apps-script/reference/spreadsheet/color) --- The color set for the maximum value of this gradient condition or `null`.\n\n*** ** * ** ***\n\n### `get``Max``Type()`\n\nGets the interpolation type for the maximum value of this gradient condition. Returns `null` if the gradient max type hasn't been set.\n\n#### Return\n\n\n[InterpolationType](/apps-script/reference/spreadsheet/interpolation-type) --- The interpolation type for the maximum value of this gradient condition or `null`.\n\n*** ** * ** ***\n\n### `get``Max``Value()`\n\nGets the max value of this gradient condition. Returns an empty string if the [InterpolationType](/apps-script/reference/spreadsheet/interpolation-type) is `MAX` or if the max value hasn't been\nset.\n\n#### Return\n\n\n`String` --- The maximum value if specified or an empty string.\n\n*** ** * ** ***\n\n### `get``Mid``Color``Object()`\n\nGets the color set for the midpoint value of this gradient condition. Returns `null` if\nthe color hasn't been set.\n\n#### Return\n\n\n[Color](/apps-script/reference/spreadsheet/color) --- The color set for the midpoint value of this gradient condition or `null`.\n\n*** ** * ** ***\n\n### `get``Mid``Type()`\n\nGets the interpolation type for the midpoint value of this gradient condition. Returns `null` if the gradient mid type hasn't been set.\n\n#### Return\n\n\n[InterpolationType](/apps-script/reference/spreadsheet/interpolation-type) --- The interpolation type for the midpoint value of this gradient condition or `null`.\n\n*** ** * ** ***\n\n### `get``Mid``Value()`\n\nGets the midpoint value of this gradient condition. Returns an empty string if the gradient mid\nvalue hasn't been set.\n\n#### Return\n\n\n`String` --- The midpoint value or an empty string.\n\n*** ** * ** ***\n\n### `get``Min``Color``Object()`\n\nGets the color set for the minimum value of this gradient condition. Returns `null` if\nthe color hasn't been set.\n\n#### Return\n\n\n[Color](/apps-script/reference/spreadsheet/color) --- The color set for the minimum value of this gradient condition or `null`.\n\n*** ** * ** ***\n\n### `get``Min``Type()`\n\nGets the interpolation type for the minimum value of this gradient condition. Returns `null` if the gradient min type hasn't been set.\n\n#### Return\n\n\n[InterpolationType](/apps-script/reference/spreadsheet/interpolation-type) --- The interpolation type for the minimum value of this gradient condition or `null`.\n\n*** ** * ** ***\n\n### `get``Min``Value()`\n\nGets the minimum value of this gradient condition. Returns an empty string if the [InterpolationType](/apps-script/reference/spreadsheet/interpolation-type) is `MIN` or if the min value hasn't been\nset.\n\n#### Return\n\n\n`String` --- The minimum value if specified or an empty string.\n\nDeprecated methods\n------------------\n\n### `get``Max``Color()`\n\n\n**Deprecated.** Replaced by [getMaxColorObject()](#getMaxColorObject())\n\nGets the color set for the maximum value of this gradient condition. Returns an empty string if\nthe color hasn't been set.\n\n#### Return\n\n\n`String` --- The color set for the maximum value of this gradient condition or an empty string.\n\n*** ** * ** ***\n\n### `get``Mid``Color()`\n\n\n**Deprecated.** Replaced by [getMidColorObject()](#getMidColorObject())\n\nGets the color set for the midpoint value of this gradient condition. Returns an empty string\nif the color hasn't been set.\n\n#### Return\n\n\n`String` --- The color set for the midpoint value of this gradient condition or an empty string.\n\n*** ** * ** ***\n\n### `get``Min``Color()`\n\n\n**Deprecated.** Replaced by [getMinColorObject()](#getMinColorObject())\n\nGets the color set for the minimum value of this gradient condition. Returns an empty string if\nthe color hasn't been set.\n\n#### Return\n\n\n`String` --- The color set for the minimum value of this gradient condition or an empty string."]]