GramIO API Reference / @gramio/contexts/dist / BackgroundTypePattern
Class: BackgroundTypePattern
Defined in: contexts/index.d.ts:1290
The background is a PNG or TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.
Constructors
Constructor
new BackgroundTypePattern(
payload):BackgroundTypePattern
Defined in: contexts/index.d.ts:1292
Parameters
| Parameter | Type |
|---|---|
payload | TelegramBackgroundTypePattern |
Returns
BackgroundTypePattern
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramBackgroundTypePattern | contexts/index.d.ts:1291 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:1294
Returns
string
document
Get Signature
get document():
DocumentAttachment
Defined in: contexts/index.d.ts:1302
Document with the pattern
Returns
fill
Get Signature
get fill(): typeof
BackgroundFillFreeformGradient| typeofBackgroundFillGradient| typeofBackgroundFillSolid
Defined in: contexts/index.d.ts:1306
The background fill that is combined with the pattern
Returns
typeof BackgroundFillFreeformGradient | typeof BackgroundFillGradient | typeof BackgroundFillSolid
intensity
Get Signature
get intensity():
number
Defined in: contexts/index.d.ts:1310
Intensity of the pattern when it is shown above the filled background; 0-100
Returns
number
isInverted
Get Signature
get isInverted():
true
Defined in: contexts/index.d.ts:1314
Optional. True, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only
Returns
true
isMoving
Get Signature
get isMoving():
true
Defined in: contexts/index.d.ts:1318
Optional. True, if the background moves slightly when the device is tilted
Returns
true
type
Get Signature
get type():
"pattern"
Defined in: contexts/index.d.ts:1298
Type of the background, always “pattern”
Returns
"pattern"