@itwin/core-common 5.1.0-dev.61 → 5.1.0-dev.64

package/lib/cjs/annotation/TextBlock.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextBlock.js","sourceRoot":"","sources":["../../../src/annotation/TextBlock.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAoDH;;;GAGG;AACH,MAAsB,kBAAkB;IAC9B,UAAU,CAAS;IACnB,eAAe,CAAyB;IAEhD,gBAAgB;IAChB,YAAsB,KAA8B;QAClD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,eAAe,GAAG,EAAE,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC;IACrD,CAAC;IAED;;;OAGG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,IAAW,SAAS,CAAC,SAAiB;QACpC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED,IAAW,cAAc,CAAC,SAAiC;QACzD,IAAI,CAAC,eAAe,GAAG,EAAE,GAAG,SAAS,EAAE,CAAC;IAC1C,CAAC;IAED,8EAA8E;IACvE,mBAAmB;QACxB,IAAI,CAAC,cAAc,GAAG,EAAG,CAAC;IAC5B,CAAC;IAED,oKAAoK;IAC7J,UAAU,CAAC,SAAiB,EAAE,OAA+B;QAClE,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAE5B,IAAI,CAAC,CAAC,OAAO,EAAE,iBAAiB,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,4GAA4G;IAC5G,IAAW,cAAc;QACvB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACrD,CAAC;IAQD;;;MAGE;IACF,IAAW,YAAY;QACrB,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IAAA,CAAC;IAEF,yDAAyD;IAClD,MAAM;QACX,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,cAAc,EAAE,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE;SAC3C,CAAC;IACJ,CAAC;IAED,uDAAuD;IAChD,MAAM,CAAC,KAAyB;QACrC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAChD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAClD,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;YAC1E,OAAO,KAAK,CAAC;QACf,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,MAAM,GAAG,GAAG,IAAoC,CAAC;YACjD,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC3D,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA5FD,gDA4FC;AAaD;;;;GAIG;AACH,IAAiB,GAAG,CAYnB;AAZD,WAAiB,GAAG;IAClB;;OAEG;IACH,SAAgB,QAAQ,CAAC,KAAe;QACtC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,MAAM,CAAC,CAAC,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC1C,KAAK,UAAU,CAAC,CAAC,OAAO,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAClD,KAAK,KAAK,CAAC,CAAC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACxC,KAAK,WAAW,CAAC,CAAC,OAAO,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAPe,YAAQ,WAOvB,CAAA;AACH,CAAC,EAZgB,GAAG,mBAAH,GAAG,QAYnB;AAyBD;;GAEG;AACH,MAAa,OAAQ,SAAQ,kBAAkB;IAC7C,iDAAiD;IACjC,IAAI,GAAG,MAAM,CAAC;IAC9B,6DAA6D;IACtD,OAAO,CAAS;IACvB,+EAA+E;IACxE,aAAa,CAAgB;IAEpC,YAAoB,KAAiC;QACnD,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,IAAI,MAAM,CAAC;IACrD,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACpC,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAAiC;QACpD,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED,kCAAkC;IAClB,SAAS;QACvB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,OAAO,KAAK,YAAY,OAAO,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACzI,CAAC;CACF;AAvCD,0BAuCC;AAcD;;;GAGG;AACH,MAAa,WAAY,SAAQ,kBAAkB;IACjD,iDAAiD;IACjC,IAAI,GAAG,UAAU,CAAC;IAClC,gCAAgC;IACzB,SAAS,CAAS;IACzB,kCAAkC;IAC3B,WAAW,CAAS;IAE3B,YAAoB,KAAqC;QACvD,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,IAAI,EAAE,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;IAC7C,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,UAAU;YAChB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAC;IACJ,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAAqC;QACxD,OAAO,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED,gJAAgJ;IAChI,SAAS,CAAC,OAAmC;QAC3D,MAAM,GAAG,GAAG,OAAO,EAAE,iBAAiB,IAAI,GAAG,CAAC;QAC9C,OAAO,GAAG,IAAI,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACtD,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,OAAO,KAAK,YAAY,WAAW,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC7I,CAAC;CACF;AAxCD,kCAwCC;AAUD;;GAEG;AACH,MAAa,YAAa,SAAQ,kBAAkB;IAClD,iDAAiD;IACjC,IAAI,GAAG,WAAW,CAAC;IAEnC,YAAoB,KAA8B;QAChD,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,WAAW;SAClB,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAA8B;QACjD,OAAO,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,8DAA8D;IAC9C,SAAS,CAAC,OAAmC;QAC3D,OAAO,OAAO,EAAE,SAAS,IAAI,GAAG,CAAC;IACnC,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,OAAO,KAAK,YAAY,YAAY,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;CACF;AA/BD,oCA+BC;AAUD;;;GAGG;AACH,MAAa,MAAO,SAAQ,kBAAkB;IAC5C,iDAAiD;IACjC,IAAI,GAAG,KAAK,CAAC;IAEb,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,KAAK;SACZ,CAAC;IACJ,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACnC,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAAgC;QACnD,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAEC;;;;KAIC;IACa,SAAS,CAAC,OAAmC;QAC3D,IAAI,OAAO,EAAE,YAAY,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAC1C,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,OAAO,KAAK,YAAY,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;CACF;AAnCD,wBAmCC;AAYD;;GAEG;AACH,MAAa,SAAU,SAAQ,kBAAkB;IAC/C,uHAAuH;IACvG,IAAI,CAAQ;IAE5B,YAAoB,KAAqB;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IAChE,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;SAC3C,CAAC;IACJ,CAAC;IAED,uDAAuD;IAChD,MAAM,CAAC,MAAM,CAAC,KAAqB;QACxC,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,qJAAqJ;IACrI,UAAU,CAAC,SAAiB,EAAE,OAA+B;QAC3E,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,CAAC,OAAO,EAAE,kBAAkB,CAAC,EAAE,CAAC;YACnC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC5B,GAAG,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;IACH,CAAC;IAED,4HAA4H;IAC5G,SAAS,CAAC,OAAmC;QAC3D,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7D,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,IAAI,CAAC,CAAC,KAAK,YAAY,SAAS,CAAC,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACnE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC;CACF;AAnDD,8BAmDC;AAmBA,CAAC;AAmBF;;;;;GAKG;AACH,MAAa,SAAU,SAAQ,kBAAkB;IAC/C;;;OAGG;IACI,KAAK,CAAS;IACrB,+CAA+C;IACxC,aAAa,CAAyB;IAC7C,mCAAmC;IAC5B,OAAO,CAAmB;IACjC,0DAA0D;IAC1C,UAAU,CAAc;IAExC,YAAoB,KAAqB;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,IAAI,MAAM,CAAC;QAEnD,yCAAyC;QACzC,IAAI,CAAC,OAAO,GAAG;YACb,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC;YAC9B,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC;YAChC,GAAG,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;YAC5B,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;SACnC,CAAC;QAEF,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC5E,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACnD,CAAC;IACJ,CAAC;IAED,wDAAwD;IACjD,MAAM,CAAC,MAAM,CAAC,KAAqB;QACxC,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED,0FAA0F;IACnF,MAAM,CAAC,WAAW;QACvB,OAAO,SAAS,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,mEAAmE;IACnE,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IAC3D,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,kJAAkJ;IAClI,UAAU,CAAC,SAAiB,EAAE,OAA+B;QAC3E,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACrC,IAAI,CAAC,CAAC,OAAO,EAAE,kBAAkB,CAAC,EAAE,CAAC;YACnC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACxC,SAAS,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;IACH,CAAC;IAED,uMAAuM;IAChM,SAAS,CAAC,OAAmC;QAClD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,IAAI,GAAG,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACI,eAAe;QACpB,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;YACjC,SAAS,EAAE,IAAI,EAAE,SAAS,IAAI,IAAI,CAAC,SAAS;YAC5C,cAAc,EAAE,IAAI,EAAE,cAAc,IAAI,SAAS;SAClD,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAChC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,GAAQ;QACvB,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;QACxF,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,IAAI,CAAC,CAAC,KAAK,YAAY,SAAS,CAAC,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACnI,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAC1E,KAAK,KAAM,KAAK,CAAC,OAAe,CAAC,GAAG,CAAC,CACtC,CAAC;QAEF,IAAI,CAAC,eAAe;YAAE,OAAO,KAAK,CAAC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAChG,CAAC;CACF;AAjHD,8BAiHC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Annotation\n */\n\nimport { TextStyleSettingsProps } from \"./TextStyle\";\n\n/** Options supplied to [[TextBlockComponent.applyStyle]] to control how the style is applied to the component and its child components.\n * @beta\n */\nexport interface ApplyTextStyleOptions {\n  /** Controls whether any deviations from the style's settings stored in [[TextBlockComponent.styleOverrides]] are retained.\n   * By default, all overrides are cleared.\n   */\n  preserveOverrides?: boolean;\n  /** Controls whether the style should be recursively applied to the [[Paragraph]]s belonging to a [[TextBlock]] and the [[Run]]s belonging to a [[Paragraph]].\n   * By default, the style change propagates to child components.\n   */\n  preventPropagation?: boolean;\n}\n\n/** The JSON representation of a [[TextBlockComponent]].\n * @beta\n */\nexport interface TextBlockComponentProps {\n  /** The name of a [[TextStyle]] stored in a [Workspace]($backend) from which the base [[TextStyleSettings]] applied to the component originates. */\n  styleName: string;\n  /** Deviations from the base [[TextStyleSettings]] defined by the [[TextStyle]] applied to this component.\n   * This permits you to, e.g., create a [[TextRun]] using \"Arial\" font and override it to use \"Comic Sans\" instead.\n   */\n  styleOverrides?: TextStyleSettingsProps;\n}\n\n/** Options supplied to [[TextBlockComponent.stringify]] to control how the content is formatted.\n * @beta\n */\nexport interface TextBlockStringifyOptions {\n  /** A string to insert in between each [[Paragraph]].\n   * Default: \" \" - a single space.\n   */\n  paragraphBreak?: string;\n  /** A string to insert for each [[LineBreakRun]].\n   * Default: \" \" - a single space.\n   */\n  lineBreak?: string;\n  /** A string to insert between the numerator and denominator of each [[FractionRun]].\n   * Default: \"/\"\n   */\n  fractionSeparator?: string;\n  /** The number of spaces to use for tabs. If not provided, tabs will be represented by a tab character: \"\\t\".\n   * Default: \"undefined\" - use \"\\t\".\n   */\n  tabsAsSpaces?: number;\n}\n\n/** Abstract representation of any of the building blocks that make up a [[TextBlock]] document - namely [[Run]]s, [[Paragraph]]s, and [[TextBlock]] itself.\n * Each component can specify a [[TextStyle]] that formats its contents and optional [[styleOverrides]] to customize that formatting.\n * @beta\n */\nexport abstract class TextBlockComponent {\n  private _styleName: string;\n  private _styleOverrides: TextStyleSettingsProps;\n\n  /** @internal */\n  protected constructor(props: TextBlockComponentProps) {\n    this._styleName = props.styleName;\n    this._styleOverrides = { ...props.styleOverrides };\n  }\n\n  /** The name of the [[TextStyle]] that provides the base formatting for the contents of this component.\n   * @note Assigning to this property is equivalent to calling [[applyStyle]] with default [[ApplyTextStyleOptions]], which propagates the style change to all of\n   * the components sub-components and clears any [[styleOverrides]].\n   */\n  public get styleName(): string {\n    return this._styleName;\n  }\n\n  public set styleName(styleName: string) {\n    this.applyStyle(styleName);\n  }\n\n  /** Deviations in individual properties of the [[TextStyle]] specified by [[styleName]].\n   * For example, if the style uses the \"Arial\" font, you can override that by settings `styleOverrides.fontName` to \"Comic Sans\".\n   * @see [[clearStyleOverrides]] to reset this to an empty object.\n   */\n  public get styleOverrides(): TextStyleSettingsProps {\n    return this._styleOverrides;\n  }\n\n  public set styleOverrides(overrides: TextStyleSettingsProps) {\n    this._styleOverrides = { ...overrides };\n  }\n\n  /** Reset any [[styleOverrides]] applied to this component's [[TextStyle]]. */\n  public clearStyleOverrides(): void {\n    this.styleOverrides = { };\n  }\n\n  /** Apply the [[TextStyle]] specified by `styleName` to this component, optionally preserving [[styleOverrides]] and/or preventing propagation to sub-components. */\n  public applyStyle(styleName: string, options?: ApplyTextStyleOptions): void {\n    this._styleName = styleName;\n\n    if (!(options?.preserveOverrides)) {\n      this.clearStyleOverrides();\n    }\n  }\n\n  /** Returns true if [[styleOverrides]] specifies any deviations from this component's base [[TextStyle]]. */\n  public get overridesStyle(): boolean {\n    return Object.keys(this.styleOverrides).length > 0;\n  }\n\n  /** Create a deep copy of this component. */\n  public abstract clone(): TextBlockComponent;\n\n  /** Compute a string representation of the contents of this component and all of its sub-components. */\n  public abstract stringify(options?: TextBlockStringifyOptions): string;\n\n  /**\n  * Returns true if the string representation of this component consists only of whitespace characters.\n  * Useful for checking if the component is visually empty (producing no graphics) or contains only spaces, tabs, or line breaks.\n  */\n  public get isWhitespace(): boolean {\n    return /^\\s*$/g.test(this.stringify());\n  };\n\n  /** Convert this component to its JSON representation. */\n  public toJSON(): TextBlockComponentProps {\n    return {\n      styleName: this.styleName,\n      styleOverrides: { ...this.styleOverrides },\n    };\n  }\n\n  /** Returns true if `this` is equivalent to `other`. */\n  public equals(other: TextBlockComponent): boolean {\n    const myKeys = Object.keys(this.styleOverrides);\n    const yrKeys = Object.keys(other._styleOverrides);\n    if (this.styleName !== other.styleName || myKeys.length !== yrKeys.length) {\n      return false;\n    }\n\n    for (const name of myKeys) {\n      const key = name as keyof TextStyleSettingsProps;\n      if (this.styleOverrides[key] !== other.styleOverrides[key]) {\n        return false;\n      }\n    }\n\n    return true;\n  }\n}\n\n/**\n * @beta\n */\nexport type Run = TextRun | FractionRun | TabRun | LineBreakRun;\n\n/** The JSON representation of a [[Run]].\n * Use the `type` field to discriminate between the different kinds of runs.\n * @beta\n */\nexport type RunProps = TextRunProps | FractionRunProps | TabRunProps | LineBreakRunProps;\n\n/** A sequence of characters within a [[Paragraph]] that share a single style. Runs are the leaf nodes of a [[TextBlock]] document. When laid out for display, a single run may span\n * multiple lines, but it will never contain different styling.\n * Use the `type` field to discriminate between the different kinds of runs.\n * @beta\n */\nexport namespace Run { // eslint-disable-line @typescript-eslint/no-redeclare\n  /** Create a run from its JSON representation.\n   * @see [[TextRun.create]], [[FractionRun.create]], and [[LineBreakRun.create]] to create a run directly.\n   */\n  export function fromJSON(props: RunProps): Run {\n    switch (props.type) {\n      case \"text\": return TextRun.create(props);\n      case \"fraction\": return FractionRun.create(props);\n      case \"tab\": return TabRun.create(props);\n      case \"linebreak\": return LineBreakRun.create(props);\n    }\n  }\n}\n\n/** Describes whether the characters of a [[TextRun]] should be displayed normally, in subscript, or in superscript.\n * [[TextStyleSettings.superScriptScale]], [[TextStyleSettings.subScriptScale]], [[TextStyleSettings.superScriptOffsetFactor]], and [[TextStyleSettings.subScriptOffsetFactor]]\n * affect how the content is rendered.\n * @beta\n */\nexport type BaselineShift = \"subscript\" | \"superscript\" | \"none\";\n\n/** JSON representation of a [[TextRun]].\n * @beta\n */\nexport interface TextRunProps extends TextBlockComponentProps {\n  /** Discriminator field for the [[RunProps]] union. */\n  readonly type: \"text\";\n  /** The characters displayed by the run.\n   * Default: an empty string.\n   */\n  content?: string;\n  /** Whether to display [[content]] as a subscript, superscript, or normally.\n   * Default: \"none\"\n   */\n  baselineShift?: BaselineShift;\n}\n\n/** The most common type of [[Run]], containing a sequence of characters to be displayed using a single style.\n * @beta\n */\nexport class TextRun extends TextBlockComponent {\n  /** Discriminator field for the [[Run]] union. */\n  public readonly type = \"text\";\n  /** The sequence of characters to be displayed by the run. */\n  public content: string;\n  /** Whether to display [[content]] as a subscript, superscript, or normally. */\n  public baselineShift: BaselineShift;\n\n  private constructor(props: Omit<TextRunProps, \"type\">) {\n    super(props);\n    this.content = props.content ?? \"\";\n    this.baselineShift = props.baselineShift ?? \"none\";\n  }\n\n  public override clone(): TextRun {\n    return new TextRun(this.toJSON());\n  }\n\n  public override toJSON(): TextRunProps {\n    return {\n      ...super.toJSON(),\n      type: \"text\",\n      content: this.content,\n      baselineShift: this.baselineShift,\n    };\n  }\n\n  public static create(props: Omit<TextRunProps, \"type\">): TextRun {\n    return new TextRun(props);\n  }\n\n  /** Simply returns [[content]]. */\n  public override stringify(): string {\n    return this.content;\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    return other instanceof TextRun && this.content === other.content && this.baselineShift === other.baselineShift && super.equals(other);\n  }\n}\n\n/** JSON representation of a [[FractionRun]].\n * @beta\n */\nexport interface FractionRunProps extends TextBlockComponentProps {\n  /** Discriminator field for the [[RunProps]] union. */\n  readonly type: \"fraction\";\n  /** The text displayed before or above the fraction separator, depending on [[TextStyle.stackedFractionType]]. Default: an empty string. */\n  numerator?: string;\n  /** The text displayed after or below the fraction separator, depending on [[TextStyle.stackedFractionType]]. Default: an empty string. */\n  denominator?: string;\n}\n\n/** A [[Run]] containing a numeric ratio to be displayed as a numerator and denominator separated by a horizontal or diagonal bar.\n * @note The [[numerator]] and [[denominator]] are stored as strings. They are not technically required to contain a numeric representation.\n * @beta\n */\nexport class FractionRun extends TextBlockComponent {\n  /** Discriminator field for the [[Run]] union. */\n  public readonly type = \"fraction\";\n  /** The fraction's numerator. */\n  public numerator: string;\n  /** The fraction's denominator. */\n  public denominator: string;\n\n  private constructor(props: Omit<FractionRunProps, \"type\">) {\n    super(props);\n    this.numerator = props.numerator ?? \"\";\n    this.denominator = props.denominator ?? \"\";\n  }\n\n  public override toJSON(): FractionRunProps {\n    return {\n      ...super.toJSON(),\n      type: \"fraction\",\n      numerator: this.numerator,\n      denominator: this.denominator,\n    };\n  }\n\n  public override clone(): FractionRun {\n    return new FractionRun(this.toJSON());\n  }\n\n  public static create(props: Omit<FractionRunProps, \"type\">): FractionRun {\n    return new FractionRun(props);\n  }\n\n  /** Formats the fraction as a string with the [[numerator]] and [[denominator]] separated by [[TextBlockStringifyOptions.fractionSeparator]]. */\n  public override stringify(options?: TextBlockStringifyOptions): string {\n    const sep = options?.fractionSeparator ?? \"/\";\n    return `${this.numerator}${sep}${this.denominator}`;\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    return other instanceof FractionRun && this.numerator === other.numerator && this.denominator === other.denominator && super.equals(other);\n  }\n}\n\n/** JSON representation of a [[LineBreakRun]].\n * @beta\n */\nexport interface LineBreakRunProps extends TextBlockComponentProps {\n  /** Discriminator field for the [[RunProps]] union. */\n  readonly type: \"linebreak\";\n}\n\n/** A [[Run]] that represents the end of a line of text within a [[Paragraph]]. It contains no content of its own - it simply causes subsequent content to display on a new line.\n * @beta\n */\nexport class LineBreakRun extends TextBlockComponent {\n  /** Discriminator field for the [[Run]] union. */\n  public readonly type = \"linebreak\";\n\n  private constructor(props: TextBlockComponentProps) {\n    super(props);\n  }\n\n  public override toJSON(): LineBreakRunProps {\n    return {\n      ...super.toJSON(),\n      type: \"linebreak\",\n    };\n  }\n\n  public static create(props: TextBlockComponentProps) {\n    return new LineBreakRun(props);\n  }\n\n  public override clone(): LineBreakRun {\n    return new LineBreakRun(this.toJSON());\n  }\n\n  /** Simply returns [[TextBlockStringifyOptions.lineBreak]]. */\n  public override stringify(options?: TextBlockStringifyOptions): string {\n    return options?.lineBreak ?? \" \";\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    return other instanceof LineBreakRun && super.equals(other);\n  }\n}\n\n/** JSON representation of a [[TabRun]].\n * @beta\n */\nexport interface TabRunProps extends TextBlockComponentProps {\n  /** Discriminator field for the [[RunProps]] union. */\n  readonly type: \"tab\";\n}\n\n/** A [[TabRun]] is used to shift the next tab stop.\n * @note Only left-justified tabs are supported at this tab.\n * @beta\n */\nexport class TabRun extends TextBlockComponent {\n  /** Discriminator field for the [[Run]] union. */\n  public readonly type = \"tab\";\n\n  public override toJSON(): TabRunProps {\n    return {\n      ...super.toJSON(),\n      type: \"tab\",\n    };\n  }\n\n  public override clone(): TabRun {\n    return new TabRun(this.toJSON());\n  }\n\n  public static create(props: Omit<TabRunProps, \"type\">): TabRun {\n    return new TabRun(props);\n  }\n\n    /**\n   * Converts a [[TabRun]] to its string representation.\n   * If the `tabsAsSpaces` option is provided, returns a string of spaces of the specified length.\n   * Otherwise, returns a tab character (\"\\t\").\n   */\n  public override stringify(options?: TextBlockStringifyOptions): string {\n    if (options?.tabsAsSpaces) {\n      return \" \".repeat(options.tabsAsSpaces);\n    }\n\n    return \"\\t\";\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    return other instanceof TabRun && super.equals(other);\n  }\n}\n\n/** JSON representation of a [[Paragraph]].\n * @beta\n */\nexport interface ParagraphProps extends TextBlockComponentProps {\n  /** The collection of [[Run]]s within the paragraph.\n   * Default: an empty array.\n   */\n  runs?: RunProps[];\n}\n\n/** A collection of [[Run]]s within a [[TextBlock]]. Each paragraph within a text block is laid out on a separate line.\n * @beta\n */\nexport class Paragraph extends TextBlockComponent {\n  /** The runs within the paragraph. You can modify the contents of this array to change the content of the paragraph. */\n  public readonly runs: Run[];\n\n  private constructor(props: ParagraphProps) {\n    super(props);\n    this.runs = props.runs?.map((run) => Run.fromJSON(run)) ?? [];\n  }\n\n  public override toJSON(): ParagraphProps {\n    return {\n      ...super.toJSON(),\n      runs: this.runs.map((run) => run.toJSON()),\n    };\n  }\n\n  /** Create a paragraph from its JSON representation. */\n  public static create(props: ParagraphProps): Paragraph {\n    return new Paragraph(props);\n  }\n\n  public override clone(): Paragraph {\n    return new Paragraph(this.toJSON());\n  }\n\n  /** Apply the specified style to this [[Paragraph]], and - unless [[ApplyTextStyleOptions.preventPropagation]] is `true` - to all of its [[runs]]. */\n  public override applyStyle(styleName: string, options?: ApplyTextStyleOptions): void {\n    super.applyStyle(styleName, options);\n    if (!(options?.preventPropagation)) {\n      for (const run of this.runs) {\n        run.applyStyle(styleName, options);\n      }\n    }\n  }\n\n  /** Compute a string representation of this paragraph by concatenating the string representations of all of its [[runs]]. */\n  public override stringify(options?: TextBlockStringifyOptions): string {\n    return this.runs.map((x) => x.stringify(options)).join(\"\");\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    if (!(other instanceof Paragraph)) {\n      return false;\n    }\n\n    if (this.runs.length !== other.runs.length || !super.equals(other)) {\n      return false;\n    }\n\n    return this.runs.every((run, index) => run.equals(other.runs[index]));\n  }\n}\n\n/** Describes the relative alignment of the content of a [[TextBlock]].\n * @beta\n */\nexport type TextBlockJustification = \"left\" | \"center\" | \"right\";\n\n/** Describes the margins around the content inside a [[TextBlock]]. It's measured in meters.\n * @beta\n */\nexport interface TextBlockMargins {\n  /** The left margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */\n  left: number;\n  /** The right margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */\n  right: number;\n  /** The top margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */\n  top: number;\n  /** The bottom margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */\n  bottom: number;\n};\n\n/** JSON representation of a [[TextBlock]].\n * @beta\n */\nexport interface TextBlockProps extends TextBlockComponentProps {\n  /** The width of the document in meters. Lines that would exceed this width are instead wrapped around to the next line if possible.\n   * A value less than or equal to zero indicates no wrapping is to be applied.\n   * Default: 0\n   */\n  width?: number;\n  /** The alignment of the document content. Default: \"left\". */\n  justification?: TextBlockJustification;\n  /** The margins to surround the document content. Default: 0 margins on all sides */\n  margins?: Partial<TextBlockMargins>;\n  /** The paragraphs within the text block. Default: an empty array. */\n  paragraphs?: ParagraphProps[];\n}\n\n/** Represents a formatted text document consisting of a series of [[Paragraph]]s, each laid out on a separate line and containing their own content in the form of [[Run]]s.\n * You can change the content of the document by directly modifying the contents of its [[paragraphs]], or via [[appendParagraph]] and [[appendRun]].\n * No word-wrapping is applied to the document unless a [[width]] greater than zero is specified.\n * @see [[TextAnnotation]] to position a text block as an annotation in 2d or 3d space.\n * @beta\n */\nexport class TextBlock extends TextBlockComponent {\n  /** The width of the document in meters. Lines that would exceed this width are instead wrapped around to the next line if possible.\n   * A value less than or equal to zero indicates no wrapping is to be applied.\n   * Default: 0\n   */\n  public width: number;\n  /** The alignment of the document's content. */\n  public justification: TextBlockJustification;\n  /** The margins of the document. */\n  public margins: TextBlockMargins;\n  /** The ordered list of paragraphs within the document. */\n  public readonly paragraphs: Paragraph[];\n\n  private constructor(props: TextBlockProps) {\n    super(props);\n    this.width = props.width ?? 0;\n    this.justification = props.justification ?? \"left\";\n\n    // Assign default margins if not provided\n    this.margins = {\n      left: props.margins?.left ?? 0,\n      right: props.margins?.right ?? 0,\n      top: props.margins?.top ?? 0,\n      bottom: props.margins?.bottom ?? 0,\n    };\n\n    this.paragraphs = props.paragraphs?.map((x) => Paragraph.create(x)) ?? [];\n  }\n\n  public override toJSON(): TextBlockProps {\n    return {\n      ...super.toJSON(),\n      width: this.width,\n      justification: this.justification,\n      margins: this.margins,\n      paragraphs: this.paragraphs.map((x) => x.toJSON()),\n    };\n  }\n\n  /** Create a text block from its JSON representation. */\n  public static create(props: TextBlockProps): TextBlock {\n    return new TextBlock(props);\n  }\n\n  /** Create an empty text block containing no [[paragraphs]] and an empty [[styleName]]. */\n  public static createEmpty(): TextBlock {\n    return TextBlock.create({ styleName: \"\" });\n  }\n\n  /** Returns true if every paragraph in this text block is empty. */\n  public get isEmpty(): boolean {\n    return this.paragraphs.every((p) => p.runs.length === 0);\n  }\n\n  public override clone(): TextBlock {\n    return new TextBlock(this.toJSON());\n  }\n\n  /** Apply the specified style to this block and - unless [[ApplyTextStyleOptions.preventPropagation]] is `true` - to all of its [[paragraphs]]. */\n  public override applyStyle(styleName: string, options?: ApplyTextStyleOptions): void {\n    super.applyStyle(styleName, options);\n    if (!(options?.preventPropagation)) {\n      for (const paragraph of this.paragraphs) {\n        paragraph.applyStyle(styleName, options);\n      }\n    }\n  }\n\n  /** Compute a string representation of the document's contents by concatenating the string representations of each of its [[paragraphs]], separated by [[TextBlockStringifyOptions.paragraphBreak]]. */\n  public stringify(options?: TextBlockStringifyOptions): string {\n    return this.paragraphs.map((x) => x.stringify(options)).join(options?.paragraphBreak ?? \" \");\n  }\n\n  /** Add and return a new paragraph.\n   * If [[paragraphs]] is not empty, the style and overrides of the last [[Paragraph]] in the block will be applied to the new paragraph; otherwise,\n   * the paragraph will inherit this block's style with no overrides.\n   */\n  public appendParagraph(): Paragraph {\n    const seed = this.paragraphs[0];\n    const paragraph = Paragraph.create({\n      styleName: seed?.styleName ?? this.styleName,\n      styleOverrides: seed?.styleOverrides ?? undefined,\n    });\n\n    this.paragraphs.push(paragraph);\n    return paragraph;\n  }\n\n  /** Append a run to the last [[Paragraph]] in this block.\n   * If the block contains no [[paragraphs]], a new one will first be created using [[appendParagraph]].\n   */\n  public appendRun(run: Run): void {\n    const paragraph = this.paragraphs[this.paragraphs.length - 1] ?? this.appendParagraph();\n    paragraph.runs.push(run);\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    if (!(other instanceof TextBlock)) {\n      return false;\n    }\n\n    if (this.width !== other.width || this.justification !== other.justification || this.paragraphs.length !== other.paragraphs.length) {\n      return false;\n    }\n\n    const marginsAreEqual = Object.entries(this.margins).every(([key, value]) =>\n      value === (other.margins as any)[key]\n    );\n\n    if (!marginsAreEqual) return false;\n\n    return this.paragraphs.every((paragraph, index) => paragraph.equals(other.paragraphs[index]));\n  }\n}\n"]}
+{"version":3,"file":"TextBlock.js","sourceRoot":"","sources":["../../../src/annotation/TextBlock.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,2CAAwE;AA4CxE;;;GAGG;AACH,MAAsB,kBAAkB;IAC9B,eAAe,CAAyB;IAEhD,gBAAgB;IAChB,YAAsB,KAA+B;QACnD,IAAI,CAAC,eAAe,GAAG,6BAAiB,CAAC,UAAU,CAAC,KAAK,EAAE,cAAc,IAAI,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;OAGG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED,IAAW,cAAc,CAAC,SAAiC;QACzD,IAAI,CAAC,eAAe,GAAG,6BAAiB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACjE,CAAC;IAED,8DAA8D;IACvD,mBAAmB,CAAC,QAAgC;QACzD,IAAI,CAAC,cAAc,GAAG,EAAG,CAAC;IAC5B,CAAC;IAED,4HAA4H;IAC5H,IAAW,cAAc;QACvB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACrD,CAAC;IAQD;;;MAGE;IACF,IAAW,YAAY;QACrB,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IAAA,CAAC;IAEF,yDAAyD;IAClD,MAAM;QACX,OAAO;YACL,cAAc,EAAE,6BAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC;SAClE,CAAC;IACJ,CAAC;IAED,uDAAuD;IAChD,MAAM,CAAC,KAAyB;QACrC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAChD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAClD,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;YACpC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,MAAM,GAAG,GAAG,IAAoC,CAAC;YACjD,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC3D,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AApED,gDAoEC;AAaD;;;;GAIG;AACH,IAAiB,GAAG,CAYnB;AAZD,WAAiB,GAAG;IAClB;;OAEG;IACH,SAAgB,QAAQ,CAAC,KAAe;QACtC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,MAAM,CAAC,CAAC,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC1C,KAAK,UAAU,CAAC,CAAC,OAAO,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAClD,KAAK,KAAK,CAAC,CAAC,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACxC,KAAK,WAAW,CAAC,CAAC,OAAO,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAPe,YAAQ,WAOvB,CAAA;AACH,CAAC,EAZgB,GAAG,mBAAH,GAAG,QAYnB;AAyBD;;GAEG;AACH,MAAa,OAAQ,SAAQ,kBAAkB;IAC7C,iDAAiD;IACjC,IAAI,GAAG,MAAM,CAAC;IAC9B,6DAA6D;IACtD,OAAO,CAAS;IACvB,+EAA+E;IACxE,aAAa,CAAgB;IAEpC,YAAoB,KAAkC;QACpD,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,OAAO,GAAG,KAAK,EAAE,OAAO,IAAI,EAAE,CAAC;QACpC,IAAI,CAAC,aAAa,GAAG,KAAK,EAAE,aAAa,IAAI,MAAM,CAAC;IACtD,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACpC,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAAkC;QACrD,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED,kCAAkC;IAClB,SAAS;QACvB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,OAAO,KAAK,YAAY,OAAO,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACzI,CAAC;CACF;AAvCD,0BAuCC;AAcD;;;GAGG;AACH,MAAa,WAAY,SAAQ,kBAAkB;IACjD,iDAAiD;IACjC,IAAI,GAAG,UAAU,CAAC;IAClC,gCAAgC;IACzB,SAAS,CAAS;IACzB,kCAAkC;IAC3B,WAAW,CAAS;IAE3B,YAAoB,KAAsC;QACxD,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,SAAS,GAAG,KAAK,EAAE,SAAS,IAAI,EAAE,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,KAAK,EAAE,WAAW,IAAI,EAAE,CAAC;IAC9C,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,UAAU;YAChB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW;SAC9B,CAAC;IACJ,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAAsC;QACzD,OAAO,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAED,gJAAgJ;IAChI,SAAS,CAAC,OAAmC;QAC3D,MAAM,GAAG,GAAG,OAAO,EAAE,iBAAiB,IAAI,GAAG,CAAC;QAC9C,OAAO,GAAG,IAAI,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACtD,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,OAAO,KAAK,YAAY,WAAW,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC7I,CAAC;CACF;AAxCD,kCAwCC;AAUD;;GAEG;AACH,MAAa,YAAa,SAAQ,kBAAkB;IAClD,iDAAiD;IACjC,IAAI,GAAG,WAAW,CAAC;IAEnC,YAAoB,KAA+B;QACjD,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,WAAW;SAClB,CAAC;IACJ,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAA+B;QAClD,OAAO,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,8DAA8D;IAC9C,SAAS,CAAC,OAAmC;QAC3D,OAAO,OAAO,EAAE,SAAS,IAAI,GAAG,CAAC;IACnC,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,OAAO,KAAK,YAAY,YAAY,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;CACF;AA/BD,oCA+BC;AAUD;;;GAGG;AACH,MAAa,MAAO,SAAQ,kBAAkB;IAC5C,iDAAiD;IACjC,IAAI,GAAG,KAAK,CAAC;IAEb,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,KAAK;SACZ,CAAC;IACJ,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACnC,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,KAAiC;QACpD,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAEC;;;;KAIC;IACa,SAAS,CAAC,OAAmC;QAC3D,IAAI,OAAO,EAAE,YAAY,EAAE,CAAC;YAC1B,OAAO,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAC1C,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,OAAO,KAAK,YAAY,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;CACF;AAnCD,wBAmCC;AAYD;;GAEG;AACH,MAAa,SAAU,SAAQ,kBAAkB;IAC/C,uHAAuH;IACvG,IAAI,CAAQ;IAE5B,YAAoB,KAAsB;QACxC,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IACjE,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;SAC3C,CAAC;IACJ,CAAC;IAED,uDAAuD;IAChD,MAAM,CAAC,MAAM,CAAC,KAAsB;QACzC,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACa,mBAAmB,CAAC,OAA+B;QACjE,KAAK,CAAC,mBAAmB,EAAE,CAAC;QAC5B,IAAI,OAAO,EAAE,yBAAyB;YACpC,OAAO;QAET,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5B,GAAG,CAAC,mBAAmB,EAAE,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,4HAA4H;IAC5G,SAAS,CAAC,OAAmC;QAC3D,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7D,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,IAAI,CAAC,CAAC,KAAK,YAAY,SAAS,CAAC,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACnE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACxE,CAAC;CACF;AAvDD,8BAuDC;AAmBA,CAAC;AAqBF;;;;;GAKG;AACH,MAAa,SAAU,SAAQ,kBAAkB;IAC/C;;;OAGG;IACI,OAAO,CAAa;IAC3B;;;OAGG;IACI,KAAK,CAAS;IACrB,+CAA+C;IACxC,aAAa,CAAyB;IAC7C,mCAAmC;IAC5B,OAAO,CAAmB;IACjC,0DAA0D;IAC1C,UAAU,CAAc;IAExC,YAAoB,KAAqB;QACvC,KAAK,CAAC,KAAK,CAAC,CAAC;QACb,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAC7B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,aAAa,IAAI,MAAM,CAAC;QAEnD,yCAAyC;QACzC,IAAI,CAAC,OAAO,GAAG;YACb,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC;YAC9B,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,IAAI,CAAC;YAChC,GAAG,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;YAC5B,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;SACnC,CAAC;QAEF,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC5E,CAAC;IAEe,MAAM;QACpB,OAAO;YACL,GAAG,KAAK,CAAC,MAAM,EAAE;YACjB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SACnD,CAAC;IACJ,CAAC;IAED,wDAAwD;IACjD,MAAM,CAAC,MAAM,CAAC,KAAqB;QACxC,OAAO,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED,wFAAwF;IACjF,MAAM,CAAC,WAAW;QACvB,OAAO,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED,mEAAmE;IACnE,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IAC3D,CAAC;IAEe,KAAK;QACnB,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACa,mBAAmB,CAAC,OAA+B;QACjE,KAAK,CAAC,mBAAmB,EAAE,CAAC;QAC5B,IAAI,OAAO,EAAE,yBAAyB;YACpC,OAAO;QAET,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACxC,SAAS,CAAC,mBAAmB,EAAE,CAAC;QAClC,CAAC;IACH,CAAC;IAED,uMAAuM;IAChM,SAAS,CAAC,OAAmC;QAClD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,IAAI,GAAG,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACI,eAAe,CAAC,eAAwB,KAAK;QAClD,IAAI,cAAc,GAA2B,EAAE,CAAC;QAEhD,IAAI,YAAY,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACzD,cAAc,GAAG,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC9C,CAAC;QAED,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;YACjC,cAAc;SACf,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAChC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,GAAQ;QACvB,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;QACxF,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAEe,MAAM,CAAC,KAAyB;QAC9C,IAAI,CAAC,CAAC,KAAK,YAAY,SAAS,CAAC,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3D,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,aAAa,KAAK,KAAK,CAAC,aAAa,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACnI,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAC1E,KAAK,KAAM,KAAK,CAAC,OAAe,CAAC,GAAG,CAAC,CACtC,CAAC;QAEF,IAAI,CAAC,eAAe;YAAE,OAAO,KAAK,CAAC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAChG,CAAC;CACF;AArID,8BAqIC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Annotation\n */\n\nimport { Id64String } from \"@itwin/core-bentley\";\nimport { TextStyleSettings, TextStyleSettingsProps } from \"./TextStyle\";\n\n/** Options supplied to [[TextBlockComponent.clearStyleOverrides]] to control how the style overrides are cleared on the component and its child components.\n * @beta\n */\nexport interface ClearTextStyleOptions {\n  /** Controls whether the styleOverrides of any child components are retained.\n   * By default, all overrides are cleared.\n   */\n  preserveChildrenOverrides?: boolean;\n}\n\n/** The JSON representation of a [[TextBlockComponent]].\n * @beta\n */\nexport interface TextBlockComponentProps {\n  /** Deviations from the base [[TextStyleSettings]] defined by the [AnnotationTextStyle]($backend) applied to this component.\n   * This permits you to, e.g., create a [[TextBlock]] using \"Arial\" font and override one of its [[TextRun]]s to use \"Comic Sans\" instead.\n   */\n  styleOverrides?: TextStyleSettingsProps;\n}\n\n/** Options supplied to [[TextBlockComponent.stringify]] to control how the content is formatted.\n * @beta\n */\nexport interface TextBlockStringifyOptions {\n  /** A string to insert in between each [[Paragraph]].\n   * Default: \" \" - a single space.\n   */\n  paragraphBreak?: string;\n  /** A string to insert for each [[LineBreakRun]].\n   * Default: \" \" - a single space.\n   */\n  lineBreak?: string;\n  /** A string to insert between the numerator and denominator of each [[FractionRun]].\n   * Default: \"/\"\n   */\n  fractionSeparator?: string;\n  /** The number of spaces to use for tabs. If not provided, tabs will be represented by a tab character: \"\\t\".\n   * Default: \"undefined\" - use \"\\t\".\n   */\n  tabsAsSpaces?: number;\n}\n\n/** Abstract representation of any of the building blocks that make up a [[TextBlock]] document - namely [[Run]]s, [[Paragraph]]s, and [[TextBlock]] itself.\n * The [[TextBlock]] can specify an [AnnotationTextStyle]($backend) that formats its contents. Each component can specify an optional [[styleOverrides]] to customize that formatting.\n * @beta\n */\nexport abstract class TextBlockComponent {\n  private _styleOverrides: TextStyleSettingsProps;\n\n  /** @internal */\n  protected constructor(props?: TextBlockComponentProps) {\n    this._styleOverrides = TextStyleSettings.cloneProps(props?.styleOverrides ?? {});\n  }\n\n  /** Deviations in individual properties of the [[TextStyleSettings]] in the [AnnotationTextStyle]($backend) specified by `styleId` on the [[TextBlock]].\n   * For example, if the style uses the \"Arial\" font, you can override that by settings `styleOverrides.fontName` to \"Comic Sans\".\n   * @see [[clearStyleOverrides]] to reset this to an empty object.\n   */\n  public get styleOverrides(): TextStyleSettingsProps {\n    return this._styleOverrides;\n  }\n\n  public set styleOverrides(overrides: TextStyleSettingsProps) {\n    this._styleOverrides = TextStyleSettings.cloneProps(overrides);\n  }\n\n  /** Reset any [[styleOverrides]] applied to this component. */\n  public clearStyleOverrides(_options?: ClearTextStyleOptions): void {\n    this.styleOverrides = { };\n  }\n\n  /** Returns true if [[styleOverrides]] specifies any deviations from the [[TextBlock]]'s [AnnotationTextStyle]($backend). */\n  public get overridesStyle(): boolean {\n    return Object.keys(this.styleOverrides).length > 0;\n  }\n\n  /** Create a deep copy of this component. */\n  public abstract clone(): TextBlockComponent;\n\n  /** Compute a string representation of the contents of this component and all of its sub-components. */\n  public abstract stringify(options?: TextBlockStringifyOptions): string;\n\n  /**\n  * Returns true if the string representation of this component consists only of whitespace characters.\n  * Useful for checking if the component is visually empty (producing no graphics) or contains only spaces, tabs, or line breaks.\n  */\n  public get isWhitespace(): boolean {\n    return /^\\s*$/g.test(this.stringify());\n  };\n\n  /** Convert this component to its JSON representation. */\n  public toJSON(): TextBlockComponentProps {\n    return {\n      styleOverrides: TextStyleSettings.cloneProps(this.styleOverrides),\n    };\n  }\n\n  /** Returns true if `this` is equivalent to `other`. */\n  public equals(other: TextBlockComponent): boolean {\n    const myKeys = Object.keys(this.styleOverrides);\n    const yrKeys = Object.keys(other._styleOverrides);\n    if (myKeys.length !== yrKeys.length) {\n      return false;\n    }\n\n    for (const name of myKeys) {\n      const key = name as keyof TextStyleSettingsProps;\n      if (this.styleOverrides[key] !== other.styleOverrides[key]) {\n        return false;\n      }\n    }\n\n    return true;\n  }\n}\n\n/**\n * @beta\n */\nexport type Run = TextRun | FractionRun | TabRun | LineBreakRun;\n\n/** The JSON representation of a [[Run]].\n * Use the `type` field to discriminate between the different kinds of runs.\n * @beta\n */\nexport type RunProps = TextRunProps | FractionRunProps | TabRunProps | LineBreakRunProps;\n\n/** A sequence of characters within a [[Paragraph]] that share a single style. Runs are the leaf nodes of a [[TextBlock]] document. When laid out for display, a single run may span\n * multiple lines, but it will never contain different styling.\n * Use the `type` field to discriminate between the different kinds of runs.\n * @beta\n */\nexport namespace Run { // eslint-disable-line @typescript-eslint/no-redeclare\n  /** Create a run from its JSON representation.\n   * @see [[TextRun.create]], [[FractionRun.create]], and [[LineBreakRun.create]] to create a run directly.\n   */\n  export function fromJSON(props: RunProps): Run {\n    switch (props.type) {\n      case \"text\": return TextRun.create(props);\n      case \"fraction\": return FractionRun.create(props);\n      case \"tab\": return TabRun.create(props);\n      case \"linebreak\": return LineBreakRun.create(props);\n    }\n  }\n}\n\n/** Describes whether the characters of a [[TextRun]] should be displayed normally, in subscript, or in superscript.\n * [[TextStyleSettings.superScriptScale]], [[TextStyleSettings.subScriptScale]], [[TextStyleSettings.superScriptOffsetFactor]], and [[TextStyleSettings.subScriptOffsetFactor]]\n * affect how the content is rendered.\n * @beta\n */\nexport type BaselineShift = \"subscript\" | \"superscript\" | \"none\";\n\n/** JSON representation of a [[TextRun]].\n * @beta\n */\nexport interface TextRunProps extends TextBlockComponentProps {\n  /** Discriminator field for the [[RunProps]] union. */\n  readonly type: \"text\";\n  /** The characters displayed by the run.\n   * Default: an empty string.\n   */\n  content?: string;\n  /** Whether to display [[content]] as a subscript, superscript, or normally.\n   * Default: \"none\"\n   */\n  baselineShift?: BaselineShift;\n}\n\n/** The most common type of [[Run]], containing a sequence of characters to be displayed using a single style.\n * @beta\n */\nexport class TextRun extends TextBlockComponent {\n  /** Discriminator field for the [[Run]] union. */\n  public readonly type = \"text\";\n  /** The sequence of characters to be displayed by the run. */\n  public content: string;\n  /** Whether to display [[content]] as a subscript, superscript, or normally. */\n  public baselineShift: BaselineShift;\n\n  private constructor(props?: Omit<TextRunProps, \"type\">) {\n    super(props);\n    this.content = props?.content ?? \"\";\n    this.baselineShift = props?.baselineShift ?? \"none\";\n  }\n\n  public override clone(): TextRun {\n    return new TextRun(this.toJSON());\n  }\n\n  public override toJSON(): TextRunProps {\n    return {\n      ...super.toJSON(),\n      type: \"text\",\n      content: this.content,\n      baselineShift: this.baselineShift,\n    };\n  }\n\n  public static create(props?: Omit<TextRunProps, \"type\">): TextRun {\n    return new TextRun(props);\n  }\n\n  /** Simply returns [[content]]. */\n  public override stringify(): string {\n    return this.content;\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    return other instanceof TextRun && this.content === other.content && this.baselineShift === other.baselineShift && super.equals(other);\n  }\n}\n\n/** JSON representation of a [[FractionRun]].\n * @beta\n */\nexport interface FractionRunProps extends TextBlockComponentProps {\n  /** Discriminator field for the [[RunProps]] union. */\n  readonly type: \"fraction\";\n  /** The text displayed before or above the fraction separator, depending on [[TextStyleSettings.stackedFractionType]]. Default: an empty string. */\n  numerator?: string;\n  /** The text displayed after or below the fraction separator, depending on [[TextStyleSettings.stackedFractionType]]. Default: an empty string. */\n  denominator?: string;\n}\n\n/** A [[Run]] containing a numeric ratio to be displayed as a numerator and denominator separated by a horizontal or diagonal bar.\n * @note The [[numerator]] and [[denominator]] are stored as strings. They are not technically required to contain a numeric representation.\n * @beta\n */\nexport class FractionRun extends TextBlockComponent {\n  /** Discriminator field for the [[Run]] union. */\n  public readonly type = \"fraction\";\n  /** The fraction's numerator. */\n  public numerator: string;\n  /** The fraction's denominator. */\n  public denominator: string;\n\n  private constructor(props?: Omit<FractionRunProps, \"type\">) {\n    super(props);\n    this.numerator = props?.numerator ?? \"\";\n    this.denominator = props?.denominator ?? \"\";\n  }\n\n  public override toJSON(): FractionRunProps {\n    return {\n      ...super.toJSON(),\n      type: \"fraction\",\n      numerator: this.numerator,\n      denominator: this.denominator,\n    };\n  }\n\n  public override clone(): FractionRun {\n    return new FractionRun(this.toJSON());\n  }\n\n  public static create(props?: Omit<FractionRunProps, \"type\">): FractionRun {\n    return new FractionRun(props);\n  }\n\n  /** Formats the fraction as a string with the [[numerator]] and [[denominator]] separated by [[TextBlockStringifyOptions.fractionSeparator]]. */\n  public override stringify(options?: TextBlockStringifyOptions): string {\n    const sep = options?.fractionSeparator ?? \"/\";\n    return `${this.numerator}${sep}${this.denominator}`;\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    return other instanceof FractionRun && this.numerator === other.numerator && this.denominator === other.denominator && super.equals(other);\n  }\n}\n\n/** JSON representation of a [[LineBreakRun]].\n * @beta\n */\nexport interface LineBreakRunProps extends TextBlockComponentProps {\n  /** Discriminator field for the [[RunProps]] union. */\n  readonly type: \"linebreak\";\n}\n\n/** A [[Run]] that represents the end of a line of text within a [[Paragraph]]. It contains no content of its own - it simply causes subsequent content to display on a new line.\n * @beta\n */\nexport class LineBreakRun extends TextBlockComponent {\n  /** Discriminator field for the [[Run]] union. */\n  public readonly type = \"linebreak\";\n\n  private constructor(props?: TextBlockComponentProps) {\n    super(props);\n  }\n\n  public override toJSON(): LineBreakRunProps {\n    return {\n      ...super.toJSON(),\n      type: \"linebreak\",\n    };\n  }\n\n  public static create(props?: TextBlockComponentProps) {\n    return new LineBreakRun(props);\n  }\n\n  public override clone(): LineBreakRun {\n    return new LineBreakRun(this.toJSON());\n  }\n\n  /** Simply returns [[TextBlockStringifyOptions.lineBreak]]. */\n  public override stringify(options?: TextBlockStringifyOptions): string {\n    return options?.lineBreak ?? \" \";\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    return other instanceof LineBreakRun && super.equals(other);\n  }\n}\n\n/** JSON representation of a [[TabRun]].\n * @beta\n */\nexport interface TabRunProps extends TextBlockComponentProps {\n  /** Discriminator field for the [[RunProps]] union. */\n  readonly type: \"tab\";\n}\n\n/** A [[TabRun]] is used to shift the next tab stop.\n * @note Only left-justified tabs are supported at this tab.\n * @beta\n */\nexport class TabRun extends TextBlockComponent {\n  /** Discriminator field for the [[Run]] union. */\n  public readonly type = \"tab\";\n\n  public override toJSON(): TabRunProps {\n    return {\n      ...super.toJSON(),\n      type: \"tab\",\n    };\n  }\n\n  public override clone(): TabRun {\n    return new TabRun(this.toJSON());\n  }\n\n  public static create(props?: Omit<TabRunProps, \"type\">): TabRun {\n    return new TabRun(props);\n  }\n\n    /**\n   * Converts a [[TabRun]] to its string representation.\n   * If the `tabsAsSpaces` option is provided, returns a string of spaces of the specified length.\n   * Otherwise, returns a tab character (\"\\t\").\n   */\n  public override stringify(options?: TextBlockStringifyOptions): string {\n    if (options?.tabsAsSpaces) {\n      return \" \".repeat(options.tabsAsSpaces);\n    }\n\n    return \"\\t\";\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    return other instanceof TabRun && super.equals(other);\n  }\n}\n\n/** JSON representation of a [[Paragraph]].\n * @beta\n */\nexport interface ParagraphProps extends TextBlockComponentProps {\n  /** The collection of [[Run]]s within the paragraph.\n   * Default: an empty array.\n   */\n  runs?: RunProps[];\n}\n\n/** A collection of [[Run]]s within a [[TextBlock]]. Each paragraph within a text block is laid out on a separate line.\n * @beta\n */\nexport class Paragraph extends TextBlockComponent {\n  /** The runs within the paragraph. You can modify the contents of this array to change the content of the paragraph. */\n  public readonly runs: Run[];\n\n  private constructor(props?: ParagraphProps) {\n    super(props);\n    this.runs = props?.runs?.map((run) => Run.fromJSON(run)) ?? [];\n  }\n\n  public override toJSON(): ParagraphProps {\n    return {\n      ...super.toJSON(),\n      runs: this.runs.map((run) => run.toJSON()),\n    };\n  }\n\n  /** Create a paragraph from its JSON representation. */\n  public static create(props?: ParagraphProps): Paragraph {\n    return new Paragraph(props);\n  }\n\n  public override clone(): Paragraph {\n    return new Paragraph(this.toJSON());\n  }\n\n  /**\n   * Clears any [[styleOverrides]] applied to this Paragraph.\n   * Will also clear [[styleOverrides]] from all child components unless [[ClearTextStyleOptions.preserveChildrenOverrides]] is `true`.\n   */\n  public override clearStyleOverrides(options?: ClearTextStyleOptions): void {\n    super.clearStyleOverrides();\n    if (options?.preserveChildrenOverrides)\n      return;\n\n    for (const run of this.runs) {\n      run.clearStyleOverrides();\n    }\n  }\n\n  /** Compute a string representation of this paragraph by concatenating the string representations of all of its [[runs]]. */\n  public override stringify(options?: TextBlockStringifyOptions): string {\n    return this.runs.map((x) => x.stringify(options)).join(\"\");\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    if (!(other instanceof Paragraph)) {\n      return false;\n    }\n\n    if (this.runs.length !== other.runs.length || !super.equals(other)) {\n      return false;\n    }\n\n    return this.runs.every((run, index) => run.equals(other.runs[index]));\n  }\n}\n\n/** Describes the relative alignment of the content of a [[TextBlock]].\n * @beta\n */\nexport type TextBlockJustification = \"left\" | \"center\" | \"right\";\n\n/** Describes the margins around the content inside a [[TextBlock]]. It's measured in meters.\n * @beta\n */\nexport interface TextBlockMargins {\n  /** The left margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */\n  left: number;\n  /** The right margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */\n  right: number;\n  /** The top margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */\n  top: number;\n  /** The bottom margin measured in meters. Must be a positive number >= 0. Negative values are disregarded */\n  bottom: number;\n};\n\n/** JSON representation of a [[TextBlock]].\n * @beta\n */\nexport interface TextBlockProps extends TextBlockComponentProps {\n  /** The ID of an [AnnotationTextStyle]($backend) stored in the iModel from which the base [[TextStyleSettings]] applied to the [[TextBlock]] originates. */\n  styleId: Id64String;\n  /** The width of the document in meters. Lines that would exceed this width are instead wrapped around to the next line if possible.\n   * A value less than or equal to zero indicates no wrapping is to be applied.\n   * Default: 0\n   */\n  width?: number;\n  /** The alignment of the document content. Default: \"left\". */\n  justification?: TextBlockJustification;\n  /** The margins to surround the document content. Default: 0 margins on all sides */\n  margins?: Partial<TextBlockMargins>;\n  /** The paragraphs within the text block. Default: an empty array. */\n  paragraphs?: ParagraphProps[];\n}\n\n/** Represents a formatted text document consisting of a series of [[Paragraph]]s, each laid out on a separate line and containing their own content in the form of [[Run]]s.\n * You can change the content of the document by directly modifying the contents of its [[paragraphs]], or via [[appendParagraph]] and [[appendRun]].\n * No word-wrapping is applied to the document unless a [[width]] greater than zero is specified.\n * @see [[TextAnnotation]] to position a text block as an annotation in 2d or 3d space.\n * @beta\n */\nexport class TextBlock extends TextBlockComponent {\n  /** The ID of the [AnnotationTextStyle]($backend) that provides the base formatting for the contents of this TextBlock.\n   * @note Assigning to this property retains all style overrides on the TextBlock and its child components.\n   * Call [[clearStyleOverrides]] to clear the TextBlock's and optionally all children's style overrides.\n   */\n  public styleId: Id64String;\n  /** The width of the document in meters. Lines that would exceed this width are instead wrapped around to the next line if possible.\n   * A value less than or equal to zero indicates no wrapping is to be applied.\n   * Default: 0\n   */\n  public width: number;\n  /** The alignment of the document's content. */\n  public justification: TextBlockJustification;\n  /** The margins of the document. */\n  public margins: TextBlockMargins;\n  /** The ordered list of paragraphs within the document. */\n  public readonly paragraphs: Paragraph[];\n\n  private constructor(props: TextBlockProps) {\n    super(props);\n    this.styleId = props.styleId;\n    this.width = props.width ?? 0;\n    this.justification = props.justification ?? \"left\";\n\n    // Assign default margins if not provided\n    this.margins = {\n      left: props.margins?.left ?? 0,\n      right: props.margins?.right ?? 0,\n      top: props.margins?.top ?? 0,\n      bottom: props.margins?.bottom ?? 0,\n    };\n\n    this.paragraphs = props.paragraphs?.map((x) => Paragraph.create(x)) ?? [];\n  }\n\n  public override toJSON(): TextBlockProps {\n    return {\n      ...super.toJSON(),\n      styleId: this.styleId,\n      width: this.width,\n      justification: this.justification,\n      margins: this.margins,\n      paragraphs: this.paragraphs.map((x) => x.toJSON()),\n    };\n  }\n\n  /** Create a text block from its JSON representation. */\n  public static create(props: TextBlockProps): TextBlock {\n    return new TextBlock(props);\n  }\n\n  /** Create an empty text block containing no [[paragraphs]] and an empty [[styleId]]. */\n  public static createEmpty(): TextBlock {\n    return TextBlock.create({ styleId: \"\" });\n  }\n\n  /** Returns true if every paragraph in this text block is empty. */\n  public get isEmpty(): boolean {\n    return this.paragraphs.every((p) => p.runs.length === 0);\n  }\n\n  public override clone(): TextBlock {\n    return new TextBlock(this.toJSON());\n  }\n\n  /**\n   * Clears any [[styleOverrides]] applied to this TextBlock.\n   * Will also clear [[styleOverrides]] from all child components unless [[ClearTextStyleOptions.preserveChildrenOverrides]] is `true`.\n   */\n  public override clearStyleOverrides(options?: ClearTextStyleOptions): void {\n    super.clearStyleOverrides();\n    if (options?.preserveChildrenOverrides)\n      return;\n\n    for (const paragraph of this.paragraphs) {\n      paragraph.clearStyleOverrides();\n    }\n  }\n\n  /** Compute a string representation of the document's contents by concatenating the string representations of each of its [[paragraphs]], separated by [[TextBlockStringifyOptions.paragraphBreak]]. */\n  public stringify(options?: TextBlockStringifyOptions): string {\n    return this.paragraphs.map((x) => x.stringify(options)).join(options?.paragraphBreak ?? \" \");\n  }\n\n  /** Add and return a new paragraph.\n   * By default, the paragraph will be created with no [[styleOverrides]], so that it inherits the style of this block.\n   * @param seedFromLast If true and [[paragraphs]] is not empty, the new paragraph will inherit the style overrides of the last [[Paragraph]] in this block.\n   */\n  public appendParagraph(seedFromLast: boolean = false): Paragraph {\n    let styleOverrides: TextStyleSettingsProps = {};\n\n    if (seedFromLast && this.paragraphs.length > 0) {\n      const seed = this.paragraphs[this.paragraphs.length - 1];\n      styleOverrides = { ...seed.styleOverrides };\n    }\n\n    const paragraph = Paragraph.create({\n      styleOverrides\n    });\n\n    this.paragraphs.push(paragraph);\n    return paragraph;\n  }\n\n  /** Append a run to the last [[Paragraph]] in this block.\n   * If the block contains no [[paragraphs]], a new one will first be created using [[appendParagraph]].\n   */\n  public appendRun(run: Run): void {\n    const paragraph = this.paragraphs[this.paragraphs.length - 1] ?? this.appendParagraph();\n    paragraph.runs.push(run);\n  }\n\n  public override equals(other: TextBlockComponent): boolean {\n    if (!(other instanceof TextBlock)) {\n      return false;\n    }\n\n    if (this.styleId !== other.styleId || !super.equals(other)) {\n      return false;\n    }\n\n    if (this.width !== other.width || this.justification !== other.justification || this.paragraphs.length !== other.paragraphs.length) {\n      return false;\n    }\n\n    const marginsAreEqual = Object.entries(this.margins).every(([key, value]) =>\n      value === (other.margins as any)[key]\n    );\n\n    if (!marginsAreEqual) return false;\n\n    return this.paragraphs.every((paragraph, index) => paragraph.equals(other.paragraphs[index]));\n  }\n}\n"]}

