Class BookmarkManager

Manages the bookmarks in the document and in the library. The AnalysisApplication owns an instance of this class and provides it as a service.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Links AddNew Apply CanApply Dispose GetBookmarks GetService Remove SavePrivateCopy Search SetName SetPublicVisibility TryGetBookmark Update

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

Links

  • Gets a collection of methods for retrieving analysis and bookmark uris of different types.

    Returns BookmarkLinks

    Since

    2.0

AddNew

Apply

  • Apply(bookmark): void

  • Applies the specified bookmark to the document.

    Parameters

    Returns void

    Since

    2.0

  • Apply(id): void

  • Applies the bookmark with the specified id on the current document.

    Parameters

    • id: Guid

      The identifier of the bookmark to apply.

    Returns void

    Since

    2.0

  • Apply(bookmark, components): void

  • Applies the components of the specified bookmark to the document.

    Parameters

    Returns void

    Since

    2.0

CanApply

  • CanApply(bookmark): boolean

  • Determines whether all components of the specified bookmark can be fully applied.

    Parameters

    Returns boolean

    True if all components of the bookmark can be applied; otherwise, False.

    Since

    2.0

  • CanApply(bookmark, components): boolean

  • Determines whether the specified components of the bookmark can be fully applied.

    Parameters

    Returns boolean

    True if the specified components of the bookmark can be applied; otherwise False.

    Since

    2.0

Dispose

GetBookmarks

GetService

  • GetService(serviceType): unknown

  • Gets the service of the specified type.

    Parameters

    • serviceType: Type

      The type to get.

    Returns unknown

    The service of the specified type.

    Since

    2.0

  • GetService<TService>(typeTService): JsType<TService>

  • Gets the service of the specified type.

    Type Parameters

    • TService

    Parameters

    Returns JsType<TService>

    The service of the specified type.

    Since

    2.0

Remove

SavePrivateCopy

Search

SetName

SetPublicVisibility

TryGetBookmark

  • TryGetBookmark(id, bookmark): boolean

  • Tries to get the bookmark specified by id.

    Parameters

    Returns boolean

    True if the bookmark exists and was retrieved; otherwise False.

    Since

    2.0

Update

Settings

Member Visibility

On This Page

Methods
Default capability