Class NutrientViewer.Annotations.HighlightAnnotation
Class HighlightAnnotation
Class
Example
Create a highlight annotation
var rects = NutrientViewer.Immutable.List([
new NutrientViewer.Geometry.Rect({ left: 10, top: 10, width: 200, height: 10 }),
new NutrientViewer.Geometry.Rect({ left: 10, top: 25, width: 200, height: 10 })
]);
var annotation = new NutrientViewer.Annotations.HighlightAnnotation({
pageIndex: 0,
rects: rects,
boundingBox: NutrientViewer.Geometry.Rect.union(rects)
});
Hierarchy
TextMarkupAnnotationHighlightAnnotation
Constructors
Parameters
optionsPartial<{ … }>Partial<
{
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>Optional
Properties
{ … } | null
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null
| Property | Description |
|---|---|
| onPageClose | |
| onPageHidden | |
| onPageOpen | |
| onPageVisible | |
| onPointerDown | |
| onPointerEnter | |
| onPointerLeave | |
| onPointerUp |
APStreamCache
Optional
{ cache: string } | { attach: string }
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion"
The blend mode defines how the color of the annotation will be applied to its background.
Default Value
"multiply"Position of this annotation on the page. It's necessary that this spans all visible points of the annotation, otherwise hit testing and other features may not work.
canReply
Optional
boolean
canSetGroup
OptionalReadonly
boolean
This property defines whether the user has permission to edit the group of this annotation.
It is only available when collaboration permissions is enabled on Server-Backed deployments.
string | null
The ID of the user who created the annotation, as determined by the
authenticated user (the user_id claim of the JWT) that created it.
Unlike creatorName, which the client supplies, this is assigned by Document Engine from the authenticated session, so a client cannot cause a different author to be recorded. Setting it on an annotation you construct yourself only affects your own copy: it is not serialized, so it never reaches Document Engine or the underlying document.
It requires Instant sync against Document Engine 1.18 or later, and is null on Standalone,
on the deprecated REST provider, against earlier Document Engine versions, and for annotations
created without an authenticated user. It is also null when the server holds an author it
can no longer resolve to an upstream user id, which is indistinguishable from the cases above.
Setting isAnonymous does not
clear it. With Collaboration Permissions configured it is hidden from other users only;
without them it is not hidden at all, which matches how creatorName already behaves.
string | null
The name of the creator of the annotation. This is a general purpose string which can easily be spoofed and might not reflect the actual creator of the annotation.
Annotations can store additional user-specified data.
NutrientViewer will not use or evaluate customData in the UI directly.
You have full control over this property. For new annotations, this defaults to null.
customData will be stored as JSON through JSON.serialize() and JSON.parse(), and
so must be a plain JSON-serializable object.
Example
Adding a new EllipseAnnotation with custom data attached:
const annotation = new NutrientViewer.Annotations.EllipseAnnotation({
pageIndex: 0,
boundingBox: new NutrientViewer.Geometry.Rect({
top: 10,
left: 10,
width: 100,
height: 100
}),
customData: {
circleId: "my-circle"
}
});
group
Optional
string | null
This property is used to define the permission scope for this annotation.
It is only available when collaboration permissions is enabled on Server-Backed deployments.
boolean
If set, do not display or print the annotation or allow it to interact with the user.
Default Value
falsestring
A unique identifier to describe the annotation. When an annotation is created in the UI, the viewer has to generate a unique ID.
When changes are saved to the underlying annotation provider, we call Instance#ensureChangesSaved to make sure the annotation has been persisted from the provider.
boolean
boolean
isDeletable
OptionalReadonly
boolean
This property defines whether this annotation can be deleted or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.
It is only available when collaboration permissions is enabled on Server-Backed deployments.
isEditable
OptionalReadonly
boolean
This property defines whether this annotation can be edited or not. The value of this field depends on the set of collaboration permissions defined in the JWT token.
It is only available when collaboration permissions is enabled on Server-Backed deployments.
boolean
The annotation flag that prevents the annotation from being modified.
Default Value
falseboolean
The annotation flag that prevents the annotation content from being modified.
Default Value
falsestring | null
An optional field that may be used to identify the annotation.
By default, we'll set that to the same value as the automatically generated Annotation#id.
boolean
The annotation flag that prevents the annotation from being printed.
Default Value
falseboolean
string | null
An optional note that can be set on any annotation.
This value is displayed in the Nutrient Web SDK UI for all annotations except NoteAnnotation, TextAnnotation, WidgetAnnotation and CommentMarkerAnnotation.
boolean
The annotation flag that prevents the annotation from being rendered in the UI.
The annotation may still be part of the printed page, depending of the value of the noPrint flag.
Default Value
falseboolean
number
A transparency value that is applied to the complete annotation. The value is capped between 0 and 1 inclusive.
Default Value
1number
The page index on which the annotation is placed. It's important to notice that an annotation can only ever be on one page. If you create for example an ink annotation with lines on two pages, two annotation records will be created.
pageIndex is zero-based and has a maximum value of totalPageCount - 1.
number | null
When the annotation is extracted directly from a PDF file, the pdfObjectId refers to the
identifier that was used in the PDF document.
This ID is optional since newly created annotations using the SYNCProvider annotation provider
won't have a pdfObjectId assigned.
Default Value
nullA list of rects where the annotation is drawn. This is necessary to display a markup annotation on multiple lines.
The boundingBox should be set to the union of this list.
Default Value
NutrientViewer.Immutable.List() Empty listnumber
string | null
An optional annotation subject, representing a short description of the subject being addressed by the annotation. This property has no effect on the annotation rendering.
className
Static
string
readableName
Static
string
Immutable Record API
24
asImmutable
Deprecated
- Deprecated
Returns
thisDeprecated
Not part of the collection API the Nutrient Web SDK supports. Build the value once, or use withMutations().
See Also
Map#asImmutable
asMutable
Deprecated
- Deprecated
Returns
thisDeprecated
Not part of the collection API the Nutrient Web SDK supports. Use withMutations().
See Also
Map#asMutable
Returns a new instance of this Record type with all values set to their default values.
Returns
this
delete<K extends keyof { … }>(key: K): thisdelete<
K extends
keyof {
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>(
key: K,
): thisReturns a new instance of this Record type with the value for the specific key set to its default value.
Type Parameters
Kextends keyof { … }extends keyof {
action: NutrientViewer.Actions.Action | null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
}Parameters
keyKReturns
this
Returns a new instance of this Record type with the value at the given key path removed.
Also available as
removeIn.Parameters
keyPathIterable<unknown>Returns
this
Parameters
otherunknownReturns
boolean
get<K extends keyof { … }>(key: K): { … }[K]get<
K extends
keyof {
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>(
key: K,
): {
action: NutrientViewer.Actions.Action | null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
}[K]Returns the value associated with the provided key, which may be the default value defined when creating the Record factory function.
If the requested key is not defined by this Record type, then notSetValue will be returned if provided. Note that this scenario would produce an error when using Flow or TypeScript.
Type Parameters
Kextends keyof { … }extends keyof {
action: NutrientViewer.Actions.Action | null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
}Parameters
keyKReturns
{ … }[K]{
action: NutrientViewer.Actions.Action | null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
}[K]
Parameters
keyPathIterable<unknown>notSetValueunknownOptionalReturns
unknown
Parameters
keyunknownReturns
boolean
merge(...collections: Partial<{ … }>[]): thismerge(
...collections: Partial<
{
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>[],
): thisParameters
...collectionsPartial<{ … }>[]Partial<
{
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>[]Returns
this
mergeDeep(
...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeep(
...collections: (
| Iterable<[string, unknown], any, any>
| Partial<
{
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>
)[],
): thisParameters
...collections(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
| Iterable<[string, unknown], any, any>
| Partial<
{
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>
)[]Returns
this
mergeDeepIn(
keyPath: Iterable<unknown>,
...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeepIn(
keyPath: Iterable<unknown>,
...collections: (
| Iterable<[string, unknown], any, any>
| Partial<
{
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>
)[],
): thisParameters
keyPathIterable<unknown>...collections(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
| Iterable<[string, unknown], any, any>
| Partial<
{
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>
)[]Returns
this
mergeDeepWith(
merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeDeepWith(
merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
...collections: (
| Iterable<[string, unknown], any, any>
| Partial<
{
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>
)[],
): thisParameters
merger(previous?: unknown, next?: unknown, key?: string) => unknown...collections(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
| Iterable<[string, unknown], any, any>
| Partial<
{
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>
)[]Returns
this
mergeIn
Deprecated
mergeIn(
keyPath: Iterable<unknown>,
...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeIn(
keyPath: Iterable<unknown>,
...collections: (
| Iterable<[string, unknown], any, any>
| Partial<
{
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>
)[],
): thisDeprecatedParameters
keyPathIterable<unknown>...collections(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
| Iterable<[string, unknown], any, any>
| Partial<
{
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>
)[]Returns
thisDeprecated
Not part of the collection API the Nutrient Web SDK supports. Use update() followed by merge().
mergeWith(
merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
...collections: (Iterable<[string, unknown], any, any> | Partial<{ … }>)[],
): thismergeWith(
merger: (previous?: unknown, next?: unknown, key?: string) => unknown,
...collections: (
| Iterable<[string, unknown], any, any>
| Partial<
{
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>
)[],
): thisParameters
merger(previous?: unknown, next?: unknown, key?: string) => unknown...collections(Iterable<[string, unknown], any, any> | Partial<{ … }>)[](
| Iterable<[string, unknown], any, any>
| Partial<
{
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>
)[]Returns
this
removeIn
Deprecated
- Deprecated
Parameters
keyPathIterable<unknown>Returns
thisDeprecated
Not part of the collection API the Nutrient Web SDK supports. Use deleteIn(), or update() followed by delete().
set<K extends keyof { … }>(key: K, value: { … }[K]): thisset<
K extends
keyof {
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>(
key: K,
value: {
action: NutrientViewer.Actions.Action | null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
}[K],
): thisType Parameters
Kextends keyof { … }extends keyof {
action: NutrientViewer.Actions.Action | null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
}Parameters
keyKvalue{ … }[K]{
action: NutrientViewer.Actions.Action | null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
}[K]Returns
this
Parameters
keyPathIterable<unknown>valueunknownReturns
this
toJS(): { … }toJS(): {
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
}Deeply converts this Record to equivalent native JavaScript Object.
Note: This method may not be overridden. Objects with custom serialization to plain JS may override toJSON() instead.
Returns
{ … }{
action: NutrientViewer.Actions.Action | null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
}
toJSON(): { … }toJSON(): {
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
}Shallowly converts this Record to equivalent native JavaScript Object.
Returns
{ … }{
action: NutrientViewer.Actions.Action | null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
}
toSeq
Deprecated
- Deprecated
Returns
Keyed<string, unknown>Deprecated
Not part of the collection API the Nutrient Web SDK supports. Use entries().
update<K extends keyof { … }>(
key: K,
updater: (value: { … }[K]) => { … }[K],
): thisupdate<
K extends
keyof {
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
},
>(
key: K,
updater: (
value: {
action: NutrientViewer.Actions.Action | null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
}[K],
) => {
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
}[K],
): thisType Parameters
Kextends keyof { … }extends keyof {
action: NutrientViewer.Actions.Action | null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
}Parameters
keyKupdater(value: { … }[K]) => { … }[K](
value: {
action: NutrientViewer.Actions.Action | null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
}[K],
) => {
action: NutrientViewer.Actions.Action
| null;
additionalActions:
| {
onPageClose?: NutrientViewer.Actions.Action;
onPageHidden?: NutrientViewer.Actions.Action;
onPageOpen?: NutrientViewer.Actions.Action;
onPageVisible?: NutrientViewer.Actions.Action;
onPointerDown?: NutrientViewer.Actions.Action;
onPointerEnter?: NutrientViewer.Actions.Action;
onPointerLeave?: NutrientViewer.Actions.Action;
onPointerUp?: NutrientViewer.Actions.Action;
}
| null;
APStreamCache: { cache: string }
| { attach: string }
| undefined;
blendMode:
| "normal"
| "multiply"
| "screen"
| "overlay"
| "darken"
| "lighten"
| "colorDodge"
| "colorBurn"
| "hardLight"
| "softLight"
| "difference"
| "exclusion";
boundingBox: NutrientViewer.Geometry.Rect
| null;
canReply: boolean | undefined;
canSetGroup: boolean | undefined;
color: NutrientViewer.Color;
createdAt: Date | null;
createdBy: string | null;
creatorName: string | null;
customData: Record<string, unknown> | null;
enrichment: AnnotationEnrichmentJSON | null | undefined;
group: string | null | undefined;
hidden: boolean | null;
id: string | null;
isAnonymous: boolean;
isCommentThreadRoot: boolean;
isDeletable: boolean | undefined;
isEditable: boolean | undefined;
locked: boolean | null;
lockedContents: boolean | null;
name: string | null;
noPrint: boolean | null;
noRotate: boolean;
note: string | null;
noView: boolean | null;
noZoom: boolean;
opacity: number | null;
pageIndex: number | null;
pdfObjectId: number | null;
readOnly: boolean | null;
rects: NutrientViewer.Immutable.List<NutrientViewer.Geometry.Rect>;
rotation: number;
subject: string | null;
updatedAt: Date | null;
[key: string]: unknown;
}[K]Returns
this
Note: Not all methods can be used on a mutable collection or within
withMutations! Onlysetmay be used mutatively.Parameters
mutator(mutable: this) => unknownReturns
thisSee Also
Map#withMutations
A highlight markup annotation. Please refer to NutrientViewer.Annotations.MarkupAnnotation for more information.