--- schema_version: "1" id: 46368052e370f8f4909a849ac004416f499c3eecfb6879f5a5ef097c868299a2 title: ReportCsf Class collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_class_reports_ReportCsf.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm source_site: developer.salesforce.com content_type: documentation content_hash: e17fadcc55093f31ee4f0ad86d78ad7e15174548b4d38100404b3dbd8ba71760 description: Contains methods and constructors for working with information about a custom summary formula (CSF).Creates an instance of the Reports.ReportCsf class using the specified parameters.Creates an instance of the Reports.ReportCsf class. You can then set values by using the class’s set methods.Returns the name of a column grouping when the acrossGroupType is CUSTOM. Otherwise, returns null.Returns where to display the aggregate.Returns the number of decimal places that numbers in the custom summary formula have.Returns the user-facing description of a custom summary formula.Returns the name of a row grouping when the downGroupType is CUSTOM. Otherwise, returns null.Returns where to display the aggregate of the custom summary formula.Returns the operations performed on values in the custom summary formula.Returns the formula type.Returns the user-facing name of the custom summary formula.Specifies the column for the across grouping.Sets where to display the aggregate.Sets where to display the aggregate.Sets the number of decimal places in numbers.Sets the user-facing description of the custom summary formula.Sets the name of a row grouping when the downGroupType is CUSTOM.Sets where to display the aggregate.Sets where to display the aggregate.Sets the operations to perform on values in the custom summary formula.Sets the format of the numbers in the custom summary formula.Sets the format of numbers used in the custom summary formula.Sets the user-facing name of the custom summary formula.Returns a string. --- # ReportCsf Class Contains methods and constructors for working with information about a custom summary formula (CSF). ## Namespace [Reports](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_namespace_Reports.htm "The Reports namespace provides classes for accessing the same data as is available in the Salesforce Reports and Dashboards REST API.") - **[ReportCsf Constructors](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_constructors)** - **[ReportCsf Methods](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_methods)** ## ReportCsf Constructors The following are constructors for ReportCsf. - **[ReportCsf(label, description, formulaType, decimalPlaces, downGroup, downGroupType, acrossGroup, acrossGroupType, formula)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_ctor)** Creates an instance of the Reports.ReportCsf class using the specified parameters. - **[ReportCsf()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_ctor_2)** Creates an instance of the Reports.ReportCsf class. You can then set values by using the class’s set methods. ### ReportCsf(label, description, formulaType, decimalPlaces, downGroup, downGroupType, acrossGroup, acrossGroupType, formula) Creates an instance of the Reports.ReportCsf class using the specified parameters. #### Signature public ReportCsf(String label, String description, Reports.FormulaType formulaType, Integer decimalPlaces, String downGroup, Reports.CsfGroupType downGroupType, String acrossGroup, Reports.CsfGroupType acrossGroupType, String formula) #### Parameters - **label**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") The user-facing name of the custom summary formula. - **description**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") The user-facing description of the custom summary formula. - **formulaType**: Type: [Reports.FormulaType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_FormulaType.htm#apex_enum_reports_FormulaType "The format of the numbers in a custom summary formula.") The format of the numbers in the custom summary formula. - **decimalPlaces**: Type: [Integer](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_integer.htm#apex_methods_system_integer "Contains methods for the Integer primitive data type.") The number of decimal places to include in numbers. - **downGroup**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") The name of a row grouping when the downGroupType is CUSTOM; null otherwise. - **downGroupType**: Type: [Reports.CsfGroupType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_CsfGroupType.htm#apex_enum_reports_CsfGroupType "The group level at which the custom summary format aggregate is displayed in a report.") Where to display the aggregate of the custom summary formula. - **acrossGroup**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") The name of a column grouping when the accrossGroupType is CUSTOM; null otherwise. - **acrossGroupType**: Type: [Reports.CsfGroupType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_CsfGroupType.htm#apex_enum_reports_CsfGroupType "The group level at which the custom summary format aggregate is displayed in a report.") Where to display the aggregate of the custom summary formula. - **formula**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") The operations performed on values in the custom summary formula. ### ReportCsf() Creates an instance of the Reports.ReportCsf class. You can then set values by using the class’s set methods. #### Signature public ReportCsf() ## ReportCsf Methods The following are methods for ReportCsf. - **[getAcrossGroup()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_getAcrossGroup)** Returns the name of a column grouping when the acrossGroupType is CUSTOM. Otherwise, returns null. - **[getAcrossGroupType()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_getAcrossGroupType)** Returns where to display the aggregate. - **[getDecimalPlaces()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_getDecimalPlaces)** Returns the number of decimal places that numbers in the custom summary formula have. - **[getDescription()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_getDescription)** Returns the user-facing description of a custom summary formula. - **[getDownGroup()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_getDownGroup)** Returns the name of a row grouping when the downGroupType is CUSTOM. Otherwise, returns null. - **[getDownGroupType()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_getDownGroupType)** Returns where to display the aggregate of the custom summary formula. - **[getFormula()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_getFormula)** Returns the operations performed on values in the custom summary formula. - **[getFormulaType()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_getFormulaType)** Returns the formula type. - **[getLabel()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_getLabel)** Returns the user-facing name of the custom summary formula. - **[setAcrossGroup(acrossGroup)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_setAcrossGroup)** Specifies the column for the across grouping. - **[setAcrossGroupType(value)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_setAcrossGroupType)** Sets where to display the aggregate. - **[setAcrossGroupType(acrossGroupType)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_setAcrossGroupType_2)** Sets where to display the aggregate. - **[setDecimalPlaces(decimalPlaces)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_setDecimalPlaces)** Sets the number of decimal places in numbers. - **[setDescription(description)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_setDescription)** Sets the user-facing description of the custom summary formula. - **[setDownGroup(downGroup)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_setDownGroup)** Sets the name of a row grouping when the downGroupType is CUSTOM. - **[setDownGroupType(value)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_setDownGroupType)** Sets where to display the aggregate. - **[setDownGroupType(downGroupType)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_setDownGroupType_2)** Sets where to display the aggregate. - **[setFormula(formula)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_setFormula)** Sets the operations to perform on values in the custom summary formula. - **[setFormulaType(value)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_setFormulaType)** Sets the format of the numbers in the custom summary formula. - **[setFormulaType(formulaType)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_setFormulaType_2)** Sets the format of numbers used in the custom summary formula. - **[setLabel(label)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_setLabel)** Sets the user-facing name of the custom summary formula. - **[toString()](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_class_reports_ReportCsf.htm#apex_reports_ReportCsf_toString)** Returns a string. ### getAcrossGroup() Returns the name of a column grouping when the acrossGroupType is CUSTOM. Otherwise, returns null. #### Signature public String getAcrossGroup() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### getAcrossGroupType() Returns where to display the aggregate. #### Signature public Reports.CsfGroupType getAcrossGroupType() #### Return Value Type: [Reports.CsfGroupType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_CsfGroupType.htm#apex_enum_reports_CsfGroupType "The group level at which the custom summary format aggregate is displayed in a report.") ### getDecimalPlaces() Returns the number of decimal places that numbers in the custom summary formula have. #### Signature public Integer getDecimalPlaces() #### Return Value Type: [Integer](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_integer.htm#apex_methods_system_integer "Contains methods for the Integer primitive data type.") ### getDescription() Returns the user-facing description of a custom summary formula. #### Signature public String getDescription() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### getDownGroup() Returns the name of a row grouping when the downGroupType is CUSTOM. Otherwise, returns null. #### Signature public String getDownGroup() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### getDownGroupType() Returns where to display the aggregate of the custom summary formula. #### Signature public Reports.CsfGroupType getDownGroupType() #### Return Value Type: [Reports.CsfGroupType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_CsfGroupType.htm#apex_enum_reports_CsfGroupType "The group level at which the custom summary format aggregate is displayed in a report.") ### getFormula() Returns the operations performed on values in the custom summary formula. #### Signature public String getFormula() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### getFormulaType() Returns the formula type. #### Signature public Reports.FormulaType getFormulaType() #### Return Value Type: [Reports.FormulaType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_FormulaType.htm#apex_enum_reports_FormulaType "The format of the numbers in a custom summary formula.") ### getLabel() Returns the user-facing name of the custom summary formula. #### Signature public String getLabel() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") ### setAcrossGroup(acrossGroup) Specifies the column for the across grouping. #### Signature public void setAcrossGroup(String acrossGroup) #### Parameters - **acrossGroup**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: void ### setAcrossGroupType(value) Sets where to display the aggregate. #### Signature public void setAcrossGroupType(String value) #### Parameters - **value**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") For possible values, see [Reports.CsfGroupType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_CsfGroupType.htm#apex_enum_reports_CsfGroupType "The group level at which the custom summary format aggregate is displayed in a report."). #### Return Value Type: void ### setAcrossGroupType(acrossGroupType) Sets where to display the aggregate. #### Signature public void setAcrossGroupType(Reports.CsfGroupType acrossGroupType) #### Parameters - **acrossGroupType**: Type: [Reports.CsfGroupType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_CsfGroupType.htm#apex_enum_reports_CsfGroupType "The group level at which the custom summary format aggregate is displayed in a report.") #### Return Value Type: void ### setDecimalPlaces(decimalPlaces) Sets the number of decimal places in numbers. #### Signature public void setDecimalPlaces(Integer decimalPlaces) #### Parameters - **decimalPlaces**: Type: [Integer](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_integer.htm#apex_methods_system_integer "Contains methods for the Integer primitive data type.") #### Return Value Type: void ### setDescription(description) Sets the user-facing description of the custom summary formula. #### Signature public void setDescription(String description) #### Parameters - **description**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: void ### setDownGroup(downGroup) Sets the name of a row grouping when the downGroupType is CUSTOM. #### Signature public void setDownGroup(String downGroup) #### Parameters - **downGroup**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: void ### setDownGroupType(value) Sets where to display the aggregate. #### Signature public void setDownGroupType(String value) #### Parameters - **value**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") For valid values, see [Reports.CsfGroupType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_CsfGroupType.htm#apex_enum_reports_CsfGroupType "The group level at which the custom summary format aggregate is displayed in a report."). #### Return Value Type: void ### setDownGroupType(downGroupType) Sets where to display the aggregate. #### Signature public void setDownGroupType(Reports.CsfGroupType downGroupType) #### Parameters - **downGroupType**: Type: [Reports.CsfGroupType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_CsfGroupType.htm#apex_enum_reports_CsfGroupType "The group level at which the custom summary format aggregate is displayed in a report.") #### Return Value Type: void ### setFormula(formula) Sets the operations to perform on values in the custom summary formula. #### Signature public void setFormula(String formula) #### Parameters - **formula**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: void ### setFormulaType(value) Sets the format of the numbers in the custom summary formula. #### Signature public void setFormulaType(String value) #### Parameters - **value**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") For valid values, see [Reports.FormulaType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_FormulaType.htm#apex_enum_reports_FormulaType "The format of the numbers in a custom summary formula."). #### Return Value Type: void ### setFormulaType(formulaType) Sets the format of numbers used in the custom summary formula. #### Signature public void setFormulaType(Reports.FormulaType formulaType) #### Parameters - **formulaType**: Type: [Reports.FormulaType](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_enum_reports_FormulaType.htm#apex_enum_reports_FormulaType "The format of the numbers in a custom summary formula.") #### Return Value Type: void ### setLabel(label) Sets the user-facing name of the custom summary formula. #### Signature public void setLabel(String label) #### Parameters - **label**: Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.") #### Return Value Type: void ### toString() Returns a string. #### Signature public String toString() #### Return Value Type: [String](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_string.htm#apex_methods_system_string "Contains methods for the String primitive data type.")