Spotfire Analyst API

https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/
Admin
Spotfire Analyst API is the developer API reference for TIBCO Spotfire, enabling programmatic access...
Tokens:2,482,930
Snippets:16,981
Trust Score:9.5
Update:6 months ago
Show doc for...
Tokens:
Raw
### Start Method Syntax

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_Interop_IAnalysisApplicationController_Start.htm

Defines the signature for the Start method, which accepts an object for callback handling.

```C#
void Start(
	Object callback
)
```

--------------------------------

### CustomPreference Remarks and Example

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/T_Spotfire_Dxp_Application_Extension_CustomPreference.htm

Explains the purpose of preferences in Spotfire and provides an example of implementing a custom preference class.

```APIDOC
## CustomPreference Remarks and Example

### Remarks
Preferences are used by add-ins to persist one or more values, for example last used settings, user preferred values, etc. An object of this type can contain one or more such values, referred to as Preference Properties. Thus to create a set of preference properties, extend this class and populate that class with the properties that shall be persisted.

When a user is logged on, the preference is populated with its persisted values, if such exist. If not, the preference is given default values while waiting for the user to set its values. When preferences are saved, their values are persisted using .Net serialization on the client and on the server depending on the settings of the preference.

Preferences properties can be applied to single users or to user groups. Preferences applied to a group are inherited by all members of the group. The users can, however, choose to override the properties with custom values. In the same way, a group can override the properties inherited from its parent groups. If the group has more than one parent group, the value from the Primary parent group (as defined using the Spotfire Administration Manager).

It is important for your preference implementation class to be decorated with the PersistenceVersionAttribute. If it is not, it will not be possible to register the preference class with the preference framework.

### Example
The following example shows an implementation of a preference class that stores two preferences of types string and ArrayList of integers.

```csharp
[Spotfire.Dxp.Framework.Persistence.PersistenceVersion(1, 0)]
public class MyPreference : CustomPreference
{
    private PreferenceProperty<string> myString; // Defaults to null
    private PreferenceProperty<ArrayList> numberList;

    public override string Category
    {
        get { return "MyCategory"; }
    }

    public override string SubCategory
    {
        get { return "MySubCategory"; }
    }

    public void AddToList(int value)
    {
        this.numberList.Value.Add(value);
        // Notify the framework of changes
        this.numberList.OnValueChanged();
    }