package/lib/cjs/annotation/TextBlockLayoutResult.d.ts

@@ -25,7 +25,7 @@ export interface RunLayoutResult {
     offsetFromLine: XAndY;
     /** Bounding box enclosing this RunLayoutResult's content. */
     range: Range2dProps;
-    /** The [[TextStyleSettings]] for the run. */
+    /** The resolved [[TextStyleSettings]] for the run. Takes into account overrides and styles on the parent classes. */
     textStyle: TextStyleSettingsProps;
     /** Bounding box used when justifying the run. This may be smaller than [[range]]. */
     justificationRange?: Range2dProps;

package/lib/cjs/annotation/TextBlockLayoutResult.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextBlockLayoutResult.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextBlockLayoutResult.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,0FAA0F;IAC1F,cAAc,EAAE,MAAM,CAAC;IACvB,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf;;;MAGE;IACF,eAAe,EAAE,MAAM,CAAC;IACxB,uDAAuD;IACvD,cAAc,EAAE,MAAM,CAAC;IACvB,0FAA0F;IAC1F,cAAc,EAAE,KAAK,CAAC;IACtB,6DAA6D;IAC7D,KAAK,EAAE,YAAY,CAAC;IACpB,6CAA6C;IAC7C,SAAS,EAAE,sBAAsB,CAAC;IAClC,qFAAqF;IACrF,kBAAkB,CAAC,EAAE,YAAY,CAAC;IAClC,4EAA4E;IAC5E,cAAc,CAAC,EAAE,YAAY,CAAC;IAC9B,8EAA8E;IAC9E,gBAAgB,CAAC,EAAE,YAAY,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,uGAAuG;IACvG,oBAAoB,EAAE,MAAM,CAAC;IAC7B,sCAAsC;IACtC,IAAI,EAAE,eAAe,EAAE,CAAC;IACxB,qDAAqD;IACrD,KAAK,EAAE,YAAY,CAAC;IACpB,sFAAsF;IACtF,kBAAkB,EAAE,YAAY,CAAC;IACjC,yEAAyE;IACzE,kBAAkB,EAAE,KAAK,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,6CAA6C;IAC7C,KAAK,EAAE,gBAAgB,EAAE,CAAC;IAC1B,4DAA4D;IAC5D,KAAK,EAAE,YAAY,CAAC;CACrB"}
+{"version":3,"file":"TextBlockLayoutResult.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextBlockLayoutResult.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,0FAA0F;IAC1F,cAAc,EAAE,MAAM,CAAC;IACvB,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf;;;MAGE;IACF,eAAe,EAAE,MAAM,CAAC;IACxB,uDAAuD;IACvD,cAAc,EAAE,MAAM,CAAC;IACvB,0FAA0F;IAC1F,cAAc,EAAE,KAAK,CAAC;IACtB,6DAA6D;IAC7D,KAAK,EAAE,YAAY,CAAC;IACpB,qHAAqH;IACrH,SAAS,EAAE,sBAAsB,CAAC;IAClC,qFAAqF;IACrF,kBAAkB,CAAC,EAAE,YAAY,CAAC;IAClC,4EAA4E;IAC5E,cAAc,CAAC,EAAE,YAAY,CAAC;IAC9B,8EAA8E;IAC9E,gBAAgB,CAAC,EAAE,YAAY,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,uGAAuG;IACvG,oBAAoB,EAAE,MAAM,CAAC;IAC7B,sCAAsC;IACtC,IAAI,EAAE,eAAe,EAAE,CAAC;IACxB,qDAAqD;IACrD,KAAK,EAAE,YAAY,CAAC;IACpB,sFAAsF;IACtF,kBAAkB,EAAE,YAAY,CAAC;IACjC,yEAAyE;IACzE,kBAAkB,EAAE,KAAK,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,6CAA6C;IAC7C,KAAK,EAAE,gBAAgB,EAAE,CAAC;IAC1B,4DAA4D;IAC5D,KAAK,EAAE,YAAY,CAAC;CACrB"}

package/lib/cjs/annotation/TextBlockLayoutResult.js.map

@@ -1 +1 @@
-{"version":3,"file":"TextBlockLayoutResult.js","sourceRoot":"","sources":["../../../src/annotation/TextBlockLayoutResult.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Annotation\n */\n\nimport { Range2dProps, XAndY } from \"@itwin/core-geometry\";\nimport { FontId } from \"../Fonts\";\nimport { TextStyleSettingsProps } from \"./TextStyle\";\n\n/**\n * Represents a single run in a [[LineLayoutResult]].\n * @note Get the text content of the RunLayoutResult using a combination of the `sourceRunIndex`, `characterOffset`, and `characterCount`.\n * @beta\n */\nexport interface RunLayoutResult {\n  /** The index of the Run this RunLayoutResult was generated from in [[Paragraph.runs]]. */\n  sourceRunIndex: number;\n  /** The ID of the font for the run. */\n  fontId: FontId;\n  /**\n   * The number of characters from the source [[Run]] that have already appeared in the layout.\n   * @note A single source [[TextRun]] can be split into multiple lines to respect the [[TextBlock.width]].\n  */\n  characterOffset: number;\n  /** The number of characters in the RunLayoutResult. */\n  characterCount: number;\n  /** The offset of the RunLayoutResult from the top and left of the [[LineLayoutResult]] */\n  offsetFromLine: XAndY;\n  /** Bounding box enclosing this RunLayoutResult's content. */\n  range: Range2dProps;\n  /** The [[TextStyleSettings]] for the run. */\n  textStyle: TextStyleSettingsProps;\n  /** Bounding box used when justifying the run. This may be smaller than [[range]]. */\n  justificationRange?: Range2dProps;\n  /** The range containing the contents of the [[FractionRun]]'s numerator. */\n  numeratorRange?: Range2dProps;\n  /** The range containing the contents of the [[FractionRun]]'s denominator. */\n  denominatorRange?: Range2dProps;\n}\n\n/**\n * Represents a single line in a [[TextBlockLayoutResult]].\n * @beta\n */\nexport interface LineLayoutResult {\n  /** The index of the paragraph this LineLayoutResult was generated from in [[TextBlock.paragraphs]]. */\n  sourceParagraphIndex: number;\n  /** The runs contained in the line. */\n  runs: RunLayoutResult[];\n  /** The range containing the contents of the line. */\n  range: Range2dProps;\n  /** Bounding box used when justifying the line. This may be smaller than [[range]]. */\n  justificationRange: Range2dProps;\n  /** The offset of the line from the top and left of the [[TextBlock]]. */\n  offsetFromDocument: XAndY;\n}\n\n/**\n * Represents the result of laying out a [[TextBlock]]'s contents into a series of lines containing runs.\n * @see [computeLayoutTextBlockResult]($backend) to lay out a `TextBlock`.\n * @beta\n */\nexport interface TextBlockLayoutResult {\n  /** The laid out lines of a [[TextBlock]]. */\n  lines: LineLayoutResult[];\n  /** The range containing the contents of a [[TextBlock]]. */\n  range: Range2dProps;\n}\n"]}
+{"version":3,"file":"TextBlockLayoutResult.js","sourceRoot":"","sources":["../../../src/annotation/TextBlockLayoutResult.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Annotation\n */\n\nimport { Range2dProps, XAndY } from \"@itwin/core-geometry\";\nimport { FontId } from \"../Fonts\";\nimport { TextStyleSettingsProps } from \"./TextStyle\";\n\n/**\n * Represents a single run in a [[LineLayoutResult]].\n * @note Get the text content of the RunLayoutResult using a combination of the `sourceRunIndex`, `characterOffset`, and `characterCount`.\n * @beta\n */\nexport interface RunLayoutResult {\n  /** The index of the Run this RunLayoutResult was generated from in [[Paragraph.runs]]. */\n  sourceRunIndex: number;\n  /** The ID of the font for the run. */\n  fontId: FontId;\n  /**\n   * The number of characters from the source [[Run]] that have already appeared in the layout.\n   * @note A single source [[TextRun]] can be split into multiple lines to respect the [[TextBlock.width]].\n  */\n  characterOffset: number;\n  /** The number of characters in the RunLayoutResult. */\n  characterCount: number;\n  /** The offset of the RunLayoutResult from the top and left of the [[LineLayoutResult]] */\n  offsetFromLine: XAndY;\n  /** Bounding box enclosing this RunLayoutResult's content. */\n  range: Range2dProps;\n  /** The resolved [[TextStyleSettings]] for the run. Takes into account overrides and styles on the parent classes. */\n  textStyle: TextStyleSettingsProps;\n  /** Bounding box used when justifying the run. This may be smaller than [[range]]. */\n  justificationRange?: Range2dProps;\n  /** The range containing the contents of the [[FractionRun]]'s numerator. */\n  numeratorRange?: Range2dProps;\n  /** The range containing the contents of the [[FractionRun]]'s denominator. */\n  denominatorRange?: Range2dProps;\n}\n\n/**\n * Represents a single line in a [[TextBlockLayoutResult]].\n * @beta\n */\nexport interface LineLayoutResult {\n  /** The index of the paragraph this LineLayoutResult was generated from in [[TextBlock.paragraphs]]. */\n  sourceParagraphIndex: number;\n  /** The runs contained in the line. */\n  runs: RunLayoutResult[];\n  /** The range containing the contents of the line. */\n  range: Range2dProps;\n  /** Bounding box used when justifying the line. This may be smaller than [[range]]. */\n  justificationRange: Range2dProps;\n  /** The offset of the line from the top and left of the [[TextBlock]]. */\n  offsetFromDocument: XAndY;\n}\n\n/**\n * Represents the result of laying out a [[TextBlock]]'s contents into a series of lines containing runs.\n * @see [computeLayoutTextBlockResult]($backend) to lay out a `TextBlock`.\n * @beta\n */\nexport interface TextBlockLayoutResult {\n  /** The laid out lines of a [[TextBlock]]. */\n  lines: LineLayoutResult[];\n  /** The range containing the contents of a [[TextBlock]]. */\n  range: Range2dProps;\n}\n"]}

package/lib/cjs/annotation/TextStyle.d.ts

@@ -1,7 +1,23 @@
 /** @packageDocumentation
  * @module Annotation
  */
+import { DeepReadonlyObject, DeepRequiredObject } from "@itwin/core-bentley";
 import { ColorDefProps } from "../ColorDef";
+/** Set of predefined shapes that can be computed and drawn around the margins of a [[TextBlock]]
+ * @beta
+*/
+export declare const textAnnotationFrameShapes: readonly ["none", "line", "rectangle", "circle", "equilateralTriangle", "diamond", "square", "pentagon", "hexagon", "octagon", "capsule", "roundedRectangle"];
+/** Describes a predefined shape that can be computed and drawn around the margins of a [[TextBlock]]
+ * @beta
+*/
+export type TextAnnotationFrameShape = typeof textAnnotationFrameShapes[number];
+/**
+ * Describes what color to use when filling the frame around a [[TextBlock]].
+ * If `background` is specified, [[GeometryParams.BackgroundFill]] will be set to `BackgroundFill.Outline`.
+ * If `none` is specified, no fill will be applied.
+ * @beta
+ */
+export type TextAnnotationFillColor = TextStyleColor | "background" | "none";
 /** Specifies how to separate the numerator and denominator of a [[FractionRun]], by either a horizontal or diagonal bar.
  * @see [[TextStyleSettingsProps.stackedFractionType]] and [[TextStyleSettings.stackedFractionType]].
  * @beta
@@ -13,15 +29,32 @@ export type StackedFractionType = "horizontal" | "diagonal";
  * @beta
  */
 export type TextStyleColor = ColorDefProps | "subcategory";
+/**
+ * Describes how to draw the frame around a [[TextAnnotation]].
+ * The frame can be a simple line, a filled shape, or both.
+ * If only a subset of properties are specified, the others will be set to their default value.
+ * @beta
+ */
+export interface TextFrameStyleProps {
+    /** Shape of the frame. Default: "none" */
+    shape?: TextAnnotationFrameShape;
+    /** The color to fill the shape of the text frame. This fill is applied using [[FillDisplay.Blanking]]. Default: "none" */
+    fill?: TextAnnotationFillColor;
+    /** The color of the text frame's outline. Default: black */
+    border?: TextStyleColor;
+    /** This will be used to set the [[GeometryParams.weight]] property of the frame (in pixels). Default: 1px */
+    borderWeight?: number;
+}
 /** Properties describing the appearance of [[TextAnnotationLeader]] in a [[TextAnnotation]].
  * Used when producing geometry for [[TextAnnotation]].
  * @beta
  */
 export interface TextLeaderStyleProps {
     /** The color of the leader.
-     * Default: "subcategory".
+     * If `inherit` is specified, the [[TextAnnotationLeader]] will use the color specified in the parent [[TextStyleSettings]]`.
+     * Default: "inherit".
      */
-    color?: TextStyleColor;
+    color?: TextStyleColor | "inherit";
     /** Whether to use an elbow in the leader.
      * Default: false
      */
@@ -42,7 +75,7 @@ export interface TextLeaderStyleProps {
      */
     terminatorWidthFactor?: number;
 }
-/** Serves both as the JSON representation of a [[TextStyleSettings]], and a way for a [[TextBlockComponent]] to selectively override aspects of a [[TextStyle]]'s properties.
+/** Serves both as the JSON representation of a [[TextStyleSettings]], and a way for a [[TextBlockComponent]] to selectively override aspects of a [AnnotationTextStyle]($backend)'s properties.
  * @beta
  */
 export interface TextStyleSettingsProps {
@@ -50,7 +83,7 @@ export interface TextStyleSettingsProps {
      * Default: "subcategory".
      */
     color?: TextStyleColor;
-    /** The name of a font stored in a [Workspace]($backend), used to draw the contents of a [[TextRun]].
+    /** The name of a font stored in an iModel, used to draw the contents of a [[TextRun]].
      * Default: "" (an invalid font name).
      */
     fontName?: string;
@@ -119,9 +152,15 @@ export interface TextStyleSettingsProps {
      * Default: 4 meters.
      */
     tabInterval?: number;
+    /**
+     * A description of the frame around the text annotation.
+     * Used when producing geometry for [[TextAnnotation]]s.
+     * Default: {shape: "none", fill: "none", border: black, borderWeight: 1} for no frame.
+     */
+    frame?: TextFrameStyleProps;
 }
 /** A description of the formatting to be applied to a [[TextBlockComponent]].
- * Named instances of these settings can be stored as [[TextStyle]]s in a [Workspace]($backend).
+ * Named instances of these settings can be stored as [AnnotationTextStyle]($backend)s in an iModel.
  * @note This is an immutable type. Use [[clone]] to create a modified copy.
  * @see [[TextStyleSettingsProps]] for documentation of each of the settings.
  * @beta
@@ -129,7 +168,7 @@ export interface TextStyleSettingsProps {
 export declare class TextStyleSettings {
     /** The color of the text. */
     readonly color: TextStyleColor;
-    /** The name of a font stored in a [Workspace]($backend), used to draw the contents of a [[TextRun]].
+    /** The name of a font stored in an iModel, used to draw the contents of a [[TextRun]].
      */
     readonly fontName: string;
     /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.
@@ -179,13 +218,17 @@ export declare class TextStyleSettings {
      * These are equally spaced from the left edge of the TextBlock. Default is 4 meters.
      */
     readonly tabInterval: number;
-    /** A fully-populated JSON representation of the default settings. */
-    static defaultProps: Readonly<Required<TextStyleSettingsProps>>;
+    /** The frame settings of the [[TextAnnotation]]. */
+    readonly frame: Readonly<Required<TextFrameStyleProps>>;
+    /** A fully-populated JSON representation of the default settings. A real `fontName` must be provided before use. */
+    static defaultProps: DeepReadonlyObject<DeepRequiredObject<TextStyleSettingsProps>>;
     /** Settings initialized to all default values. */
     static defaults: TextStyleSettings;
     private constructor();
     /** Create a copy of these settings, modified according to the properties defined by `alteredProps`. */
     clone(alteredProps?: TextStyleSettingsProps): TextStyleSettings;
+    /** Creates a deep copy of the `TextStyleSettingsProps`. */
+    static cloneProps(props: TextStyleSettingsProps): TextStyleSettingsProps;
     /** Create settings from their JSON representation. */
     static fromJSON(props?: TextStyleSettingsProps): TextStyleSettings;
     toJSON(): TextStyleSettingsProps;
@@ -194,32 +237,18 @@ export declare class TextStyleSettings {
      * @returns true if the two leader styles are equal, false otherwise.
      */
     leaderEquals(other: TextLeaderStyleProps): boolean;
+    frameEquals(other: TextFrameStyleProps): boolean;
     equals(other: TextStyleSettings): boolean;
-}
-/** The JSON representation of a [[TextStyle]].
- * @beta
- */
-export interface TextStyleProps {
-    /** The name of the style. */
-    name: string;
-    /** The settings defined for the style. Any omitted properties will use their default values, as described by [[TextStyleSettingsProps]]. */
-    settings?: TextStyleSettingsProps;
-}
-/** A named, immutable [[TextStyleSettings]] stored in a [Workspace]($backend).
- * @see [[TextBlockComponent.styleName]] to define the text style for a component of a [[TextBlock]].
- * @note This is an immutable type. Use [[clone]] to create a modified copy.
- * @beta
- */
-export declare class TextStyle {
-    readonly name: string;
-    readonly settings: TextStyleSettings;
-    private constructor();
-    /** Create a style from its JSON representation. */
-    static fromJSON(json: TextStyleProps): TextStyle;
-    /** Create a new style. */
-    static create(name: string, settings: TextStyleSettings): TextStyle;
-    /** Create a copy of this style with the same name, and settings modified according to the properties defined by `alteredSettings`. */
-    clone(alteredSettings: TextStyleSettingsProps): TextStyle;
-    equals(other: TextStyle): boolean;
+    /**
+     * Returns a list of validation errors for this instance.
+     *
+     * A TextStyleSettings object may contain values that are invalid in all contexts.
+     * If this method returns any error strings, using the settings will likely result in rendering failures or runtime exceptions.
+     *
+     * This method only checks for universally invalid values. Additional domain-specific validation may be required depending on the context in which these settings are used.
+     *
+     * @returns An array of error strings describing the invalid values, or an empty array if the settings are valid.
+     */
+    getValidationErrors(): string[];
 }
 //# sourceMappingURL=TextStyle.d.ts.map

package/lib/cjs/annotation/TextStyle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextStyle.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,UAAU,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,aAAa,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;uBAGmB;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B,6BAA6B;IAC7B,SAAgB,KAAK,EAAE,cAAc,CAAC;IACtC;OACG;IACH,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C,kFAAkF;IAClF,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC,sFAAsF;IACtF,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,2EAA2E;IAC3E,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAgB,oBAAoB,EAAE,MAAM,CAAC;IAC7C,oFAAoF;IACpF,SAAgB,mBAAmB,EAAE,mBAAmB,CAAC;IACzD;;OAEG;IACH,SAAgB,qBAAqB,EAAE,MAAM,CAAC;IAC9C;;OAEG;IACH,SAAgB,cAAc,EAAE,MAAM,CAAC;IACvC;;OAEG;IACH,SAAgB,uBAAuB,EAAE,MAAM,CAAC;IAChD;;OAEG;IACH,SAAgB,gBAAgB,EAAE,MAAM,CAAC;IACzC,sFAAsF;IACtF,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,SAAgB,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACjE;;OAEG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IAEpC,qEAAqE;IACrE,OAAc,YAAY,EAAE,QAAQ,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAuBpE;IAEF,kDAAkD;IAClD,OAAc,QAAQ,EAAE,iBAAiB,CAA6B;IAEtE,OAAO;IA8BP,uGAAuG;IAChG,KAAK,CAAC,YAAY,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAItE,sDAAsD;WACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAIlE,MAAM,IAAI,sBAAsB;IAGvC;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO;IAMlD,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;CAUjD;AAKD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,4IAA4I;IAC5I,QAAQ,CAAC,EAAE,sBAAsB,CAAC;CACnC;AAED;;;;GAIG;AACH,qBAAa,SAAS;IACpB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,QAAQ,EAAE,iBAAiB,CAAC;IAE5C,OAAO;IAKP,mDAAmD;WACrC,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,SAAS;IAIvD,0BAA0B;WACZ,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,GAAG,SAAS;IAI1E,sIAAsI;IAC/H,KAAK,CAAC,eAAe,EAAE,sBAAsB,GAAG,SAAS;IAIzD,MAAM,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO;CAGzC"}
+{"version":3,"file":"TextStyle.d.ts","sourceRoot":"","sources":["../../../src/annotation/TextStyle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAC7E,OAAO,EAAY,aAAa,EAAE,MAAM,aAAa,CAAC;AAEtD;;EAEE;AACF,eAAO,MAAM,yBAAyB,+JAAgK,CAAC;AAEvM;;EAEE;AACF,MAAM,MAAM,wBAAwB,GAAG,OAAO,yBAAyB,CAAC,MAAM,CAAC,CAAC;AAEhF;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,YAAY,GAAG,MAAM,CAAC;AAE7E;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,UAAU,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,aAAa,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,0CAA0C;IAC1C,KAAK,CAAC,EAAE,wBAAwB,CAAC;IACjC,0HAA0H;IAC1H,IAAI,CAAC,EAAE,uBAAuB,CAAC;IAC/B,4DAA4D;IAC5D,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,6GAA6G;IAC7G,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,KAAK,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;uBAGmB;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAC;CAC7B;AAcD;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC5B,6BAA6B;IAC7B,SAAgB,KAAK,EAAE,cAAc,CAAC;IACtC;OACG;IACH,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,SAAgB,iBAAiB,EAAE,MAAM,CAAC;IAC1C,kFAAkF;IAClF,SAAgB,MAAM,EAAE,OAAO,CAAC;IAChC,sFAAsF;IACtF,SAAgB,QAAQ,EAAE,OAAO,CAAC;IAClC,2EAA2E;IAC3E,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAgB,oBAAoB,EAAE,MAAM,CAAC;IAC7C,oFAAoF;IACpF,SAAgB,mBAAmB,EAAE,mBAAmB,CAAC;IACzD;;OAEG;IACH,SAAgB,qBAAqB,EAAE,MAAM,CAAC;IAC9C;;OAEG;IACH,SAAgB,cAAc,EAAE,MAAM,CAAC;IACvC;;OAEG;IACH,SAAgB,uBAAuB,EAAE,MAAM,CAAC;IAChD;;OAEG;IACH,SAAgB,gBAAgB,EAAE,MAAM,CAAC;IACzC,sFAAsF;IACtF,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,SAAgB,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACjE;;OAEG;IACH,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,oDAAoD;IACpD,SAAgB,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAE/D,oHAAoH;IACpH,OAAc,YAAY,EAAE,kBAAkB,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC,CA6BxF;IAEF,kDAAkD;IAClD,OAAc,QAAQ,EAAE,iBAAiB,CAA6B;IAEtE,OAAO;IAsCP,uGAAuG;IAChG,KAAK,CAAC,YAAY,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAItE,2DAA2D;WAC7C,UAAU,CAAC,KAAK,EAAE,sBAAsB,GAAG,sBAAsB;IAW/E,sDAAsD;WACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,iBAAiB;IAIlE,MAAM,IAAI,sBAAsB;IAIvC;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO;IAMlD,WAAW,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO;IAOhD,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;IAYhD;;;;;;;;;OASG;IACI,mBAAmB,IAAI,MAAM,EAAE;CAgBvC"}

package/lib/cjs/annotation/TextStyle.js

@@ -7,9 +7,26 @@
  * @module Annotation
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TextStyle = exports.TextStyleSettings = void 0;
+exports.TextStyleSettings = exports.textAnnotationFrameShapes = void 0;
+const ColorDef_1 = require("../ColorDef");
+/** Set of predefined shapes that can be computed and drawn around the margins of a [[TextBlock]]
+ * @beta
+*/
+exports.textAnnotationFrameShapes = ["none", "line", "rectangle", "circle", "equilateralTriangle", "diamond", "square", "pentagon", "hexagon", "octagon", "capsule", "roundedRectangle"];
+;
+function deepFreeze(obj) {
+    if (obj === null || typeof obj !== "object" || Object.isFrozen(obj))
+        return;
+    Object.getOwnPropertyNames(obj).forEach((prop) => {
+        const value = obj[prop];
+        if (value && typeof value === "object") {
+            deepFreeze(value);
+        }
+    });
+    Object.freeze(obj);
+}
 /** A description of the formatting to be applied to a [[TextBlockComponent]].
- * Named instances of these settings can be stored as [[TextStyle]]s in a [Workspace]($backend).
+ * Named instances of these settings can be stored as [AnnotationTextStyle]($backend)s in an iModel.
  * @note This is an immutable type. Use [[clone]] to create a modified copy.
  * @see [[TextStyleSettingsProps]] for documentation of each of the settings.
  * @beta
@@ -17,7 +34,7 @@ exports.TextStyle = exports.TextStyleSettings = void 0;
 class TextStyleSettings {
     /** The color of the text. */
     color;
-    /** The name of a font stored in a [Workspace]($backend), used to draw the contents of a [[TextRun]].
+    /** The name of a font stored in an iModel, used to draw the contents of a [[TextRun]].
      */
     fontName;
     /** The height each line of text, in meters. Many other settings use the line height as the basis for computing their own values.
@@ -67,7 +84,9 @@ class TextStyleSettings {
      * These are equally spaced from the left edge of the TextBlock. Default is 4 meters.
      */
     tabInterval;
-    /** A fully-populated JSON representation of the default settings. */
+    /** The frame settings of the [[TextAnnotation]]. */
+    frame;
+    /** A fully-populated JSON representation of the default settings. A real `fontName` must be provided before use. */
     static defaultProps = {
         color: "subcategory",
         fontName: "",
@@ -84,13 +103,19 @@ class TextStyleSettings {
         superScriptScale: 2 / 3,
         widthFactor: 1,
         leader: {
-            color: "subcategory",
+            color: "inherit",
             wantElbow: false,
             elbowLength: 1.0,
             terminatorHeightFactor: 1.0,
             terminatorWidthFactor: 1.0,
         },
         tabInterval: 4,
+        frame: {
+            shape: "none",
+            fill: "none",
+            border: ColorDef_1.ColorDef.black.toJSON(),
+            borderWeight: 1,
+        },
     };
     /** Settings initialized to all default values. */
     static defaults = new TextStyleSettings({});
@@ -121,11 +146,30 @@ class TextStyleSettings {
         };
         this.leader = Object.freeze(leader);
         this.tabInterval = props.tabInterval ?? defaults.tabInterval;
+        const frame = {
+            shape: props.frame?.shape ?? defaults.frame.shape,
+            fill: props.frame?.fill ?? defaults.frame.fill,
+            border: props.frame?.border ?? defaults.frame.border,
+            borderWeight: props.frame?.borderWeight ?? defaults.frame.borderWeight,
+        };
+        // Cast to indicate to TypeScript that the frame properties are all defined
+        this.frame = Object.freeze(frame);
     }
     /** Create a copy of these settings, modified according to the properties defined by `alteredProps`. */
     clone(alteredProps) {
         return alteredProps ? new TextStyleSettings(alteredProps, this) : this;
     }
+    /** Creates a deep copy of the `TextStyleSettingsProps`. */
+    static cloneProps(props) {
+        const copy = { ...props };
+        if (props.leader) {
+            copy.leader = { ...props.leader };
+        }
+        if (props.frame) {
+            copy.frame = { ...props.frame };
+        }
+        return copy;
+    }
     /** Create settings from their JSON representation. */
     static fromJSON(props) {
         return props ? new TextStyleSettings(props) : TextStyleSettings.defaults;
@@ -142,47 +186,48 @@ class TextStyleSettings {
             && this.leader.elbowLength === other.elbowLength && this.leader.terminatorHeightFactor === other.terminatorHeightFactor
             && this.leader.terminatorWidthFactor === other.terminatorWidthFactor;
     }
+    frameEquals(other) {
+        return this.frame?.shape === other.shape
+            && this.frame?.fill === other.fill
+            && this.frame?.border === other.border
+            && this.frame?.borderWeight === other.borderWeight;
+    }
     equals(other) {
         return this.color === other.color && this.fontName === other.fontName
             && this.lineHeight === other.lineHeight && this.lineSpacingFactor === other.lineSpacingFactor && this.widthFactor === other.widthFactor
             && this.isBold === other.isBold && this.isItalic === other.isItalic && this.isUnderlined === other.isUnderlined
             && this.stackedFractionType === other.stackedFractionType && this.stackedFractionScale === other.stackedFractionScale
             && this.subScriptOffsetFactor === other.subScriptOffsetFactor && this.subScriptScale === other.subScriptScale
-            && this.superScriptOffsetFactor === other.superScriptOffsetFactor
-            && this.superScriptScale === other.superScriptScale
-            && this.tabInterval === other.tabInterval && this.leaderEquals(other.leader);
-    }
-}
-exports.TextStyleSettings = TextStyleSettings;
-Object.freeze(TextStyleSettings.defaultProps);
-Object.freeze(TextStyleSettings.defaults);
-/** A named, immutable [[TextStyleSettings]] stored in a [Workspace]($backend).
- * @see [[TextBlockComponent.styleName]] to define the text style for a component of a [[TextBlock]].
- * @note This is an immutable type. Use [[clone]] to create a modified copy.
- * @beta
- */
-class TextStyle {
-    name;
-    settings;
-    constructor(name, settings) {
-        this.name = name;
-        this.settings = settings;
-    }
-    /** Create a style from its JSON representation. */
-    static fromJSON(json) {
-        return TextStyle.create(json.name, TextStyleSettings.fromJSON(json.settings));
-    }
-    /** Create a new style. */
-    static create(name, settings) {
-        return new TextStyle(name, settings);
-    }
-    /** Create a copy of this style with the same name, and settings modified according to the properties defined by `alteredSettings`. */
-    clone(alteredSettings) {
-        return TextStyle.create(this.name, this.settings.clone(alteredSettings));
+            && this.superScriptOffsetFactor === other.superScriptOffsetFactor && this.superScriptScale === other.superScriptScale
+            && this.tabInterval === other.tabInterval
+            && this.leaderEquals(other.leader)
+            && this.frameEquals(other.frame);
     }
-    equals(other) {
-        return this.name === other.name && this.settings.equals(other.settings);
+    /**
+     * Returns a list of validation errors for this instance.
+     *
+     * A TextStyleSettings object may contain values that are invalid in all contexts.
+     * If this method returns any error strings, using the settings will likely result in rendering failures or runtime exceptions.
+     *
+     * This method only checks for universally invalid values. Additional domain-specific validation may be required depending on the context in which these settings are used.
+     *
+     * @returns An array of error strings describing the invalid values, or an empty array if the settings are valid.
+     */
+    getValidationErrors() {
+        const errorMessages = [];
+        if (this.fontName.trim() === "") {
+            errorMessages.push("fontName must be provided");
+        }
+        if (this.lineHeight <= 0) {
+            errorMessages.push("lineHeight must be greater than 0");
+        }
+        if (this.stackedFractionScale <= 0) {
+            errorMessages.push("stackedFractionScale must be greater than 0");
+        }
+        return errorMessages;
     }
 }
-exports.TextStyle = TextStyle;
+exports.TextStyleSettings = TextStyleSettings;
+deepFreeze(TextStyleSettings.defaultProps);
+deepFreeze(TextStyleSettings.defaults);
 //# sourceMappingURL=TextStyle.js.map