Base Widgets

Warning

This documentation will soon be updated Filippo Broggini

Squirro comes with a number of existing widgets. Any of these widgets can be extended, thus making use of the existing configuration options and all existing code.

This table lists all of the default widgets. The Name column lists the name that is to be used as the baseWidget in the squirro_widget upload command. The JavaScript class is the class name used in the JavaScript file to extend from.

NameJavaScript classTitle (in user interface)Notes
Base Widgets
BaseWidgets.Base- (not available in interface)

Using this as a baseWidget will disable any configuration options in the user interface for the widget.

This can even be used as a baseWidget when the JavaScript class actually extends from another widget.

StaticWidgets.Static- (not available in interface)

Base widget that does not fetch any results from the server.

getCollection can be defined to fetch a custom collection.

Widgets

Items




SearchWidgets.SearchResult List
CardsWidgets.CardsCards
ItemDetailWidgets.ItemDetailItem Detail

Navigation




PredQueryWidgets.PredQueryTabs
BreadcrumbWidgets.BreadcrumbBreadcrumbs
LinkWidgets.LinkLink
ResetWidgets.ResetReset Filters
NavChipsWidgets.NavChipsNavigation Chips

Filters




SearchQuery

Widgets.SearchQuerySearch Bar
TimeWidgets.TimeTime Selection
EntitiesListWidgets.EntitiesListEntities
FacetsListWidgets.FacetsListFacets
SmartfiltersWidgets.SmartfiltersSmart Filters
TrendsListWidgets.TrendsListTrends List
FavoritesWidgets.FavoritesFavorites

Over Time




FrequencyWidgets.FrequencyTimeline
FacetsHistogramWidgets.FacetsHistogramLine Chart

Comparison




FacetsWidgets.FacetsPie Chart
FacetsBarWidgets.FacetsBarBar Chart
TagCloudWidgets.TagCloudWord Cloud
ConnectionWidgets.ConnectionHeat Map
KeywordsWidgets.KeywordsTable
FacetsTableWidgets.FacetsTableFacets Table

Geographical




MapWidgets.MapWorld Map
ChoroplethMapWidgets.ChoroplethMapRegion Map

Special




SignificantTermsWidgets.SignificantTermsSignificant Terms
TrendWidgets.TrendTrend
RecommendationsWidgets.RecommendationsREC Results
RecommendationsEventsWidgets.RecommendationsEventsREC Explanations
RecommendationsEntitiesWidgets.RecommendationsEntitiesREC Input
HoneycombWidgets.HoneycombTopic Cluster
KanbanLaneWidgets.KanbanLaneKanban Lane
DataLabelingLaneWidgets.DataLabelingLaneData Labeling Lane
InferenceWidgets.InferenceSample Text Labeller
SeparatorWidgets.SeparatorDivider

Others




RichTextEditorWidgets.RichTextEditorRich Text Editor
TextWidgets.TextHTML Editor
CalendarWidgets.CalendarCalendar
MetricWidgets.MetricMetric
IFrameWidgets.IFrameIFrame

Custom




Custom Widgets