    public string MyString
    {
```
```

--------------------------------

### Start Impersonation Subprocess

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Framework_ApplicationModel_Subprocess_StartImpersonationSubprocess.htm

Use this method to start an external program as an impersonation subprocess. Provide the program's file path and any necessary arguments. An error message will be returned if the process cannot be started.

```csharp
public static Subprocess StartImpersonationSubprocess(
	string fileName,
	string args,
	out string errorText
)
```

--------------------------------

### Get DataTable by Guid

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Data_DataTableCollection_Item.htm

Retrieves a DataTable from the collection using its Guid. Ensure the Guid exists to avoid an ArgumentException.

```csharp
public DataTable this[
	Guid id
] { get; }
```

--------------------------------

### Show method syntax

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Forms_Components_VisualizationContextMenu_Show.htm

Displays the context menu at the specified client coordinate. Requires prior initialization via Initialize.

```C#
public void Show(
	Point clientCoordinate
)
```

--------------------------------

### ZoomLevelRange.Start Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Visuals_Maps_ZoomLevelRange_Start.htm

Gets the starting (farthest) zoom level, or null if not limited to a starting zoom level.

```APIDOC
## ZoomLevelRange.Start Property

### Description
Gets the starting (farthest) zoom level, or null if not limited to a starting zoom level.

### Namespace
Spotfire.Dxp.Application.Visuals.Maps

### Assembly
Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll)

### Syntax
```csharp
public Nullable<int> Start { get; }
```

### Property Value
Type: Nullable<Int32>
The starting zoom level.

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Initialize CustomVirtualColumnProducer in C#

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_Extension_CustomVirtualColumnProducer__ctor.htm

Constructor for the CustomVirtualColumnProducer class, accessible within the Spotfire.Dxp.Application.Extension namespace.

```C#
protected CustomVirtualColumnProducer()
```

--------------------------------

### Get ZoomLevelRange Start

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Visuals_Maps_ZoomLevelRange_Start.htm

Retrieves the starting zoom level of a map. Returns null if no starting zoom level is defined. Supported in Spotfire versions 14.0 and later.

```csharp
public Nullable<int> Start { get; }
```

--------------------------------

### IAnalysisApplicationController.StartWithCommandLine Method

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_Interop_IAnalysisApplicationController_StartWithCommandLine.htm

Starts the analysis application with a command line. This method is part of the Spotfire.Dxp.Application.Interop namespace and requires the Spotfire.Dxp.Application.dll assembly.

```APIDOC
## void StartWithCommandLine(Object callback, string commandLine)

### Description
Starts the analysis application with a command line.

### Method
(Implicitly a method call within C# context, not a REST API)

### Endpoint
(Not applicable for this C# method)

### Parameters
#### Path Parameters
(Not applicable)

#### Query Parameters
(Not applicable)

#### Request Body
(Not applicable)

### Request Example
(Not applicable for this C# method)

### Response
#### Success Response (void)
This method returns void.

#### Response Example
(Not applicable for void method)
```

--------------------------------

### RangeColorRule.StartValue Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Visuals_ConditionalColoring_RangeColorRule_StartValue.htm

Gets or sets the start value for this rule.

```APIDOC
## RangeColorRule.StartValue Property

### Description
Gets or sets the start value for this rule.

### Namespace
Spotfire.Dxp.Application.Visuals.ConditionalColoring

### Assembly
Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll)

### Syntax
```csharp
public ConditionValue StartValue { get; set; }
```

### Property Value
Type: ConditionValue

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### RangeRuleCondition.StartValueManualDisplayName Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Visuals_RangeRuleCondition_StartValueManualDisplayName.htm

Gets or sets the user-defined display name for the starting value. If set to null, the start value will be represented with an auto-generated name.

```APIDOC
## RangeRuleCondition.StartValueManualDisplayName Property

### Description
Gets or sets the user-defined display name for the starting value. If set to null, the start value will be represented with an auto-generated name.

### Namespace
Spotfire.Dxp.Application.Visuals

### Assembly
Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll)

### Syntax
```csharp
public string StartValueManualDisplayName { get; set; }
```

### Property Value
Type: String

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Initialize CustomShareTool with Menu Text

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_Extension_CustomShareTool_1__ctor.htm

Use this constructor to create a new CustomShareTool instance. The provided string will be displayed in the menu.

```csharp
protected CustomShareTool(
	string menuText
)
```

--------------------------------

### Start Analysis with Command Line (C#)

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_Interop_IAnalysisApplicationController_StartWithCommandLine.htm

Use this method to initiate the Spotfire analysis application programmatically, providing a callback object and a command line string. Ensure the callback object implements IAnalysisApplicationControllerCallback.

```csharp
void StartWithCommandLine(
	Object callback,
	string commandLine
)
```

--------------------------------

### Get or Set Sparkline Start Value Visibility

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Visuals_Miniatures_SparklineMiniatureVisualization_ShowStartValue.htm

Use this property to control whether the starting value of a sparkline is displayed. Supported in multiple Spotfire versions.

```csharp
public bool ShowStartValue { get; set; }
```

--------------------------------

### ExecuteSubtask Example

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Framework_ApplicationModel_Progress_ExecuteSubtask_2.htm

Example demonstrating how to use the ExecuteSubtask method within a progress operation. Ensure to call TryReportProgress() and CheckCancel() within the subtask loop.

```csharp
ProgressService progressService = GetService<ProgressService>();
progressService.ExecuteWithProgress("Opening File",
    delegate
    {
        // Do some work
        // ...

        ProgressService.CurrentProgress.ExecuteSubtask(
            "Sub task",
            stepCount,
            "Step {0} of {1}",
            delegate
            {
                // Perform subtask
                for (int i = 0; i < stepCount; i++)
                {
                    // Do something
                    // ...

                    ProgressService.CurrentProgress.TryReportProgress();
                    ProgressService.CurrentProgress.CheckCancel();
                }
            });

        // Do more work
        // ...
    }
```

--------------------------------

### Define and Initialize Preference Properties

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/T_Spotfire_Dxp_Application_Extension_CustomPreference.htm

Demonstrates how to implement property accessors and initialize preferences using AddPreference with specific persistence scopes and usage settings.

```csharp
        get { return this.myString.Value; }
        set
        {
            // The framwork is aware of the change to the property since
            // it is explicitly set.
            this.myString.Value = value;
        }
    }

    public MyPreference()
    {
        this.myString = this.AddPreference<string>(
            new PreferenceProperty<string>(
            "myString", "1.0",
            PreferencePersistenceScope.Server,
            PreferenceUsage.SingleUser));

        this.numberList = this.AddPreference<ArrayList>(
            new PreferenceProperty<ArrayList>(
                "numberList", "1.0",
                PreferencePersistenceScope.Server,
                PreferenceUsage.SingleUser,
                delegate
                {
                    // Calculate the default value
                    ArrayList defaultList = new ArrayList();
                    defaultList.Add(10);
                    return defaultList;
                }));
    }
}
```

--------------------------------

### TextDataReaderSettings.StartReadingRow Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Data_Import_TextDataReaderSettings_StartReadingRow.htm

Gets or sets the row to start reading from. All rows before this will be completely ignored.

```APIDOC
## TextDataReaderSettings.StartReadingRow Property

### Description
Gets or sets the row to start reading from. Note that all rows before this will be completely ignored.

### Namespace
Spotfire.Dxp.Data.Import

### Assembly
Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll)

### Syntax
```csharp
public int StartReadingRow { get; set; }
```

### Property Value
Type: Int32
The row to start reading from.

### Remarks
Note that all rows before this will be completely ignored.

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### TryGetItem by GUID

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/Overload_Spotfire_Dxp_Framework_Library_LibraryManager_TryGetItem.htm

Tries to get a library item using its unique identifier (GUID). Returns true if the item is found, false otherwise. Populates the provided LibraryItem object on success.

```APIDOC
## TryGetItem(Guid, LibraryItem, LibraryItemRetrievalOption[])

### Description
Tries to get the item associated with the specified id. Returns true if the item is found and false otherwise. On success, the item parameter is assigned and populated according to the specified metadata options.

### Method
(Assumed to be a method call within the Spotfire API, not a direct HTTP endpoint)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
(Conceptual example, as this is a method call)
```csharp
Guid itemId = new Guid("...");
LibraryItem item = null;
LibraryItemRetrievalOption[] options = { LibraryItemRetrievalOption.Metadata };
bool found = libraryManager.TryGetItem(itemId, out item, options);
```

### Response
#### Success Response (true)
- **item** (LibraryItem) - Populated with the library item details.

#### Response Example
(Conceptual)
```csharp
// If found is true, the 'item' object will contain the library item data.
```

#### Error Handling
- Returns `false` if the item is not found.
```

--------------------------------

### Open Library File With Progress and Prompts

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_AnalysisApplication_OpenFromLibrary_1.htm

Execute the OpenFromLibrary method with progress indication and prompt handling. This requires obtaining the ProgressService.

```csharp
string path="/DXP Files/Sales";
string name="Sales February";
ProgressService progressService = application.GetService<ProgressService>();
progressService.ExecuteWithProgress("Opening from Library", "Opening " + name, delegate()
{
    bool loaded = application.OpenFromLibrary(path, name);
});
```

--------------------------------

### RangeColorRule.StartValueManualDisplayName Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Visuals_ConditionalColoring_RangeColorRule_StartValueManualDisplayName.htm

Gets or sets the user-defined display name for the starting value of a range color rule. If this property is set to null, Spotfire will automatically generate a display name for the start value.

```APIDOC
## RangeColorRule.StartValueManualDisplayName Property

### Description
Gets or sets the user set display name for the starting value. If set to null, the start value will be represented with an auto-generated name.

### Namespace
Spotfire.Dxp.Application.Visuals.ConditionalColoring

### Assembly
Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll)

### Syntax
```csharp
public string StartValueManualDisplayName { get; set; }
```

### Property Value
Type: String

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Method: IAnalysisApplicationControllerCallback.Started

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_Interop_IAnalysisApplicationControllerCallback_Started.htm

Documentation for the Started method within the IAnalysisApplicationControllerCallback interface.

```APIDOC
## Started Method

### Description
Called when the analysis application has started.

### Namespace
Spotfire.Dxp.Application.Interop

### Parameters
- **context** (Spotfire.Dxp.Application.Interop.IStartContext) - Required - The context of the application startup.

### Syntax
```csharp
void Started(
	IStartContext context
)
```

### Version Information
Supported in: 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Get or Set Quote Character Escape Sequence

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Data_Import_TextDataReaderSettings_QuoteCharEscape.htm

Use this property to get or set the escape sequence for quote characters. For example, the quote character could be "" or & for the quote character ".

```csharp
public string QuoteCharEscape { get; set; }
```

--------------------------------

### Initialize SupportedFileExtension in C#

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Framework_Persistence_SupportedFileExtension__ctor.htm

Constructor for creating a new instance of SupportedFileExtension with a description and a list of supported file extensions.

```C#
public SupportedFileExtension(
	string description,
	string[] extensions
)
```

--------------------------------

### StartSubprocess Method

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Framework_ApplicationModel_SubprocessService_StartSubprocess_2.htm

Initiates a subprocess with specified type, assembly paths, and arguments.

```APIDOC
## StartSubprocess Method

### Description
Tries to start a subprocess within the Spotfire application framework.

### Parameters
- **typeToCreate** (System.Type) - Required - The type to create an instance of in the subprocess.
- **assemblyResolvePath** (System.Tuple<String, Boolean>) - Required - A tuple containing the path to the folder where the assemblies are located and a boolean indicating if sub-folders should be searched.
- **args** (IEnumerable<String>) - Required - The arguments to pass to the instance.
- **redirectOutput** (Boolean) - Required - If set to true, redirects output (only works when the subprocess uses the Process class).
- **errorText** (String) - Output - If no process can be started, a non-empty string with an error message is returned.

### Return Value
- **Subprocess** (Object) - A Subprocess object if the process started successfully; otherwise, null.
```

--------------------------------

### Property: ShowStartValue

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Visuals_Miniatures_SparklineMiniatureVisualization_ShowStartValue.htm

Gets or sets a boolean value indicating whether the start value of the sparkline should be displayed.

```APIDOC
## Property: ShowStartValue

### Description
Gets or sets a value indicating whether the start value of the sparkline shall be shown.

### Namespace
Spotfire.Dxp.Application.Visuals.Miniatures

### Assembly
Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll)

### Syntax
```csharp
public bool ShowStartValue { get; set; }
```

### Property Value
- **Type**: Boolean

### Version Information
Supported in: 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### ParallelCoordinatePlotColumnScale.Span Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Visuals_ParallelCoordinatePlotColumnScale_Span.htm

Gets or sets the absolute span of the scale area, for example the space available for the axis and its labels.

```APIDOC
## ParallelCoordinatePlotColumnScale.Span Property

### Description
Gets or sets the absolute span of the scale area, for example the space available for the axis and its labels.

### Namespace
Spotfire.Dxp.Application.Visuals

### Assembly
Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll)

### Syntax
```csharp
public float Span { get; set; }
```

### Property Value
**Type:** Single

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Custom Tool Implementation

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/N_Spotfire_Dxp_Application_Tools.htm

Example of how to define a custom tool by specifying a context class from the Spotfire.Dxp.Application.Tools namespace.

```APIDOC
## Custom Tool Implementation

### Description
Shows how to implement a custom tool by inheriting from CustomTool and providing a context class like TablePlotCellContext.

### Request Example
```csharp
public sealed class MyTablePlotCellTool : CustomTool<TablePlotCellContext>
{
}
```
```

--------------------------------

### Get ColumnSubtotalsLayout Property Name

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/F_Spotfire_Dxp_Application_Visuals_CrossTablePlot_PropertyNames_ColumnSubtotalsLayout.htm

Use this property name to access the ColumnSubtotalsLayout setting for a CrossTablePlot. No setup is required.

```csharp
public static readonly PropertyName ColumnSubtotalsLayout
```

--------------------------------

### Initialize VisualizationContextMenu

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Forms_Components_VisualizationContextMenu__ctor.htm

Use this constructor to create a new instance of the VisualizationContextMenu. Supported in multiple Spotfire versions.

```csharp
public VisualizationContextMenu()
```

--------------------------------

### ExecuteWithProgress Example

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/T_Spotfire_Dxp_Framework_ApplicationModel_ProgressService.htm

Demonstrates how to execute an operation with progress reporting and subtasks using the ProgressService. Ensure proper handling of CanceledException and perform cleanup in the finally block.

```csharp
ProgressService progressService = GetService<ProgressService>();
progressService.ExecuteWithProgress("Opening File",
    "Task description",
    delegate
    {
        // Do some work
        // ...

        ProgressService.CurrentProgress.ExecuteSubtask(
            "Sub task",
            stepCount,
            "Step {0} of {1}",
            delegate
            {
                try
                {
                    // Perform sub task
                    for (int i = 0; i < stepCount; i++)
                    {
                        // Do something
                        // ...

                        ProgressService.CurrentProgress.TryReportProgress();
                        ProgressService.CurrentProgress.CheckCancel();
                    }
                }
                catch (CanceledException)
                {
                    // Handle exception
                }
                finally
                {
                    // Perform Cleanup
                }
            });

        // Do more work
        // ...
    }
```

--------------------------------

### Get or Set AdditionalSpacingBetweenKpis

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Visuals_KpiChart_AdditionalSpacingBetweenKpis.htm

Use this property to get or set the number of pixels for spacing between KPIs when each KPI starts on a new row. This has no effect if NewRowPerKpi is false. The default value is 24, and allowed values are between 0 and 100.

```csharp
public int AdditionalSpacingBetweenKpis { get; set; }
```

--------------------------------

### StartSubprocess32 Method

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Framework_ApplicationModel_SubprocessService_StartSubprocess32.htm

Initiates a subprocess in 32-bit mode using the provided arguments.

```APIDOC
## StartSubprocess32(string, out string)

### Description
Tries to start a subprocess in 32-bit mode.

### Parameters
- **args** (string) - Required - The arguments string to send to the subprocess.
- **errorText** (string) - Required - An out parameter that returns an error message if the process fails to start.

### Return Value
- **Subprocess** (Object) - A Process object connected to the running process if successful, otherwise null.
```

--------------------------------

### Get SubProcessCommand

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Framework_ApplicationModel_SubprocessService_SubProcessCommand.htm

Retrieves the command used to start a subprocess. If this property is null or empty, the subprocess file itself is expected to be executable.

```csharp
public string SubProcessCommand { get; }
```

--------------------------------

### Initialize InformationLinkDataSource with Guid and Parameters

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Data_Import_InformationLinkDataSource__ctor_3.htm

Use this constructor to create a new InformationLinkDataSource instance. Provide the unique identifier for the information link and an enumerable collection of InformationLinkParameter objects. The parameters argument can be null.

```csharp
public InformationLinkDataSource(
	Guid informationLinkId,
	IEnumerable<InformationLinkParameter> parameters
)
```

--------------------------------

### TextDataReaderSettings.CommentPrefix Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Data_Import_TextDataReaderSettings_CommentPrefix.htm

Gets or sets the string describing how a commented line starts. If this is left empty, the parser will not look for comments at all.

```APIDOC
## TextDataReaderSettings.CommentPrefix Property

### Description
Gets or sets the string describing how a commented line starts. If this is left empty, the parser will not look for comments at all.

### Property Type
String

### Remarks
Example: `//comment line name,name2,name3 1,2,3 4,5,6 //another comment line. 7,8,9` Here `//` will be good to set as CommentPrefix.

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Get InformationLinkParameter ElementIdentifier

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Data_Import_InformationLinkParameter_ElementIdentifier.htm

Retrieves the Guid identifier for an information link element. This property is always Guid.Empty for named parameters.

```csharp
public Guid ElementIdentifier { get; }
```

--------------------------------

### MiniatureVisualizationDetails.PropertyNames Constructor

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_Visuals_Miniatures_MiniatureVisualizationDetails_PropertyNames__ctor.htm

This constructor initializes a new instance of the PropertyNames class.

```APIDOC
## MiniatureVisualizationDetails.PropertyNames Constructor

### Description
Initializes a new instance of the `PropertyNames` class.

### Method
protected PropertyNames()

### Endpoint
N/A (This is a constructor, not an API endpoint)

### Parameters
None

### Request Example
N/A

### Response
N/A

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### WaterfallChart.LabelOrientation Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Visuals_WaterfallChart_LabelOrientation.htm

Gets or sets the label orientation of this plot. This property is supported in various versions of Spotfire, starting from 14.0.

```APIDOC
## WaterfallChart.LabelOrientation Property

### Description
Gets or sets the label orientation of this plot.

### Namespace
Spotfire.Dxp.Application.Visuals

### Assembly
Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll)

