content-quality-get-context-node-id-and-range

Type: Operation

Can be used to get the needed contextNodeId and range when creating you own custom mutation operations for resolving annotations.

Imported operation data

  1. annotationId

    (Required)

    Type: String

    The annotation id for which to get the context node id and range.

  2. [contextNodeIdQuery]

    (Required)

    (Optional) A XPath query to set the contextNodeId to something other then the one set based on the annotation range. The contextNode for the query is set to the range's commonAncestorContainer. The following variables are available in the query: $RANGE_COMMON_ANCESTOR_CONTAINER_ID, $RANGE_START_CONTAINER_ID, $RANGE_START_CONTAINER, $RANGE_START_OFFSET, $RANGE_END_CONTAINER_ID, $RANGE_END_CONTAINER, and $RANGE_END_OFFSET.

Exported operation data

  1. contextNodeId

    Type: NodeId

    The nodeId of the node which is or contains the annotation range. If the annotation is a whole node, the node's nodeId is used, otherwise the range's commonAncestorContainer nodeId is used.

  2. overrideRange

    A range object using node Id's instead of nodes for the start and end containers. Used for overriding the affected range of an operation which usually is the selection range.

  3. range

    Type: Object

    The range object for the annotation. Contains the following properties: commonAncestorContainerId, startContainerId, endContainerId, startOffset, and endOffset.