Action
    Preparing search index...

    Class ModLayerCollection

    A collection of Spotfire.Dxp.Application.Mods.ModLayers in a Spotfire.Dxp.Application.Mods.ModVisualization.

    2.4

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    [iterator] Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Item Context Count IsAttached Transactions AddLayer Clear ForEachNodeInSubTree Move Remove RemoveAll RemoveAt TryGetLayer

    Methods

    • 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

    • 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.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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 T1 | null

    • 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

    Item: PropertyGet<number | Int32, ModLayer>

    Gets the Spotfire.Dxp.Application.Mods.ModLayer at the specified index.

    The zero-based index for the item to retrieve.

    The Spotfire.Dxp.Application.Mods.ModLayer at the specified index.

    2.4

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get Count(): number

      Gets the number of layers.

      Returns number

      2.4

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get Transactions(): ITransactions

      Gets a collection of methods for executing transactions on the document.

      Returns ITransactions

      2.0

    • Adds a layer of the specified type layerType to the visualization.

      Parameters

      • layerType: string | String

        The type of the layer, as defined the mod manifest.

      • Optionaltitle: string | String | null

        A title expression for the layer, or null for automatic title.

      Returns ModLayer

      The mod layer.

      2.4

    • Removes all layers.

      Returns void

      2.4

    • Move the layer from index fromIndex to index toIndex.

      Parameters

      • fromIndex: number | Int32

        The index of the layer to move.

      • toIndex: number | Int32

        The destination to move the layer to.

      Returns void

      2.4

    • Move the specified layer to index toIndex.

      Parameters

      • layer: ModLayer

        A layer in the collection.

      • toIndex: number | Int32

        The destination to move the layer to.

      Returns boolean

      true if the layer could be found in the collection, otherwise false.

      2.4

    • Removes the specified layer.

      Parameters

      Returns void

      2.4

    • Removes all the layers that match the specified predicate.

      Parameters

      • match: Predicate<ModLayer>

        The predicate that defines the conditions of the elements to remove.

      Returns void

      2.4

    • Removes the layer at the specified index.

      Parameters

      • index: number | Int32

        The zero-based index of the item to remove.

      Returns void

      2.4

    • Tries to get the layer with the specified id.

      Parameters

      • id: Guid

        The id of the layer.

      • layer: OutParam<ModLayer>

        The layer if it could be found, otherwise null.

      Returns boolean

      true if a layer with the specified id could be found, otherwise false.

      2.4

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability