Nutrient Web SDK
    Preparing search index...

    Type Alias AnnotationToolbarColorPresetsCallback

    AnnotationToolbarColorPresetsCallback: (
        options: {
            defaultAnnotationToolbarColorPresets: ColorPreset[];
            propertyName:
                | "color"
                | "stroke-color"
                | "fill-color"
                | "background-color"
                | "border-color"
                | "outline-color"
                | "font-color";
        },
    ) => { presets: ColorPreset[]; showColorPicker?: boolean }
    | undefined

    This callback allows users to customize the colors that will be displayed in our color dropdown picker, and to add a custom color picker UI to it.

    Type Declaration

      • (
            options: {
                defaultAnnotationToolbarColorPresets: ColorPreset[];
                propertyName:
                    | "color"
                    | "stroke-color"
                    | "fill-color"
                    | "background-color"
                    | "border-color"
                    | "outline-color"
                    | "font-color";
            },
        ): { presets: ColorPreset[]; showColorPicker?: boolean }
        | undefined
      • Parameters

        • options: {
              defaultAnnotationToolbarColorPresets: ColorPreset[];
              propertyName:
                  | "color"
                  | "stroke-color"
                  | "fill-color"
                  | "background-color"
                  | "border-color"
                  | "outline-color"
                  | "font-color";
          }
          • defaultAnnotationToolbarColorPresets: ColorPreset[]

            array of default colors

          • propertyName:
                | "color"
                | "stroke-color"
                | "fill-color"
                | "background-color"
                | "border-color"
                | "outline-color"
                | "font-color"

            options.propertyName The annotation property for which we need to render a customized array of colors in the color dropdown. The built-in color properties are:

            • 'color'
            • 'stroke-color'
            • 'fill-color'
            • 'background-color'
            • 'font-color'
            • 'outline-color'

            Different annotations have different color properties, but all of them are listed above. If you pass a color property that it's not supported, you will get an error.

        Returns { presets: ColorPreset[]; showColorPicker?: boolean } | undefined

        The configuration of the customized color picker

        • { presets: ColorPreset[]; showColorPicker?: boolean }
          • presets: ColorPreset[]

            The array of colors to be displayed in a customized color picker dropdown

          • OptionalshowColorPicker?: boolean

            Defines whether you want to render the custom color picker UI. The default value is true, meaning that by default we render the custom color picker in the color dropdown.

        • undefined

    Customize different color dropdowns.

    NutrientViewer.load({
    annotationToolbarColorPresets: function ({ propertyName }) {
    if (propertyName === "font-color") {
    return {
    presets: [
    {
    color: new NutrientViewer.Color({ r: 0, g: 0, b: 0 }),
    localization: {
    id: "brightRed",
    defaultMessage: "Bright Red",
    },
    },
    {
    color: new NutrientViewer.Color({ r: 100, g: 100, b: 180 }),
    localization: {
    id: "deepBlue",
    defaultMessage: "deepBlue",
    },
    },
    ],
    };
    }

    if (propertyName === "stroke-color") {
    return {
    presets: [
    {
    color: new NutrientViewer.Color({ r: 0, g: 0, b: 0 }),
    localization: {
    id: "brightRed",
    defaultMessage: "Bright Red",
    },
    },
    {
    color: new NutrientViewer.Color({ r: 100, g: 100, b: 180 }),
    localization: {
    id: "deepBlue",
    defaultMessage: "deepBlue",
    },
    },
    ],
    showColorPicker: false,
    };
    }
    },
    //...
    });