IPushPullPluginOptions

Options available in ipushpull plugin; allows users to collaborate and share data in powerful ways

TypeScript
export interface

Properties

PropertyDescriptionDefault
autoLoginWhether AdapTable should try log in to ipushpull automatically at start-upfalse
cellStylesThe color theme to use when styling data pushed to ipushpull pagesderived from Adaptable's current theme (lightTheme or darkTheme)
includeSystemReportsWhether AdapTable will include System Reports (e.g. 'All Data', 'Selected Cells' etc) in the ipushpull toolbar dropdowntrue
ippConfigThe config required to run ipushpull; use your ipushpull credentials
passwordThe user's ipushpull password; if supplied, pre-populates the login screen's password textbox
throttleTimeHow many miliseconds AdapTable should throttle when sending data updates to ipushpull2000
usernameUser's ipushpull user name (usually email address); if supplied, pre-populates the login screen's username textbox

Property Details

autoLogin

Whether AdapTable should try log in to ipushpull automatically at start-up

TypeScript
autoLogin?: boolean;
Default Value

false

Property Value

boolean

cellStyles

The color theme to use when styling data pushed to ipushpull pages

TypeScript
cellStyles?: 'lightTheme' | 'darkTheme';
Default Value

derived from Adaptable's current theme (lightTheme or darkTheme)

Property Value

'lightTheme' | 'darkTheme'

includeSystemReports

Whether AdapTable will include System Reports (e.g. 'All Data', 'Selected Cells' etc) in the ipushpull toolbar dropdown

TypeScript
includeSystemReports?: boolean;
Default Value

true

Property Value

boolean

ippConfig

The config required to run ipushpull; use your ipushpull credentials

TypeScript
ippConfig?: IPushPullConfig;
Property Value

IPushPullConfig

password

The user's ipushpull password; if supplied, pre-populates the login screen's password textbox

TypeScript
password?: string;
Property Value

string

throttleTime

How many miliseconds AdapTable should throttle when sending data updates to ipushpull

TypeScript
throttleTime?: number;
Default Value

2000

Property Value

number

username

User's ipushpull user name (usually email address); if supplied, pre-populates the login screen's username textbox

TypeScript
username?: string;
Property Value

string