Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

VariantsAPI

• webVis API Reference
• VariantsAPI

Interface VariantsAPI

interface VariantsAPI {
    isNodePartOfEnabledVariant(nodeId: number): Promise<boolean>;
    requestVariants(nodeId: number): Promise<VariantProperties[]>;
    setVariantEnabled(variant: number, enabled: boolean): Promise<void>;
}

Hierarchy (View Summary)

• VariantsAPI
  • ContextAPI

Index

Methods

isNodePartOfEnabledVariant requestVariants setVariantEnabled

Methods

isNodePartOfEnabledVariant

• isNodePartOfEnabledVariant(nodeId: number): Promise<boolean>

• Parameters

  • nodeId: number

    The ID of the Node.

  Returns Promise<boolean>

  True, if the Node is Part of an enabled Variant. False otherwise.

requestVariants

• requestVariants(nodeId: number): Promise<VariantProperties[]>

• Parameters

  • nodeId: number

    The ID of the Node.

  Returns Promise<VariantProperties[]>

  The Variant(s) for a given nodeID.

setVariantEnabled

• setVariantEnabled(variant: number, enabled: boolean): Promise<void>

• Enables or disables a given Variant.

  Parameters

  • variant: number

    The ID of the Variant.
  • enabled: boolean

    The enabled state.

  Returns Promise<void>