Type Alias DowncastAttributeCreatorFunction

Type Declaration

• • (
        attributeValue: unknown,
        conversionApi: DowncastConversionApi,
        data: {
            attributeKey: string;
            attributeNewValue: unknown;
            attributeOldValue: unknown;
            item: ModelItem;
            range: ModelRange;
        },
    ): DowncastAttributeDescriptor
    | null

  • Parameters

    • attributeValue: unknown

      The model attribute value to be converted to the view attribute element.

    • conversionApi: DowncastConversionApi

      The conversion interface.

    • data: {
          attributeKey: string;
          attributeNewValue: unknown;
          attributeOldValue: unknown;
          item: ModelItem;
          range: ModelRange;
      }

      Additional information about the change (same as for module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute attribute event).

      • attributeKey: string

        Attribute key.

      • attributeNewValue: unknown

        New attribute value.

      • attributeOldValue: unknown

        Attribute value before the change. This is null when selection attribute is converted.

      • item: ModelItem

        Changed item or converted selection.

      • range: ModelRange

        Range spanning over changed item or selection range.

    Returns DowncastAttributeDescriptor | null

    A { key, value } object. If key is 'class', value can be a String or an array of Strings. If key is 'style', value is an object with key-value pairs. In other cases, value is a String.