lucid-extension-sdk 0.0.444 → 0.0.445
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/commandtypes.d.ts +16 -12
- package/core/cardintegration/cardfielddisplaysettings.d.ts +5 -459
- package/core/cardintegration/cardintegrationautosyncconfig.d.ts +3 -3
- package/core/cardintegration/cardintegrationconfig.d.ts +4 -446
- package/core/cardintegration/cardintegrationparams.d.ts +2 -2
- package/core/cardintegration/cardpaneltabs/tab.d.ts +1 -1
- package/core/cardintegration/cardpaneltabs/tabs/listtab.d.ts +1 -1
- package/core/cardintegration/cardpaneltabs/tabs.d.ts +4 -4
- package/core/cardintegration/extensiondatapanel/extensiondatapanellistitem.d.ts +4 -4
- package/core/cardintegration/extensiondatapanel/extensiondatapanellistitemtag.d.ts +2 -2
- package/core/cardintegration/extensiondatapanel/extensiondatapanellistitemusertag.d.ts +1 -1
- package/core/cardintegration/lucidcardintegration.d.ts +21 -13
- package/core/cardintegration/lucidcardintegrationcustomimportmodal.d.ts +3 -2
- package/core/cardintegration/lucidcardintegrationregistry.d.ts +1 -0
- package/core/cardintegration/lucidcardintegrationregistry.js +24 -1
- package/core/cardintegration/lucidcardintegrationstandardimportmodal.d.ts +2 -2
- package/core/cardintegration/useritemeditpermissions.d.ts +1 -1
- package/core/data/datasource/datasourceutils.d.ts +2 -2
- package/core/data/datasource/serializeddatasourceproperties.d.ts +2 -2
- package/core/data/datasource/serializedimporteddatasource.d.ts +6 -6
- package/core/data/datasource/sourceforeignkeys.d.ts +1 -1
- package/core/data/datasource/upstreamconfig.d.ts +2 -2
- package/core/data/fieldspecification.d.ts +4 -4
- package/core/data/fieldtypedefinition/basefieldtypedefinition.d.ts +5 -5
- package/core/data/fieldtypedefinition/collectionenumfieldtype.d.ts +2 -2
- package/core/data/fieldtypedefinition/fieldtypearray.d.ts +3 -3
- package/core/data/fieldtypedefinition/fieldtypedefinition.d.ts +1 -1
- package/core/data/fieldtypedefinition/lucidfields.d.ts +5 -1
- package/core/data/fieldtypedefinition/lucidfields.js +4 -0
- package/core/data/fieldtypedefinition/ndimensionalfieldtypearray.d.ts +1 -1
- package/core/data/fieldtypedefinition/semantickind.js +1 -1
- package/core/data/lucidicon.d.ts +1 -1
- package/core/data/referencekeys/serializedreferencekey.d.ts +2 -2
- package/core/data/serializedfield/serializeddataitems.d.ts +1 -1
- package/core/data/serializedfield/serializeddisplayoption.d.ts +1 -1
- package/core/data/serializedfield/serializedfielddefinition.d.ts +3 -3
- package/core/data/serializedfield/serializedschema.d.ts +1 -1
- package/core/format/format.d.ts +3 -3
- package/core/format/objectformat.d.ts +2 -2
- package/core/format/pointformat.d.ts +2 -2
- package/core/format/primitiveformat.d.ts +1 -1
- package/core/format/recordformat.d.ts +1 -1
- package/core/format/simpleformat.d.ts +1 -1
- package/core/guards.d.ts +1 -1
- package/core/importcardfromdetails/importcardfromdetails.d.ts +2 -2
- package/core/importcardfrompastedlink/importcardfrompastedlinkcallback.d.ts +1 -1
- package/core/iterable.d.ts +1 -1
- package/core/mutable.d.ts +1 -1
- package/core/primitivedata.d.ts +9 -8
- package/core/properties/datagraphic/staticdatagraphicsettings.d.ts +2 -2
- package/core/rules/serializedcondition.d.ts +1 -1
- package/core/rules/serializeddatagraphic.d.ts +1 -1
- package/core/rules/serializedeffect.d.ts +2 -2
- package/core/rules/serializedstencilgraphic.d.ts +1 -1
- package/core/sharedcardintegration/cardintegrationdefinitions.d.ts +69 -9
- package/core/sharedcardintegration/cardintegrationdefinitions.js +24 -1
- package/core/spreadsheetintegration/lucidspreadsheetintegration.d.ts +5 -5
- package/core/unfurl/unfurlcallbacks.d.ts +1 -1
- package/core/unfurl/unfurldetails.d.ts +2 -2
- package/core/unfurl/unfurliframe.d.ts +1 -1
- package/core/validators/validators.d.ts +1 -1
- package/core/xhr.d.ts +2 -2
- package/data/collectiondefinition.d.ts +3 -3
- package/data/collectionproxy.d.ts +4 -3
- package/data/datasourceproxy.d.ts +2 -2
- package/data/displayoptiondefinition.d.ts +1 -1
- package/data/fieldconstraintdefinition.d.ts +1 -1
- package/data/referencekeydefinition.d.ts +3 -3
- package/data/referencekeyproxy.d.ts +3 -2
- package/data/schemadefinition.d.ts +10 -5
- package/data/schemadefinition.js +19 -1
- package/dataconnector/actions/action.d.ts +13 -1
- package/dataconnector/actions/action.js +10 -1
- package/dataconnector/actions/patch.d.ts +5 -5
- package/dataconnector/actions/patchresponsebody.d.ts +3 -3
- package/dataconnector/actions/serializedactions.d.ts +1 -1
- package/dataconnector/actions/serializedactions.js +8 -3
- package/dataconnector/actions/serializedpatchtypes.d.ts +1 -1
- package/dataconnector/dataconnector.d.ts +8 -7
- package/dataconnector/dataconnector.js +12 -5
- package/dataconnector/dataconnectorclient.d.ts +5 -4
- package/dataconnector/datasourceclient.d.ts +2 -2
- package/dataconnector/datasourceupdatetypes.d.ts +8 -8
- package/dataconnector/itemrekeyerandrelabeler.d.ts +1 -1
- package/dataconnector/signaturevalidator.d.ts +1 -1
- package/dataconnector/throwunsuccessful.d.ts +1 -1
- package/document/blockclasses/cardblockproxy.d.ts +1 -1
- package/document/blockclasses/linkunfurlblockproxy.d.ts +2 -2
- package/document/blockclasses/swimlaneblockproxy.d.ts +3 -3
- package/document/blockclasses/tableblockproxy.d.ts +3 -3
- package/document/blockdefinition.d.ts +3 -3
- package/document/blockproxy.d.ts +4 -4
- package/document/documentchunk.d.ts +1 -1
- package/document/documentelement/ruleproxy.d.ts +2 -2
- package/document/documentproxy.d.ts +4 -4
- package/document/elementproxy.d.ts +1 -1
- package/document/graphdefinition.d.ts +1 -1
- package/document/imagedefinition.d.ts +3 -3
- package/document/itemproxy.d.ts +3 -3
- package/document/lineproxy.d.ts +3 -3
- package/document/pageproxy.d.ts +7 -7
- package/document/ruledefinition.d.ts +3 -3
- package/document/shapedataproxy.d.ts +2 -2
- package/document/text/textstyle.d.ts +2 -10
- package/editorclient.d.ts +8 -8
- package/message/importcardfrompastedlinkeventmessage.d.ts +1 -1
- package/message/unfurleventmessage.d.ts +1 -1
- package/package.json +1 -1
- package/ui/iframeui.d.ts +1 -1
package/commandtypes.d.ts
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
import { SerializedCardIntegrationConfig } from './core/cardintegration/cardintegrationconfig';
|
|
2
|
-
import { SerializedFieldTypeDefinition } from './core/data/fieldtypedefinition/fieldtypedefinition';
|
|
3
|
-
import { SerializedReferenceKeyType } from './core/data/referencekeys/serializedreferencekey';
|
|
4
|
-
import { SerializedFieldType } from './core/data/serializedfield/serializedfields';
|
|
5
|
-
import { JsonObject, UnsafeJsonSerializableOrUndefined } from './core/jsonserializable';
|
|
1
|
+
import type { SerializedCardIntegrationConfig } from './core/cardintegration/cardintegrationconfig';
|
|
2
|
+
import type { SerializedFieldTypeDefinition } from './core/data/fieldtypedefinition/fieldtypedefinition';
|
|
3
|
+
import type { SerializedReferenceKeyType } from './core/data/referencekeys/serializedreferencekey';
|
|
4
|
+
import type { SerializedFieldType } from './core/data/serializedfield/serializedfields';
|
|
5
|
+
import type { JsonObject, UnsafeJsonSerializableOrUndefined } from './core/jsonserializable';
|
|
6
6
|
import { LucidProduct } from './core/lucidproduct';
|
|
7
|
-
import { LinearOffsetType } from './core/offsettype';
|
|
8
|
-
import { PartialAndNullish } from './core/partialandundefined';
|
|
9
|
-
import { SerializedDataError } from './core/serializeddataerror';
|
|
7
|
+
import type { LinearOffsetType } from './core/offsettype';
|
|
8
|
+
import type { PartialAndNullish } from './core/partialandundefined';
|
|
9
|
+
import type { SerializedDataError } from './core/serializeddataerror';
|
|
10
10
|
import { ShapeDataInheritance } from './core/shapedatainheritance';
|
|
11
11
|
import { DocumentAccessPermission } from './document/documentaccesspermission';
|
|
12
12
|
import { DocumentElementType } from './document/documentelement/documentelementtype';
|
|
13
|
-
import { SerializedLineTextAreaPositioning } from './document/linetextareapositioning';
|
|
14
|
-
import { TextStyle } from './document/text/textstyle';
|
|
15
|
-
import { Box, Point } from './math';
|
|
13
|
+
import type { SerializedLineTextAreaPositioning } from './document/linetextareapositioning';
|
|
14
|
+
import type { TextStyle } from './document/text/textstyle';
|
|
15
|
+
import type { Box, Point } from './math';
|
|
16
16
|
import { MenuLocation, MenuType } from './ui/menu';
|
|
17
17
|
import { PanelLocation } from './ui/panel';
|
|
18
18
|
/**
|
|
@@ -752,7 +752,6 @@ export type AddCardsActions = {
|
|
|
752
752
|
'cc': string;
|
|
753
753
|
};
|
|
754
754
|
export type AutoSyncSettings = {
|
|
755
|
-
'h': string;
|
|
756
755
|
/** Phrases */
|
|
757
756
|
'p'?: {
|
|
758
757
|
/** Header */
|
|
@@ -865,6 +864,11 @@ export type AddCardIntegrationQuery = {
|
|
|
865
864
|
* Tag callback, to display tag information for any card
|
|
866
865
|
*/
|
|
867
866
|
'tc'?: string | undefined;
|
|
867
|
+
/**
|
|
868
|
+
* @experimental
|
|
869
|
+
* Banner action callback, to handle action button clicks in import error banners
|
|
870
|
+
*/
|
|
871
|
+
'bac'?: string | undefined;
|
|
868
872
|
/**
|
|
869
873
|
* If specified, the text phrases to show in the dependency mapping UI.
|
|
870
874
|
* If not specified, dependency mapping for this integration uses the default fallback phrases.
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { FormatToDeserializedType, FormatToSerializedType } from '../format/format';
|
|
2
|
-
import { DeepWritable } from '../mutable';
|
|
1
|
+
import { type FormatToDeserializedType, type FormatToSerializedType } from '../format/format';
|
|
2
|
+
import type { DeepWritable } from '../mutable';
|
|
3
3
|
import { HorizontalBadgePos, VerticalBadgePos } from '../properties/datagraphic/badgeposition';
|
|
4
4
|
/**
|
|
5
5
|
* When configuring a field on a LucidCardBlock to be displayed as a data graphic, one of these values specifies
|
|
@@ -435,466 +435,12 @@ export type LucidCardFieldDisplaySettings = DeepWritable<FormatToDeserializedTyp
|
|
|
435
435
|
/** @ignore */
|
|
436
436
|
export type SerializedLucidCardFieldDisplaySettings = FormatToSerializedType<typeof CardFieldDisplaySettingsFormatter>;
|
|
437
437
|
/** @ignore */
|
|
438
|
-
export declare const isSerializedLucidCardFieldDisplaySettings:
|
|
439
|
-
readonly stencilConfig: readonly ["StencilConfig", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
|
|
440
|
-
/**
|
|
441
|
-
* How should we generate the stencil/data graphic from the specified field value?
|
|
442
|
-
* These are registered in LucidCardsLibrary.registerStencilDisplayTypes.
|
|
443
|
-
*
|
|
444
|
-
* The serialized key is `getterKey` for backwards compatible, legacy reasons. We have renamed this field in code,
|
|
445
|
-
* but need to support the original serialized key.
|
|
446
|
-
*/
|
|
447
|
-
readonly displayType: readonly ["getterKey", import("../format/format").Format<FieldDisplayType, FieldDisplayType>];
|
|
448
|
-
/**
|
|
449
|
-
* For displayType values that support it, you may provide an override for the
|
|
450
|
-
* background color for this data. If this is not provided, the background color
|
|
451
|
-
* will default to the background color of the card itself, darkened 5%.
|
|
452
|
-
*
|
|
453
|
-
* This may be provided as a literal color hex, e.g. "#00ff00ff" or as a formula
|
|
454
|
-
* by starting the string with "=", e.g. "=darken("#ffffff", 0.5)"
|
|
455
|
-
*/
|
|
456
|
-
readonly backgroundColor: readonly ["bg", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
457
|
-
/**
|
|
458
|
-
* For displayType values that support it, you may provide an override for the
|
|
459
|
-
* foreground color for this data. If this is not provided, the foreground color
|
|
460
|
-
* will default to grey.
|
|
461
|
-
*
|
|
462
|
-
* This may be provided as a literal color hex, e.g. "#00ff00ff" or as a formula
|
|
463
|
-
* by starting the string with "=", e.g. "=darken("#ffffff", 0.5)"
|
|
464
|
-
*/
|
|
465
|
-
readonly foregroundColor: readonly ["fg", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
466
|
-
/**
|
|
467
|
-
* For displayType values that support it, you may provide a height and a width
|
|
468
|
-
* for the image size. Images are 24px by 24px by default.
|
|
469
|
-
*
|
|
470
|
-
*/
|
|
471
|
-
readonly imageBadgeSettings: readonly ["imageBadgeSettings", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
|
|
472
|
-
readonly height: readonly ["height", import("../format/format").Format<number, number>];
|
|
473
|
-
readonly width: readonly ["width", import("../format/format").Format<number, number>];
|
|
474
|
-
}> | null | undefined, {
|
|
475
|
-
readonly height: number;
|
|
476
|
-
readonly width: number;
|
|
477
|
-
} | null | undefined>];
|
|
478
|
-
/**
|
|
479
|
-
* If specified, the result of this formula (executed in the context of the data item
|
|
480
|
-
* associated with this card) will be used instead of the raw field value when
|
|
481
|
-
* creating the data graphic. This can be useful if, for example, you want to convert
|
|
482
|
-
* an ID into a URL.
|
|
483
|
-
*/
|
|
484
|
-
readonly valueFormula: readonly ["f", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
485
|
-
/**
|
|
486
|
-
* If specified, the result of this formula (executed in the context of the data item
|
|
487
|
-
* associated with this card) will be used as a tooltip when the user hovers the
|
|
488
|
-
* cursor over this data graphic.
|
|
489
|
-
*/
|
|
490
|
-
readonly tooltipFormula: readonly ["t", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
491
|
-
/**
|
|
492
|
-
* Each display type has its default location on the card. You can override those
|
|
493
|
-
* default locations by setting these values.
|
|
494
|
-
*/
|
|
495
|
-
readonly horizontalPosition: readonly ["h", import("../format/format").Format<HorizontalBadgePos | null | undefined, HorizontalBadgePos | null | undefined>];
|
|
496
|
-
/**
|
|
497
|
-
* Each display type has its default location on the card. You can override those
|
|
498
|
-
* default locations by setting these values.
|
|
499
|
-
*/
|
|
500
|
-
readonly verticalPosition: readonly ["v", import("../format/format").Format<VerticalBadgePos | null | undefined, VerticalBadgePos | null | undefined>];
|
|
501
|
-
/**
|
|
502
|
-
* If specified, what behavior should happen when the user clicks on the data graphic
|
|
503
|
-
* generated via the above displayType?
|
|
504
|
-
*/
|
|
505
|
-
readonly onClickHandlerKey: readonly ["onClickHandlerKey", import("../format/format").Format<OnClickHandlerKeys | null | undefined, OnClickHandlerKeys | null | undefined>];
|
|
506
|
-
/**
|
|
507
|
-
* If onClickHandlerKey is OpenBrowserWindow, this formula calculates the URL to open.
|
|
508
|
-
*/
|
|
509
|
-
readonly linkFormula: readonly ["l", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
510
|
-
/**
|
|
511
|
-
* @experimental
|
|
512
|
-
* If onClickHandlerKey is OpenTargetTab, this specifies the label of the tab to open.
|
|
513
|
-
*/
|
|
514
|
-
readonly targetTabLabel: readonly ["targetTabLabel", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
515
|
-
/**
|
|
516
|
-
* Allows the same card to have multiple textbadges but have different properties.
|
|
517
|
-
* You can change bold, italic, underline, rounding, minwidth, minheight, maxtextwidth, maxfontsize
|
|
518
|
-
*/
|
|
519
|
-
readonly textBadgeSettings: readonly ["textBadgeSettings", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
|
|
520
|
-
readonly rounding: readonly ["rounding", import("../format/format").Format<number | null | undefined, number | null | undefined>];
|
|
521
|
-
readonly bold: readonly ["bold", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
|
|
522
|
-
readonly italic: readonly ["italic", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
|
|
523
|
-
readonly underline: readonly ["underline", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
|
|
524
|
-
readonly minwidth: readonly ["minwidth", import("../format/format").Format<number | null | undefined, number | null | undefined>];
|
|
525
|
-
readonly minheight: readonly ["minheight", import("../format/format").Format<number | null | undefined, number | null | undefined>];
|
|
526
|
-
readonly maxfontsize: readonly ["maxfontsize", import("../format/format").Format<number | null | undefined, number | null | undefined>];
|
|
527
|
-
readonly maxtextwidth: readonly ["maxtextwidth", import("../format/format").Format<number | null | undefined, number | null | undefined>];
|
|
528
|
-
readonly iswithinpill: readonly ["iswithinpill", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
|
|
529
|
-
readonly hasleadingicon: readonly ["hasleadingicon", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
|
|
530
|
-
}> | null | undefined, {
|
|
531
|
-
readonly rounding?: number | null | undefined;
|
|
532
|
-
readonly bold?: boolean | null | undefined;
|
|
533
|
-
readonly italic?: boolean | null | undefined;
|
|
534
|
-
readonly underline?: boolean | null | undefined;
|
|
535
|
-
readonly minwidth?: number | null | undefined;
|
|
536
|
-
readonly minheight?: number | null | undefined;
|
|
537
|
-
readonly maxfontsize?: number | null | undefined;
|
|
538
|
-
readonly maxtextwidth?: number | null | undefined;
|
|
539
|
-
readonly iswithinpill?: boolean | null | undefined;
|
|
540
|
-
readonly hasleadingicon?: boolean | null | undefined;
|
|
541
|
-
} | null | undefined>];
|
|
542
|
-
}> | null | undefined, {
|
|
543
|
-
readonly displayType: FieldDisplayType;
|
|
544
|
-
readonly backgroundColor?: string | null | undefined;
|
|
545
|
-
readonly foregroundColor?: string | null | undefined;
|
|
546
|
-
readonly imageBadgeSettings?: {
|
|
547
|
-
readonly height: number;
|
|
548
|
-
readonly width: number;
|
|
549
|
-
} | null | undefined;
|
|
550
|
-
readonly valueFormula?: string | null | undefined;
|
|
551
|
-
readonly tooltipFormula?: string | null | undefined;
|
|
552
|
-
readonly horizontalPosition?: HorizontalBadgePos | null | undefined;
|
|
553
|
-
readonly verticalPosition?: VerticalBadgePos | null | undefined;
|
|
554
|
-
readonly onClickHandlerKey?: OnClickHandlerKeys | null | undefined;
|
|
555
|
-
readonly linkFormula?: string | null | undefined;
|
|
556
|
-
readonly targetTabLabel?: string | null | undefined;
|
|
557
|
-
readonly textBadgeSettings?: {
|
|
558
|
-
readonly rounding?: number | null | undefined;
|
|
559
|
-
readonly bold?: boolean | null | undefined;
|
|
560
|
-
readonly italic?: boolean | null | undefined;
|
|
561
|
-
readonly underline?: boolean | null | undefined;
|
|
562
|
-
readonly minwidth?: number | null | undefined;
|
|
563
|
-
readonly minheight?: number | null | undefined;
|
|
564
|
-
readonly maxfontsize?: number | null | undefined;
|
|
565
|
-
readonly maxtextwidth?: number | null | undefined;
|
|
566
|
-
readonly iswithinpill?: boolean | null | undefined;
|
|
567
|
-
readonly hasleadingicon?: boolean | null | undefined;
|
|
568
|
-
} | null | undefined;
|
|
569
|
-
} | null | undefined>];
|
|
570
|
-
}>>;
|
|
438
|
+
export declare const isSerializedLucidCardFieldDisplaySettings: typeof CardFieldDisplaySettingsFormatter.validator;
|
|
571
439
|
export declare function copyLucidCardFieldDisplaySettings(settings: LucidCardFieldDisplaySettings): LucidCardFieldDisplaySettings;
|
|
572
440
|
/** @ignore */
|
|
573
|
-
export declare const serializeLucidCardFieldDisplaySettings:
|
|
574
|
-
readonly stencilConfig?: {
|
|
575
|
-
readonly displayType: FieldDisplayType;
|
|
576
|
-
readonly backgroundColor?: string | null | undefined;
|
|
577
|
-
readonly foregroundColor?: string | null | undefined;
|
|
578
|
-
readonly imageBadgeSettings?: {
|
|
579
|
-
readonly height: number;
|
|
580
|
-
readonly width: number;
|
|
581
|
-
} | null | undefined;
|
|
582
|
-
readonly valueFormula?: string | null | undefined;
|
|
583
|
-
readonly tooltipFormula?: string | null | undefined;
|
|
584
|
-
readonly horizontalPosition?: HorizontalBadgePos | null | undefined;
|
|
585
|
-
readonly verticalPosition?: VerticalBadgePos | null | undefined;
|
|
586
|
-
readonly onClickHandlerKey?: OnClickHandlerKeys | null | undefined;
|
|
587
|
-
readonly linkFormula?: string | null | undefined;
|
|
588
|
-
readonly targetTabLabel?: string | null | undefined;
|
|
589
|
-
readonly textBadgeSettings?: {
|
|
590
|
-
readonly rounding?: number | null | undefined;
|
|
591
|
-
readonly bold?: boolean | null | undefined;
|
|
592
|
-
readonly italic?: boolean | null | undefined;
|
|
593
|
-
readonly underline?: boolean | null | undefined;
|
|
594
|
-
readonly minwidth?: number | null | undefined;
|
|
595
|
-
readonly minheight?: number | null | undefined;
|
|
596
|
-
readonly maxfontsize?: number | null | undefined;
|
|
597
|
-
readonly maxtextwidth?: number | null | undefined;
|
|
598
|
-
readonly iswithinpill?: boolean | null | undefined;
|
|
599
|
-
readonly hasleadingicon?: boolean | null | undefined;
|
|
600
|
-
} | null | undefined;
|
|
601
|
-
} | null | undefined;
|
|
602
|
-
}) => import("../format/objectformat").ObjectFormatSerializedType<{
|
|
603
|
-
readonly stencilConfig: readonly ["StencilConfig", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
|
|
604
|
-
/**
|
|
605
|
-
* How should we generate the stencil/data graphic from the specified field value?
|
|
606
|
-
* These are registered in LucidCardsLibrary.registerStencilDisplayTypes.
|
|
607
|
-
*
|
|
608
|
-
* The serialized key is `getterKey` for backwards compatible, legacy reasons. We have renamed this field in code,
|
|
609
|
-
* but need to support the original serialized key.
|
|
610
|
-
*/
|
|
611
|
-
readonly displayType: readonly ["getterKey", import("../format/format").Format<FieldDisplayType, FieldDisplayType>];
|
|
612
|
-
/**
|
|
613
|
-
* For displayType values that support it, you may provide an override for the
|
|
614
|
-
* background color for this data. If this is not provided, the background color
|
|
615
|
-
* will default to the background color of the card itself, darkened 5%.
|
|
616
|
-
*
|
|
617
|
-
* This may be provided as a literal color hex, e.g. "#00ff00ff" or as a formula
|
|
618
|
-
* by starting the string with "=", e.g. "=darken("#ffffff", 0.5)"
|
|
619
|
-
*/
|
|
620
|
-
readonly backgroundColor: readonly ["bg", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
621
|
-
/**
|
|
622
|
-
* For displayType values that support it, you may provide an override for the
|
|
623
|
-
* foreground color for this data. If this is not provided, the foreground color
|
|
624
|
-
* will default to grey.
|
|
625
|
-
*
|
|
626
|
-
* This may be provided as a literal color hex, e.g. "#00ff00ff" or as a formula
|
|
627
|
-
* by starting the string with "=", e.g. "=darken("#ffffff", 0.5)"
|
|
628
|
-
*/
|
|
629
|
-
readonly foregroundColor: readonly ["fg", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
630
|
-
/**
|
|
631
|
-
* For displayType values that support it, you may provide a height and a width
|
|
632
|
-
* for the image size. Images are 24px by 24px by default.
|
|
633
|
-
*
|
|
634
|
-
*/
|
|
635
|
-
readonly imageBadgeSettings: readonly ["imageBadgeSettings", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
|
|
636
|
-
readonly height: readonly ["height", import("../format/format").Format<number, number>];
|
|
637
|
-
readonly width: readonly ["width", import("../format/format").Format<number, number>];
|
|
638
|
-
}> | null | undefined, {
|
|
639
|
-
readonly height: number;
|
|
640
|
-
readonly width: number;
|
|
641
|
-
} | null | undefined>];
|
|
642
|
-
/**
|
|
643
|
-
* If specified, the result of this formula (executed in the context of the data item
|
|
644
|
-
* associated with this card) will be used instead of the raw field value when
|
|
645
|
-
* creating the data graphic. This can be useful if, for example, you want to convert
|
|
646
|
-
* an ID into a URL.
|
|
647
|
-
*/
|
|
648
|
-
readonly valueFormula: readonly ["f", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
649
|
-
/**
|
|
650
|
-
* If specified, the result of this formula (executed in the context of the data item
|
|
651
|
-
* associated with this card) will be used as a tooltip when the user hovers the
|
|
652
|
-
* cursor over this data graphic.
|
|
653
|
-
*/
|
|
654
|
-
readonly tooltipFormula: readonly ["t", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
655
|
-
/**
|
|
656
|
-
* Each display type has its default location on the card. You can override those
|
|
657
|
-
* default locations by setting these values.
|
|
658
|
-
*/
|
|
659
|
-
readonly horizontalPosition: readonly ["h", import("../format/format").Format<HorizontalBadgePos | null | undefined, HorizontalBadgePos | null | undefined>];
|
|
660
|
-
/**
|
|
661
|
-
* Each display type has its default location on the card. You can override those
|
|
662
|
-
* default locations by setting these values.
|
|
663
|
-
*/
|
|
664
|
-
readonly verticalPosition: readonly ["v", import("../format/format").Format<VerticalBadgePos | null | undefined, VerticalBadgePos | null | undefined>];
|
|
665
|
-
/**
|
|
666
|
-
* If specified, what behavior should happen when the user clicks on the data graphic
|
|
667
|
-
* generated via the above displayType?
|
|
668
|
-
*/
|
|
669
|
-
readonly onClickHandlerKey: readonly ["onClickHandlerKey", import("../format/format").Format<OnClickHandlerKeys | null | undefined, OnClickHandlerKeys | null | undefined>];
|
|
670
|
-
/**
|
|
671
|
-
* If onClickHandlerKey is OpenBrowserWindow, this formula calculates the URL to open.
|
|
672
|
-
*/
|
|
673
|
-
readonly linkFormula: readonly ["l", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
674
|
-
/**
|
|
675
|
-
* @experimental
|
|
676
|
-
* If onClickHandlerKey is OpenTargetTab, this specifies the label of the tab to open.
|
|
677
|
-
*/
|
|
678
|
-
readonly targetTabLabel: readonly ["targetTabLabel", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
679
|
-
/**
|
|
680
|
-
* Allows the same card to have multiple textbadges but have different properties.
|
|
681
|
-
* You can change bold, italic, underline, rounding, minwidth, minheight, maxtextwidth, maxfontsize
|
|
682
|
-
*/
|
|
683
|
-
readonly textBadgeSettings: readonly ["textBadgeSettings", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
|
|
684
|
-
readonly rounding: readonly ["rounding", import("../format/format").Format<number | null | undefined, number | null | undefined>];
|
|
685
|
-
readonly bold: readonly ["bold", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
|
|
686
|
-
readonly italic: readonly ["italic", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
|
|
687
|
-
readonly underline: readonly ["underline", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
|
|
688
|
-
readonly minwidth: readonly ["minwidth", import("../format/format").Format<number | null | undefined, number | null | undefined>];
|
|
689
|
-
readonly minheight: readonly ["minheight", import("../format/format").Format<number | null | undefined, number | null | undefined>];
|
|
690
|
-
readonly maxfontsize: readonly ["maxfontsize", import("../format/format").Format<number | null | undefined, number | null | undefined>];
|
|
691
|
-
readonly maxtextwidth: readonly ["maxtextwidth", import("../format/format").Format<number | null | undefined, number | null | undefined>];
|
|
692
|
-
readonly iswithinpill: readonly ["iswithinpill", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
|
|
693
|
-
readonly hasleadingicon: readonly ["hasleadingicon", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
|
|
694
|
-
}> | null | undefined, {
|
|
695
|
-
readonly rounding?: number | null | undefined;
|
|
696
|
-
readonly bold?: boolean | null | undefined;
|
|
697
|
-
readonly italic?: boolean | null | undefined;
|
|
698
|
-
readonly underline?: boolean | null | undefined;
|
|
699
|
-
readonly minwidth?: number | null | undefined;
|
|
700
|
-
readonly minheight?: number | null | undefined;
|
|
701
|
-
readonly maxfontsize?: number | null | undefined;
|
|
702
|
-
readonly maxtextwidth?: number | null | undefined;
|
|
703
|
-
readonly iswithinpill?: boolean | null | undefined;
|
|
704
|
-
readonly hasleadingicon?: boolean | null | undefined;
|
|
705
|
-
} | null | undefined>];
|
|
706
|
-
}> | null | undefined, {
|
|
707
|
-
readonly displayType: FieldDisplayType;
|
|
708
|
-
readonly backgroundColor?: string | null | undefined;
|
|
709
|
-
readonly foregroundColor?: string | null | undefined;
|
|
710
|
-
readonly imageBadgeSettings?: {
|
|
711
|
-
readonly height: number;
|
|
712
|
-
readonly width: number;
|
|
713
|
-
} | null | undefined;
|
|
714
|
-
readonly valueFormula?: string | null | undefined;
|
|
715
|
-
readonly tooltipFormula?: string | null | undefined;
|
|
716
|
-
readonly horizontalPosition?: HorizontalBadgePos | null | undefined;
|
|
717
|
-
readonly verticalPosition?: VerticalBadgePos | null | undefined;
|
|
718
|
-
readonly onClickHandlerKey?: OnClickHandlerKeys | null | undefined;
|
|
719
|
-
readonly linkFormula?: string | null | undefined;
|
|
720
|
-
readonly targetTabLabel?: string | null | undefined;
|
|
721
|
-
readonly textBadgeSettings?: {
|
|
722
|
-
readonly rounding?: number | null | undefined;
|
|
723
|
-
readonly bold?: boolean | null | undefined;
|
|
724
|
-
readonly italic?: boolean | null | undefined;
|
|
725
|
-
readonly underline?: boolean | null | undefined;
|
|
726
|
-
readonly minwidth?: number | null | undefined;
|
|
727
|
-
readonly minheight?: number | null | undefined;
|
|
728
|
-
readonly maxfontsize?: number | null | undefined;
|
|
729
|
-
readonly maxtextwidth?: number | null | undefined;
|
|
730
|
-
readonly iswithinpill?: boolean | null | undefined;
|
|
731
|
-
readonly hasleadingicon?: boolean | null | undefined;
|
|
732
|
-
} | null | undefined;
|
|
733
|
-
} | null | undefined>];
|
|
734
|
-
}>;
|
|
441
|
+
export declare const serializeLucidCardFieldDisplaySettings: typeof CardFieldDisplaySettingsFormatter.toJson;
|
|
735
442
|
/** @ignore */
|
|
736
|
-
export declare const deserializeLucidCardFieldDisplaySettings:
|
|
737
|
-
readonly stencilConfig: readonly ["StencilConfig", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
|
|
738
|
-
/**
|
|
739
|
-
* How should we generate the stencil/data graphic from the specified field value?
|
|
740
|
-
* These are registered in LucidCardsLibrary.registerStencilDisplayTypes.
|
|
741
|
-
*
|
|
742
|
-
* The serialized key is `getterKey` for backwards compatible, legacy reasons. We have renamed this field in code,
|
|
743
|
-
* but need to support the original serialized key.
|
|
744
|
-
*/
|
|
745
|
-
readonly displayType: readonly ["getterKey", import("../format/format").Format<FieldDisplayType, FieldDisplayType>];
|
|
746
|
-
/**
|
|
747
|
-
* For displayType values that support it, you may provide an override for the
|
|
748
|
-
* background color for this data. If this is not provided, the background color
|
|
749
|
-
* will default to the background color of the card itself, darkened 5%.
|
|
750
|
-
*
|
|
751
|
-
* This may be provided as a literal color hex, e.g. "#00ff00ff" or as a formula
|
|
752
|
-
* by starting the string with "=", e.g. "=darken("#ffffff", 0.5)"
|
|
753
|
-
*/
|
|
754
|
-
readonly backgroundColor: readonly ["bg", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
755
|
-
/**
|
|
756
|
-
* For displayType values that support it, you may provide an override for the
|
|
757
|
-
* foreground color for this data. If this is not provided, the foreground color
|
|
758
|
-
* will default to grey.
|
|
759
|
-
*
|
|
760
|
-
* This may be provided as a literal color hex, e.g. "#00ff00ff" or as a formula
|
|
761
|
-
* by starting the string with "=", e.g. "=darken("#ffffff", 0.5)"
|
|
762
|
-
*/
|
|
763
|
-
readonly foregroundColor: readonly ["fg", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
764
|
-
/**
|
|
765
|
-
* For displayType values that support it, you may provide a height and a width
|
|
766
|
-
* for the image size. Images are 24px by 24px by default.
|
|
767
|
-
*
|
|
768
|
-
*/
|
|
769
|
-
readonly imageBadgeSettings: readonly ["imageBadgeSettings", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
|
|
770
|
-
readonly height: readonly ["height", import("../format/format").Format<number, number>];
|
|
771
|
-
readonly width: readonly ["width", import("../format/format").Format<number, number>];
|
|
772
|
-
}> | null | undefined, {
|
|
773
|
-
readonly height: number;
|
|
774
|
-
readonly width: number;
|
|
775
|
-
} | null | undefined>];
|
|
776
|
-
/**
|
|
777
|
-
* If specified, the result of this formula (executed in the context of the data item
|
|
778
|
-
* associated with this card) will be used instead of the raw field value when
|
|
779
|
-
* creating the data graphic. This can be useful if, for example, you want to convert
|
|
780
|
-
* an ID into a URL.
|
|
781
|
-
*/
|
|
782
|
-
readonly valueFormula: readonly ["f", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
783
|
-
/**
|
|
784
|
-
* If specified, the result of this formula (executed in the context of the data item
|
|
785
|
-
* associated with this card) will be used as a tooltip when the user hovers the
|
|
786
|
-
* cursor over this data graphic.
|
|
787
|
-
*/
|
|
788
|
-
readonly tooltipFormula: readonly ["t", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
789
|
-
/**
|
|
790
|
-
* Each display type has its default location on the card. You can override those
|
|
791
|
-
* default locations by setting these values.
|
|
792
|
-
*/
|
|
793
|
-
readonly horizontalPosition: readonly ["h", import("../format/format").Format<HorizontalBadgePos | null | undefined, HorizontalBadgePos | null | undefined>];
|
|
794
|
-
/**
|
|
795
|
-
* Each display type has its default location on the card. You can override those
|
|
796
|
-
* default locations by setting these values.
|
|
797
|
-
*/
|
|
798
|
-
readonly verticalPosition: readonly ["v", import("../format/format").Format<VerticalBadgePos | null | undefined, VerticalBadgePos | null | undefined>];
|
|
799
|
-
/**
|
|
800
|
-
* If specified, what behavior should happen when the user clicks on the data graphic
|
|
801
|
-
* generated via the above displayType?
|
|
802
|
-
*/
|
|
803
|
-
readonly onClickHandlerKey: readonly ["onClickHandlerKey", import("../format/format").Format<OnClickHandlerKeys | null | undefined, OnClickHandlerKeys | null | undefined>];
|
|
804
|
-
/**
|
|
805
|
-
* If onClickHandlerKey is OpenBrowserWindow, this formula calculates the URL to open.
|
|
806
|
-
*/
|
|
807
|
-
readonly linkFormula: readonly ["l", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
808
|
-
/**
|
|
809
|
-
* @experimental
|
|
810
|
-
* If onClickHandlerKey is OpenTargetTab, this specifies the label of the tab to open.
|
|
811
|
-
*/
|
|
812
|
-
readonly targetTabLabel: readonly ["targetTabLabel", import("../format/format").Format<string | null | undefined, string | null | undefined>];
|
|
813
|
-
/**
|
|
814
|
-
* Allows the same card to have multiple textbadges but have different properties.
|
|
815
|
-
* You can change bold, italic, underline, rounding, minwidth, minheight, maxtextwidth, maxfontsize
|
|
816
|
-
*/
|
|
817
|
-
readonly textBadgeSettings: readonly ["textBadgeSettings", import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
|
|
818
|
-
readonly rounding: readonly ["rounding", import("../format/format").Format<number | null | undefined, number | null | undefined>];
|
|
819
|
-
readonly bold: readonly ["bold", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
|
|
820
|
-
readonly italic: readonly ["italic", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
|
|
821
|
-
readonly underline: readonly ["underline", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
|
|
822
|
-
readonly minwidth: readonly ["minwidth", import("../format/format").Format<number | null | undefined, number | null | undefined>];
|
|
823
|
-
readonly minheight: readonly ["minheight", import("../format/format").Format<number | null | undefined, number | null | undefined>];
|
|
824
|
-
readonly maxfontsize: readonly ["maxfontsize", import("../format/format").Format<number | null | undefined, number | null | undefined>];
|
|
825
|
-
readonly maxtextwidth: readonly ["maxtextwidth", import("../format/format").Format<number | null | undefined, number | null | undefined>];
|
|
826
|
-
readonly iswithinpill: readonly ["iswithinpill", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
|
|
827
|
-
readonly hasleadingicon: readonly ["hasleadingicon", import("../format/format").Format<boolean | null | undefined, boolean | null | undefined>];
|
|
828
|
-
}> | null | undefined, {
|
|
829
|
-
readonly rounding?: number | null | undefined;
|
|
830
|
-
readonly bold?: boolean | null | undefined;
|
|
831
|
-
readonly italic?: boolean | null | undefined;
|
|
832
|
-
readonly underline?: boolean | null | undefined;
|
|
833
|
-
readonly minwidth?: number | null | undefined;
|
|
834
|
-
readonly minheight?: number | null | undefined;
|
|
835
|
-
readonly maxfontsize?: number | null | undefined;
|
|
836
|
-
readonly maxtextwidth?: number | null | undefined;
|
|
837
|
-
readonly iswithinpill?: boolean | null | undefined;
|
|
838
|
-
readonly hasleadingicon?: boolean | null | undefined;
|
|
839
|
-
} | null | undefined>];
|
|
840
|
-
}> | null | undefined, {
|
|
841
|
-
readonly displayType: FieldDisplayType;
|
|
842
|
-
readonly backgroundColor?: string | null | undefined;
|
|
843
|
-
readonly foregroundColor?: string | null | undefined;
|
|
844
|
-
readonly imageBadgeSettings?: {
|
|
845
|
-
readonly height: number;
|
|
846
|
-
readonly width: number;
|
|
847
|
-
} | null | undefined;
|
|
848
|
-
readonly valueFormula?: string | null | undefined;
|
|
849
|
-
readonly tooltipFormula?: string | null | undefined;
|
|
850
|
-
readonly horizontalPosition?: HorizontalBadgePos | null | undefined;
|
|
851
|
-
readonly verticalPosition?: VerticalBadgePos | null | undefined;
|
|
852
|
-
readonly onClickHandlerKey?: OnClickHandlerKeys | null | undefined;
|
|
853
|
-
readonly linkFormula?: string | null | undefined;
|
|
854
|
-
readonly targetTabLabel?: string | null | undefined;
|
|
855
|
-
readonly textBadgeSettings?: {
|
|
856
|
-
readonly rounding?: number | null | undefined;
|
|
857
|
-
readonly bold?: boolean | null | undefined;
|
|
858
|
-
readonly italic?: boolean | null | undefined;
|
|
859
|
-
readonly underline?: boolean | null | undefined;
|
|
860
|
-
readonly minwidth?: number | null | undefined;
|
|
861
|
-
readonly minheight?: number | null | undefined;
|
|
862
|
-
readonly maxfontsize?: number | null | undefined;
|
|
863
|
-
readonly maxtextwidth?: number | null | undefined;
|
|
864
|
-
readonly iswithinpill?: boolean | null | undefined;
|
|
865
|
-
readonly hasleadingicon?: boolean | null | undefined;
|
|
866
|
-
} | null | undefined;
|
|
867
|
-
} | null | undefined>];
|
|
868
|
-
}>) => {
|
|
869
|
-
readonly stencilConfig?: {
|
|
870
|
-
readonly displayType: FieldDisplayType;
|
|
871
|
-
readonly backgroundColor?: string | null | undefined;
|
|
872
|
-
readonly foregroundColor?: string | null | undefined;
|
|
873
|
-
readonly imageBadgeSettings?: {
|
|
874
|
-
readonly height: number;
|
|
875
|
-
readonly width: number;
|
|
876
|
-
} | null | undefined;
|
|
877
|
-
readonly valueFormula?: string | null | undefined;
|
|
878
|
-
readonly tooltipFormula?: string | null | undefined;
|
|
879
|
-
readonly horizontalPosition?: HorizontalBadgePos | null | undefined;
|
|
880
|
-
readonly verticalPosition?: VerticalBadgePos | null | undefined;
|
|
881
|
-
readonly onClickHandlerKey?: OnClickHandlerKeys | null | undefined;
|
|
882
|
-
readonly linkFormula?: string | null | undefined;
|
|
883
|
-
readonly targetTabLabel?: string | null | undefined;
|
|
884
|
-
readonly textBadgeSettings?: {
|
|
885
|
-
readonly rounding?: number | null | undefined;
|
|
886
|
-
readonly bold?: boolean | null | undefined;
|
|
887
|
-
readonly italic?: boolean | null | undefined;
|
|
888
|
-
readonly underline?: boolean | null | undefined;
|
|
889
|
-
readonly minwidth?: number | null | undefined;
|
|
890
|
-
readonly minheight?: number | null | undefined;
|
|
891
|
-
readonly maxfontsize?: number | null | undefined;
|
|
892
|
-
readonly maxtextwidth?: number | null | undefined;
|
|
893
|
-
readonly iswithinpill?: boolean | null | undefined;
|
|
894
|
-
readonly hasleadingicon?: boolean | null | undefined;
|
|
895
|
-
} | null | undefined;
|
|
896
|
-
} | null | undefined;
|
|
897
|
-
};
|
|
443
|
+
export declare const deserializeLucidCardFieldDisplaySettings: typeof CardFieldDisplaySettingsFormatter.fromJson;
|
|
898
444
|
/**
|
|
899
445
|
* These are the six possible values for the status of a basic card block.
|
|
900
446
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { SerializedFieldType } from '../data/serializedfield/serializedfields';
|
|
2
|
-
import { ExtensionCardFieldDefinition, ImportResult, SearchResult } from '../sharedcardintegration/cardintegrationdefinitions';
|
|
1
|
+
import type { SerializedFieldType } from '../data/serializedfield/serializedfields';
|
|
2
|
+
import type { ExtensionCardFieldDefinition, ImportResult, SearchResult } from '../sharedcardintegration/cardintegrationdefinitions';
|
|
3
3
|
/**
|
|
4
4
|
* The amount of results that will be displayed per page when using pagination. To enable pagination, define the
|
|
5
5
|
* {@link SearchResult.itemsPerSearchResult} field in your search results and return workitems equal to this variable's
|
|
@@ -14,7 +14,7 @@ export interface CardIntegrationAutoSyncConfig {
|
|
|
14
14
|
/**
|
|
15
15
|
* @deprecated Use AutoSyncConfigPhrasesType instead.
|
|
16
16
|
*/
|
|
17
|
-
header
|
|
17
|
+
header?: string | undefined;
|
|
18
18
|
/**
|
|
19
19
|
* The phrases to use for the auto sync callout. This is used to display the correct strings in the UI.
|
|
20
20
|
*/
|