Chartbreaker
    Preparing search index...

    Variable ObjectEFlagsConst

    ObjectEFlags: {
        CONTAINER: 32;
        EXPOSED: 128;
        GENERATED: 4;
        LOCKED: 2;
        NONE: 0;
        PASSTHROUGH: 8;
        REMOVABLE: 16;
        SIGNAL: 1;
        UNFINISHED: 64;
    }

    An enum containing various bit flags to indicate properties for instances of ChartbreakerObject or it's options Bits 1-16 are reserved by ChartBreaker; applications may use all aditional bits

    Checking for a flag

      // manually
    var isLocked = (object.get('objFlags') & ObjectEFlags.LOCKED);
    // using the utility methods
    var isLocked = utils.hasFlag(object, ObjectEFlags.LOCKED);

    Modifying flags

    Unlike most other config values, you will probably not want to directly set a new value most of the time. Instead, you might want to add, remove or toggle flags

      // adding a flag manually using |
    object.set('objFlags', object.get('objFlags') | ObjectEFlags.LOCKED);
    // using the utility method
    utils.addFlag(object, ObjectEFlags.LOCKED);
    // removing a flag manually using &~
    object.set('objFlags', object.get('objFlags') & ~ObjectEFlags.LOCKED);
    // using the utility method
    utils.rmFlag(object, ObjectEFlags.LOCKED);
    // toggling flags manually using ^
    object.set('objFlags', object.get('objFlags') ^ ObjectEFlags.LOCKED);

    Type Declaration

    • ReadonlyCONTAINER: 32

      object has children (e.g. chart contains timeseries, timeseries contain layers, ...)

    • ReadonlyEXPOSED: 128

      exposed to ui; e.g. if this flag is set, the UI may show this object

    • ReadonlyGENERATED: 4

      object was automatically generated by a ToolGenerator, often used in combination with the LOCKED flag

    • ReadonlyLOCKED: 2

      object is locked, and can/must not be modified, but can be selected/interacted with

    • ReadonlyNONE: 0

      no flags

    • ReadonlyPASSTHROUGH: 8

      object is ignored by event handling; e.g. can not be selected/hovered/interacted with

    • ReadonlyREMOVABLE: 16

      object can be removed via UI

    • ReadonlySIGNAL: 1

      object has signal characteristics (e.g. for a horizontal line tool = threshold value of an indicator)

    • ReadonlyUNFINISHED: 64

      object is not yet finialized (e.g. a tool that is currently being placed)