WrappedDOMElement | SiteKiosk Online API

Index

Properties

Methods

activate? closeCallback? closeOverlay deactivate? getChildren getDataBindingContext getDomElement getParent getPropertyValue hide onBeforeAction replacePropertyPlaceholders set setPropertyValue show showAsOverlay trigger

Properties

name

name: string

The DOM elements ID

Methods

`Optional` activate

activate(): void
Returns void

`Optional` closeCallback

closeCallback(result?: any): void
Parameters
- Optional result: any
Returns void

closeOverlay

closeOverlay(): void
Closes the overlay.

Returns void

`Optional` deactivate

deactivate(): void
Returns void

getChildren

getChildren(): any[]
Returns the elements children.

Returns any[]

getDataBindingContext

getDataBindingContext(dataSourceName: string): Object
Returns the elements data binding context.
Parameters
- dataSourceName: string
  
  The data sources name.
Returns Object

getDomElement

getDomElement(): any
Returns the DOM element.

Returns any

getParent

getParent(): any
Returns the elements parent.

Returns any

getPropertyValue

getPropertyValue(propertyName: string): any
Returns the properties value.
Parameters
- propertyName: string
  
  The property name.
Returns any

hide

hide(forceHide?: boolean): void
Hides the element.
Parameters
- Optional forceHide: boolean
  
  Whether the hide should be forced.
Returns void

onBeforeAction

onBeforeAction(handler: (() => void)): void
Executes the handler on before element action.
Parameters
- handler: (() => void)
  
  The handler.
  - - (): void
    - Returns void
Returns void

replacePropertyPlaceholders

replacePropertyPlaceholders(propertyName: string, placeholderValues: Object): void
Replces all given placeholders of a property.
Parameters
- propertyName: string
  
  The property name. E.g.: "text"
- placeholderValues: Object
  
  The placeholder ({$myPlaceholder}) replacement object. E.g.: {myPlaceholder: "My new content"}
Returns void

set

set(path: string, value: any): void
Sets the properties value.
Parameters
- path: string
  
  The property path.
- value: any
  
  The property value.
Returns void

setPropertyValue

setPropertyValue(name: string, value: any): void
Sets the properties value.
Parameters
- name: string
  
  The property name.
- value: any
  
  The property value.
Returns void

show

show(forceShow?: boolean): void
Un-hides the element.
Parameters
- Optional forceShow: boolean
  
  Whether the un-hide should be forced.
Returns void

showAsOverlay

showAsOverlay(): void
Shows the element as overlay.

Returns void

trigger

trigger(param?: string | number): void
Executes the actions of an action block element, does nothing if the element is not an action block.
Parameters
- Optional param: string | number
  
  optional parameter that can be used inside the action block
Returns void

Generated using TypeDoc