[]
DEMOS DOC DESIGNER API
DOWNLOAD
(Showing Draft Content)

GC.Spread.Report

Namespace: Report

GC.Spread.Report

Table of contents

Classes

Interfaces

Type aliases

Type aliases

Binding

Ƭ Binding: string

CellAddress

Ƭ CellAddress: string

Change

Ƭ Change: Object

property {GC.Spread.Report.IRecord[]} records - The updated and inserted records.

property {GC.Spread.Report.IRecord[]} deleteRecords - The deleted records.

property rule - The report sheet dataEntry write back rule.

Type declaration

Name Type Description
deleteRecords IRecord[] The deleted records.
records IRecord[] The updated and inserted records.
rule IWriteBackRule The report sheet dataEntry write back rule.

ChartCell

Ƭ ChartCell: Object

Type declaration

Name Type
chartPreviewVisible? boolean
dataChartName string
type "Chart"

ConditionRule

Ƭ ConditionRule: { column: string ; operator: ConditionRuleOperator } & IConditionRuleValueType | IConditionRuleCellType | IConditionRuleDataColumnType | IConditionRuleParameterType | IConditionRuleFormulaType

ConditionRuleOperator

Ƭ ConditionRuleOperator: "Equal" | "NotEqual" | "GreaterThanOrEqual" | "GreaterThan" | "LessThanOrEqual" | "LessThan" | "StartWith" | "NotStartWith" | "EndWith" | "NotEndWith" | "Contains" | "NotContains" | "In" | "NotIn"

DataEntrySetting

Ƭ DataEntrySetting: IWriteBackRule[]

DataType

Ƭ DataType: number | string | Date | boolean

FieldState

Ƭ FieldState: "normal" | "new" | "updated" | "deleted"

FilterCondition

Ƭ FilterCondition: ConditionRule | FilterConditionFormulaRule | IFilterConditionAndRelationType | IFilterConditionOrRelationType

FilterConditionFormulaRule

Ƭ FilterConditionFormulaRule: Object

Type declaration

Name Type
formula string

Formula

Ƭ Formula: string

GroupCell

Ƭ GroupCell: IDataCellBase & { bins?: IGroupBin[] ; fixedFillCount?: number ; formula?: Formula ; type: "Group" }

InitParametersUIFunctionType

Ƭ InitParametersUIFunctionType: (sheet: Worksheet) => void

Type declaration

▸ (sheet): void

description The callback when parameterUI sheet is rendering.

Parameters
Name Type Description
sheet Worksheet The init parametersUI sheet, users can update the parameterUI sheet here.
Returns

void

LayoutSetting

Ƭ LayoutSetting: IRowLayoutSetting | IColumnLayoutSetting

ListCell

Ƭ ListCell: IDataCellBase & { fixedFillCount?: number ; spillMode?: "Insert" | "Overwrite" ; type: "List" }

OnChangeFunctionType

Ƭ OnChangeFunctionType: (sheet: ReportSheet, changedArgs: IParameterChangedArgs) => void

Type declaration

▸ (sheet, changedArgs): void

description The callback when the parameterUI value changed.

Parameters
Name Type Description
sheet ReportSheet The parametersUI bound reportSheet.
changedArgs IParameterChangedArgs The changed parameter values.
Returns

void

PaginationOrder

Ƭ PaginationOrder: "DownThenOver" | "OverThenDown"

RenderMode

Ƭ RenderMode: "Design" | "PaginatedPreview" | "Preview"

SheetNameGenerator

Ƭ SheetNameGenerator: (pageIndex: number) => string

Type declaration

▸ (pageIndex): string

Parameters
Name Type
pageIndex number
Returns

string

SortOption

Ƭ SortOption: { asc: string } | { desc: string } & { list?: string[] }

SpillDirection

Ƭ SpillDirection: "Horizontal" | "Vertical" | "None"

StaticCell

Ƭ StaticCell: Object

Type declaration

Name Type
autoExpand? "Both" | "Horizontal" | "Vertical" | "None"
initialExpansionState? "Expanded" | "Collapsed"
pin? "None" | "Row" | "Column" | "Both"
preserveFormulaInExport? boolean
showCollapseButton? boolean
type "Static"

SummaryAggregate

Ƭ SummaryAggregate: "Sum" | "Avg" | "Max" | "Min" | "Count"

SummaryCell

Ƭ SummaryCell: IDataCellBase & { aggregate: SummaryAggregate ; type: "Summary" }

TemplateCell

Ƭ TemplateCell: ListCell | GroupCell | SummaryCell | StaticCell | ChartCell & ITemplateCellCommonSetting