### Syntax
```csharp
public LabelOrientation LabelOrientation { get; set; }
```

### Property Value
Type: LabelOrientation
A value indicating the label orientation of this plot. Defaults to Horizontal.

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Open File from Library With Progress and Prompts

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_AnalysisApplication_OpenFromLibrary_2.htm

Execute the OpenFromLibrary method with progress indication and prompt handling. This ensures the user is aware of the operation's status and can respond to any prompts.

```csharp
string path="/DXP Files/Sales";
string name="Sales February";
DocumentOpenSettings settings = new DocumentOpenSettings()
ProgressService progressService = application.GetService<ProgressService>();
progressService.ExecuteWithProgress("Opening from Library", "Opening " + name, delegate()
{
    bool loaded = application.OpenFromLibrary(path, name, settings);
});
```

--------------------------------

### CustomShareTool<TContext> Constructor (String)

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_Extension_CustomShareTool_1__ctor.htm

Initializes a new instance of the CustomShareTool<TContext> class with specified menu text.

```APIDOC
## CustomShareTool<TContext> Constructor (String)

### Description
Initializes a new instance of the CustomShareTool<TContext> class.

### Method
Constructor

### Endpoint
N/A (Class Constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```csharp
protected CustomShareTool(string menuText)
```

### Response
#### Success Response (N/A)
This is a constructor, it does not return a value.

#### Response Example
N/A
```

--------------------------------

### Get Bookmark ID

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_AnalyticItems_Bookmark_Id.htm

Use this property to retrieve the unique Guid identifier for a bookmark. Supported in multiple Spotfire versions.

```csharp
public Guid Id { get; }
```

--------------------------------

### Progress.BeginSubtask Method

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Framework_ApplicationModel_Progress_BeginSubtask.htm

Starts a new determinate subtask, that is, a subtask in which the extent of the operation is known, for example that it requires x steps to be performed.

```APIDOC
## Progress.BeginSubtask Method

### Description
Starts a new determinate subtask, that is, a subtask in which the extent of the operation is known, for example that it requires x steps to be performed.

### Method
C#

### Endpoint
Spotfire.Dxp.Framework.ApplicationModel

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```csharp
public IDisposable BeginSubtask(
	string title,
	long totalSteps,
	string progressDescription
)
```

### Response
#### Success Response (200)
- **IDisposable** - An object that controls the span of the subtask. This object must be disposed in order to signal that the subtask is completed.

#### Response Example
```csharp
// Example usage within a larger operation
ProgressService progressService = GetService<ProgressService>();
progressService.ExecuteWithProgress("Opening File",
    delegate
    {
        // Do some work
        // ...

        using(ProgressService.CurrentProgress.BeginSubtask(
            "Sub task",
            stepCount,
            "Step {0} of {1}"))
        {
            // Perform subtask
            for (int i = 0; i < stepCount; i++)
            {
                // Do something
                // ...

                ProgressService.CurrentProgress.TryReportProgress();
                ProgressService.CurrentProgress.CheckCancel();
            }
        }

        // Do more work
        // ...
    }
```

### Exceptions
- **ArgumentNullException**: If either title, or progressDescription is null.
- **ArgumentOutOfRangeException**: If totalSteps is negative.
- **FormatException**: If progressDescription contains more than two placeholders.
```

--------------------------------

### Initialize LabelStyle in C#

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_Visuals_ReferenceElements_LabelStyle__ctor.htm

Constructor syntax for creating a new LabelStyle instance.

```C#
public LabelStyle()
```

--------------------------------

### Calculation.IsValid Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Data_Calculation_IsValid.htm

Gets a value indicating whether or not this calculation can be calculated. A calculation may for example be invalid when vital dependencies are missing.

```APIDOC
## Calculation.IsValid Property

### Description
Gets a value indicating whether or not this calculation can be calculated. A calculation may for example be invalid when vital dependencies are missing.

### Namespace
Spotfire.Dxp.Data

### Assembly
Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll)

### Syntax
```csharp
public bool IsValid { get; }
```

### Property Value
Type: Boolean

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Initialize DocumentOpenSettings in C#

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_DocumentOpenSettings__ctor.htm

Use this constructor to create a new instance of DocumentOpenSettings with default configuration settings.

```C#
public DocumentOpenSettings()
```

--------------------------------

### RangeRuleCondition.StartValue Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Visuals_RangeRuleCondition_StartValue.htm

Gets or sets the start value for this rule. This property is part of the Spotfire.Dxp.Application.Visuals namespace and is available in multiple Spotfire versions.

```APIDOC
## RangeRuleCondition.StartValue Property

### Description
Gets or sets the start value for this rule.

### Namespace
Spotfire.Dxp.Application.Visuals

### Assembly
Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll)

### Syntax
```csharp
public ConditionValue StartValue { get; set; }
```

### Property Value
Type: ConditionValue

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Initialize AnalysisApplicationComView in C#

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_Interop_AnalysisApplicationComView__ctor.htm

Constructor for creating a new instance of the AnalysisApplicationComView class.

```C#
protected AnalysisApplicationComView(
	AnalysisApplication analysisApplication
)
```

--------------------------------

### KpiChart.NewRowPerKpi Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Visuals_KpiChart_NewRowPerKpi.htm

Gets or sets a value indicating whether the tiles for one kpi should be grouped and started on a new line or not. This also affects the sorting, when the kpis each starts on a new line sorting is done for each kpi separately. Default value if false.

```APIDOC
## KpiChart.NewRowPerKpi Property

### Description
Gets or sets a value indicating whether the tiles for one kpi should be grouped and started on a new line or not. This also affects the sorting, when the kpis each starts on a new line sorting is done for each kpi separately. Default value if false.

### Namespace
Spotfire.Dxp.Application.Visuals

### Assembly
Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll)

### Syntax
```csharp
public bool NewRowPerKpi { get; set; }
```

### Property Value
Type: Boolean

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0
```

--------------------------------

### CustomVirtualColumnProducer Constructor

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_Extension_CustomVirtualColumnProducer__ctor.htm

