Kqlmagic - palette features¶

Explains how to customize and use Kqlmagic palette features

Make sure that you have the lastest version of Kqlmagic¶

Download Kqlmagic from PyPI and install/update (if latest version ims already installed you can skip this step)

In [ ]:

#!pip install Kqlmagic --no-cache-dir --upgrade

Add Kqlmagic to notebook magics¶

In [ ]:

%reload_ext Kqlmagic

Authenticate to get access to data¶

In [ ]:

%kql AzureDataExplorer://code;cluster='help';database='Samples'

Query and render to piechart¶

In [ ]:

%%kql
    StormEvents 
    | summarize count() by State
    | sort by count_ 
    | limit 10 
    | render piechart

Use palette Reds for the piechart¶

set option -palette_name or -pn to Reds

In [ ]:

%%kql -palette_name "Reds"
    StormEvents 
    | summarize count() by State
    | sort by count_ 
    | limit 10 
    | render piechart

Note - to set a different palette, use option -palette_name¶

Use desaturated Reds for the piechart¶

set option -palette_desaturation or -pd with a value between 0 to 1

In [ ]:

%%kql  -palette_name "Reds" -palette_desaturation 0.5 
    StormEvents 
    | summarize count() by State
    | sort by count_ 
    | limit 10 
    | render piechart

Parametrized palette and desaturation¶

set python variables to the palette and distaturioan value, and refer them from the magic

In [ ]:

my_palettes = ["Reds", "Greens", "Blues"]
my_saturation = 0.7
current_palette = 2

In [ ]:

%%kql  -palette_name my_palettes[current_palette] -palette_desaturation my_saturation 
    StormEvents 
    | summarize count() by State
    | sort by count_ 
    | limit 10 
    | render piechart

In [ ]:

current_palette = 0

In [ ]:

%%kql  -palette_name my_palettes[current_palette] -palette_desaturation my_saturation 
    StormEvents 
    | summarize count() by State
    | sort by count_ 
    | limit 10 
    | render piechart

Show current default palette¶

In [ ]:

%kql --palette

palette desaturated by half (0.5)¶

-pd is an abreviation of -palette_desaturation
desturation value must be between to 1

In [ ]:

%kql --palette -pd 0.5

Note - desaturation value is explicitly specified only if it is less than 1¶

palette extended to 40 colors¶

-pc is an abreviation of palettte_colors

In [ ]:

%kql --palette -pd 0.5 -pc 40

alternative Reds palette, desaturated by 0.9, 40 colors¶

Beware that palettes are case sensitive

In [ ]:

%kql --palette -pn "Reds" -pd 0.5 -pc 40

Builtin palettes¶

push the button to open a popup window with the palettes

In [ ]:

%kql --palettes -popup_window

show all builtin palettes desaturated¶

set option -palette_desaturation or -pd with a value between 0 to 1

In [ ]:

%kql --palettes -palette_desaturation 0.5

set option -palette_colrs or -pc with a value greater than 0
set option -palette_desaturation or -pd with a value between 0 to 1
push the button to open a popup window with the palettes

In [ ]:

%kql --palettes -pd 0.5 -pc 20 -pw

Configure default palette properties¶

palette_name
palette_desaturation
palette_colors

show palette name of the default palette¶

In [ ]:

%config Kqlmagic.palette_name

modify the default palette¶

In [ ]:

%config Kqlmagic.palette_name = 'Greens'
%config Kqlmagic.palette_name

show palette desaturation default¶

In [ ]:

%config Kqlmagic.palette_desaturation

modify palette desaturation¶

In [ ]:

%config Kqlmagic.palette_desaturation = 0.95
%config Kqlmagic.palette_desaturation

show number of colors in default palette¶

In [ ]:

%config Kqlmagic.palette_colors

modify number of colors in default palette¶

In [ ]:

%config Kqlmagic.palette_colors = 6
%config Kqlmagic.palette_colors

show the deault palette based on the new defaults¶

