ArcGIS Pro 3.8 API Reference Guide
ArcGIS.Core.CIM Namespace / CIMBACalculatedVariableDocument Class
Properties Methods Events


In This Topic
    CIMBACalculatedVariableDocument Class Members
    In This Topic

    The following tables list the members exposed by CIMBACalculatedVariableDocument.

    Public Constructors
    Public Properties
     NameDescription
    Public Property Gets or sets the alias of the variable.  
    Public Property Gets or sets the average base of the variable.  
    Public Property Gets or sets the build an item was created with. Set by the system. (Inherited from ArcGIS.Core.CIM.CIMVersion)
    Public Property Gets or sets a value indicating whether to use the Card View mode.  
    Public Property Gets or sets the category of the variable.  
    Public Property Gets or sets the data source used in calculation of distances. Structure of the value is TYPE;COUNTRY_INFO;LOCAL_DATA_INFO where TYPE can be ONLINE, LOCAL, or CUSTOM. COUNTRY_INFO is country_id{|hierarchy}. For example, US|census or US. LOCAL_DATA_INFO is ID of local dataset. For example, USA_ESRI_2019. For example, for local US 2019 dataset it will be: "LOCAL;;USA_ESRI_2019". If online US data source is used, it may be "ONLINE;US|census;". Can act as the value of the baDataSource GP environment variable. https://pro.arcgis.com/en/pro-app/tool-reference/environment-settings/ba-data-source.htm.  
    Public Property Gets or sets how to display the values of the custom variable in reports.  
    Public Property Gets or sets a value indicating whether the variable has an index base.  
    Public Property Gets or sets the index base of the variable.  
    Public Property Gets or sets the length of the variable.  
    Public Property Gets or sets the name of the variable.  
    Public Property Gets or sets the output type of the variable.  
    Public Property Gets or sets the percent base of the variable.  
    Public Property Gets or sets the precision of the variable.  
    Public Property Gets or sets the Python script (expression) which should be calculated.  
    Public Property Gets or sets the summary type of the variable.  
    Public Property Gets or sets the variables used in the script expression. For example, if Script is "!RENTER_CY! / !TOTPOP_CY!", UsedVariables contains "RENTER_CY" and "TOTPOP_CY".  
    Public Property Gets or sets the definition of the variable.  
    Public Property Gets or sets document version. Set by the system. (Inherited from ArcGIS.Core.CIM.CIMVersion)
    Top
    Public Methods
     NameDescription
    Public Method Creates a deep copy of CIMBACalculatedVariableDocument.  
    Public Methodstatic (Shared in Visual Basic) Reconstructs the CIMBACalculatedVariableDocument with a specified state from a JSON encoding.  
    Public Method Not implemented, reserved for future use. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Public Method Reads the element inside the reader. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Public MethodOverridden.  Creates a JSON encoding of the CIMBACalculatedVariableDocument and its current state.  
    Public Method Writes the element inside the writer. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Top
    Protected Methods
     NameDescription
    Protected Method Called from a property setter to notify the framework that an Object member has changed. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Protected MethodOverridden.  Reads the child element inside the reader.  
    Protected MethodOverridden.  Writes a child element to the writer.  
    Top
    Public Events
     NameDescription
    Public Event Occurs when a property value changes. (Inherited from ArcGIS.Core.CIM.CIMObject)
    Top
    See Also