p30928647
/
excelize
1
0
Fork 1
Code Issues Pull Requests Projects Releases 23 Wiki Activity

Support set time period type conditional formatting (#1718)

This commit is contained in:
Yang Li 2023-11-14 09:47:57 +08:00 committed by GitHub
parent 2499bf6b5b
commit 5e247de805
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 86 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

120
styles.go
View File

@ -26,15 +26,13 @@ import (
// validType defined the list of valid validation types. // validType defined the list of valid validation types.
var validType = map[string]string{ var validType = map[string]string{
"cell": "cellIs", "cell": "cellIs",
"date": "date", // Doesn't support currently
"time": "time", // Doesn't support currently
"average": "aboveAverage", "average": "aboveAverage",
"duplicate": "duplicateValues", "duplicate": "duplicateValues",
"unique": "uniqueValues", "unique": "uniqueValues",
"top": "top10", "top": "top10",
"bottom": "top10", "bottom": "top10",
"text": "text", "text": "text",
"time_period": "timePeriod", // Doesn't support currently "time_period": "timePeriod",
"blanks": "containsBlanks", "blanks": "containsBlanks",
"no_blanks": "notContainsBlanks", "no_blanks": "notContainsBlanks",
"errors": "containsErrors", "errors": "containsErrors",
@ -48,60 +46,62 @@ var validType = map[string]string{
// criteriaType defined the list of valid criteria types. // criteriaType defined the list of valid criteria types.
var criteriaType = map[string]string{ var criteriaType = map[string]string{
"between": "between", "!=": "notEqual",
"not between": "notBetween", "<": "lessThan",
"equal to": "equal", "<=": "lessThanOrEqual",
"<>": "notEqual",
"=": "equal", "=": "equal",
"==": "equal", "==": "equal",
"not equal to": "notEqual",
"!=": "notEqual",
"<>": "notEqual",
"greater than": "greaterThan",
">": "greaterThan", ">": "greaterThan",
"less than": "lessThan",
"<": "lessThan",
"greater than or equal to": "greaterThanOrEqual",
">=": "greaterThanOrEqual", ">=": "greaterThanOrEqual",
"less than or equal to": "lessThanOrEqual",
"<=": "lessThanOrEqual",
"containing": "containsText",
"not containing": "notContains",
"begins with": "beginsWith", "begins with": "beginsWith",
"between": "between",
"containing": "containsText",
"continue month": "nextMonth",
"continue week": "nextWeek",
"ends with": "endsWith", "ends with": "endsWith",
"yesterday": "yesterday", "equal to": "equal",
"today": "today", "greater than or equal to": "greaterThanOrEqual",
"greater than": "greaterThan",
"last 7 days": "last7Days", "last 7 days": "last7Days",
"last week": "lastWeek",
"this week": "thisWeek",
"continue week": "continueWeek",
"last month": "lastMonth", "last month": "lastMonth",
"last week": "lastWeek",
"less than or equal to": "lessThanOrEqual",
"less than": "lessThan",
"not between": "notBetween",
"not containing": "notContains",
"not equal to": "notEqual",
"this month": "thisMonth", "this month": "thisMonth",
"continue month": "continueMonth", "this week": "thisWeek",
"today": "today",
"tomorrow": "tomorrow",
"yesterday": "yesterday",
} }
// operatorType defined the list of valid operator types. // operatorType defined the list of valid operator types.
var operatorType = map[string]string{ var operatorType = map[string]string{
"lastMonth": "last month",
"between": "between",
"notEqual": "not equal to",
"greaterThan": "greater than",
"lessThanOrEqual": "less than or equal to",
"today": "today",
"equal": "equal to",
"notContains": "not containing",
"thisWeek": "this week",
"endsWith": "ends with",
"yesterday": "yesterday",
"lessThan": "less than",
"beginsWith": "begins with", "beginsWith": "begins with",
"last7Days": "last 7 days", "between": "between",
"thisMonth": "this month",
"containsText": "containing", "containsText": "containing",
"lastWeek": "last week", "endsWith": "ends with",
"continueWeek": "continue week", "equal": "equal to",
"continueMonth": "continue month", "greaterThan": "greater than",
"notBetween": "not between",
"greaterThanOrEqual": "greater than or equal to", "greaterThanOrEqual": "greater than or equal to",
"last7Days": "last 7 days",
"lastMonth": "last month",
"lastWeek": "last week",
"lessThan": "less than",
"lessThanOrEqual": "less than or equal to",
"nextMonth": "continue month",
"nextWeek": "continue week",
"notBetween": "not between",
"notContains": "not containing",
"notEqual": "not equal to",
"thisMonth": "this month",
"thisWeek": "this week",
"today": "today",
"tomorrow": "tomorrow",
"yesterday": "yesterday",
} }
// stylesReader provides a function to get the pointer to the structure after // stylesReader provides a function to get the pointer to the structure after
@ -1225,6 +1225,7 @@ var (
// drawContFmtFunc defines functions to create conditional formats. // drawContFmtFunc defines functions to create conditional formats.
drawContFmtFunc = map[string]func(p int, ct, ref, GUID string, fmtCond *ConditionalFormatOptions) (*xlsxCfRule, *xlsxX14CfRule){ drawContFmtFunc = map[string]func(p int, ct, ref, GUID string, fmtCond *ConditionalFormatOptions) (*xlsxCfRule, *xlsxX14CfRule){
"cellIs": drawCondFmtCellIs, "cellIs": drawCondFmtCellIs,
"timePeriod": drawCondFmtTimePeriod,
"text": drawCondFmtText, "text": drawCondFmtText,
"top10": drawCondFmtTop10, "top10": drawCondFmtTop10,
"aboveAverage": drawCondFmtAboveAverage, "aboveAverage": drawCondFmtAboveAverage,
@ -1243,6 +1244,7 @@ var (
// extractContFmtFunc defines functions to get conditional formats. // extractContFmtFunc defines functions to get conditional formats.
extractContFmtFunc = map[string]func(c *xlsxCfRule, extLst *xlsxExtLst) ConditionalFormatOptions{ extractContFmtFunc = map[string]func(c *xlsxCfRule, extLst *xlsxExtLst) ConditionalFormatOptions{
"cellIs": extractCondFmtCellIs, "cellIs": extractCondFmtCellIs,
"timePeriod": extractCondFmtTimePeriod,
"containsText": extractCondFmtText, "containsText": extractCondFmtText,
"notContainsText": extractCondFmtText, "notContainsText": extractCondFmtText,
"beginsWith": extractCondFmtText, "beginsWith": extractCondFmtText,
@ -2241,10 +2243,6 @@ func (f *File) SetCellStyle(sheet, hCell, vCell string, styleID int) error {
// | Value // | Value
// | MinValue // | MinValue
// | MaxValue // | MaxValue
// date | Criteria
// | Value
// | MinValue
// | MaxValue
// time_period | Criteria // time_period | Criteria
// text | Criteria // text | Criteria
// | Value // | Value
@ -2772,6 +2770,12 @@ func extractCondFmtCellIs(c *xlsxCfRule, extLst *xlsxExtLst) ConditionalFormatOp
return format return format
} }
// extractCondFmtTimePeriod provides a function to extract conditional format
// settings for time period by given conditional formatting rule.
func extractCondFmtTimePeriod(c *xlsxCfRule, extLst *xlsxExtLst) ConditionalFormatOptions {
return ConditionalFormatOptions{StopIfTrue: c.StopIfTrue, Type: "time_period", Criteria: operatorType[c.Operator], Format: *c.DxfID}
}
// extractCondFmtText provides a function to extract conditional format // extractCondFmtText provides a function to extract conditional format
// settings for text cell values by given conditional formatting rule. // settings for text cell values by given conditional formatting rule.
func extractCondFmtText(c *xlsxCfRule, extLst *xlsxExtLst) ConditionalFormatOptions { func extractCondFmtText(c *xlsxCfRule, extLst *xlsxExtLst) ConditionalFormatOptions {
@ -3034,6 +3038,32 @@ func drawCondFmtCellIs(p int, ct, ref, GUID string, format *ConditionalFormatOpt
return c, nil return c, nil
} }
// drawCondFmtTimePeriod provides a function to create conditional formatting
// rule for time period by given priority, criteria type and format settings.
func drawCondFmtTimePeriod(p int, ct, ref, GUID string, format *ConditionalFormatOptions) (*xlsxCfRule, *xlsxX14CfRule) {
return &xlsxCfRule{
Priority: p + 1,
StopIfTrue: format.StopIfTrue,
Type: "timePeriod",
Operator: ct,
Formula: []string{
map[string]string{
"yesterday": fmt.Sprintf("FLOOR(%s,1)=TODAY()-1", ref),
"today": fmt.Sprintf("FLOOR(%s,1)=TODAY()", ref),
"tomorrow": fmt.Sprintf("FLOOR(%s,1)=TODAY()+1", ref),
"last 7 days": fmt.Sprintf("AND(TODAY()-FLOOR(%[1]s,1)<=6,FLOOR(%[1]s,1)<=TODAY())", ref),
"last week": fmt.Sprintf("AND(TODAY()-ROUNDDOWN(%[1]s,0)>=(WEEKDAY(TODAY())),TODAY()-ROUNDDOWN(%[1]s,0)<(WEEKDAY(TODAY())+7))", ref),
"this week": fmt.Sprintf("AND(TODAY()-ROUNDDOWN(%[1]s,0)<=WEEKDAY(TODAY())-1,ROUNDDOWN(%[1]s,0)-TODAY()>=7-WEEKDAY(TODAY()))", ref),
"continue week": fmt.Sprintf("AND(ROUNDDOWN(%[1]s,0)-TODAY()>(7-WEEKDAY(TODAY())),ROUNDDOWN(%[1]s,0)-TODAY()<(15-WEEKDAY(TODAY())))", ref),
"last month": fmt.Sprintf("AND(MONTH(%[1]s)=MONTH(TODAY())-1,OR(YEAR(%[1]s)=YEAR(TODAY()),AND(MONTH(%[1]s)=1,YEAR(%[1]s)=YEAR(TODAY())-1)))", ref),
"this month": fmt.Sprintf("AND(MONTH(%[1]s)=MONTH(TODAY()),YEAR(%[1]s)=YEAR(TODAY()))", ref),
"continue month": fmt.Sprintf("AND(MONTH(%[1]s)=MONTH(TODAY())+1,OR(YEAR(%[1]s)=YEAR(TODAY()),AND(MONTH(%[1]s)=12,YEAR(%[1]s)=YEAR(TODAY())+1)))", ref),
}[ct],
},
DxfID: intPtr(format.Format),
}, nil
}
// drawCondFmtText provides a function to create conditional formatting rule for // drawCondFmtText provides a function to create conditional formatting rule for
// text cell values by given priority, criteria type and format settings. // text cell values by given priority, criteria type and format settings.
func drawCondFmtText(p int, ct, ref, GUID string, format *ConditionalFormatOptions) (*xlsxCfRule, *xlsxX14CfRule) { func drawCondFmtText(p int, ct, ref, GUID string, format *ConditionalFormatOptions) (*xlsxCfRule, *xlsxX14CfRule) {

18
styles_test.go
View File

@ -192,19 +192,23 @@ func TestSetConditionalFormat(t *testing.T) {
// Test creating a conditional format with invalid icon set style // Test creating a conditional format with invalid icon set style
assert.Equal(t, ErrParameterInvalid, f.SetConditionalFormat("Sheet1", "A1:A2", []ConditionalFormatOptions{{Type: "icon_set", IconStyle: "unknown"}})) assert.Equal(t, ErrParameterInvalid, f.SetConditionalFormat("Sheet1", "A1:A2", []ConditionalFormatOptions{{Type: "icon_set", IconStyle: "unknown"}}))
// Test unsupported conditional formatting rule types // Test unsupported conditional formatting rule types
for _, val := range []string{ assert.Equal(t, ErrParameterInvalid, f.SetConditionalFormat("Sheet1", "A1", []ConditionalFormatOptions{{Type: "unsupported"}}))
"date",
"time",
"time_period",
} {
assert.Equal(t, ErrParameterInvalid, f.SetConditionalFormat("Sheet1", "A1", []ConditionalFormatOptions{{Type: val}}))
}
} }
func TestGetConditionalFormats(t *testing.T) { func TestGetConditionalFormats(t *testing.T) {
for _, format := range [][]ConditionalFormatOptions{ for _, format := range [][]ConditionalFormatOptions{
{{Type: "cell", Format: 1, Criteria: "greater than", Value: "6"}}, {{Type: "cell", Format: 1, Criteria: "greater than", Value: "6"}},
{{Type: "cell", Format: 1, Criteria: "between", MinValue: "6", MaxValue: "8"}}, {{Type: "cell", Format: 1, Criteria: "between", MinValue: "6", MaxValue: "8"}},
{{Type: "time_period", Format: 1, Criteria: "yesterday"}},
{{Type: "time_period", Format: 1, Criteria: "today"}},
{{Type: "time_period", Format: 1, Criteria: "tomorrow"}},
{{Type: "time_period", Format: 1, Criteria: "last 7 days"}},
{{Type: "time_period", Format: 1, Criteria: "last week"}},
{{Type: "time_period", Format: 1, Criteria: "this week"}},
{{Type: "time_period", Format: 1, Criteria: "continue week"}},
{{Type: "time_period", Format: 1, Criteria: "last month"}},
{{Type: "time_period", Format: 1, Criteria: "this month"}},
{{Type: "time_period", Format: 1, Criteria: "continue month"}},
{{Type: "text", Format: 1, Criteria: "containing", Value: "~!@#$%^&*()_+{}|:<>?\"';"}}, {{Type: "text", Format: 1, Criteria: "containing", Value: "~!@#$%^&*()_+{}|:<>?\"';"}},
{{Type: "text", Format: 1, Criteria: "not containing", Value: "text"}}, {{Type: "text", Format: 1, Criteria: "not containing", Value: "text"}},
{{Type: "text", Format: 1, Criteria: "begins with", Value: "prefix"}}, {{Type: "text", Format: 1, Criteria: "begins with", Value: "prefix"}},