Advanced library filtering: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
(Updated for v18)
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{mininav|[[Video library]]|[[Video_management|Video Management]] }}
{{mininav|[[Music_library|Music Library]] {{l2|[[Video_library|Video Library]]}} | {{l2|[[Video_management|Video Management]]}}}}
<section begin="intro" />Advanced Library Filtering replaces the very basic filtering option which allowed users to enter a part of a media title and get a list of matching items with a much more sophisticated filtering functionality which, depending on the media type, offers filtering by title, genre, actors and much more.<section end="intro" />


[[File:advancedfiltering.jpg|right|500px]]
__TOC__
{{-}}


== How to get to the Advanced Filtering ==
= Introduction =
[[File:sidebar.png|left]] The advanced filtering option is located in the sidebar in any library view and replaces the old basic filtering option. The toggle button indicates whether the currently visible list is filtered or not. Click on the "Filter" button and you will get the filter dialog.
<section begin="intro" />Filter is a Music and Video Library feature that allows a user to quickly reduce a list of titles to a smaller list that matches a user specified criteria. For example, filter the main listing of movies to only movies whose genre is Science Fiction. <section end="intro" />
{{-}}


== Advanced Filtering dialog ==
There are numerous fields available that can be used to filter lists.
The Advanced Filtering dialog lists all the available filters for the currently listed media items. Depending on the type of the media items there are different filtering options available. Changing a filtering option will directly affect the list of items i.e. the user can see the list of filtered items in the background and therefore get direct feedback on the impact of a filtering option. Using the "Clear" button it is possible to remove all previously specified filtering options which will result in all initially available media items being listed.
[[File:filter_dialog.png|center]]


=== Filter Types ===
'''A filter will only be available when a listing of titles is visible on screen.'''
There are different types of filters and every type comes with a different style and representation and allows different user actions.


==== Text Input ====
[[File:text_input.png|right]] Text Input filters allow the user to specify a series of characters which should be contained in the filtered property of the media items. The user can type directly in the Text Input when it is focused or open the on-screen keyboard by pressing on the filter option.
{{-}}


==== Range Selector ====
[[File:rangeselector.png|right]] Range Selector filters allow the user to specify a range e.g. a range of years or a range of ratings. If the selection covers the whole range no filter will be used. The user can move both range selectors to the left or right to specify the range. Moving up or down switches between the two range selectors.
{{-}}


==== Choice Spinner ====
= Filter -v- Search =
[[File:choice_spinner.png|right]] Choice Spinner filters allow the user to choose between one of several choices. Every Choice Spinner filter will have a choice named "All" which disables that specific filter.
Filter and Search are not the same. They can be explained as follows:
{{-}}


==== Multiple Selection ====
;Filter
[[File:multiselection.png|200px|right]] Multiple Selection filters are presented as a button. Pressing the button will open up the multi-selection dialog with a list of possible options. The user can select any number of options. To apply the selected options the dialog has to be closed by using the "OK" button. Closing the dialog with the backspace or escape key will result in ignoring the selected options.
:When a list of titles is displayed on the screen, applying a filter will remove items that do not match the users criteria. ie A large list is reduced to a smaller list.


The options that are being listed can depend on what other filters are already applied. If there are no filters applied all the available options will be listed but if there are other filters that already limit the listed items only those options are listed that match the already filtered list of items.
;Search
If only one or no options are available for a list of media items the button to open the multi-selection dialog will be deactivated and therefore can't be used.
:Starts with an empty list and adds to it based on the users criteria. ie An empty list is added to with matching titles.
{{-}}


== Advanced Filtering options ==
When a Filter is not available, the option will be replaced by Search.
 
 
 
= Access =
<!--[[File:Estuary-player-sidebar-video.jpg|210px|left]]
[[File:EstuarySideBarMenu_small.gif|right]] -->
The filter option is accessed from the '''''[[Basic_controls#Sideblade_Menu|Left Sideblade Menu]]'''''
   
