Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NavigationComponent

class

NavigationComponent

classdesc

Fallback navigation component for environments without WebGL support.

Replaces the functionality in the Direction and Sequence components.

Hierarchy

  • Component<IComponentConfiguration>
    • NavigationComponent

Index

Properties

Static componentName

componentName: string = "navigation"

Accessors

activated

  • get activated(): boolean

defaultConfiguration

  • get defaultConfiguration(): IComponentConfiguration
  • Get default configuration.

    Returns IComponentConfiguration

    Default configuration for component.

name

  • get name(): string
  • Get name.

    description

    The name of the component. Used when interacting with the component through the Viewer's API.

    Returns string

Methods

activate

  • activate(conf?: IComponentConfiguration): void
  • Parameters

    • Optional conf: IComponentConfiguration

    Returns void

configure

  • configure(conf: IComponentConfiguration): void
  • Parameters

    • conf: IComponentConfiguration

    Returns void

deactivate

  • deactivate(): void

fire

  • fire(eventType: string, data: any): void
  • Parameters

    • eventType: string
    • data: any

    Returns void

off

  • off(eventType: string, fn: any): void
  • Unsubscribe from an event by its name.

    Parameters

    • eventType: string

      The name of the event to subscribe to.

    • fn: any

      The handler to remove.

    Returns void

on

  • on(eventType: string, fn: any): void
  • Subscribe to an event by its name.

    Parameters

    • eventType: string

      The name of the event to subscribe to.

    • fn: any

      The handler called when the event occurs.

    Returns void

Generated using TypeDoc