Skip to content

Latest commit

 

History

History
65 lines (37 loc) · 2.02 KB

constructor.md

File metadata and controls

65 lines (37 loc) · 2.02 KB

NDanmaku构造方法

new NDanmaku(container, prefix = '', zIndex = 'auto')
  • container - 弹幕容器元素,可以是一个字符串(元素的id),也可以是一个DOM元素对象

  • prefix - 容器弹幕的前缀,默认为空。

  • zIndex - 上述容器将被设置的z-index值,默认为auto

container

取值为DOM元素对象或者DOM元素的id

弹幕将会在这个元素内进行创建,因此咱们也称其为“弹幕的容器”。

此参数已经在README中说明过了,这里不再赘述。

prefix

  • 默认值: ''

取值为可以用作DOM元素的id字符串。

prefix取值不为空时,程序将会给每一条弹幕的DOM元素设置一个唯一的id,这个id的格式如下:

N-danmaku-{prefix}-{弹幕的唯一id}

举个栗子:

  • 创建对象时没有设置prefix

    const demo_1 = new NDanmaku('demo-1');

    20220817211158-2022-08-17

    可以看到弹幕元素并没有id属性。


  • 创建对象时设置prefixtest

    const demo_1 = new NDanmaku('demo-1', 'test');

    20220817211440-2022-08-17

    可以看到此时弹幕元素idN-danmaku-test-0

zIndex

  • 默认值: 'auto'

这个参数的取值CSS中的z-index属性是一致的。

在对象创建后,程序会在container元素中创建一个div元素,作为该容器的弹幕层。紧接着,程序会将该弹幕层的样式的z-index属性为本参数的值。

当弹幕层元素受容器中其他层元素遮挡时,这个参数非常有用。