A separate label effect instance is created for each targetted control:
$(selector).labeleffect();
.
Each instance may have different settings, e.g.
$(selector).labeleffect({effect: 'echoed'});
Below are the options that may be applied to each label effect instance.
color | effect | hiBlend | hiColor | hiDir | hiFill | hiOffset | shadowBlend | shadowColor | shadowDir | shadowFill | shadowOffset
Name | Type | Default | Comments |
---|---|---|---|
color | string | '' | Override the colour of the original text. Leave as blank for no change. |
hiColor | string | 'silver' | The colour of the highlight effect text. |
hiDir | number | this.NONE | The direction of the highlight effect text. Use one of the constants:
UPLEFT , UP , UPRIGHT ,
LEFT , NONE , RIGHT ,
DOWNLEFT , DOWN , or DOWNRIGHT -
all available via the $.labeleffect object. |
hiOffset | number | 0 | The distance by which the highlight effect text is offset. |
hiFill | boolean | false | Set to true if the space between the original text and
the highlight effect text should be filled, giving an extruded look.
Set to false to leave the space empty. |
hiBlend | boolean | false | Set to true if the space between the original text and
the highlight effect text should be filled with a transition from
the original text colour to that of the highlight effect text.
This effect is only seen if hiFill is also true .
Set to false to leave the space empty. |
shadowColor | string | 'silver' | The colour of the shadow effect text. |
shadowDir | number | this.DOWNRIGHT | The direction of the shadow effect text. Use one of the constants:
UPLEFT , UP , UPRIGHT ,
LEFT , NONE , RIGHT ,
DOWNLEFT , DOWN , or DOWNRIGHT -
all available via the $.labeleffect object. |
shadowOffset | number | 5 | The distance by which the shadow effect text is offset. |
shadowFill | boolean | false | Set to true if the space between the original text and
the shadow effect text should be filled, giving an extruded look.
Set to false to leave the space empty. |
shadowBlend | boolean | false | Set to true if the space between the original text and
the shadow effect text should be filled with a transition from
the original text colour to that of the shadow effect text.
This effect is only seen if shadowFill is also true .
Set to false to leave the space empty. |
effect | string | '' | Implement a preset effect, which causes most of the other settings to be assigned appropriate values. Current effects are 'echoed', 'floating', 'raised', 'shadow', 'sunken'. |