Class MarkerShapeDefinitions

Class responsible for embedding custom marker shapes in the document.

Since

2.1

Hierarchy (View Summary)

DocumentNode
- MarkerShapeDefinitions

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context IsAttached Transactions Embed ForEachNodeInSubTree ReplaceUsagesInDocument TryGetMarkerShape UpdateEmbeddedShapes

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from DocumentNode.Cast

Equals

Equals(obj: any): 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.

Inherited from DocumentNode.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from DocumentNode.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from DocumentNode.TryCast

`Static`Equals

Equals(objA: any, objB: any): 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.

Inherited from DocumentNode.Equals

Default capability

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

Embed

Embed(shape: CustomShape): MarkerShape
Embeds a custom shape in the document, and returns a Spotfire.Dxp.Application.Visuals.MarkerShape object that can be used to configure visualizations. If the specified shape is already embedded, a corresponding marker shape object is returned.
Parameters
- shape: CustomShape
  The shape to embed.
Returns MarkerShape
A marker shape object that can be used when configuring visualizations.

Remark
This method will also update any embedded shapes that come from another shape collection with same id as the collection the supplied shape comes from. This is because only one version of a shape collection can be used in the document.

Since
2.1

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNode.ForEachNodeInSubTree

ReplaceUsagesInDocument

ReplaceUsagesInDocument(shape: CustomShape, markerShape: MarkerShape): void
Replaces the usage of a custom shape in the document with the specified marker shape.
Parameters
- shape: CustomShape
  The custom shape to replace usages for.
- markerShape: MarkerShape
  The marker shape to use in its place.
Returns void
Since
2.1

TryGetMarkerShape

TryGetMarkerShape(
shape: CustomShape,
markerShape: OutParam<MarkerShape>,
): boolean
Tries to get a marker shape that can be used to configure visualization from a see Spotfire.Dxp.Application.Visuals.Shapes.CustomShape object. If the specified custom shape has not already been embedded, this method will return false.
Parameters
- shape: CustomShape
  The custom shape to get a Spotfire.Dxp.Application.Visuals.MarkerShape for.
- markerShape: OutParam<MarkerShape>
  The resulting marker shape if the shape has already been embedded, otherwise null.
Returns boolean
True if the given marker shape has already been embedded in the document.

Since
2.1

UpdateEmbeddedShapes

UpdateEmbeddedShapes(shapeCollection: CustomShapeCollection): boolean
Updates any embedded shapes that uses a collection with the same id to use shapes from the supplied collection.
Parameters
- shapeCollection: CustomShapeCollection
  The shape collection to update from.
Returns boolean
true if an update was made.

Since
2.1

Class MarkerShapeDefinitions

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

Context

Returns INodeContext

Since

IsAttached

Returns boolean

Since

Transactions

Returns ITransactions

Since

Embed

Parameters

Returns MarkerShape

Remark

Since

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

ReplaceUsagesInDocument

Parameters

Returns void

Since

TryGetMarkerShape

Parameters

Returns boolean

Since

UpdateEmbeddedShapes

Parameters

Returns boolean

Since

Settings

On This Page

`Static`Equals