Options
All
  • Public
  • Public/Protected
  • All
Menu

This class is a subclass of QRCode and is used to generate a WiFi QR-code element

Hierarchy

Index

Constructors

constructor

  • new WiFiQRCode(name: string, ssid: string, wifiEncryption: string, wifiPassword?: string, wifiHidden?: boolean): WiFiQRCode
  • Parameters

    • name: string

      The name of this Code object (Cloud Office Print tag)

    • ssid: string

      The ssid of the WiFi

    • wifiEncryption: string

      The encryption type

    • Optional wifiPassword: string

      The WiFi password Optional.

    • Optional wifiHidden: boolean

      Whether or not the WiFi is hidden. Optional.

    Returns WiFiQRCode

Properties

autoColor

autoColor: undefined | boolean

autoColorDark

autoColorDark: undefined | string

autoColorLight

autoColorLight: undefined | string

backgroundImage

backgroundImage: undefined | string

backgroundImageAlpha

backgroundImageAlpha: undefined | number

colorDark

colorDark: undefined | string

colorLight

colorLight: undefined | string

data

data: string

dotscale

dotscale: undefined | number

logo

logo: undefined | string

logoBackgroundColor

logoBackgroundColor: undefined | string

logoHeight

logoHeight: undefined | string | number

logoWidth

logoWidth: undefined | string | number

name

name: string

piBlColor

piBlColor: undefined | string

piColor

piColor: undefined | string

piTlColor

piTlColor: undefined | string

piTrColor

piTrColor: undefined | string

poBlColor

poBlColor: undefined | string

poColor

poColor: undefined | string

poTlColor

poTlColor: undefined | string

poTrColor

poTrColor: undefined | string

quietZone

quietZone: undefined | number

quietZoneColor

quietZoneColor: undefined | string

timingColor

timingColor: undefined | string

timingHColor

timingHColor: undefined | string

timingVColor

timingVColor: undefined | string

type

type: string

wifiEncryption

wifiEncryption: string

wifiHidden

wifiHidden: undefined | boolean

wifiPassword

wifiPassword: undefined | string

Methods

asDict

  • asDict(): {}
  • The dict representation of this object

    Returns {}

    dict representation of this object

    • [key: string]: string | number | boolean

asDictSuffixes

  • asDictSuffixes(): {}
  • Get the suffixes that need to be appended to the keys of the dict representation of this Code object.

    Returns {}

    the suffixes that need to be appended to the keys of the dict representation of this Code object

    • [key: string]: string | number | boolean

availableTags

  • availableTags(): Set<string>

setAutoColor

  • setAutoColor(autoColor: boolean): void

setAutoColorDark

  • setAutoColorDark(autoColorDark: string): void
  • Parameters

    • autoColorDark: string

      Automatic color: dark CSS color (only required when qr_auto_color is set true) (dark color prefered, otherwise may lead to undetectable QR)

    Returns void

setAutoColorLight

  • setAutoColorLight(autoColorLight: string): void

setBackgroundImage

  • setBackgroundImage(backgroundImage: string): void

setBackgroundImageAlpha

  • setBackgroundImageAlpha(backgroundImageAlpha: number): void

setColorDark

  • setColorDark(colorDark: string): void

setColorLight

  • setColorLight(colorLight: string): void

setDotscale

  • setDotscale(dotscale: number): void

setLogo

  • setLogo(logo: string): void

setLogoBackgroundColor

  • setLogoBackgroundColor(logoBackgroundColor: string): void

setLogoHeight

  • setLogoHeight(logoHeight: string | number): void

setLogoWidth

  • setLogoWidth(logoWidth: string | number): void

setPiBlColor

  • setPiBlColor(piBlColor: string): void

setPiColor

  • setPiColor(piColor: string): void

setPiTlColor

  • setPiTlColor(piTlColor: string): void

setPiTrColor

  • setPiTrColor(piTrColor: string): void

setPoBlColor

  • setPoBlColor(poBlColor: string): void

setPoColor

  • setPoColor(poColor: string): void

setPoTlColor

  • setPoTlColor(poTlColor: string): void

setPoTrColor

  • setPoTrColor(poTrColor: string): void

setQuietZone

  • setQuietZone(quietZone: number): void

setQuietZoneColor

  • setQuietZoneColor(quietZoneColor: string): void

setTimingColor

  • setTimingColor(timingColor: string): void

setTimingHColor

  • setTimingHColor(timingHColor: string): void

setTimingVColor

  • setTimingVColor(timingVColor: string): void

Generated using TypeDoc