# GC.Spread.Sheets.TableSheet.IGroupSummaryFieldOptions

## Content

# Interface: IGroupSummaryFieldOptions

[Sheets](../modules/GC.Spread.Sheets).[TableSheet](../modules/GC.Spread.Sheets.TableSheet).IGroupSummaryFieldOptions

## Hierarchy

- [`IGroupColumnOptions`](GC.Spread.Sheets.TableSheet.IGroupColumnOptions)

  ↳ **`IGroupSummaryFieldOptions`**

## Table of contents

### Properties

- [allowFilterByList](GC.Spread.Sheets.TableSheet.IGroupSummaryFieldOptions#allowfilterbylist)
- [allowFilterByValue](GC.Spread.Sheets.TableSheet.IGroupSummaryFieldOptions#allowfilterbyvalue)
- [allowSort](GC.Spread.Sheets.TableSheet.IGroupSummaryFieldOptions#allowsort)
- [caption](GC.Spread.Sheets.TableSheet.IGroupSummaryFieldOptions#caption)
- [conditionalFormats](GC.Spread.Sheets.TableSheet.IGroupSummaryFieldOptions#conditionalformats)
- [formula](GC.Spread.Sheets.TableSheet.IGroupSummaryFieldOptions#formula)
- [headerFit](GC.Spread.Sheets.TableSheet.IGroupSummaryFieldOptions#headerfit)
- [headerStyle](GC.Spread.Sheets.TableSheet.IGroupSummaryFieldOptions#headerstyle)
- [position](GC.Spread.Sheets.TableSheet.IGroupSummaryFieldOptions#position)
- [relateTo](GC.Spread.Sheets.TableSheet.IGroupSummaryFieldOptions#relateto)
- [slice](GC.Spread.Sheets.TableSheet.IGroupSummaryFieldOptions#slice)
- [style](GC.Spread.Sheets.TableSheet.IGroupSummaryFieldOptions#style)
- [validator](GC.Spread.Sheets.TableSheet.IGroupSummaryFieldOptions#validator)
- [width](GC.Spread.Sheets.TableSheet.IGroupSummaryFieldOptions#width)

## Properties

### <a id="allowfilterbylist" name="allowfilterbylist"></a> allowFilterByList

• `Optional` **allowFilterByList**: `boolean`

Whether show filter by list after opening filer dialog. If allowSort, allowFilterByValue and allowFilterByList are all false, not show the filter button in this column.

#### Inherited from

[IGroupColumnOptions](GC.Spread.Sheets.TableSheet.IGroupColumnOptions).[allowFilterByList](GC.Spread.Sheets.TableSheet.IGroupColumnOptions#allowfilterbylist)

___

### <a id="allowfilterbyvalue" name="allowfilterbyvalue"></a> allowFilterByValue

• `Optional` **allowFilterByValue**: `boolean`

Whether show filter by value after opening filer dialog.

#### Inherited from

[IGroupColumnOptions](GC.Spread.Sheets.TableSheet.IGroupColumnOptions).[allowFilterByValue](GC.Spread.Sheets.TableSheet.IGroupColumnOptions#allowfilterbyvalue)

___

### <a id="allowsort" name="allowsort"></a> allowSort

• `Optional` **allowSort**: `boolean`

Whether show sort after opening filer dialog.

#### Inherited from

[IGroupColumnOptions](GC.Spread.Sheets.TableSheet.IGroupColumnOptions).[allowSort](GC.Spread.Sheets.TableSheet.IGroupColumnOptions#allowsort)

___

### <a id="caption" name="caption"></a> caption

• `Optional` **caption**: `string`

#### Inherited from

[IGroupColumnOptions](GC.Spread.Sheets.TableSheet.IGroupColumnOptions).[caption](GC.Spread.Sheets.TableSheet.IGroupColumnOptions#caption)

___

### <a id="conditionalformats" name="conditionalformats"></a> conditionalFormats

• `Optional` **conditionalFormats**: ([`AverageRuleOptions`](../modules/GC.Data#averageruleoptions) \| [`CellValueRuleOptions`](../modules/GC.Data#cellvalueruleoptions) \| [`DataBarRuleOptions`](../modules/GC.Data#databarruleoptions) \| [`DateOccurringRuleOptions`](../modules/GC.Data#dateoccurringruleoptions) \| [`DuplicateRuleOptions`](../modules/GC.Data#duplicateruleoptions) \| [`FormulaRuleOptions`](../modules/GC.Data#formularuleoptions) \| [`SpecificTextRuleOptions`](../modules/GC.Data#specifictextruleoptions) \| [`Top10RuleOptions`](../modules/GC.Data#top10ruleoptions) \| [`UniqueRuleOptions`](../modules/GC.Data#uniqueruleoptions) \| [`TwoScaleRuleOptions`](../modules/GC.Data#twoscaleruleoptions) \| [`ThreeScaleRuleOptions`](../modules/GC.Data#threescaleruleoptions) \| [`IconSetRuleOptions`](../modules/GC.Data#iconsetruleoptions))[]

#### Inherited from

[IGroupColumnOptions](GC.Spread.Sheets.TableSheet.IGroupColumnOptions).[conditionalFormats](GC.Spread.Sheets.TableSheet.IGroupColumnOptions#conditionalformats)

___

### <a id="formula" name="formula"></a> formula

• **formula**: `string`

___

### <a id="headerfit" name="headerfit"></a> headerFit

• `Optional` **headerFit**: ``"normal"`` \| ``"vertical"`` \| ``"stack"``

the header fit mode, default is normal

#### Inherited from

[IGroupColumnOptions](GC.Spread.Sheets.TableSheet.IGroupColumnOptions).[headerFit](GC.Spread.Sheets.TableSheet.IGroupColumnOptions#headerfit)

___

### <a id="headerstyle" name="headerstyle"></a> headerStyle

• `Optional` **headerStyle**: [`HeaderStyleOptions`](../modules/GC.Data#headerstyleoptions)

the column header style

#### Inherited from

[IGroupColumnOptions](GC.Spread.Sheets.TableSheet.IGroupColumnOptions).[headerStyle](GC.Spread.Sheets.TableSheet.IGroupColumnOptions#headerstyle)

___

### <a id="position" name="position"></a> position

• `Optional` **position**: ``"header"`` \| ``"footer"``

___

### <a id="relateto" name="relateto"></a> relateTo

• `Optional` **relateTo**: `string`

___

### <a id="slice" name="slice"></a> slice

• `Optional` **slice**: `string` \| [`IGroupSummarySliceFieldOptions`](GC.Spread.Sheets.TableSheet.IGroupSummarySliceFieldOptions)

___

### <a id="style" name="style"></a> style

• `Optional` **style**: [`StyleOptions`](../modules/GC.Data#styleoptions)

#### Inherited from

[IGroupColumnOptions](GC.Spread.Sheets.TableSheet.IGroupColumnOptions).[style](GC.Spread.Sheets.TableSheet.IGroupColumnOptions#style)

___

### <a id="validator" name="validator"></a> validator

• `Optional` **validator**: [`DateValidatorOptions`](../modules/GC.Data#datevalidatoroptions) \| [`FormulaListValidatorOptions`](../modules/GC.Data#formulalistvalidatoroptions) \| [`FormulaValidatorOptions`](../modules/GC.Data#formulavalidatoroptions) \| [`NumberValidatorOptions`](../modules/GC.Data#numbervalidatoroptions) \| [`TimeValidatorOptions`](../modules/GC.Data#timevalidatoroptions) \| [`TextLengthValidatorOptions`](../modules/GC.Data#textlengthvalidatoroptions) \| [`ListValidatorOptions`](../modules/GC.Data#listvalidatoroptions)

#### Inherited from

[IGroupColumnOptions](GC.Spread.Sheets.TableSheet.IGroupColumnOptions).[validator](GC.Spread.Sheets.TableSheet.IGroupColumnOptions#validator)

___

### <a id="width" name="width"></a> width

• `Optional` **width**: `number`

#### Inherited from

[IGroupColumnOptions](GC.Spread.Sheets.TableSheet.IGroupColumnOptions).[width](GC.Spread.Sheets.TableSheet.IGroupColumnOptions#width)