Class: StateTimeline

StateTimeline()

new StateTimeline()

NB: Attributes not available here - use connectedCallback to reference
Source:

Members

$ :function

Mini jQuery-like shadow dom selector (see constructor)
Type:
  • function
Source:

$ :function

Mini jQuery-like shadow dom selector (see constructor)
Type:
  • function
Source:

$ :function

Mini jQuery-like shadow dom selector (see constructor)
Type:
  • function
Source:

$$ :function

Mini jQuery-like shadow dom multi-selector (see constructor)
Type:
  • function
Source:

$$ :function

Mini jQuery-like shadow dom multi-selector (see constructor)
Type:
  • function
Source:

$$ :function

Mini jQuery-like shadow dom multi-selector (see constructor)
Type:
  • function
Source:

_iCount

Holds a count of how many instances of this component are on the page Used to ensure a unique id if needing to add one dynamically
Source:

_iCount

Holds a count of how many instances of this component are on the page Used to ensure a unique id if needing to add one dynamically
Source:

_iCount

Holds a count of how many instances of this component are on the page Used to ensure a unique id if needing to add one dynamically
Source:

online

Are we online?
Source:

online

Are we online?
Source:

online

Are we online?
Source:

opts

Runtime configuration settings
Source:

opts

Runtime configuration settings
Source:

opts

Runtime configuration settings
Source:

states :HTMLCollectionOf.<Element>

LIVE ref to all state divs - updates automatically as new states are added
Type:
  • HTMLCollectionOf.<Element>
Source:

states :HTMLCollectionOf.<Element>

LIVE ref to all state divs - updates automatically as new states are added
Type:
  • HTMLCollectionOf.<Element>
Source:

states :HTMLCollectionOf.<Element>

LIVE ref to all state divs - updates automatically as new states are added
Type:
  • HTMLCollectionOf.<Element>
Source:

uib

Is UIBUILDER loaded?
Source:

uib

Is UIBUILDER loaded?
Source:

uib

Is UIBUILDER loaded?
Source:

version

Component version
Source:

version

Report the current component version string
Source:

version

Component version
Source:

version

Report the current component version string
Source:

version

Component version
Source:

version

Report the current component version string
Source:

(static) observedAttributes

Makes HTML attribute change watched
Source:

(static) observedAttributes

Makes HTML attribute change watched
Source:

(static) observedAttributes

Makes HTML attribute change watched
Source:

Methods

attributeChangedCallback(attrib, oldVal, newVal)

Handle watched attributes NOTE: On initial startup, this is called for each watched attrib set in HTML - BEFORE connectedCallback is called. Attribute values can only ever be strings
Parameters:
Name Type Description
attrib string The name of the attribute that is changing
oldVal string The old value of the attribute
newVal string The new value of the attribute
Source:

attributeChangedCallback(attrib, oldVal, newVal)

Handle watched attributes NOTE: On initial startup, this is called for each watched attrib set in HTML - BEFORE connectedCallback is called. Attribute values can only ever be strings
Parameters:
Name Type Description
attrib string The name of the attribute that is changing
oldVal string The old value of the attribute
newVal string The new value of the attribute
Source:

attributeChangedCallback(attrib, oldVal, newVal)

Handle watched attributes NOTE: On initial startup, this is called for each watched attrib set in HTML - BEFORE connectedCallback is called. Attribute values can only ever be strings
Parameters:
Name Type Description
attrib string The name of the attribute that is changing
oldVal string The old value of the attribute
newVal string The new value of the attribute
Source:

config(config) → {object}

OPTIONAL. Update runtime configuration, return complete config
Parameters:
Name Type Description
config object | undefined If present, partial or full set of options. If undefined, fn returns the current full option settings
Source:
Returns:
The current full option settings
Type
object

config(config) → {object}

OPTIONAL. Update runtime configuration, return complete config
Parameters:
Name Type Description
config object | undefined If present, partial or full set of options. If undefined, fn returns the current full option settings
Source:
Returns:
The current full option settings
Type
object

config(config) → {object}

OPTIONAL. Update runtime configuration, return complete config
Parameters:
Name Type Description
config object | undefined If present, partial or full set of options. If undefined, fn returns the current full option settings
Source:
Returns:
The current full option settings
Type
object

connectedCallback()

Runs when an instance is added to the DOM
Source:

connectedCallback()

Runs when an instance is added to the DOM
Source:

connectedCallback()

Runs when an instance is added to the DOM
Source:

disconnectedCallback()

Runs when an instance is added to the DOM
Source:

disconnectedCallback()

Runs when an instance is added to the DOM
Source:

disconnectedCallback()

Runs when an instance is added to the DOM
Source:

(async) doInheritStyles(url)