Initializes a new instance of the CustomVirtualColumnProducer class.

```APIDOC
## Constructor: CustomVirtualColumnProducer()

### Description
Initializes a new instance of the CustomVirtualColumnProducer class.

### Namespace
Spotfire.Dxp.Application.Extension

### Assembly
Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll)

### Syntax
```csharp
protected CustomVirtualColumnProducer()
```

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### ApplyPreferences Method Syntax

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_Calculations_DataRelationships_DataRelationshipsCalculationSettings_ApplyPreferences.htm

Initializes the settings with the preferences of the current user.

```C#
public void ApplyPreferences()
```

--------------------------------

### GET SubProcessCommand Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Framework_ApplicationModel_SubprocessService_SubProcessCommand.htm

Retrieves the command string used to start a SubProcess. If the value is null or empty, the SubProcess file is treated as an executable.

```APIDOC
## GET SubprocessService.SubProcessCommand

### Description
Gets the command that should be used to start the SubProcess. If null or empty, the SubProcess file itself is expected to be executable.

### Namespace
Spotfire.Dxp.Framework.ApplicationModel

### Assembly
Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll)

### Syntax
```csharp
public string SubProcessCommand { get; }
```

### Property Value
- **Type**: String

### Version Information
- **Supported in**: 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Sections.LogicalFunctions Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Data_Computations_Sections_LogicalFunctions.htm

Gets the section for logical functions. This property is part of the Spotfire.Dxp.Data.Computations namespace and is available in various Spotfire versions starting from 11.8.

```APIDOC
## Sections.LogicalFunctions Property

### Description
Gets the section for logical functions.

### Method
GET (Implicit - Property Access)

### Endpoint
N/A (This is a property, not an endpoint)

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **string** - The localized name of the section for logical functions.

### Response Example
```json
{
  "LogicalFunctions": "Logical Functions"
}
```

### Version Information
Supported in: 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Initialize VisualRenderSettings

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_Visuals_VisualRenderSettings__ctor.htm

Use this constructor to create a new instance of the VisualRenderSettings class. Supported in Spotfire versions 14.7 down to 11.8.

```csharp
public VisualRenderSettings()
```

--------------------------------

### Get or Set RangeColorRule StartValue

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Visuals_ConditionalColoring_RangeColorRule_StartValue.htm

Use this property to retrieve or define the starting value for a range-based color rule. This is part of the Spotfire.Dxp.Application.Visuals.ConditionalColoring namespace.

```csharp
public ConditionValue StartValue { get; set; }
```

--------------------------------

### StartSubprocess32 Method

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Framework_ApplicationModel_SubprocessService_StartSubprocess32_2.htm

Initiates a subprocess in 32-bit mode using the specified type, assembly path, and arguments.

```APIDOC
## StartSubprocess32