The Filter option itself is available on any page that has a listing of Movies, TV Shows, Episodes or Music Videos for the Video Library or any page that has a listing of Artists, Albums or Songs for the Music Library.
 
Filter is a library only function. It will work from the main menu options of Movies, TV Shows, Music Videos and Music as well as their Nodes (genre, year, studio etc). It will not be available in Videos>Files as this is not accessing the library nor Smart Playlists as playlists are already filtered.
<!-- daveblake [17:34] 16 July 2018
@karellen the facility to  filter an already filtered list would be nice, but I don't think the current way queries (the way data is fetched internally) are built can cope with that. This makes smart playlists and custom nodes very static, you have to make another one for every slight variation. As you know I would love to add better dynamic filtering (to the music library at least). Something for v19.... -->
 
 
= Usage =
;Apply Filter
*From the Filter Dialogue Screen as shown in the below row of images, enter or adjust a field as required. The changes are immediately visible in the background. Select '''OK''' to accept and view the modified list.
*Multiple filters can be applied.
*Filters are '''not''' persistant. They will cancel when exiting the list- this could be due to backing out to the previous menu, or pressing play on a title.
 
;Clear Filter
* If still in the filter dialogue screen, select ''Clear'' and back out of the list.
* If viewing the filtered list, back out of the list to the previous menu, then re-enter the list to see the unfiltered list again.
 
 
 
= Available Filters =
The following screenshots display the available filters as described.
 
A table at after the images summarises all available filters for each class of media.
 
 
 
== Video Library ==
The following four screenshots show the filters available for Movies, TV Shows, Episodes and Music Videos.
 
<gallery mode="packed-overlay" widths="500" heights="290">
File:Filter-Movies.jpg|The Filter options in the '''''Movie library'''''.
File:Filter-TVShows.jpg|The Filter options in the '''''TV Show library'''''.
File:Filter-Episodes.jpg|The Filter options in the '''''Episodes library'''''.
File:Filter-MusicVideos.jpg|The Filter options in the '''''Music Videos library'''''.
</gallery>
 
 
 
== Music Library ==
The following three screenshots show the filters available for Artists, Albums and Songs. A table at the end of this page summarises all available filters for each class of media.
 
<gallery mode="packed-overlay" widths="500" heights="290">
File:Filter-Artist.jpg|The Filter options in the '''''Artists'''''.
File:Filter-Album.jpg|The Filter options in the '''''Albums'''''.
File:Filter-Songs.jpg|The Filter options in the '''''Songs'''''.
</gallery>
 
 
 
