Interface Styles

Interface for the style items and style groups

Hierarchy

  • Styles

Properties

Groups Items

Properties

Groups

Groups: {
    Add(item) => StyleGroup;
    All() => StyleGroup[];
    ById(id) => StyleGroup;
    ByName(name, exactMatch?) => StyleGroup;
    Delete(itemOrId) => boolean;
    Update(item) => StyleGroup;
}

Interface to retrieve and manage the style groups in the system.

Type declaration

  • Add:function
    • Add(item): StyleGroup

    • Adds a new style group. A group must have a name, the id will be autocalculated.

      Parameters

      Returns StyleGroup

      The added style group or null if it could not add it.

  • All:function
    • All(): StyleGroup[]

    • Returns an array with all available style groups.

      Returns StyleGroup[]

      All available style groups

  • ById:function
    • ById(id): StyleGroup

    • Return a style group by its id.

      Parameters

      • id: string

        The id of the style group to return.

      Returns StyleGroup

      The style group with the given id or null if not found.

  • ByName:function
    • ByName(name, exactMatch?): StyleGroup

    • Returns a style group by its name, where the name can be an exact match or a partial match.

      Parameters

      • name: string

        The name of the style group to return.

      • Optional exactMatch: boolean

        Flag to indicate if the name must be an exact match or a partial match.

      Returns StyleGroup

      The style group with the given name or null if not found.

  • Delete:function
    • Delete(itemOrId): boolean

    • Deletes a style group from the listing. This will not update any fields with that group applied - as they still will have the original style applied.

      Parameters

      • itemOrId: string | StyleGroup

        The style group or the id of the style group to delete.

      Returns boolean

      True if the style group was deleted, false otherwise.

  • Update:function
    • Update(item): StyleGroup

    • The style group to update. The id must match an existing style group. This will not update any fields with that grou appliedp - as they still will have the original style applied.

      Parameters

      Returns StyleGroup

      The updated style group or null if it could not update it.

Items

Items: {
    Add(item) => StyleItem;
    All() => StyleItem[];
    ById(id) => StyleItem;
    ByName(name, exactMatch?) => StyleItem;
    Delete(itemOrId) => boolean;
    Update(item) => StyleItem;
}

Interface to retrieve and manage the style items in the system.

Type declaration

  • Add:function
    • Add(item): StyleItem

    • Adds a new style item. A style must have a name, the id will be autocalculated.

      Parameters

      Returns StyleItem

      The added style item or null if it could not add it.

  • All:function
    • All(): StyleItem[]

    • Returns an array with all available style items.

      Returns StyleItem[]

      All available style items

  • ById:function
    • ById(id): StyleItem

    • Return a style item by its id.

      Parameters

      • id: string

        The id of the style item to return.

      Returns StyleItem

      The style item with the given id or null if not found.

  • ByName:function
    • ByName(name, exactMatch?): StyleItem

    • Returns a style item by its name, where the name can be an exact match or a partial match.

      Parameters

      • name: string

        The name of the style item to return.

      • Optional exactMatch: boolean

        Flag to indicate if the name must be an exact match or a partial match.

      Returns StyleItem

      The style item with the given name or null if not found.

  • Delete:function
    • Delete(itemOrId): boolean

    • Deletes a style item from the listing. This will also clear the style from any text fields it is assigned to.

      Parameters

      • itemOrId: string | StyleItem

        The style item or the id of the style item to delete.

      Returns boolean

      True if the style item was deleted, false otherwise.

  • Update:function
    • Update(item): StyleItem

    • The style item to update. The id must match an existing style item. If the style is assigned to text fields, the changes will be reflected on the text fields.

      Parameters

      Returns StyleItem

      The updated style item or null if it could not update it.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc