ImageFiltersPlugin class. Adds the "Image Filters" button.

Example

<script src="gcimageviewer.js"></script></head>
<script src="plugins/imageFilters.js"></script>
<script>
var viewer = new GcImageViewer("#root");
viewer.addPlugin(new ImageFiltersPlugin());
</script>

Param

Hierarchy

  • ImageFiltersPlugin

Properties

id: string = "imageFilters"

Unique plugin identifier.

Plugin options

Constructors

Accessors

  • get filters(): { [filterName: string]: ImageFilterDefinition }
  • Gets available image filters.

    Example

    // Create Image Filters plugin:
    const imageFiltersPlugin = new ImageFiltersPlugin();
    // Remove the default image filters, except for the "Invert" filter:
    const filters = imageFiltersPlugin.filters;
    for(const filterName in filters) {
    if(filterName === "invert")
    continue;
    delete filters[filterName];
    }
    // Add custom Image Filter:
    filters["lemon-effect"] = {
    filterId: "lemon-effect",
    toolbarKey: "lemon-effect",
    title: "Apply Custom Lemon effect",
    text: "Apply Lemon effect",
    action: function(imageData) {
    for (i = 0; i < imageData.data.length; i += 4) {
    imageData.data[i + 1] = imageData.data[i] + 45; // increase green component
    }
    return imageData;
    }
    };
    // Register Image Filters plugin:
    viewer.addPlugin(imageFiltersPlugin);

    Returns { [filterName: string]: ImageFilterDefinition }

  • get isReady(): boolean
  • Returns true if the image is loaded into the viewer and the image format is supported by the Image Filters plugin.

    Returns boolean

  • get naturalSize(): { width: number; height: number }
  • Natural image size.

    Returns { width: number; height: number }

    • width: number
    • height: number

Methods

  • Called when parent viewer requests confirm and apply changes, usually when the Ctrl+Enter or Enter key is pressed.

    Returns boolean | void | Promise<boolean | void>

  • Called when parent viewer requests cancel changes, usually when the ESCAPE key is pressed.

    Returns boolean | void | Promise<boolean | void>

  • Undo viewer transaction step. Return true if undo operation is consumed.

    Returns boolean | void

  • Redo viewer transaction step. Return true if redo operation is consumed.

    Returns boolean | void

  • Apply image filter.

    Parameters

    • filterName: string
    • Optional intensity: number

    Returns Promise<boolean>

  • Checks if the image format specified by the imageFormat parameter is supported.

    Parameters

    Returns boolean