Class Utilities

Utilities for the HybridForms API

Hierarchy

Utilities

Index

Constructors

Methods

barCodeGenerator copyToClipboard decodeHTML fillOutForm getFromObject guid isDefined qrCodeGenerator requestCounter sanitizeHtml zipHandler

Constructors

constructor

new Utilities(): Utilities
Returns Utilities

Methods

`Static` barCodeGenerator

barCodeGenerator(input: string, format: string, customOptions?: BarcodeOptions): SVGElement
Generate a barcode SVG Element by given input and format

Returns
SVGElement
Parameters
- input: string
  
  string
- format: string
  
  barcode format
- Optional customOptions: BarcodeOptions
  
  custom options overwrite default. See https://github.com/lindell/JsBarcode/wiki/Options
Returns SVGElement

`Static` copyToClipboard

copyToClipboard(value: string, copyContext?: HTMLElement, tooltipEl?: HTMLElement): void
Copy given value to system clipboard
Parameters
- value: string
  
  string
- Optional copyContext: HTMLElement
  
  HTMLElement, parent wrapper of the input to copy
- Optional tooltipEl: HTMLElement
  
  HTMLElement, element to display the tooltip
Returns void

`Static` decodeHTML

decodeHTML(html: string): string
Decodes a given HTML string.

Returns
decoded HTML string
Parameters
- html: string
Returns string

`Static` fillOutForm

fillOutForm(formData: { [key: string]: string | boolean | number }): void
Fill out multiple form fields by given form data object.
Parameters
- formData: { [key: string]: string | boolean | number }
  - [key: string]: string | boolean | number
Returns void

`Static` getFromObject

getFromObject(object: any, path: string, defaultValue?: any): any
Gets the value at path of object. If the resolved value is undefined, the defaultValue is returned in its place.

Returns
Returns the resolved value.
Parameters
- object: any
  
  The object to query.
- path: string
  
  The path of the property to get.
- defaultValue: any = undefined
  
  The value returned for undefined resolved values.
Returns any

`Static` guid

guid(): string
Generates a guid.

Returns string

`Static` isDefined

isDefined(value: any): boolean
Checks if a variable has a value.
Parameters
- value: any
Returns boolean

`Static` qrCodeGenerator

qrCodeGenerator(input: string, size: number, customOptions?: QRCodeOptions): SVGElement
Generate a QR Code SVG Element by given input

Returns
SVGElement
Parameters
- input: string
  
  string
- size: number
  
  SVG size
- Optional customOptions: QRCodeOptions
  
  custom options overwrite default. See https://docs.telerik.com/kendo-ui/api/javascript/dataviz/ui/qrcode
Returns SVGElement

`Static` requestCounter

requestCounter(counterId: string, counterData?: ICounterData): Promise<ICounterResponse>
Return a counter value for a defined counter id. The counter must be registered and activated at the server.

Returns
A promise of type ICounterResponse
Parameters
- counterId: string
  
  The id of the counter you want to request.
- Optional counterData: ICounterData
  
  This is the data that you want to send to request the counter.
Returns Promise<ICounterResponse>

`Static` sanitizeHtml

sanitizeHtml(value: string | Node, options?: Config & { RETURN_DOM?: false; RETURN_DOM_FRAGMENT?: false }): string
Sanitize HTML input to prevent XSS attacks. Supports hf-img tag from HtmlContainer

Returns
clean HTML string
Parameters
- value: string | Node
  
  HTML string or Node to sanitize
- options: Config & { RETURN_DOM?: false; RETURN_DOM_FRAGMENT?: false } = {}
  
  DOMPurify config to tweak sanitizing. https://github.com/cure53/DOMPurify
Returns string

`Static` zipHandler

zipHandler(input?: string, width?: number, height?: number): any
Returns a JSZip node module instance for working with ZIPs
Parameters
- Optional input: string
- Optional width: number
- Optional height: number
Returns any

Class Utilities

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns Utilities

Methods

Static barCodeGenerator

Returns

Parameters

input: string

format: string

Optional customOptions: BarcodeOptions

Returns SVGElement

Static copyToClipboard

Parameters

value: string

Optional copyContext: HTMLElement

Optional tooltipEl: HTMLElement

Returns void

Static decodeHTML

Returns

Parameters

html: string

Returns string

Static fillOutForm

Parameters

formData: { [key: string]: string | boolean | number }

[key: string]: string | boolean | number

Returns void

Static getFromObject

Returns

Parameters

object: any

path: string

defaultValue: any = undefined

Returns any

Static guid

Returns string

Static isDefined

Parameters

value: any

Returns boolean

Static qrCodeGenerator

Returns

Parameters

input: string

size: number

Optional customOptions: QRCodeOptions

Returns SVGElement

Static requestCounter

Returns

Parameters

counterId: string

Optional counterData: ICounterData

Returns Promise<ICounterResponse>

Static sanitizeHtml

Returns

Parameters

value: string | Node

options: Config & { RETURN_DOM?: false; RETURN_DOM_FRAGMENT?: false } = {}

Returns string

Static zipHandler

Parameters

Optional input: string

Optional width: number

Optional height: number

Returns any

Settings

Member Visibility

Theme

`Static` barCodeGenerator

`Optional` customOptions: BarcodeOptions

`Static` copyToClipboard

`Optional` copyContext: HTMLElement

`Optional` tooltipEl: HTMLElement

`Static` decodeHTML

`Static` fillOutForm

`Static` getFromObject

`Static` guid

`Static` isDefined

`Static` qrCodeGenerator

`Optional` customOptions: QRCodeOptions

`Static` requestCounter

`Optional` counterData: ICounterData

`Static` sanitizeHtml

`Static` zipHandler

`Optional` input: string

`Optional` width: number

`Optional` height: number