Fdc3Options

Options for configuring FDC3 in AdapTable

TypeScript
export interface

Properties

PropertyTypeDescriptionDefault
actionColumnDefaultConfigurationActionColumnDefaultConfigurationConfigures the default FDC3 Actions columncolumnId: 'fdc3ActionColumn', headerName: 'FDC3 Actions', width: 200, resizable: true, movable: false, rowScope: ExcludeDataRows: false, ExcludeGroupRows: true, ExcludeSummaryRows: true, ExcludeTotalRows: true
contextsFdc3ContextOptionsConfigures FDC3 standard Contexts that AdapTable will listen for and broadcast
enableLoggingbooleanEnable logging message exchanges to Consolefalse
gridDataContextMappingGridDataContextMappingMaps Context Type to AdapTable Grid Data
intentsFdc3IntentOptionsConfigures FDC3 standard Intents that AdapTable will listen for and raise
resolveContextData(context:ResolveContextDataContext) => ContextBuilds Context Data (useful for postprocessing Context Data mapped from Grid data)
uiControlsDefaultConfiguration\{ contexts?: \{ [contextName in StandardContextType]?:UIControlConfig; \}; intents?: \{ [intentName in StandardIntent]?:UIControlConfig; \}; \}Customises FDC3 UI Controlscontexts: , intents:

Property Details

actionColumnDefaultConfiguration

Configures the default FDC3 Actions column

TypeScript
actionColumnDefaultConfiguration?: ActionColumnDefaultConfiguration;
Default Value

columnId: 'fdc3ActionColumn', headerName: 'FDC3 Actions', width: 200, resizable: true, movable: false, rowScope: ExcludeDataRows: false, ExcludeGroupRows: true, ExcludeSummaryRows: true, ExcludeTotalRows: true

Property Value

ActionColumnDefaultConfiguration

contexts

Configures FDC3 standard Contexts that AdapTable will listen for and broadcast

TypeScript
contexts?: Fdc3ContextOptions;
Property Value

Fdc3ContextOptions

enableLogging

Enable logging message exchanges to Console

TypeScript
enableLogging?: boolean;
Default Value

false

Property Value

boolean

gridDataContextMapping

Maps Context Type to AdapTable Grid Data

TypeScript
gridDataContextMapping?: GridDataContextMapping;
Property Value

GridDataContextMapping

intents

Configures FDC3 standard Intents that AdapTable will listen for and raise

TypeScript
intents?: Fdc3IntentOptions;
Property Value

Fdc3IntentOptions

resolveContextData

Builds Context Data (useful for postprocessing Context Data mapped from Grid data)

TypeScript
resolveContextData?: (context: ResolveContextDataContext) => Context;
Property Value

(context:ResolveContextDataContext) => Context

uiControlsDefaultConfiguration

Customises FDC3 UI Controls

TypeScript
uiControlsDefaultConfiguration?: {
        contexts?: {
            [contextName in StandardContextType]?: UIControlConfig;
        };
        intents?: {
            [intentName in StandardIntent]?: UIControlConfig;
        };
    };
Default Value

contexts: , intents:

Property Value

\{ contexts?: \{ [contextName in StandardContextType]?:UIControlConfig; \}; intents?: \{ [intentName in StandardIntent]?:UIControlConfig; \}; \}