ng2-fullpage
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • MnFullpageService

Index

Methods

destroy

  • destroy(type: string): void
  • Destroys the plugin events and optionally its HTML markup and styles. Ideal to use when using AJAX to load content.

    type: can be empty or all. If all is passed, the HTML markup and styles used by fullpage.js will be removed. This way the original HTML markup, the one used before any plugin modification is made, will be maintained.

    Parameters

    • type: string

    Returns void

moveSectionDown

  • moveSectionDown(): void

moveSectionUp

  • moveSectionUp(): void

moveSlideLeft

  • moveSlideLeft(): void

moveSlideRight

  • moveSlideRight(): void

moveTo

  • moveTo(section: string | number, slide?: number): void
  • Scrolls the page to the given section and slide. The first slide, the visible one by default, will have index 0.

    Parameters

    • section: string | number
    • Optional slide: number

    Returns void

reBuild

  • reBuild(): void
  • Updates the DOM structure to fit the new window size or its contents. Ideal to use in combination with AJAX calls or external changes in the DOM structure of the site.

    Returns void

setAllowScrolling

  • setAllowScrolling(allow: boolean, directions?: string): void
  • Adds or remove the possibility of scrolling through sections by using the mouse wheel/trackpad or touch gestures (which is active by default). Note this won't disable the keyboard scrolling. You would need to use setKeyboardScrolling for it.

    Directions: (optional parameter) Admitted values: all, up, down, left, right or a combination of them separated by commas like down, right. It defines the direction for which the scrolling will be enabled or disabled.

    Parameters

    • allow: boolean
    • Optional directions: string

    Returns void

setAutoScrolling

  • setAutoScrolling(enable: boolean): void
  • Sets the scrolling configuration in real time. Defines the way the page scrolling behaves. If it is set to true, it will use the "automatic" scrolling, otherwise, it will use the "manual" or "normal" scrolling of the site. Be careful when combining this option with scrollOverflow set to true, as it might be difficult to scroll using the mouse wheel or the trackpad when the section is scrollable

    Parameters

    • enable: boolean

    Returns void

setFitToSection

  • setFitToSection(enable: boolean): void
  • Sets the value for the option fitToSection determining whether to fit the section in the screen or not.

    Parameters

    • enable: boolean

    Returns void

setKeyboardScrolling

  • setKeyboardScrolling(allow: boolean, directions?: string): void
  • Adds or remove the possibility of scrolling through sections by using the keyboard arrow keys (which is active by default).

    Directions: (optional parameter) Admitted values: all, up, down, left, right or a combination of them separated by commas like down, right. It defines the direction for which the scrolling will be enabled or disabled.

    Parameters

    • allow: boolean
    • Optional directions: string

    Returns void

setLockAnchors

  • setLockAnchors(enable: boolean): void
  • Sets the value for the option lockAnchors determining whether anchors will have any effect in the URL or not.

    Parameters

    • enable: boolean

    Returns void

setRecordHistory

  • setRecordHistory(enable: boolean): void

setScrollingSpeed

  • setScrollingSpeed(milliseconds: number): void

silentMoveTo

  • silentMoveTo(section: string | number, slide?: number): void
  • Exactly the same as moveTo but in this case it performs the scroll without animation. A direct jump to the destination.

    Parameters

    • section: string | number
    • Optional slide: number

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc