evolutionProgressIndicator jQuery Plugin

jQuery.fn.evolutionProgressIndicator

This plugin supports rendering a progress indicator including a progress bar and/or a message log. This plugin is typically invoked by the scheduledfile UI components as rendered by core_v2_ui.ScheduledFile() scheduled script file execution status indicators.

Usage

$('SELECTOR').evolutionProgressIndicator(options)

Options

• includePercentComplete: (boolean) Whether or not to include a percentage-based progress bar
  • default true
• includeLatestMessage: (boolean) Whether or not to include only the latest message received from $().evolutionProgressIndicator('progress').
  • default true
• includeAllMessages: (boolean) Whether or not to include all messages received from $().evolutionProgressIndicator('progress').
  • default false
• progressClass: (string) CSS class applied while in progress
  • default progress-indicator-progress
• completeClass: (string) CSS class applied when complete
  • default progress-indicator-complete
• errorClass: (string) CSS class applied when an error is raised
  • default progress-indicator-error
• warnBeforeUnload: (boolean) Whether a message should be shown warning before leaving a non-completed progress session
  • default false
• showPending: (boolean) Whether a pending state should be shown before progress is received
  • default false
• beforeUnloadMessageTip: (string) UI Tip message to show with label if warnBeforeUnload` is enabled
  • default null
• beforeUnloadMessageLabel: (string) Message to show in label if warnBeforeUnload` is enabled
  • default null
• pendingTip: (string) Message to show in UI Tip if showPending is enabled`
  • default null

Methods

progress

Applies a progress report to the indicator, including a completion percentage and/or a status message.

// Send a progress report with percent complete and a message
$('SELECTOR').evolutionProgressIndicator('progress', { percentComplete: .5, message: 'Halfway done!' });

// Send a progress report with percent complete
$('SELECTOR').evolutionProgressIndicator('progress', { percentComplete: .5 });

// Send a progress report with a message
$('SELECTOR').evolutionProgressIndicator('progress', { message: 'Halfway done!' });

Options:

• percentComplete: (float) Completion percentage, between 0.0 and 1.0.
  • default null
• message: (string) Status message
  • default null

complete

Applies a completion state to the indicator

$('SELECTOR').evolutionProgressIndicator('complete')

error

Applies an error state to the indicator

$('SELECTOR').evolutionProgressIndicator('error')