[ Index ]

PHP Cross Reference of WordPress




/wp-includes/js/dist/ -> annotations.js (summary)

(no description)

File Size: 1132 lines (35 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 28 functions


Functions that are not part of a class:

__webpack_require__(moduleId)   X-Ref
No description

getDefault()   X-Ref
No description

getModuleExports()   X-Ref
No description

applyAnnotations(record, annotations = [])   X-Ref
Applies given annotations to the given record.

param: {Object} record The record to apply annotations to.
param: {Array} annotations The annotation to apply.
return: {Object} A record with the annotations applied.

removeAnnotations(record)   X-Ref
Removes annotations from the given record.

param: {Object} record Record to remove annotations from.
return: {Object} The cleaned record.

retrieveAnnotationPositions(formats)   X-Ref
Retrieves the positions of annotations inside an array of formats.

param: {Array} formats Formats with annotations in there.
return: {Object} ID keyed positions of annotations.

updateAnnotationsWithPositions(annotations, positions, {removeAnnotation,updateAnnotationRange})   X-Ref
Updates annotations in the state based on positions retrieved from RichText.

param: {Array}    annotations                   The annotations that are currently applied.
param: {Array}    positions                     The current positions of the given annotations.
param: {Object}   actions
param: {Function} actions.removeAnnotation      Function to remove an annotation from the state.
param: {Function} actions.updateAnnotationRange Function to update an annotation range in the state.

filterWithReference(collection, predicate)   X-Ref
Filters an array based on the predicate, but keeps the reference the same if
the array hasn't changed.

param: {Array}    collection The collection to filter.
param: {Function} predicate  Function that determines if the item should stay
return: {Array} Filtered array.

isValidAnnotationRange(annotation)   X-Ref
Verifies whether the given annotations is a valid annotation.

param: {Object} annotation The annotation to verify.
return: {boolean} Whether the given annotation is valid.

reducer_annotations(state = {}, action)   X-Ref
Reducer managing annotations.

param: {Object} state  The annotations currently shown in the editor.
param: {Object} action Dispatched action.
return: {Array} Updated state.

__experimentalGetAllAnnotationsForBlock(state, blockClientId)   X-Ref
No description

__experimentalGetAnnotations(state)   X-Ref
Returns all annotations in the editor state.

param: {Object} state Editor state.
return: {Array} All annotations currently applied.

__experimentalAddAnnotation({blockClientId,richTextIdentifier = null,range = null,selector = 'range',source = 'default',id = Object(v4["a" ])   X-Ref
Adds an annotation to a block.

The `block` attribute refers to a block ID that needs to be annotated.
`isBlockAnnotation` controls whether or not the annotation is a block
annotation. The `source` is the source of the annotation, this will be used
to identity groups of annotations.

The `range` property is only relevant if the selector is 'range'.

param: {Object}            annotation                    The annotation to add.
param: {string}            annotation.blockClientId      The blockClientId to add the annotation to.
param: {string}            annotation.richTextIdentifier Identifier for the RichText instance the annotation applies to.
param: {WPAnnotationRange} annotation.range              The range at which to apply this annotation.
param: {string}            [annotation.selector="range"] The way to apply this annotation.
param: {string}            [annotation.source="default"] The source that added the annotation.
param: {string}            [annotation.id]               The ID the annotation should have. Generates a UUID by default.
return: {Object} Action object.

__experimentalRemoveAnnotation(annotationId)   X-Ref
Removes an annotation with a specific ID.

param: {string} annotationId The annotation to remove.
return: {Object} Action object.

__experimentalUpdateAnnotationRange(annotationId, start, end)   X-Ref
Updates the range of an annotation.

param: {string} annotationId ID of the annotation to update.
param: {number} start The start of the new range.
param: {number} end The end of the new range.
return: {Object} Action object.

__experimentalRemoveAnnotationsBySource(source)   X-Ref
Removes all annotations of a specific source.

param: {string} source The source to remove.
return: {Object} Action object.

rng()   X-Ref
No description

validate(uuid)   X-Ref
No description

stringify(arr)   X-Ref
No description

v4(options, buf, offset)   X-Ref
No description

arrayOf( value )   X-Ref
Returns the first argument as the sole entry in an array.

param: {*} value Value to return.
return: {Array} Value returned as entry in array.

isObjectLike( value )   X-Ref
Returns true if the value passed is object-like, or false otherwise. A value
is object-like if it can support property assignment, e.g. object or array.

param: {*} value Value to test.
return: {boolean} Whether value is object-like.

createCache()   X-Ref
Creates and returns a new cache object.

return: {Object} Cache object.

isShallowEqual( a, b, fromIndex )   X-Ref
Returns true if entries within the two arrays are strictly equal by
reference from a starting index.

param: {Array}  a         First array.
param: {Array}  b         Second array.
param: {number} fromIndex Index from which to start comparison.
return: {boolean} Whether arrays are shallowly equal.

getRootCache()   X-Ref
Returns the root cache. If WeakMap is supported, this is assigned to the
root WeakMap cache set, otherwise it is a shared instance of the default
cache object.

return: {(WeakMap|Object)} Root cache object.

getWeakMapCache( dependants )   X-Ref
Returns the cache for a given dependants array. When possible, a WeakMap
will be used to create a unique cache for each set of dependants. This
is feasible due to the nature of WeakMap in allowing garbage collection
to occur on entries where the key object is no longer referenced. Since
WeakMap requires the key to be an object, this is only possible when the
dependant is object-like. The root cache is created as a hierarchy where
each top-level key is the first entry in a dependants set, the value a
WeakMap where each key is the next dependant, and so on. This continues
so long as the dependants are object-like. If no dependants are object-
like, then the cache is shared across all invocations.

param: {Array} dependants Selector dependants.
return: {Object} Cache object.

clear()   X-Ref
Resets root memoization cache.

callSelector( )   X-Ref
The augmented selector call, considering first whether dependants have
changed before passing it to underlying memoize function.

param: {Object} source    Source object for derivation.
param: {...*}   extraArgs Additional arguments to pass to selector.
return: {*} Selector result.

Generated: Sat Sep 25 01:00:04 2021 Cross-referenced by PHPXref 0.7.1