Optionally apply an external linked style sheet (called from connectedCallback)
Parameters:
Name Type Description
url * The URL for the linked style sheet
Source:

(async) doInheritStyles(url)

Optionally apply an external linked style sheet (called from connectedCallback)
Parameters:
Name Type Description
url * The URL for the linked style sheet
Source:

(async) doInheritStyles(url)

Optionally apply an external linked style sheet (called from connectedCallback)
Parameters:
Name Type Description
url * The URL for the linked style sheet
Source:

updateState(stateName)

Updates the timeline with a new state
Parameters:
Name Type Description
stateName string Name of the state
Source:

updateState(stateName)

Updates the timeline with a new state
Parameters:
Name Type Description
stateName string Name of the state
Source:

updateState(stateName)

Updates the timeline with a new state
Parameters:
Name Type Description
stateName string Name of the state
Source:

(static) deepAssign(target, …sources) → {object}

Utility object deep merge fn
Parameters:
Name Type Attributes Description
target object Target object to merge into
sources object <repeatable>
Source objects to merge
Source:
Returns:
Deep merged object
Type
object

(static) deepAssign(target, …sources) → {object}

Utility object deep merge fn
Parameters:
Name Type Attributes Description
target object Target object to merge into
sources object <repeatable>
Source objects to merge
Source:
Returns:
Deep merged object
Type
object

(static) deepAssign(target, …sources) → {object}

Utility object deep merge fn
Parameters:
Name Type Attributes Description
target object Target object to merge into
sources object <repeatable>
Source objects to merge
Source:
Returns:
Deep merged object
Type
object

StateTimeline()

new StateTimeline()

NB: Attributes not available here - use connectedCallback to reference
Source:

Members

$ :function

Mini jQuery-like shadow dom selector (see constructor)
Type:
  • function
Source:

$ :function

Mini jQuery-like shadow dom selector (see constructor)
Type:
  • function
Source:

$ :function

Mini jQuery-like shadow dom selector (see constructor)
Type:
  • function
Source:

$$ :function

Mini jQuery-like shadow dom multi-selector (see constructor)
Type:
  • function
Source:

$$ :function

Mini jQuery-like shadow dom multi-selector (see constructor)
Type:
  • function
Source:

$$ :function

Mini jQuery-like shadow dom multi-selector (see constructor)
Type:
  • function
Source:

_iCount

Holds a count of how many instances of this component are on the page Used to ensure a unique id if needing to add one dynamically
Source:

_iCount

Holds a count of how many instances of this component are on the page Used to ensure a unique id if needing to add one dynamically
Source:

_iCount

Holds a count of how many instances of this component are on the page Used to ensure a unique id if needing to add one dynamically
Source:

online

Are we online?
Source:

online

Are we online?
Source:

online

Are we online?
Source:

opts

Runtime configuration settings
Source:

opts

Runtime configuration settings
Source:

opts

Runtime configuration settings
Source:

states :HTMLCollectionOf.<Element>

LIVE ref to all state divs - updates automatically as new states are added
Type:
  • HTMLCollectionOf.<Element>
Source:

states :HTMLCollectionOf.<Element>

LIVE ref to all state divs - updates automatically as new states are added
Type:
  • HTMLCollectionOf.<Element>
Source:

states :HTMLCollectionOf.<Element>

LIVE ref to all state divs - updates automatically as new states are added
Type:
  • HTMLCollectionOf.<Element>
Source:

uib

Is UIBUILDER loaded?
Source:

uib

Is UIBUILDER loaded?
Source:

uib

Is UIBUILDER loaded?
Source:

version

Component version
Source:

version

Report the current component version string
Source:

version

Component version
Source:

version

Report the current component version string
Source:

version

Component version
Source:

version

Report the current component version string
Source:

(static) observedAttributes

Makes HTML attribute change watched
Source:

(static) observedAttributes

Makes HTML attribute change watched
Source:

(static) observedAttributes

Makes HTML attribute change watched
Source:

Methods

attributeChangedCallback(attrib, oldVal, newVal)

Handle watched attributes NOTE: On initial startup, this is called for each watched attrib set in HTML - BEFORE connectedCallback is called. Attribute values can only ever be strings
Parameters:
Name Type Description
attrib string The name of the attribute that is changing
oldVal string The old value of the attribute
newVal string The new value of the attribute
Source:

attributeChangedCallback(attrib, oldVal, newVal)

Handle watched attributes NOTE: On initial startup, this is called for each watched attrib set in HTML - BEFORE connectedCallback is called. Attribute values can only ever be strings
Parameters:
Name Type Description
attrib string The name of the attribute that is changing
oldVal string The old value of the attribute
newVal string The new value of the attribute
Source:

attributeChangedCallback(attrib, oldVal, newVal)

Handle watched attributes NOTE: On initial startup, this is called for each watched attrib set in HTML - BEFORE connectedCallback is called. Attribute values can only ever be strings
Parameters:
Name Type Description
attrib string The name of the attribute that is changing
oldVal string The old value of the attribute
newVal string The new value of the attribute
Source:

config(config) → {object}

OPTIONAL. Update runtime configuration, return complete config
Parameters:
Name Type Description
config object | undefined If present, partial or full set of options. If undefined, fn returns the current full option settings
Source:
Returns:
The current full option settings
Type
object

config(config) → {object}

OPTIONAL. Update runtime configuration, return complete config
Parameters:
Name Type Description
config object | undefined If present, partial or full set of options. If undefined, fn returns the current full option settings
Source:
Returns:
The current full option settings
Type
object

config(config) → {object}

OPTIONAL. Update runtime configuration, return complete config
Parameters:
Name Type Description
config object | undefined If present, partial or full set of options. If undefined, fn returns the current full option settings
Source:
Returns:
The current full option settings
Type
object

connectedCallback()

Runs when an instance is added to the DOM
Source:

connectedCallback()

Runs when an instance is added to the DOM
Source:

connectedCallback()

Runs when an instance is added to the DOM
Source:

disconnectedCallback()

Runs when an instance is added to the DOM
Source:

disconnectedCallback()

Runs when an instance is added to the DOM
Source:

disconnectedCallback()

Runs when an instance is added to the DOM
Source:

(async) doInheritStyles(url)

Optionally apply an external linked style sheet (called from connectedCallback)
Parameters:
Name Type Description
url * The URL for the linked style sheet
Source:

(async) doInheritStyles(url)

Optionally apply an external linked style sheet (called from connectedCallback)
Parameters:
Name Type Description
url * The URL for the linked style sheet
Source:

(async) doInheritStyles(url)

Optionally apply an external linked style sheet (called from connectedCallback)
Parameters:
Name Type Description
url * The URL for the linked style sheet
Source:

updateState(stateName)

Updates the timeline with a new state
Parameters:
Name Type Description
stateName string Name of the state
Source:

updateState(stateName)

Updates the timeline with a new state
Parameters:
Name Type Description
stateName string Name of the state
Source:

updateState(stateName)

Updates the timeline with a new state
Parameters:
Name Type Description
stateName string Name of the state
Source:

(static) deepAssign(target, …sources) → {object}

Utility object deep merge fn
Parameters:
Name Type Attributes Description
target object Target object to merge into
sources object <repeatable>
Source objects to merge
Source:
Returns:
Deep merged object
Type
object

(static) deepAssign(target, …sources) → {object}

Utility object deep merge fn
Parameters:
Name Type Attributes Description
target object Target object to merge into
sources object <repeatable>
Source objects to merge
Source:
Returns:
Deep merged object
Type
object

(static) deepAssign(target, …sources) → {object}

Utility object deep merge fn
Parameters:
Name Type Attributes Description
target object Target object to merge into
sources object <repeatable>
Source objects to merge
Source:
Returns:
Deep merged object
Type
object

StateTimeline()

new StateTimeline()

NB: Attributes not available here - use connectedCallback to reference
Source:

Members

$ :function

Mini jQuery-like shadow dom selector (see constructor)
Type:
  • function
Source:

$ :function

Mini jQuery-like shadow dom selector (see constructor)
Type:
  • function
Source:

$ :function

Mini jQuery-like shadow dom selector (see constructor)
Type:
  • function
Source:

$$ :function

Mini jQuery-like shadow dom multi-selector (see constructor)
Type:
  • function
Source:

$$ :function

Mini jQuery-like shadow dom multi-selector (see constructor)
Type:
  • function
Source:

$$ :function

Mini jQuery-like shadow dom multi-selector (see constructor)
Type:
  • function
Source:

_iCount

Holds a count of how many instances of this component are on the page Used to ensure a unique id if needing to add one dynamically
Source:

_iCount

Holds a count of how many instances of this component are on the page Used to ensure a unique id if needing to add one dynamically
Source:

_iCount

Holds a count of how many instances of this component are on the page Used to ensure a unique id if needing to add one dynamically
Source:

online

Are we online?
Source:

online

Are we online?
Source:

online

Are we online?
Source:

opts

Runtime configuration settings
Source:

opts

Runtime configuration settings
Source:

opts

Runtime configuration settings
Source:

states :HTMLCollectionOf.<Element>

LIVE ref to all state divs - updates automatically as new states are added
Type:
  • HTMLCollectionOf.<Element>
Source:

states :HTMLCollectionOf.<Element>

