Some test text!
Web / Guides / Strikeout
Strikeout annotations are annotations that draw a strikeout line through text.
Text strikeout annotations use the stroke color as the strikeout color. Setting a fill color will have no visual impact on the annotation by default.
WebViewer(...)
.then(instance => {
const { documentViewer, annotationManager, Annotations } = instance.Core;
let debounce = null;
// Automatically create strikeout annotations on text selection
documentViewer.addEventListener('textSelected', (quads, text, pageNumber) => {
// Add some debouncing to prevent constant triggering during selection
if (debounce) {
clearTimeout(debounce);
}
debounce = setTimeout(() => {
// Create annotation with object initializer
const annot = new Annotations.TextStrikeoutAnnotation({
PageNumber: pageNumber,
Quads: quads,
StrokeColor: new Annotations.Color(0, 0, 255, 1),
StrokeThickness: 3,
});
annotationManager.addAnnotation(annot);
annotationManager.redrawAnnotation(annot);
debounce = null;
}, 1000);
});
});
Element name: strikeout
<strikeout page="1" rect="36,677.030,265.128,704.526" color="#E44234" flags="print" name="5e9acb3f-e851-416d-35a1-66f5601550c3" title="Guest" subject="Strikeout" date="D:20220517174415-07'00'" creationdate="D:20220517174414-07'00'" coords="36,704.526105859375,265.12800000000016,704.526105859375,36,693.02635,265.12800000000016,693.02635,36,688.530105859375,96.60000000000001,688.530105859375,36,677.03035,96.60000000000001,677.03035">
<trn-custom-data bytes="{"trn-annot-preview":"You plan to embed PDF functionality into an\napplication."}"/>
</strikeout>
Gets or sets the page number of a document that the annotation appears on.
Gets of sets the text quads of the annotation. Since text annotations can span multiple lines of text, the lines of text are represented with an array of quads.
For the full list of properties, please visit the annotation's API docs.
Gets or sets the color of the annotation's stroke.
Gets or sets the width of the annotation's stroke outline.
The author of the annotation.
Gets or sets the annotation's stroke color.
Gets or sets whether the annotation is hidden.
Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use "Hidden".
Gets or sets whether any parts of the annotation drawn outside of the rect are clickable.
Gets or sets whether the annotation should be listed in annotation lists. If set to false, the annotation will also become unselectable.
Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited.
Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted.
Gets or sets if this annotation can be deleted.
Gets or sets whether or not the annotation can be moved.
Gets or sets if this annotation can be resized by the user.
Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set.
Gets or sets the opacity of the annotation.
Gets or sets whether the annotation should be displayed when printing the page.
Gets or sets whether the annotation is readonly or not. If it's readonly both the annotation itself and its note can't be edited or deleted.
Gets or sets whether the ToggleNoView flag is set on the annotation.
Although it is possible to get the quads using the Quads
property, there is also a getQuads
method on the annotation to get its quads.
console.log(strikeout.getQuads());
[
{ // First quad of the first line
"x1":58.24,
"y1":98.97,
"x2":265.13,
"y2":98.97,
"x3":265.13,
"y3":87.47,
"x4":58.25,
"y4":87.47
},
... // Second quad of the second line and so on
]
Using the setQuads
API can be used to set the quads for the annotation as well.
WebViewer(...)
.then(instance => {
const { annotationManager, Annotations } = instance.Core;
annotationManager.addEventListener('annotationChanged', (annotations, action) => {
if (annotations.length > 0 && action === 'add') {
annotations.forEach(annot => {
if (annot instanceof Annotations.TextStrikeoutAnnotation) {
const quads = annot.getQuads();
quads.forEach(quad => {
quad.x1 = Math.round(quad.x1 * 100) / 100;
quad.y1 = Math.round(quad.y1 * 100) / 100;
});
annot.setQuads(quads);
}
});
}
});
});
Trial setup questions? Ask experts on Discord
Need other help? Contact Support
Pricing or product questions? Contact Sales