IAttributeDescriptorBody

IAttributeDescriptorBody.conditionalFormattingpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Semantic-layer conditional formatting authored on the underlying label, fact, or date dataset.

conditionalFormatting?: ISemanticConditionalFormatting;

IAttributeDescriptorBody.formatproperty

Describes format information in case of date attribute.

format?: {
        locale: string;
        pattern: string;
        timezone?: string;
    };

IAttributeDescriptorBody.formOfproperty

Describes attributes to which the display form belongs.

formOf: IAttributeHeaderFormOf;

IAttributeDescriptorBody.geoAreaConfigpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Geo area configuration bound to this attribute display form.

geoAreaConfig?: IAttributeDisplayFormGeoAreaConfig;

IAttributeDescriptorBody.granularityproperty

Specifies granularity in case of date attribute.

granularity?: string;

IAttributeDescriptorBody.identifierproperty

Display form identifier

identifier: string;

IAttributeDescriptorBody.labelTypeproperty

Label type (eg. image, hyperlink, etc…)

labelType?: AttributeDisplayFormType;

IAttributeDescriptorBody.localIdentifierproperty

Local identifier of the display form - this references back to the IAttribute which was on the input to the execution.

localIdentifier: string;

IAttributeDescriptorBody.nameproperty

Human readable name of the attribute.

name: string;

IAttributeDescriptorBody.primaryLabelproperty

Primary label of the attribute from formOf

primaryLabel: ObjRef;

IAttributeDescriptorBody.refproperty

Opaque reference of the display form object.

ref: ObjRef;

IAttributeDescriptorBody.totalItemsproperty

totalItems?: ITotalDescriptor[];

IAttributeDescriptorBody.typeproperty

Display form type

type?: string;

IAttributeDescriptorBody.uriproperty

URI of the display form object

uri: string;