processBackground

[ Function ]

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

Sets multiple background properties 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.Background, null

Complex object for the background color and the background image.

Return value

Type

Description

void

No return value

processBackground 1:

Available from 1.8

Sample - JavaScript

var newElem = $('<div class="testdiv"></div>');
TcHmi.StyleProvider.processBackground(newElem, 
    {
        color: {color: 'red'},
        image: null,
        imageWidth: null,
        imageWidthUnit: 'px',
        imageHeight: null,
        imageHeightUnit: 'px',
        imageHorizontalAlignment: 'Center',
        imageVerticalAlignment: 'Center',
        imagePadding: null
    }
);