In [ ]:

%kql --palette

In [ ]:

%%kql -palette_desaturation 0.5 
    StormEvents 
    | summarize count() by State
    | sort by count_ 
    | limit 10 
    | render piechart

Note - The palette size extends automativally, if required by chart (in above chart extended from 6 colors palette to 10 colors palette¶

Reverse color order of palette¶

Set option -palette_reverse / -pr

In [ ]:

%%kql  -palette_reverse 
    StormEvents 
    | summarize count() by State
    | sort by count_ 
    | limit 10 
    | render piechart

In [ ]:

%config Kqlmagic.palette_colors = 20
%config Kqlmagic.palette_colors

Palette derivative names¶

basic names
subset names
reversed names
custom

basic pastel palette¶

In [ ]:

%kql --palette -pn "pastel"

Note - When not specified, palette_name, palette_colors and palette_desaturation default properties are used¶

subset derived from a basic palette¶

In [ ]:

%kql --palette -pn "pastel[4:11]"

reversed from a basic palette¶

In [ ]:

%kql --palette -pn "pastel_r"

reversed subset of a basic palette¶

In [ ]:

%kql --palette -pn "pastel[4:11]_r"

piechart rendered using a derived palette¶

In [ ]:

%%kql -pn "pastel[4:11]_r" 
    StormEvents 
    | summarize count() by State
    | sort by count_ 
    | limit 7 
    | render piechart

config default palette with a derived palette¶

In [ ]:

%config Kqlmagic.palette_name = "pastel[4:11]_r"
%config Kqlmagic.palette_name

barchart rendered using the new default palette¶

In [ ]:

%%kql 
    StormEvents 
    | summarize count() by State
    | extend count2 = count_*1.4 
    | extend count3 = count_*2.4
    | sort by count_ 
    | limit 7 
    | render barchart

Custom palette¶

define an alternative basic palette
have same characteristics as basic palette, a subset can be derived and/or reversed

show custom palette¶

make sure that there are no white spaces in the string that defines the custom palette

In [ ]:

%kql --palette -pn "['rgb(127,155,173)','rgb(103,135,156)','rgb(82,114,140)','rgb(63,93,122)','rgb(48,73,102)']"

show derived subset palette from the custom palette¶

In [ ]:

%kql --palette -pn "['rgb(127,155,173)','rgb(103,135,156)','rgb(82,114,140)','rgb(63,93,122)','rgb(48,73,102)'][1:4]"

show derived reversed subset palette from custom palette¶

In [ ]:

%kql --palette -pn "['rgb(127,155,173)','rgb(103,135,156)','rgb(82,114,140)','rgb(63,93,122)','rgb(48,73,102)'][1:4]_r"

columnchart rendered using a custom palette¶

In [ ]:

%%kql -pn "['rgb(127,155,173)','rgb(103,135,156)','rgb(82,114,140)','rgb(63,93,122)','rgb(48,73,102)'][1:4]_r"
    StormEvents 
    | summarize count() by State
    | extend count2 = count_*1.4 
    | extend count3 = count_*2.4
    | sort by count_ 
    | limit 7 
    | render columnchart

set custom palette as default palette¶

In [ ]:

%config Kqlmagic.palette_name = "['rgb(127,155,173)','rgb(103,135,156)','rgb(82,114,140)','rgb(63,93,122)','rgb(48,73,102)'][1:4]_r"
%config Kqlmagic.palette_name

barchart rendered using default palette (set to the custom chart)¶

In [ ]:

%%kql 
    StormEvents 
    | summarize count() by State
    | extend count2 = count_*1.4 
    | extend count3 = count_*2.4
    | sort by count_ 
    | limit 7 
    | render barchart

Python integration¶

In [ ]:

%%kql -pn "Spectral" -pd 0.95 -pc 10
    StormEvents 
    | summarize count() by State
    | extend count2 = count_*1.4 
    | extend count3 = count_*2.4
    | sort by count_ 
    | limit 10
    | render piechart

get last kql result palette¶

In [ ]:

_kql_raw_result_.palette

get a slice from palette¶

behave as list of colors

In [ ]:

_kql_raw_result_.palette[3:]

get one color from palette¶

In [ ]:

_kql_raw_result_.palette[7]

get the palette raw rgb data¶

In [ ]:

list(_kql_raw_result_.palette)

get palette_name (name of the palette)¶

In [ ]:

_kql_raw_result_.options['palette_name']

get palette_colors value (number of colors in palette)¶

In [ ]:

_kql_raw_result_.options['palette_colors']

get palette_desaturation value¶

In [ ]:

_kql_raw_result_.options['palette_desaturation']

get palette_reverse state¶

In [ ]:

_kql_raw_result_.options['palette_reverse']

get builin palettes¶

In [ ]:

_kql_raw_result_.palettes

get builtin palette by name¶

In [ ]:

_kql_raw_result_.palettes['Oranges']

get builtin palette by index¶

In [ ]:

_kql_raw_result_.palettes[5]

get slice of an indexed builtin palette¶

In [ ]:

_kql_raw_result_.palettes[5][:6]

get a color of a slice from an indexed builtin palette¶

In [ ]:

_kql_raw_result_.palettes[5][:6][3]

get slice of a named builtin palette¶

In [ ]:

_kql_raw_result_.palettes['terrain'][:6]

get all the names of the builtin palettes¶

In [ ]:

list(_kql_raw_result_.palettes)

get the raw rgb data of a slice from an indexed buitin palette¶

In [ ]:

list(_kql_raw_result_.palettes[5][:6])

In [ ]:

%kql --help

In [ ]:

Kqlmagic - palette features¶

Make sure that you have the lastest version of Kqlmagic¶

Add Kqlmagic to notebook magics¶

Authenticate to get access to data¶

Query and render to piechart¶

Use palette Reds for the piechart¶

Note - to set a different palette, use option -palette_name¶

Use desaturated Reds for the piechart¶

Parametrized palette and desaturation¶

Show current default palette¶

palette desaturated by half (0.5)¶

Note - desaturation value is explicitly specified only if it is less than 1¶

palette extended to 40 colors¶

alternative Reds palette, desaturated by 0.9, 40 colors¶

Builtin palettes¶

popup all builtin palettes¶

show all builtin palettes desaturated¶

popup all builtin n_colors palettes desaturated¶

Configure default palette properties¶

show palette name of the default palette¶

modify the default palette¶

show palette desaturation default¶

modify palette desaturation¶

show number of colors in default palette¶

modify number of colors in default palette¶

show the deault palette based on the new defaults¶

Note - The palette size extends automativally, if required by chart (in above chart extended from 6 colors palette to 10 colors palette¶

Reverse color order of palette¶

Palette derivative names¶

basic pastel palette¶

Note - When not specified, palette_name, palette_colors and palette_desaturation default properties are used¶

subset derived from a basic palette¶

reversed from a basic palette¶

reversed subset of a basic palette¶

piechart rendered using a derived palette¶

config default palette with a derived palette¶

barchart rendered using the new default palette¶

Custom palette¶

show custom palette¶

show derived subset palette from the custom palette¶

show derived reversed subset palette from custom palette¶

columnchart rendered using a custom palette¶

set custom palette as default palette¶

barchart rendered using default palette (set to the custom chart)¶

Python integration¶

get last kql result palette¶

get a slice from palette¶

get one color from palette¶

get the palette raw rgb data¶

get palette_name (name of the palette)¶

get palette_colors value (number of colors in palette)¶

get palette_desaturation value¶

get palette_reverse state¶

get builin palettes¶

get builtin palette by name¶

get builtin palette by index¶

get slice of an indexed builtin palette¶

get a color of a slice from an indexed builtin palette¶

get slice of a named builtin palette¶

get all the names of the builtin palettes¶

get the raw rgb data of a slice from an indexed buitin palette¶