VariantsAPI

• webVis API Reference
• VariantsAPI

Interface VariantsAPI

Hierarchy

• VariantsAPI
  • ContextAPI

Index

Methods

isNodePartOfEnabledVariant requestVariants setVariantEnabled

Methods

isNodePartOfEnabledVariant

• isNodePartOfEnabledVariant(nodeId): 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): Promise<VariantProperties[]>

• Parameters

  • nodeId: number

    The ID of the Node.

  Returns Promise<VariantProperties[]>

  The Variant(s) for a given nodeID.

setVariantEnabled

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

• Enables or disables a given Variant.

  Parameters

  • variant: number

    The ID of the Variant.

  • enabled: boolean

    The enabled state.

  Returns Promise<void>