LIVE ref to all state divs - updates automatically as new states are added
Type:
  • HTMLCollectionOf.<Element>
Source:

states :HTMLCollectionOf.<Element>

LIVE ref to all state divs - updates automatically as new states are added
Type:
  • HTMLCollectionOf.<Element>
Source:

uib

Is UIBUILDER loaded?
Source:

uib

Is UIBUILDER loaded?
Source:

uib

Is UIBUILDER loaded?
Source:

version

Component version
Source:

version

Report the current component version string
Source:

version

Component version
Source:

version

Report the current component version string
Source:

version

Component version
Source:

version

Report the current component version string
Source:

(static) observedAttributes

Makes HTML attribute change watched
Source:

(static) observedAttributes

Makes HTML attribute change watched
Source:

(static) observedAttributes

Makes HTML attribute change watched
Source:

Methods

attributeChangedCallback(attrib, oldVal, newVal)

Handle watched attributes NOTE: On initial startup, this is called for each watched attrib set in HTML - BEFORE connectedCallback is called. Attribute values can only ever be strings
Parameters:
Name Type Description
attrib string The name of the attribute that is changing
oldVal string The old value of the attribute
newVal string The new value of the attribute
Source:

attributeChangedCallback(attrib, oldVal, newVal)

Handle watched attributes NOTE: On initial startup, this is called for each watched attrib set in HTML - BEFORE connectedCallback is called. Attribute values can only ever be strings
Parameters:
Name Type Description
attrib string The name of the attribute that is changing
oldVal string The old value of the attribute
newVal string The new value of the attribute
Source:

attributeChangedCallback(attrib, oldVal, newVal)

Handle watched attributes NOTE: On initial startup, this is called for each watched attrib set in HTML - BEFORE connectedCallback is called. Attribute values can only ever be strings
Parameters:
Name Type Description
attrib string The name of the attribute that is changing
oldVal string The old value of the attribute
newVal string The new value of the attribute
Source:

config(config) → {object}

OPTIONAL. Update runtime configuration, return complete config
Parameters:
Name Type Description
config object | undefined If present, partial or full set of options. If undefined, fn returns the current full option settings
Source:
Returns:
The current full option settings
Type
object

config(config) → {object}

OPTIONAL. Update runtime configuration, return complete config
Parameters:
Name Type Description
config object | undefined If present, partial or full set of options. If undefined, fn returns the current full option settings
Source:
Returns:
The current full option settings
Type
object

config(config) → {object}

OPTIONAL. Update runtime configuration, return complete config
Parameters:
Name Type Description
config object | undefined If present, partial or full set of options. If undefined, fn returns the current full option settings
Source:
Returns:
The current full option settings
Type
object

connectedCallback()

Runs when an instance is added to the DOM
Source:

connectedCallback()

Runs when an instance is added to the DOM
Source:

connectedCallback()

Runs when an instance is added to the DOM
Source:

disconnectedCallback()

Runs when an instance is added to the DOM
Source:

disconnectedCallback()

Runs when an instance is added to the DOM
Source:

disconnectedCallback()

Runs when an instance is added to the DOM
Source:

(async) doInheritStyles(url)

Optionally apply an external linked style sheet (called from connectedCallback)
Parameters:
Name Type Description
url * The URL for the linked style sheet
Source:

(async) doInheritStyles(url)

Optionally apply an external linked style sheet (called from connectedCallback)
Parameters:
Name Type Description
url * The URL for the linked style sheet
Source:

(async) doInheritStyles(url)

Optionally apply an external linked style sheet (called from connectedCallback)
Parameters:
Name Type Description
url * The URL for the linked style sheet
Source:

updateState(stateName)

Updates the timeline with a new state
Parameters:
Name Type Description
stateName string Name of the state
Source:

updateState(stateName)

Updates the timeline with a new state
Parameters:
Name Type Description
stateName string Name of the state
Source:

updateState(stateName)

Updates the timeline with a new state
Parameters:
Name Type Description
stateName string Name of the state
Source:

(static) deepAssign(target, …sources) → {object}

Utility object deep merge fn
Parameters:
Name Type Attributes Description
target object Target object to merge into
sources object <repeatable>
Source objects to merge
Source:
Returns:
Deep merged object
Type
object

(static) deepAssign(target, …sources) → {object}

Utility object deep merge fn
Parameters:
Name Type Attributes Description
target object Target object to merge into
sources object <repeatable>
Source objects to merge
Source:
Returns:
Deep merged object
Type
object

(static) deepAssign(target, …sources) → {object}

Utility object deep merge fn
Parameters:
Name Type Attributes Description
target object Target object to merge into
sources object <repeatable>
Source objects to merge
Source:
Returns:
Deep merged object
Type
object