### Description
Tries to start a subprocess in 32-bit mode.

### Parameters
- **typeToCreate** (System.Type) - Required - The type to create an instance of in the subprocess.
- **assemblyResolvePath** (System.Tuple<String, Boolean>) - Required - A tuple containing the path to the folder where the assemblies are located and a boolean indicating if sub-folders should be searched.
- **args** (System.Collections.Generic.IEnumerable<String>) - Required - The arguments to pass to the instance.
- **errorText** (System.String) - Output - If no process can be started, a non-empty string with an error message will be returned.

### Return Value
- **Subprocess** - A Process object; if the subprocess started, the object is connected to the running process; otherwise, null is returned.
```

--------------------------------

### Get or Set FrequencyExpression

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Visuals_FittingModels_ForecastHoltWintersFittingModel_FrequencyExpression.htm

Use this property to get or set the frequency expression, which defines the number of observations per sampling period. For example, monthly data has a frequency of 12. This string must evaluate to a positive integer greater than 1 to fit a seasonal component.

```csharp
public string FrequencyExpression { get; set; }
```

--------------------------------

### Create a catalog path in C#

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Data_InformationModel_DataSourceItemPath_CreateCatalog.htm

Use this static method to initialize a path to a catalog within the Spotfire Information Model.

```C#
public static DataSourceItemPath CreateCatalog(
	string catalog
)
```

--------------------------------

### ExecuteStickyTransaction2 Method

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Framework_DocumentModel_ITransactions_ExecuteStickyTransaction2.htm

Starts a sticky transaction on the document model by executing a provided action. Consecutive calls with the same Guid will be grouped into a single undo entry.

```APIDOC
## ExecuteStickyTransaction2

### Description
Starts a sticky transaction on the document model by executing an action. If a transaction is already ongoing, it is included in the current transaction. Modifications are recorded for undo functionality.

### Parameters
- **guid** (System.Guid) - Required - The ID identifying the transactions that should stick together.
- **action** (System.Action) - Required - The delegate to execute.

### Request Example
```csharp
Guid transactionId = Guid.NewGuid();
ITransactions.ExecuteStickyTransaction2(transactionId, () => {
    // Perform document modifications here
});
```
```

--------------------------------

### Constructor: HighlightSelection.PropertyNames

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Data_HighlightSelection_PropertyNames__ctor.htm

Initializes a new instance of the HighlightSelection.PropertyNames class.

```APIDOC
## Constructor: HighlightSelection.PropertyNames

### Description
Initializes a new instance of the HighlightSelection.PropertyNames class. This constructor is protected.

### Syntax
protected PropertyNames()

### Namespace
Spotfire.Dxp.Data

### Assembly
Spotfire.Dxp.Data.dll (Version: 69.0.21424.2902)

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### MiniatureVisualization.PropertyNames Class Overview

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/T_Spotfire_Dxp_Application_Visuals_Miniatures_MiniatureVisualization_PropertyNames.htm

Provides an overview of the MiniatureVisualization.PropertyNames class, its inheritance hierarchy, namespace, and assembly information.

```APIDOC
## MiniatureVisualization.PropertyNames Class

### Description
Contains property name constants for the public properties of MiniatureVisualization.

### Inheritance Hierarchy
* System.Object
* Spotfire.Dxp.Framework.DocumentModel.DocumentNode.PropertyNames
* Spotfire.Dxp.Application.Visuals.VisualContent.PropertyNames
* Spotfire.Dxp.Application.Visuals.Visualization.PropertyNames
* Spotfire.Dxp.Application.Visuals.Miniatures.MiniatureVisualization.PropertyNames
* Spotfire.Dxp.Application.Visuals.Miniatures.BulletGraphMiniatureVisualization.PropertyNames
* Spotfire.Dxp.Application.Visuals.Miniatures.CalculatedValueMiniatureVisualization.PropertyNames
* Spotfire.Dxp.Application.Visuals.Miniatures.IconMiniatureVisualization.PropertyNames
* Spotfire.Dxp.Application.Visuals.Miniatures.SparklineMiniatureVisualization.PropertyNames

### Namespace
Spotfire.Dxp.Application.Visuals.Miniatures

### Assembly
Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll)
Version: 69.0.21424.2902 (69.0.21424.2902)

### Syntax
```csharp
public abstract class PropertyNames : Visualization.PropertyNames
```

### Version Information
Supported in: 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### TextDataReaderSettings.CultureName Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Data_Import_TextDataReaderSettings_CultureName.htm

Gets or sets the name of the explicitly set culture. Example: "en-US" for English(United States) culture settings.

```APIDOC
## TextDataReaderSettings.CultureName Property

### Description
Gets or sets the name of the explicitly set culture. Example: "en-US" for English(United States) culture settings.

### Namespace
Spotfire.Dxp.Data.Import

### Assembly
Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll)

### Syntax
```csharp
public string CultureName { get; set; }
```

