processBoxShadow

[ Function ]

public static processBoxShadow(
    element: JQuery | HTMLElement[] | NodeListOf<HTMLElement> | HTMLCollectionOf<HTMLElement> | HTMLElement | undefined,
    valueNew: TcHmi.BoxShadow[] | null | undefined
): void;

Sets the shadow for one or more HTML elements.

Parameter

Name

Type

Description

element

Info: Type HTMLElement supported from version 1.10
Info: Types HTMLElement[] | NodeListOf<HTMLElement> | HTMLCollectionOf<HTMLElement> from version 1.10.1171.21

JQuery, HTMLElement[], NodeListOf<HTMLElement>, HTMLCollectionOf<HTMLElement>, HTMLElement, undefined

  • jQuery collection with the elements to be changed
  • any array-like element list (also for example from document.querySelectorAll() or document.getElementsByClassName())
  • single HTML element

valueNew

TcHmi.BoxShadow[], null, undefined

Object for the shadow.

Return value

Type

Description

void

No return value

processBoxShadow 1:

Available from 1.8

Sample - JavaScript

var newElem = $('<div class="testdiv"></div>');
TcHmi.StyleProvider.processBoxShadow(newElem, 
    [{
        blur: 5.0, 
        blurUnit: 'px', 
        color: { color: 'rgba(0, 0, 0, 0.6)' }, 
        offsetX: 0.0, 
        offsetXUnit: 'px', 
        offsetY: 0.0, 
        offsetYUnit: 'px', 
        spread: 0.0, 
        spreadUnit: 'px'
    }]
);