接口 DOMTokenList

A set of space-separated tokens. Such a set is returned by Element.classList, HTMLLinkElement.relList, HTMLAnchorElement.relList, HTMLAreaElement.relList, HTMLIframeElement.sandbox, or HTMLOutputElement.htmlFor. It is indexed beginning with 0 as with JavaScript Array objects. DOMTokenList is always case-sensitive.

interface DOMTokenList {
    length: number;
    value: string;
    add(...tokens: string[]): void;
    contains(token: string): boolean;
    forEach(callbackfn: ((value: string, key: number, parent: DOMTokenList) => void), thisArg?: any): void;
    item(index: number): null | string;
    remove(...tokens: string[]): void;
    replace(token: string, newToken: string): boolean;
    supports(token: string): boolean;
    toggle(token: string, force?: boolean): boolean;
    toString(): string;
    [index: number]: string;
}

可索引

  • [index: number]: string

属性

length value

方法

add contains forEach item remove replace supports toggle toString

属性

只读length

length: number

Returns the number of tokens.

value

value: string

Returns the associated set as string.

Can be set, to change the associated attribute.

方法

add

  • add(...tokens): void

  • Adds all arguments passed, except those already present.

    Throws a "SyntaxError" DOMException if one of the arguments is the empty string.

    Throws an "InvalidCharacterError" DOMException if one of the arguments contains any ASCII whitespace.

    参数

    • 动态参数...tokens: string[]

    返回 void

contains

  • contains(token): boolean

  • Returns true if token is present, and false otherwise.

    参数

    • token: string

    返回 boolean

forEach

  • forEach(callbackfn, thisArg?): void

  • 参数

    • callbackfn: ((value: string, key: number, parent: DOMTokenList) => void)
        • (value, key, parent): void

        • 参数

          返回 void

    • 可选thisArg: any

    返回 void

item

  • item(index): null | string

  • Returns the token with index index.

    参数

    • index: number

    返回 null | string

remove

  • remove(...tokens): void

  • Removes arguments passed, if they are present.

    Throws a "SyntaxError" DOMException if one of the arguments is the empty string.

    Throws an "InvalidCharacterError" DOMException if one of the arguments contains any ASCII whitespace.

    参数

    • 动态参数...tokens: string[]

    返回 void

replace

  • replace(token, newToken): boolean

  • Replaces token with newToken.

    Returns true if token was replaced with newToken, and false otherwise.

    Throws a "SyntaxError" DOMException if one of the arguments is the empty string.

    Throws an "InvalidCharacterError" DOMException if one of the arguments contains any ASCII whitespace.

    参数

    • token: string
    • newToken: string

    返回 boolean

supports

  • supports(token): boolean

  • Returns true if token is in the associated attribute's supported tokens. Returns false otherwise.

    Throws a TypeError if the associated attribute has no supported tokens defined.

    参数

    • token: string

    返回 boolean

toggle

  • toggle(token, force?): boolean

  • If force is not given, "toggles" token, removing it if it's present and adding it if it's not present. If force is true, adds token (same as add()). If force is false, removes token (same as remove()).

    Returns true if token is now present, and false otherwise.

    Throws a "SyntaxError" DOMException if token is empty.

    Throws an "InvalidCharacterError" DOMException if token contains any spaces.

    参数

    • token: string
    • 可选force: boolean

    返回 boolean

toString

  • toString(): string

  • 返回 string

显示设置

成员可见性

目录

属性
方法