### Property Value
Type: String
The name of the culture.

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### StartSubprocess32 Method Syntax

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Framework_ApplicationModel_SubprocessService_StartSubprocess32_2.htm

Defines the signature for starting a 32-bit subprocess, including parameters for the type to create, assembly resolution paths, and arguments.

```C#
public Subprocess StartSubprocess32(
	Type typeToCreate,
	Tuple<string, bool> assemblyResolvePath,
	IEnumerable<string> args,
	out string errorText
)
```

--------------------------------

### DataProperty.HasInheritedType Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Data_DataProperty_HasInheritedType.htm

Gets a value indicating whether the property has a value type that is derived from the container. For example, a column property that is a list of column values.

```APIDOC
## DataProperty.HasInheritedType Property

### Description
Gets a value indicating whether the property has a value type that is derived from the container. For example, a column property that is a list of column values.

### Namespace
Spotfire.Dxp.Data

### Assembly
Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll)

### Syntax
```csharp
public bool HasInheritedType { get; }
```

### Property Value
Type: Boolean

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Get TableCell Border Color

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Visuals_TableCell_BorderColor.htm

Use this property to retrieve the border color of a table cell. It is available in various Spotfire versions starting from 14.0.

```csharp
public Color BorderColor { get; }
```

--------------------------------

### VisualizationContextMenu Constructor

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Forms_Components_VisualizationContextMenu__ctor.htm

Initializes a new VisualizationContextMenu instance.

```APIDOC
## VisualizationContextMenu Constructor

### Description
Initializes a new VisualizationContextMenu instance.

### Namespace
Spotfire.Dxp.Forms.Components

### Assembly
Spotfire.Dxp.Forms (in Spotfire.Dxp.Forms.dll)

### Syntax
```csharp
public VisualizationContextMenu()
```

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### Accessing StartValueManualDisplayName in C#

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Visuals_ConditionalColoring_RangeColorRule_StartValueManualDisplayName.htm

Defines the property signature for getting or setting the manual display name of a range color rule's start value.

```C#
public string StartValueManualDisplayName { get; set; }
```

--------------------------------

### Constructor: CustomVisual()

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_Extension_CustomVisual__ctor.htm

Initializes a new instance of the CustomVisual class within the Spotfire.Dxp.Application.Extension namespace.

```APIDOC
## Constructor: CustomVisual()

### Description
Initializes a new instance of the CustomVisual class.

### Namespace
Spotfire.Dxp.Application.Extension

### Assembly
Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll)

### Syntax
```csharp
protected CustomVisual()
```

### Version Information
Supported in: 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### TablePlotColumnContext.TableColumn Property

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Application_Tools_TablePlotColumnContext_TableColumn.htm

Gets the clicked table column in the plot. This property is part of the Spotfire.Dxp.Application.Tools namespace and is available in various Spotfire versions starting from 11.8.

```APIDOC
## TablePlotColumnContext.TableColumn Property

### Description
Gets the clicked table column in the plot.

### Method
GET

### Endpoint
N/A (This is a property, not an API endpoint)

### Parameters
N/A

### Request Body
N/A

### Response
#### Success Response (200)
- **TableColumn** (TableColumn) - The table column that was clicked.

### Response Example
```json
{
  "TableColumn": {
    "Name": "ExampleColumn",
    "DataType": "string"
  }
}
```

### Version Information
Supported in: 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```

--------------------------------

### StartSubprocess32 Method Signature

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Framework_ApplicationModel_SubprocessService_StartSubprocess32.htm

Use this method to start a 32-bit subprocess. Provide arguments as a string and receive error messages via an output parameter. Returns a Process object connected to the subprocess or null if it fails to start.

```csharp
public Subprocess StartSubprocess32(
	string args,
	out string errorText
)
```

--------------------------------

### Get MaxLength of NameString

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/P_Spotfire_Dxp_Data_NameString_MaxLength.htm

Retrieves the maximum allowable length for name strings. This property is read-only and does not require any setup or imports beyond the Spotfire.Dxp.Data namespace.

```csharp
public static int MaxLength { get; }
```

--------------------------------

### IAnalysisApplicationController.Start Method

Source: https://docs.tibco.com/pub/doc_remote/sfire_dev/area/doc/api/TIB_sfire-analyst_api/html/M_Spotfire_Dxp_Application_Interop_IAnalysisApplicationController_Start.htm

Starts the analysis application. This method is part of the Spotfire.Dxp.Application.Interop namespace and is available in multiple Spotfire versions.

```APIDOC
## Start Method

### Description
Starts the analysis application.

### Method
(Implicitly called, not a direct HTTP method)

### Endpoint
(Not applicable for this method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
(Not applicable for this method)

### Response
#### Success Response (void)
This method returns void.

#### Response Example
(Not applicable for this method)

### Syntax
```csharp
void Start(
	Object callback
)
```

### Parameters
- **callback** (System.Object) - Required - An object with callback methods. Shall implement IAnalysisApplicationControllerCallback.

### Supported Versions
14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
```
Tokens:
Raw