Bluestep JS Documentation
    Preparing search index...

    Class DocumentThumbnail

    TODO

    TODO
    Index

    Constructors

    constructor

    Methods

    build height html includeLink scaleType transformType width

    Constructors

    Methods

    • Finalizes the builder created by thumbnail(). Without calling this method, you willget no usable results and merely recieve a hash if you try to display it on a page.

      Returns string

    • Sets the height of the display created by thumbnail().

      Parameters

      • height: number

      Returns DocumentThumbnail

    • Determines if you want the result of the thumbnail builder to return html of the documentor not. Passing true to this, (or simply not passing an argument at all) will cause it to give you said html after build() is called. If you pass false or simply do not set this value at all, it will return a relative link to that documentafter build() is called.

      Parameters

      • Optionalcondition: boolean

        if missing, condition is assumed true

      Returns DocumentThumbnail

      javascript// these two are equivalent
      documentField.thumbnail().html(true);
      documentField.thumbnail().html();
      // further, these two are equivalent as well
      documentField.thumbnail().html(false);
      documentField.thumbnail();

    • Determines if a link to the original document should be included after build() is called. This obeys the same true/false behavior as the sibling method: html()

      Parameters

      • Optionalcondition: boolean

      Returns DocumentThumbnail

    • TODO

      Parameters

      • scaleType: string

      Returns DocumentThumbnail

    • TODO

      Parameters

      • transformType: string

      Returns DocumentThumbnail

    • Sets the width of the display created by thumbnail().

      Parameters

      • width: number

      Returns DocumentThumbnail

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods