File

projects/components/src/widgets/common/card/card.component.doc.ts

Description

The wmCard component defines the card widget.

Index

Methods
Inputs

Methods

onClick
onClick($event: MouseEvent, widget: any, item: any, currentItemWidgets: any)

Callback function which will be triggered when the widget is clicked.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the card widget

item any No

Data of the card on which click event is triggered

currentItemWidgets any No

Widgets inside the card on which click event is triggered

Returns : void
onDblclick
onDblclick($event: MouseEvent, widget: any, item: any, currentItemWidgets: any)

Callback function which will be triggered when the widget is double clicked.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the card widget

item any No

Data of the card on which double click event is triggered

currentItemWidgets any No

Widgets inside the card on which double click event is triggered

Returns : void
onDoubletap
onDoubletap($event: TouchEvent, widget: any, item, currentItemWidgets)

Callback function which will be triggered when the double tap event is triggered on a widget.

Parameters :
Name Type Optional Description
$event TouchEvent No

DOM event on which call back is triggered

widget any No

Instance of the card widget

item No

Data of the card on which double tap event is triggered

currentItemWidgets No

Widgets inside the card on which double tap event is triggered

Returns : void
onMouseenter
onMouseenter($event: MouseEvent, widget: any, item: any, currentItemWidgets: any)

Callback function which will be triggered when the mouse enters the widget.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the card widget

item any No

Data of the card on which mouse enter event is triggered

currentItemWidgets any No

Widgets inside the card on which mouse enter event is triggered

Returns : void
onMouseleave
onMouseleave($event: MouseEvent, widget: any, item: any, currentItemWidgets: any)

Callback function which will be triggered when the mouse leaves the widget.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the card widget

item any No

Data of the card on which mouse leave event is triggered

currentItemWidgets any No

Widgets inside the card on which mouse leave event is triggered

Returns : void
onMouseout
onMouseout($event: MouseEvent, widget: any, item: any, currentItemWidgets: any)

Callback function which will be triggered when the mouse moves away from the card.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the card widget

item any No

Data of the card on which mouse out event is triggered

currentItemWidgets any No

Widgets inside the card on which mouse out event is triggered

Returns : void
onMouseover
onMouseover($event: MouseEvent, widget: any, item: any, currentItemWidgets: any)

Callback function which will be triggered when the mouse moves over the card.

Parameters :
Name Type Optional Description
$event MouseEvent No

DOM event on which call back is triggered

widget any No

Instance of the card widget

item any No

Data of the card on which mouse over event is triggered

currentItemWidgets any No

Widgets inside the card on which mouse over event is triggered

Returns : void
onTap
onTap($event: TouchEvent, widget: any, item, currentItemWidgets)

Callback function which will be triggered when the tap event is triggered on a widget.

Parameters :
Name Type Optional Description
$event TouchEvent No

DOM event on which call back is triggered

widget any No

Instance of the card widget

item No

Data of the card on which tap event is triggered

currentItemWidgets No

Widgets inside the card on which tap event is triggered

Returns : void

Inputs

actions

This property sets the the data and events action for the widget.

Bindable: true

Type : string

class

Class of the widget.

Type : string

iconclass

CSS class of the icon.

Bindable: true

Type : string

iconurl

url of the icon.

Bindable: true

Type : string

imageheight

height of the image.

Type : string

Default value : '200px'

itemaction

This property specifies the item action for dynamically generated menu items.

Bindable: true

Type : string

itemchildren

This property is to add sub menu items.

Bindable: true

Type : string

itemicon

This property specifies icon for dynamically generated menu items.

Bindable: true

Type : string

itemlabel

This property specifies label for dynamically generated menu items.

Bindable: true

Type : string

itemlink

This property specifies link for dynamically generated menu items

Bindable: true

Type : string

name

Name of the card widget.

Type : string

picturesource

picturesource of the card widget.

Bindable: true

Type : string

picturetitle

Picturetitle of the card widget.

Bindable: true

Type : string

show

This property will be used to show/hide the Card widget on the web page.

Bindable: true

Type : boolean

Default value : true

subheading

Sub Heading of the card widget.

Bindable: true

Type : string

title

Title of the card widget.

Bindable: true

Type : string

userrole

This property specifies the role for dynamically generated menu items.

Bindable: true

Type : string

result-matching ""

    No results matching ""