Interface SliderActionDefinition

An action definition that provides a slider.

interface SliderActionDefinition {
    changeValueOf(item: TocItem, value: number): void;
    fromIcon?: string;
    fromLabel?: string;
    icon?: string;
    id: string;
    isVisibleForItem(item: TocItem): boolean | Promise<boolean>;
    label?: string;
    max: number;
    min: number;
    step: number;
    toIcon?: string;
    toLabel?: string;
    type: "slider";
    valueOf(item: TocItem): number;
}

Hierarchy (View Summary)

Properties

fromIcon? fromLabel? icon? id label? max min step toIcon? toLabel? type

Methods

changeValueOf isVisibleForItem? valueOf

Properties

Optional ReadonlyfromIcon

fromIcon?: string

Icon of the left side of the slider.

Optional ReadonlyfromLabel

fromLabel?: string

Label of the left side of the slider.

Optional Readonlyicon

icon?: string

Icon of the menu entry.

Readonlyid

id: string

This action's unique id.

Optional Readonlylabel

label?: string

A textual label (or title) for this action.

Readonlymax

max: number

Maximum slider value (right side).

Readonlymin

min: number

Minimum slider value (left side).

Readonlystep

step: number

Increment value of the slider.

Optional ReadonlytoIcon

toIcon?: string

Icon of the right side of the slider.

Optional ReadonlytoLabel

toLabel?: string

Label of the right side of the slider.

Readonlytype

type: "slider"

The type of this action.

Methods

changeValueOf

  • changeValueOf(item: TocItem, value: number): void

  • This method is called if the value of the slider was changed.

    Parameters

    Returns void

OptionalisVisibleForItem

  • isVisibleForItem(item: TocItem): boolean | Promise<boolean>

  • Returns true if the action shall be available for the given item. Should return false otherwise.

    Note that this method may be asynchronous (i.e. return a Promise<boolean>).

    Parameters

    Returns boolean | Promise<boolean>

valueOf

  • valueOf(item: TocItem): number

  • This method must return the current value of the item.

    Parameters

    Returns number

Settings

Member Visibility

On This Page

Properties
Methods