== Filter Summary ==
The following table lists which filters are available for which media type:
The following table lists which filters are available for which media type:
{| class="prettytable" style="margin-right: 0;"
{| class="mw-collapsible mw-collapsed wikitable"
!colspan="2"|Filter
!colspan="2" style="width:210px;"|Filter
!colspan="3"|Music
!colspan="3" style="width:210px;"|Music
!colspan="4"|Video
!colspan="4" style="width:280px;"|Video
|-
|-
!style="padding-left: 5px; padding-right: 10px;"|Name
!style="padding-left: 5px; padding-right: 10px; width:90px;"|Name
!style="padding-left: 10px; padding-right: 10px;"|Type
!style="padding-left: 10px; padding-right: 10px; width:120px;"|Type
!style="padding-left: 10px; padding-right: 10px;"|Artists
!style="padding-left: 10px; padding-right: 10px; width:70px;"|Artists
!style="padding-left: 10px; padding-right: 10px;"|Albums
!style="padding-left: 10px; padding-right: 10px; width:70px;"|Albums
!style="padding-left: 10px; padding-right: 10px;"|Songs
!style="padding-left: 10px; padding-right: 10px; width:70px;"|Songs
!style="padding-left: 10px; padding-right: 10px;"|Movies
!style="padding-left: 10px; padding-right: 10px; width:70px;"|Movies
!style="padding-left: 10px; padding-right: 10px;"|TV Shows
!style="padding-left: 10px; padding-right: 10px; width:70px;"|TV Shows
!style="padding-left: 10px; padding-right: 10px;"|Episodes
!style="padding-left: 10px; padding-right: 10px; width:70px;"|Episodes
!style="padding-left: 10px; padding-right: 10px;"|Music Videos
!style="padding-left: 10px; padding-right: 10px; width:70px;"|Music Videos
|-
|-
|style="padding-left: 5px;"|Title
|style="padding-left: 5px;"|Title
Line 71: Line 113:
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|style="padding-left: 5px;"|My Rating
|[[#Range Selector|Range Selector]]
|{{no}}
|{{no}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|-
|-
|style="padding-left: 5px;"|In progress
|style="padding-left: 5px;"|In progress
Line 79: Line 131:
|{{no}}
|{{no}}
|{{yes}}
|{{yes}}
|{{no}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
Line 86: Line 138:
|[[#Range Selector|Range Selector]]
|[[#Range Selector|Range Selector]]
|{{no}}
|{{no}}
|{{no}}
|{{yes}}
|{{no}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
Line 94: Line 146:
|-
|-
|style="padding-left: 5px;"|Tags
|style="padding-left: 5px;"|Tags
|[[#Multiple Selection|Multiple Selection]]
|[[#Text Input|Text Input]]
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{yes}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{yes}}
|{{no}}
|-
|-
|style="padding-left: 5px;"|Genre
|style="padding-left: 5px;"|Genre
|[[#Multiple Selection|Multiple Selection]]
|[[#Text Input|Text Input]]
|{{yes}}
|{{yes}}
|{{yes}}
|{{yes}}
Line 124: Line 176:
|-
|-
|style="padding-left: 5px;"|Director
|style="padding-left: 5px;"|Director
|[[#Multiple Selection|Multiple Selection]]
|[[#Text Input|Text Input]]
|{{no}}
|{{no}}
|{{no}}
|{{no}}
Line 134: Line 186:
|-
|-
|style="padding-left: 5px;"|Studio
|style="padding-left: 5px;"|Studio
|[[#Multiple Selection|Multiple Selection]]
|[[#Text Input|Text Input]]
|{{no}}
|{{no}}
|{{no}}
|{{no}}
Line 156: Line 208:
|[[#Multiple Selection|Multiple Selection]]
|[[#Multiple Selection|Multiple Selection]]
|{{yes}}
|{{yes}}
|{{no}}
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{yes}}
|-
|style="padding-left: 5px;"|Source
|[[#Multiple Selection|Multiple Selection]]
|{{yes}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;"|Moods
|[[#Multiple Selection|Multiple Selection]]
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;"|Styles
|[[#Text Input|Text Input]]
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;"|Instruments
|[[#Text Input|Text Input]]
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;"|Type
|[[#Text Input|Text Input]]
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;"|Gender
|[[#Text Input|Text Input]]
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;"|Disambiguation
|[[#Text Input|Text Input]]
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;"|Biography
|[[#Text Input|Text Input]]
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;"|Born
|[[#Text Input|Text Input]]
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;"|Formed
|[[#Text Input|Text Input]]
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|-
|-
|style="padding-left: 5px;"|Album
|style="padding-left: 5px;"|Disbanded
|[[#Multiple Selection|Multiple Selection]]
|[[#Text Input|Text Input]]
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;"|Died
|[[#Text Input|Text Input]]
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|-
|style="padding-left: 5px;"|Album Artist
|[[#Text Input|Text Input]]
|{{no}}
|{{no}}
|{{yes}}
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|{{no}}
|-
|-
|style="padding-left: 5px;"|Album type
|style="padding-left: 5px;"|Compilation
|[[#Multiple Selection|Multiple Selection]]
|[[#Text Input|Text Input]]
|{{no}}
|{{no}}
|{{yes}}
|{{yes}}
Line 183: Line 355:
|{{no}}
|{{no}}
|-
|-
|style="padding-left: 5px;"|Music label
|style="padding-left: 5px;"|Album
|[[#Text Input|Text Input]]
|{{no}}
|{{no}}
|{{yes}}
|{{no}}
|{{no}}
|{{no}}
|{{yes}}
|-
|style="padding-left: 5px;"|Label
|[[#Multiple Selection|Multiple Selection]]
|[[#Multiple Selection|Multiple Selection]]
|{{no}}
|{{no}}
Line 205: Line 387:
|}
|}


{{Isengard updated}}


= Filter Types =
There are different types of filters and every type comes with a different style and representation. The above series of images display the various types of Filters.
== Text Input ==
Text Input filters allow the user to specify a series of characters which should be contained in the filtered property of the media items. The user can type directly in the Text Input when it is focused or open the on-screen keyboard by pressing on the filter option.
'''Title''' is an example of this type.
== Range Selector ==
Range Selector filters allow the user to specify a range e.g. a range of years or a range of ratings. If the selection covers the whole range no filter will be used. The user can move both range selectors to the left or right to specify the range. Moving up or down switches between the two range selectors.
'''Rating''' is an example of this type.
== Choice Spinner ==
Choice Spinner filters allow the user to choose between one of several choices. Every Choice Spinner filter will have a choice named "All" which disables that specific filter.
'''Compilation''' in Albums is an example of this type.
== Multiple Selection ==
Multiple Selection filters are presented as a title followed by a number in brackets- '''Genre[25]'''. The number indicates the number of available options in the list.
Selecting the button will open the multi-selection dialog with a list of possible options. The user can select any number of options. Selected options will use a '''{{green|green coloured font}}'''
To '''apply''' the selected options the dialog has to be closed by using the '''OK''' button. Closing the dialog with the backspace or escape key will result in '''cancelling''' the selected options.
The available options in the list will depend on what other filters have already been applied.
*If there are no filters applied all the available options will be listed
*If other filters have been applied then the options in the list may be reduced to match the already adjusted filter options.
The button will be greyed out if the list has either 0 or 1 options.
'''Genre''' is one example ofa this type.
{{top}}
{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:How-to]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:Video library]]
[[Category:Video library]]
[[Category:General topics]]
[[Category:First time user]]
[[Category:Quick Start Guide]]

Revision as of 03:43, 18 April 2019

Home icon grey.png   ▶ Music Library
▶ Video Library
▶
▶ Video Management
▶ Advanced library filtering


Introduction

Filter is a Music and Video Library feature that allows a user to quickly reduce a list of titles to a smaller list that matches a user specified criteria. For example, filter the main listing of movies to only movies whose genre is Science Fiction.

There are numerous fields available that can be used to filter lists.

A filter will only be available when a listing of titles is visible on screen.


Filter -v- Search

Filter and Search are not the same. They can be explained as follows:

Filter
When a list of titles is displayed on the screen, applying a filter will remove items that do not match the users criteria. ie A large list is reduced to a smaller list.
Search
Starts with an empty list and adds to it based on the users criteria. ie An empty list is added to with matching titles.

When a Filter is not available, the option will be replaced by Search.


Access

The filter option is accessed from the Left Sideblade Menu

The Filter option itself is available on any page that has a listing of Movies, TV Shows, Episodes or Music Videos for the Video Library or any page that has a listing of Artists, Albums or Songs for the Music Library.

Filter is a library only function. It will work from the main menu options of Movies, TV Shows, Music Videos and Music as well as their Nodes (genre, year, studio etc). It will not be available in Videos>Files as this is not accessing the library nor Smart Playlists as playlists are already filtered.


Usage

Apply Filter
  • From the Filter Dialogue Screen as shown in the below row of images, enter or adjust a field as required. The changes are immediately visible in the background. Select OK to accept and view the modified list.
  • Multiple filters can be applied.
  • Filters are not persistant. They will cancel when exiting the list- this could be due to backing out to the previous menu, or pressing play on a title.
Clear Filter
  • If still in the filter dialogue screen, select Clear and back out of the list.
  • If viewing the filtered list, back out of the list to the previous menu, then re-enter the list to see the unfiltered list again.


Available Filters

The following screenshots display the available filters as described.

A table at after the images summarises all available filters for each class of media.


Video Library

The following four screenshots show the filters available for Movies, TV Shows, Episodes and Music Videos.


Music Library

The following three screenshots show the filters available for Artists, Albums and Songs. A table at the end of this page summarises all available filters for each class of media.


Filter Summary

The following table lists which filters are available for which media type:

Filter Music Video
Name Type Artists Albums Songs Movies TV Shows Episodes Music Videos
Title Text Input No Yes Yes Yes Yes Yes Yes
Rating Range Selector No Yes Yes Yes Yes Yes Yes
My Rating Range Selector No Yes Yes Yes Yes Yes Yes
In progress Choice Spinner No No No Yes Yes Yes No
Year Range Selector No Yes Yes Yes Yes No No
Tags Text Input No No No Yes Yes No Yes
Genre Text Input Yes Yes Yes Yes Yes No Yes
Actor Multiple Selection No No No Yes Yes Yes No
Director Text Input No No No Yes Yes Yes Yes
Studio Text Input No No No Yes Yes No Yes
First aired Range Selector No No No No No Yes No
Artist Multiple Selection Yes No Yes No No No Yes
Source Multiple Selection Yes Yes Yes No No No No
Moods Multiple Selection Yes No No No No No No
Styles Text Input Yes No No No No No No
Instruments Text Input Yes No No No No No No
Type Text Input Yes Yes No No No No No
Gender Text Input Yes No No No No No No
Disambiguation Text Input Yes No No No No No No
Biography Text Input Yes No No No No No No
Born Text Input Yes No No No No No No
Formed Text Input Yes No No No No No No
Disbanded Text Input Yes No No No No No No
Died Text Input Yes No No No No No No
Album Artist Text Input No Yes No No No No No
Compilation Text Input No Yes No No No No No
Album Text Input No No Yes No No No Yes
Label Multiple Selection No Yes No No No No No
Duration Range Selector No No Yes No No No No


Filter Types

There are different types of filters and every type comes with a different style and representation. The above series of images display the various types of Filters.


Text Input

Text Input filters allow the user to specify a series of characters which should be contained in the filtered property of the media items. The user can type directly in the Text Input when it is focused or open the on-screen keyboard by pressing on the filter option.

Title is an example of this type.


Range Selector

Range Selector filters allow the user to specify a range e.g. a range of years or a range of ratings. If the selection covers the whole range no filter will be used. The user can move both range selectors to the left or right to specify the range. Moving up or down switches between the two range selectors.

Rating is an example of this type.


Choice Spinner

Choice Spinner filters allow the user to choose between one of several choices. Every Choice Spinner filter will have a choice named "All" which disables that specific filter.

Compilation in Albums is an example of this type.


Multiple Selection

Multiple Selection filters are presented as a title followed by a number in brackets- Genre[25]. The number indicates the number of available options in the list.

Selecting the button will open the multi-selection dialog with a list of possible options. The user can select any number of options. Selected options will use a green coloured font

To apply the selected options the dialog has to be closed by using the OK button. Closing the dialog with the backspace or escape key will result in cancelling the selected options.

The available options in the list will depend on what other filters have already been applied.

  • If there are no filters applied all the available options will be listed
  • If other filters have been applied then the options in the list may be reduced to match the already adjusted filter options.

The button will be greyed out if the list has either 0 or 1 options.

Genre is one example ofa this type.



Return to top